| /******************************************************************************* |
| * Copyright (c) 2013, 2020 Dirk Fauth and others. |
| * |
| * This program and the accompanying materials are made |
| * available under the terms of the Eclipse Public License 2.0 |
| * which is available at https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Dirk Fauth <dirk.fauth@googlemail.com> - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.nebula.widgets.nattable.examples._600_GlazedLists._603_Filter; |
| |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Random; |
| |
| import org.eclipse.nebula.widgets.nattable.NatTable; |
| import org.eclipse.nebula.widgets.nattable.config.AbstractRegistryConfiguration; |
| import org.eclipse.nebula.widgets.nattable.config.CellConfigAttributes; |
| import org.eclipse.nebula.widgets.nattable.config.ConfigRegistry; |
| import org.eclipse.nebula.widgets.nattable.config.DefaultNatTableStyleConfiguration; |
| import org.eclipse.nebula.widgets.nattable.config.IConfigRegistry; |
| import org.eclipse.nebula.widgets.nattable.config.IEditableRule; |
| import org.eclipse.nebula.widgets.nattable.data.IColumnPropertyAccessor; |
| import org.eclipse.nebula.widgets.nattable.data.IDataProvider; |
| import org.eclipse.nebula.widgets.nattable.data.ListDataProvider; |
| import org.eclipse.nebula.widgets.nattable.data.ReflectiveColumnPropertyAccessor; |
| import org.eclipse.nebula.widgets.nattable.data.convert.DefaultDoubleDisplayConverter; |
| import org.eclipse.nebula.widgets.nattable.data.convert.DefaultIntegerDisplayConverter; |
| import org.eclipse.nebula.widgets.nattable.data.convert.DisplayConverter; |
| import org.eclipse.nebula.widgets.nattable.edit.EditConfigAttributes; |
| import org.eclipse.nebula.widgets.nattable.edit.editor.IComboBoxDataProvider; |
| import org.eclipse.nebula.widgets.nattable.examples.AbstractNatExample; |
| import org.eclipse.nebula.widgets.nattable.examples._600_GlazedLists._603_Filter._6035_ExcelLikeFilterRowCustomTypesExample.MyRowObject.Gender; |
| import org.eclipse.nebula.widgets.nattable.examples.runner.StandaloneNatExampleRunner; |
| import org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsEventLayer; |
| import org.eclipse.nebula.widgets.nattable.extension.glazedlists.filterrow.ComboBoxFilterRowHeaderComposite; |
| import org.eclipse.nebula.widgets.nattable.filterrow.FilterRowDataLayer; |
| import org.eclipse.nebula.widgets.nattable.filterrow.combobox.ComboBoxFilterIconPainter; |
| import org.eclipse.nebula.widgets.nattable.filterrow.combobox.ComboBoxFilterRowConfiguration; |
| import org.eclipse.nebula.widgets.nattable.filterrow.combobox.FilterRowComboBoxCellEditor; |
| import org.eclipse.nebula.widgets.nattable.filterrow.config.FilterRowConfigAttributes; |
| import org.eclipse.nebula.widgets.nattable.grid.data.DefaultColumnHeaderDataProvider; |
| import org.eclipse.nebula.widgets.nattable.grid.data.DefaultCornerDataProvider; |
| import org.eclipse.nebula.widgets.nattable.grid.data.DefaultRowHeaderDataProvider; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.ColumnHeaderLayer; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.CornerLayer; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.DefaultColumnHeaderDataLayer; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.DefaultRowHeaderDataLayer; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.GridLayer; |
| import org.eclipse.nebula.widgets.nattable.grid.layer.RowHeaderLayer; |
| import org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform; |
| import org.eclipse.nebula.widgets.nattable.layer.DataLayer; |
| import org.eclipse.nebula.widgets.nattable.layer.ILayer; |
| import org.eclipse.nebula.widgets.nattable.layer.cell.ColumnLabelAccumulator; |
| import org.eclipse.nebula.widgets.nattable.persistence.command.DisplayPersistenceDialogCommandHandler; |
| import org.eclipse.nebula.widgets.nattable.selection.SelectionLayer; |
| import org.eclipse.nebula.widgets.nattable.style.DisplayMode; |
| import org.eclipse.nebula.widgets.nattable.ui.menu.HeaderMenuConfiguration; |
| import org.eclipse.nebula.widgets.nattable.ui.menu.PopupMenuBuilder; |
| import org.eclipse.nebula.widgets.nattable.util.GUIHelper; |
| import org.eclipse.nebula.widgets.nattable.viewport.ViewportLayer; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| |
| import ca.odell.glazedlists.EventList; |
| import ca.odell.glazedlists.FilterList; |
| import ca.odell.glazedlists.GlazedLists; |
| import ca.odell.glazedlists.SortedList; |
| import ca.odell.glazedlists.TransformedList; |
| |
| /** |
| * Example showing how to add the filter row to the layer composition of a grid |
| * that looks like the Excel filter. It also shows how to add support for |
| * filtering custom data type in such a filter row. |
| */ |
| public class _6035_ExcelLikeFilterRowCustomTypesExample extends AbstractNatExample { |
| |
| Random randomGenerator = new Random(); |
| |
| public static void main(String[] args) throws Exception { |
| StandaloneNatExampleRunner.run(new _6035_ExcelLikeFilterRowCustomTypesExample()); |
| } |
| |
| @Override |
| public String getDescription() { |
| return "This example shows the usage of the filter row within a grid that looks like the Excel" |
| + " filter row. It also shows how to add support for filtering custom data types" |
| + " in such a filter row."; |
| } |
| |
| @Override |
| public Control createExampleControl(Composite parent) { |
| // create a new ConfigRegistry which will be needed for GlazedLists |
| // handling |
| ConfigRegistry configRegistry = new ConfigRegistry(); |
| |
| String[] propertyNames = { "name", "age", "money", "gender", "city" }; |
| |
| // mapping from property to label, needed for column header labels |
| Map<String, String> propertyToLabelMap = new HashMap<>(); |
| propertyToLabelMap.put("name", "Name"); |
| propertyToLabelMap.put("age", "Age"); |
| propertyToLabelMap.put("money", "Money"); |
| propertyToLabelMap.put("gender", "Gender"); |
| propertyToLabelMap.put("city", "City"); |
| |
| IColumnPropertyAccessor<MyRowObject> columnPropertyAccessor = |
| new ReflectiveColumnPropertyAccessor<>(propertyNames); |
| |
| BodyLayerStack<MyRowObject> bodyLayerStack = |
| new BodyLayerStack<>(createMyRowObjects(50), columnPropertyAccessor); |
| // add a label accumulator to be able to register converter |
| bodyLayerStack.getBodyDataLayer().setConfigLabelAccumulator(new ColumnLabelAccumulator()); |
| |
| // build the column header layer |
| IDataProvider columnHeaderDataProvider = |
| new DefaultColumnHeaderDataProvider(propertyNames, propertyToLabelMap); |
| DataLayer columnHeaderDataLayer = |
| new DefaultColumnHeaderDataLayer(columnHeaderDataProvider); |
| ILayer columnHeaderLayer = |
| new ColumnHeaderLayer(columnHeaderDataLayer, bodyLayerStack, bodyLayerStack.getSelectionLayer()); |
| |
| // example on how to configure a different icon if a filter is applied |
| ComboBoxFilterRowHeaderComposite<MyRowObject> filterRowHeaderLayer = |
| new ComboBoxFilterRowHeaderComposite<>( |
| bodyLayerStack.getFilterList(), |
| bodyLayerStack.getBodyDataLayer(), |
| bodyLayerStack.getSortedList(), columnPropertyAccessor, |
| columnHeaderLayer, columnHeaderDataProvider, configRegistry, |
| false); |
| final IComboBoxDataProvider comboBoxDataProvider = filterRowHeaderLayer.getComboBoxDataProvider(); |
| filterRowHeaderLayer.addConfiguration( |
| new ComboBoxFilterRowConfiguration( |
| new FilterRowComboBoxCellEditor(comboBoxDataProvider, 5), |
| new ComboBoxFilterIconPainter(comboBoxDataProvider, GUIHelper.getImage("filter"), null))); |
| |
| // build the row header layer |
| IDataProvider rowHeaderDataProvider = |
| new DefaultRowHeaderDataProvider(bodyLayerStack.getBodyDataProvider()); |
| DataLayer rowHeaderDataLayer = |
| new DefaultRowHeaderDataLayer(rowHeaderDataProvider); |
| ILayer rowHeaderLayer = |
| new RowHeaderLayer(rowHeaderDataLayer, bodyLayerStack, bodyLayerStack.getSelectionLayer()); |
| |
| // build the corner layer |
| IDataProvider cornerDataProvider = |
| new DefaultCornerDataProvider(columnHeaderDataProvider, rowHeaderDataProvider); |
| DataLayer cornerDataLayer = |
| new DataLayer(cornerDataProvider); |
| ILayer cornerLayer = |
| new CornerLayer(cornerDataLayer, rowHeaderLayer, filterRowHeaderLayer); |
| |
| // build the grid layer |
| GridLayer gridLayer = |
| new GridLayer(bodyLayerStack, filterRowHeaderLayer, rowHeaderLayer, cornerLayer); |
| |
| // turn the auto configuration off as we want to add our header menu |
| // configuration |
| NatTable natTable = new NatTable(parent, gridLayer, false); |
| // as the autoconfiguration of the NatTable is turned off, we have to |
| // add the DefaultNatTableStyleConfiguration and the ConfigRegistry |
| // manually |
| natTable.setConfigRegistry(configRegistry); |
| natTable.addConfiguration(new DefaultNatTableStyleConfiguration()); |
| natTable.addConfiguration(new MyRowObjectTableConfiguration()); |
| natTable.addConfiguration(new FilterRowConfiguration()); |
| |
| natTable.addConfiguration(new HeaderMenuConfiguration(natTable) { |
| @Override |
| protected PopupMenuBuilder createCornerMenu(NatTable natTable) { |
| return super.createCornerMenu(natTable) |
| .withStateManagerMenuItemProvider(); |
| } |
| }); |
| |
| natTable.addConfiguration(new AbstractRegistryConfiguration() { |
| |
| @Override |
| public void configureRegistry(IConfigRegistry configRegistry) { |
| configRegistry.registerConfigAttribute( |
| EditConfigAttributes.CELL_EDITABLE_RULE, |
| IEditableRule.ALWAYS_EDITABLE); |
| } |
| |
| }); |
| |
| natTable.configure(); |
| |
| natTable.registerCommandHandler( |
| new DisplayPersistenceDialogCommandHandler(natTable)); |
| |
| return natTable; |
| } |
| |
| /** |
| * Always encapsulate the body layer stack in an AbstractLayerTransform to |
| * ensure that the index transformations are performed in later commands. |
| * |
| * @param <T> |
| */ |
| class BodyLayerStack<T> extends AbstractLayerTransform { |
| |
| private final SortedList<T> sortedList; |
| private final FilterList<T> filterList; |
| |
| private final IDataProvider bodyDataProvider; |
| private final DataLayer bodyDataLayer; |
| |
| private final SelectionLayer selectionLayer; |
| |
| public BodyLayerStack(List<T> values, IColumnPropertyAccessor<T> columnPropertyAccessor) { |
| // wrapping of the list to show into GlazedLists |
| // see http://publicobject.com/glazedlists/ for further information |
| EventList<T> eventList = GlazedLists.eventList(values); |
| TransformedList<T, T> rowObjectsGlazedList = GlazedLists.threadSafeList(eventList); |
| |
| // use the SortedList constructor with 'null' for the Comparator |
| // because the Comparator |
| // will be set by configuration |
| this.sortedList = new SortedList<>(rowObjectsGlazedList, null); |
| // wrap the SortedList with the FilterList |
| this.filterList = new FilterList<>(getSortedList()); |
| |
| this.bodyDataProvider = new ListDataProvider<>(this.filterList, columnPropertyAccessor); |
| this.bodyDataLayer = new DataLayer(getBodyDataProvider()); |
| |
| // layer for event handling of GlazedLists and PropertyChanges |
| GlazedListsEventLayer<T> glazedListsEventLayer = |
| new GlazedListsEventLayer<>(this.bodyDataLayer, this.filterList); |
| |
| this.selectionLayer = new SelectionLayer(glazedListsEventLayer); |
| ViewportLayer viewportLayer = new ViewportLayer(getSelectionLayer()); |
| |
| setUnderlyingLayer(viewportLayer); |
| } |
| |
| public SelectionLayer getSelectionLayer() { |
| return this.selectionLayer; |
| } |
| |
| public SortedList<T> getSortedList() { |
| return this.sortedList; |
| } |
| |
| public FilterList<T> getFilterList() { |
| return this.filterList; |
| } |
| |
| public IDataProvider getBodyDataProvider() { |
| return this.bodyDataProvider; |
| } |
| |
| public DataLayer getBodyDataLayer() { |
| return this.bodyDataLayer; |
| } |
| } |
| |
| /** |
| * Converter for the Gender enumeration of the MyRowObject type |
| */ |
| class GenderDisplayConverter extends DisplayConverter { |
| |
| @Override |
| public Object canonicalToDisplayValue(Object canonicalValue) { |
| if (canonicalValue instanceof Gender) { |
| String result = canonicalValue.toString(); |
| result = result.substring(0, 1) |
| + result.substring(1).toLowerCase(); |
| return result; |
| } |
| return ""; |
| } |
| |
| @Override |
| public Object displayToCanonicalValue(Object displayValue) { |
| return Gender.valueOf(displayValue.toString().toUpperCase()); |
| } |
| |
| } |
| |
| /** |
| * Converter for the City type |
| */ |
| class CityDisplayConverter extends DisplayConverter { |
| |
| @Override |
| public Object canonicalToDisplayValue(Object canonicalValue) { |
| if (canonicalValue instanceof City) { |
| return ((City) canonicalValue).getPlz() + " " |
| + ((City) canonicalValue).getName(); |
| } |
| return ""; |
| } |
| |
| @Override |
| public Object displayToCanonicalValue(Object displayValue) { |
| // I know there are better ways for conversion, this should only be |
| // an example |
| // for a more complex way to convert custom data types |
| String plz = displayValue.toString().substring(0, 4); |
| for (City city : _6035_ExcelLikeFilterRowCustomTypesExample.this.possibleCities) { |
| if (city.getPlz() == Integer.valueOf(plz)) { |
| return city; |
| } |
| } |
| return null; |
| } |
| |
| } |
| |
| class MyRowObjectTableConfiguration extends AbstractRegistryConfiguration { |
| |
| @Override |
| public void configureRegistry(IConfigRegistry configRegistry) { |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new DefaultIntegerDisplayConverter(), |
| DisplayMode.NORMAL, |
| ColumnLabelAccumulator.COLUMN_LABEL_PREFIX + 1); |
| |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new DefaultDoubleDisplayConverter(), |
| DisplayMode.NORMAL, |
| ColumnLabelAccumulator.COLUMN_LABEL_PREFIX + 2); |
| |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new GenderDisplayConverter(), |
| DisplayMode.NORMAL, |
| ColumnLabelAccumulator.COLUMN_LABEL_PREFIX + 3); |
| |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new CityDisplayConverter(), |
| DisplayMode.NORMAL, |
| ColumnLabelAccumulator.COLUMN_LABEL_PREFIX + 4); |
| } |
| } |
| |
| /** |
| * The configuration to enable the edit mode for the grid and additional |
| * edit configurations like converters and validators. |
| */ |
| class FilterRowConfiguration extends AbstractRegistryConfiguration { |
| |
| @Override |
| public void configureRegistry(IConfigRegistry configRegistry) { |
| |
| // register the converters used by the filter logic |
| configRegistry.registerConfigAttribute( |
| FilterRowConfigAttributes.FILTER_DISPLAY_CONVERTER, |
| new DefaultIntegerDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 1); |
| |
| configRegistry.registerConfigAttribute( |
| FilterRowConfigAttributes.FILTER_DISPLAY_CONVERTER, |
| new DefaultDoubleDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 2); |
| |
| configRegistry.registerConfigAttribute( |
| FilterRowConfigAttributes.FILTER_DISPLAY_CONVERTER, |
| new GenderDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 3); |
| |
| configRegistry.registerConfigAttribute( |
| FilterRowConfigAttributes.FILTER_DISPLAY_CONVERTER, |
| new CityDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 4); |
| |
| // register the converters for rendering in |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new GenderDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 3); |
| |
| configRegistry.registerConfigAttribute( |
| CellConfigAttributes.DISPLAY_CONVERTER, |
| new CityDisplayConverter(), |
| DisplayMode.NORMAL, |
| FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX + 4); |
| } |
| |
| } |
| |
| private List<MyRowObject> createMyRowObjects(int amount) { |
| List<MyRowObject> result = new ArrayList<>(); |
| |
| MyRowObject obj = null; |
| for (int i = 0; i < amount; i++) { |
| obj = new MyRowObject(); |
| |
| String[] maleNames = { "Bart", "Homer", "Lenny", "Carl", "Waylon", |
| "Ned", "Timothy" }; |
| String[] femaleNames = { "Marge", "Lisa", "Maggie", "Edna", |
| "Helen", "Jessica" }; |
| String[] lastNames = { "Simpson", "Leonard", "Carlson", "Smithers", |
| "Flanders", "Krabappel", "Lovejoy" }; |
| |
| obj.setGender(Gender.values()[this.randomGenerator.nextInt(2)]); |
| |
| if (obj.getGender().equals(Gender.MALE)) { |
| obj.setName(maleNames[this.randomGenerator.nextInt(maleNames.length)] |
| + " " |
| + lastNames[this.randomGenerator.nextInt(lastNames.length)]); |
| } else { |
| obj.setName(femaleNames[this.randomGenerator |
| .nextInt(femaleNames.length)] |
| + " " |
| + lastNames[this.randomGenerator.nextInt(lastNames.length)]); |
| } |
| |
| obj.setAge(this.randomGenerator.nextInt(100)); |
| obj.setMoney(this.randomGenerator.nextDouble() * this.randomGenerator.nextInt(100)); |
| |
| obj.setCity(this.possibleCities.get(this.randomGenerator.nextInt(this.possibleCities.size()))); |
| |
| result.add(obj); |
| } |
| |
| return result; |
| } |
| |
| public static class MyRowObject { |
| |
| enum Gender { |
| MALE, FEMALE |
| } |
| |
| String name; |
| int age; |
| double money; |
| Gender gender; |
| City city; |
| |
| public String getName() { |
| return this.name; |
| } |
| |
| public void setName(String name) { |
| this.name = name; |
| } |
| |
| public int getAge() { |
| return this.age; |
| } |
| |
| public void setAge(int age) { |
| this.age = age; |
| } |
| |
| public double getMoney() { |
| return this.money; |
| } |
| |
| public void setMoney(double money) { |
| this.money = money; |
| } |
| |
| public Gender getGender() { |
| return this.gender; |
| } |
| |
| public void setGender(Gender gender) { |
| this.gender = gender; |
| } |
| |
| public City getCity() { |
| return this.city; |
| } |
| |
| public void setCity(City city) { |
| this.city = city; |
| } |
| |
| } |
| |
| private List<City> possibleCities = new ArrayList<>(); |
| { |
| this.possibleCities.add(new City(1111, "Springfield")); |
| this.possibleCities.add(new City(2222, "Shelbyville")); |
| this.possibleCities.add(new City(3333, "Ogdenville")); |
| this.possibleCities.add(new City(4444, "Waverly Hills")); |
| this.possibleCities.add(new City(5555, "North Haverbrook")); |
| this.possibleCities.add(new City(6666, "Capital City")); |
| } |
| |
| public static class City { |
| final int plz; |
| final String name; |
| |
| City(int plz, String name) { |
| this.plz = plz; |
| this.name = name; |
| } |
| |
| public int getPlz() { |
| return this.plz; |
| } |
| |
| public String getName() { |
| return this.name; |
| } |
| } |
| |
| } |
