* Add a SelectionMode shorthand for Grid.
Hides setSelectionModel(...) by making it protected.
Refactores the usage of constructor / extend method for Abstract-, Single- and MultiSelectionModelImpl.
Fixes vaadin/framework8-issues#519
Change-Id: I48c30886450506639be9ee6e21c45b0c06755c88
import com.vaadin.shared.ui.grid.SectionState;
import com.vaadin.shared.util.SharedUtil;
import com.vaadin.ui.Grid.FooterRow;
+import com.vaadin.ui.components.grid.AbstractSelectionModel;
import com.vaadin.ui.components.grid.EditorImpl;
import com.vaadin.ui.components.grid.Footer;
import com.vaadin.ui.components.grid.Header;
import com.vaadin.ui.components.grid.Header.Row;
+import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
+import com.vaadin.ui.components.grid.NoSelectionModel;
import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
import com.vaadin.ui.declarative.DesignContext;
import com.vaadin.ui.renderers.AbstractRenderer;
void columnReorder(ColumnReorderEvent event);
}
+ /**
+ * Selection mode representing the built-in selection models in grid.
+ * <p>
+ * These enums can be used in {@link Grid#setSelectionMode(SelectionMode)}
+ * to easily switch between the build-in selection models.
+ *
+ * @see Grid#setSelectionMode(SelectionMode)
+ * @see Grid#setSelectionModel(GridSelectionModel)
+ */
+ public enum SelectionMode {
+
+ /**
+ * Single selection mode that maps to build-in
+ * {@link SingleSelectionModel}.
+ *
+ * @see SingleSelectionModelImpl
+ */
+ SINGLE {
+ @Override
+ protected <T> GridSelectionModel<T> createModel() {
+ return new SingleSelectionModelImpl<>();
+ }
+ },
+
+ /**
+ * Multiselection mode that maps to build-in
+ * {@link MultiSelectionModel}.
+ *
+ * @see MultiSelectionModelImpl
+ */
+ MULTI {
+ @Override
+ protected <T> GridSelectionModel<T> createModel() {
+ return new MultiSelectionModelImpl<>();
+ }
+ },
+
+ /**
+ * Selection model that doesn't allow selection.
+ *
+ * @see NoSelectionModel
+ */
+ NONE {
+ @Override
+ protected <T> GridSelectionModel<T> createModel() {
+ return new NoSelectionModel<>();
+ }
+ };
+
+ /**
+ * Creates the selection model to use with this enum.
+ *
+ * @param <T>
+ * the type of items in the grid
+ * @return the selection model
+ */
+ protected abstract <T> GridSelectionModel<T> createModel();
+ }
+
/**
* The server-side interface that controls Grid's selection state.
* SelectionModel should extend {@link AbstractGridExtension}.
*
* @param <T>
* the grid bean type
+ * @see AbstractSelectionModel
* @see SingleSelectionModel
* @see MultiSelectionModel
*/
* empty selection).
*/
@Override
- void remove();
+ public void remove();
}
/**
}
/**
- * Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead.
- * The cell has a width of all merged cells together, inherits styles of the first merged cell
- * but has empty caption.
+ * Merges column cells in the row. Original cells are hidden, and new
+ * merged cell is shown instead. The cell has a width of all merged
+ * cells together, inherits styles of the first merged cell but has
+ * empty caption.
*
* @param cellsToMerge
- * the cells which should be merged. The cells should not be merged to any other cell set.
+ * the cells which should be merged. The cells should not be
+ * merged to any other cell set.
* @return the remaining visible cell after the merge
*
- * @see #join(Grid.HeaderCell...)
+ * @see #join(Grid.HeaderCell...)
* @see com.vaadin.ui.AbstractComponent#setCaption(String) setCaption
*/
HeaderCell join(Set<HeaderCell> cellsToMerge);
/**
- * Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead.
- * The cell has a width of all merged cells together, inherits styles of the first merged cell
- * but has empty caption.
+ * Merges column cells in the row. Original cells are hidden, and new
+ * merged cell is shown instead. The cell has a width of all merged
+ * cells together, inherits styles of the first merged cell but has
+ * empty caption.
*
* @param cellsToMerge
- * the cells which should be merged. The cells should not be merged to any other cell set.
+ * the cells which should be merged. The cells should not be
+ * merged to any other cell set.
* @return the remaining visible cell after the merge
*
- * @see #join(Set)
+ * @see #join(Set)
* @see com.vaadin.ui.AbstractComponent#setCaption(String) setCaption
*/
HeaderCell join(HeaderCell... cellsToMerge);
}
/**
- * Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead.
- * The cell has a width of all merged cells together, inherits styles of the first merged cell
- * but has empty caption.
+ * Merges column cells in the row. Original cells are hidden, and new
+ * merged cell is shown instead. The cell has a width of all merged
+ * cells together, inherits styles of the first merged cell but has
+ * empty caption.
*
* @param cellsToMerge
- * the cells which should be merged. The cells should not be merged to any other cell set.
+ * the cells which should be merged. The cells should not be
+ * merged to any other cell set.
* @return the remaining visible cell after the merge
*
* @see #join(Grid.FooterCell...)
FooterCell join(Set<FooterCell> cellsToMerge);
/**
- * Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead.
- * The cell has a width of all merged cells together, inherits styles of the first merged cell
- * but has empty caption.
+ * Merges column cells in the row. Original cells are hidden, and new
+ * merged cell is shown instead. The cell has a width of all merged
+ * cells together, inherits styles of the first merged cell but has
+ * empty caption.
*
* @param cellsToMerge
- * the cells which should be merged. The cells should not be merged to any other cell set.
+ * the cells which should be merged. The cells should not be
+ * merged to any other cell set.
* @return the remaining visible cell after the merge
*
* @see #join(Set)
* @see com.vaadin.ui.AbstractComponent#setCaption(String) setCaption
*/
- FooterCell join(FooterCell ... cellsToMerge);
+ FooterCell join(FooterCell... cellsToMerge);
}
/**
setDefaultHeaderRow(appendHeaderRow());
- selectionModel = new SingleSelectionModelImpl<>(this);
+ setSelectionModel(new SingleSelectionModelImpl<>());
detailsManager = new DetailsManager<>();
addExtension(detailsManager);
}
/**
- * Returns the selection model for this listing.
+ * Returns the selection model for this grid.
*
* @return the selection model, not null
*/
}
/**
- * Sets the selection model for this listing.
+ * Sets the selection model for the grid.
+ * <p>
+ * This method is for setting a custom selection model, and is
+ * {@code protected} because {@link #setSelectionMode(SelectionMode)} should
+ * be used for easy switching between built-in selection models.
* <p>
* The default selection model is {@link SingleSelectionModelImpl}.
+ * <p>
+ * To use a custom selection model, you can e.g. extend the grid call this
+ * method with your custom selection model.
*
* @param model
* the selection model to use, not {@code null}
+ *
+ * @see #setSelectionMode(SelectionMode)
*/
- public void setSelectionModel(GridSelectionModel<T> model) {
+ @SuppressWarnings("unchecked")
+ protected void setSelectionModel(GridSelectionModel<T> model) {
Objects.requireNonNull(model, "selection model cannot be null");
- selectionModel.remove();
+ if (selectionModel != null) { // null when called from constructor
+ selectionModel.remove();
+ }
selectionModel = model;
+
+ if (selectionModel instanceof AbstractListingExtension) {
+ ((AbstractListingExtension<T>) selectionModel).extend(this);
+ } else {
+ addExtension(selectionModel);
+ }
+ }
+
+ /**
+ * Sets the grid's selection mode.
+ * <p>
+ * The built-in selection models are:
+ * <ul>
+ * <li>{@link SelectionMode#SINGLE} -> {@link SingleSelectionModelImpl},
+ * <b>the default model</b></li>
+ * <li>{@link SelectionMode#MULTI} -> {@link MultiSelectionModelImpl}, with
+ * checkboxes in the first column for selection</li>
+ * <li>{@link SelectionMode#NONE} -> {@link NoSelectionModel}, preventing
+ * selection</li>
+ * </ul>
+ * <p>
+ * To use your custom selection model, you can use
+ * {@link #setSelectionModel(GridSelectionModel)}, see existing selection
+ * model implementations for example.
+ *
+ * @param selectionMode
+ * the selection mode to switch to, not {@code null}
+ * @return the used selection model
+ *
+ * @see SelectionMode
+ * @see GridSelectionModel
+ * @see #setSelectionModel(GridSelectionModel)
+ */
+ public GridSelectionModel<T> setSelectionMode(SelectionMode selectionMode) {
+ Objects.requireNonNull(selectionMode, "Selection mode cannot be null.");
+ GridSelectionModel<T> model = selectionMode.createModel();
+ setSelectionModel(model);
+
+ return model;
}
@Override
import com.vaadin.shared.data.DataCommunicatorConstants;
import com.vaadin.shared.ui.grid.AbstractSelectionModelState;
+import com.vaadin.ui.AbstractListing;
+import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.AbstractGridExtension;
import com.vaadin.ui.Grid.GridSelectionModel;
return (AbstractSelectionModelState) super.getState(markAsDirty);
}
+ /**
+ * Returns the grid this selection model is attached to using, or throws
+ * {@link IllegalStateException} if not attached to any selection model.
+ *
+ * @return the grid this selection model is attached to
+ * @throws IllegalStateException
+ * if this selection mode is not attached to any grid
+ */
+ protected Grid<T> getGrid() throws IllegalStateException {
+ Grid<T> parent = getParent();
+ if (parent == null) {
+ throw new IllegalStateException(
+ "This selection model is no currently attached to any grid.");
+ }
+ return parent;
+ }
+
+ @Override
+ public void extend(AbstractListing<T> grid) {
+ if (getParent() != null) {
+ throw new IllegalStateException(
+ "This selection model has been bound to a grid already. Please remove the existing binding with model.remove() first.");
+ }
+ // type is verified in parent
+ super.extend(grid);
+
+ init();
+ }
+
+ /**
+ * Initializes the selection model after it has been attached to a grid.
+ */
+ protected abstract void init();
+
@Override
public void remove() {
deselectAll();
import com.vaadin.event.selection.MultiSelectionEvent;
import com.vaadin.event.selection.MultiSelectionListener;
+import com.vaadin.server.data.DataCommunicator;
import com.vaadin.server.data.DataProvider;
import com.vaadin.server.data.Query;
import com.vaadin.shared.Registration;
import com.vaadin.shared.data.selection.GridMultiSelectServerRpc;
import com.vaadin.shared.ui.grid.MultiSelectionModelState;
-import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.MultiSelectionModel;
import com.vaadin.ui.MultiSelect;
import com.vaadin.util.ReflectTools;
.findMethod(MultiSelectionListener.class, "accept",
MultiSelectionEvent.class);
- private final Grid<T> grid;
-
private Set<T> selection = new LinkedHashSet<>();
private SelectAllCheckBoxVisible selectAllCheckBoxVisible = SelectAllCheckBoxVisible.DEFAULT;
- /**
- * Constructs a new multiselection model for the given grid.
- *
- * @param grid
- * the grid to bind the selection model into
- */
- public MultiSelectionModelImpl(Grid<T> grid) {
- this.grid = grid;
- extend(grid);
-
+ @Override
+ protected void init() {
registerRpc(new GridMultiSelectServerRpcImpl());
}
* in- memory.
*
* @param selectAllCheckBoxVisible
- * the mode to use
+ * the visiblity mode to use
* @see SelectAllCheckBoxVisible
*/
public void setSelectAllCheckBoxVisible(
/**
* Gets the current mode for the select all checkbox visibility.
*
- * @return the select all checkbox visibility state
+ * @return the select all checkbox visibility mode
* @see SelectAllCheckBoxVisible
* @see #isSelectAllCheckBoxVisible()
*/
getState(false).selectAllCheckBoxVisible = false;
break;
case DEFAULT:
- getState(false).selectAllCheckBoxVisible = grid.getDataProvider()
- .isInMemory();
+ getState(false).selectAllCheckBoxVisible = getGrid()
+ .getDataProvider().isInMemory();
break;
default:
break;
getState().allSelected = true;
}
- DataProvider<T, ?> dataSource = grid.getDataProvider();
+ DataProvider<T, ?> dataSource = getGrid().getDataProvider();
// this will fetch everything from backend
Stream<T> stream = dataSource.fetch(new Query<>());
LinkedHashSet<T> allItems = new LinkedHashSet<>();
set.addAll(addedItems);
// refresh method is NOOP for items that are not present client side
- removedItems.forEach(grid.getDataCommunicator()::refresh);
- addedItems.forEach(grid.getDataCommunicator()::refresh);
+ DataCommunicator<T, ?> dataCommunicator = getGrid()
+ .getDataCommunicator();
+ removedItems.forEach(dataCommunicator::refresh);
+ addedItems.forEach(dataCommunicator::refresh);
}, userOriginated);
}
LinkedHashSet<T> oldSelection = new LinkedHashSet<>(selection);
handler.accept(selection);
- fireEvent(new MultiSelectionEvent<>(grid, asMultiSelect(), oldSelection,
- userOriginated));
+ fireEvent(new MultiSelectionEvent<>(getGrid(), asMultiSelect(),
+ oldSelection, userOriginated));
}
}
import java.util.Set;
import com.vaadin.server.AbstractExtension;
-import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.GridSelectionModel;
/**
public class NoSelectionModel<T> extends AbstractExtension
implements GridSelectionModel<T> {
- /**
- * Creates a new no selection model and attaches it for the given grid.
- *
- * @param grid
- * the grid to bind the selection model into
- */
- public NoSelectionModel(Grid<T> grid) {
- extend(grid);
- }
-
@Override
public Set<T> getSelectedItems() {
return Collections.emptySet();
public void deselectAll() {
}
-}
\ No newline at end of file
+}
import com.vaadin.shared.data.selection.SelectionServerRpc;
import com.vaadin.shared.ui.grid.SingleSelectionModelState;
import com.vaadin.ui.Component;
-import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.SingleSelectionModel;
import com.vaadin.ui.SingleSelect;
import com.vaadin.util.ReflectTools;
.findMethod(SingleSelectionListener.class, "accept",
SingleSelectionEvent.class);
- private final Grid<T> grid;
private T selectedItem = null;
- /**
- * Constructs a new single selection model for the given grid.
- *
- * @param grid
- * the grid to bind the selection model into
- */
- public SingleSelectionModelImpl(Grid<T> grid) {
- this.grid = grid;
- extend(grid);
+ @Override
+ protected void init() {
registerRpc(new SelectionServerRpc() {
@Override
}
if (selectedItem != null) {
- grid.getDataCommunicator().refresh(selectedItem);
+ getGrid().getDataCommunicator().refresh(selectedItem);
}
selectedItem = getData(key);
if (selectedItem != null) {
- grid.getDataCommunicator().refresh(selectedItem);
+ getGrid().getDataCommunicator().refresh(selectedItem);
}
}
}
doSetSelectedKey(key);
- fireEvent(new SingleSelectionEvent<>(grid, asSingleSelect(), true));
+ fireEvent(
+ new SingleSelectionEvent<>(getGrid(), asSingleSelect(), true));
}
/**
}
doSetSelectedKey(key);
- fireEvent(new SingleSelectionEvent<>(grid, asSingleSelect(), false));
+ fireEvent(
+ new SingleSelectionEvent<>(getGrid(), asSingleSelect(), false));
}
/**
return null;
} else {
// TODO creates a key if item not in data provider
- return grid.getDataCommunicator().getKeyMapper().key(item);
+ return getGrid().getDataCommunicator().getKeyMapper().key(item);
}
}
import com.vaadin.tests.data.bean.Sex;
import com.vaadin.tests.data.bean.TestEnum;
import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.MultiSelect;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
-import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
public class GridAsMultiSelectInBinder
extends BinderTestBase<Binder<BeanWithEnums>, BeanWithEnums> {
private class CustomMultiSelectModel extends MultiSelectionModelImpl<Sex> {
- public CustomMultiSelectModel(Grid<Sex> grid) {
- super(grid);
- }
-
@Override
public void updateSelection(Set<Sex> addedItems, Set<Sex> removedItems,
boolean userOriginated) {
item = new BeanWithEnums();
grid = new Grid<>();
grid.setItems(TestEnum.values());
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
select = grid.asMultiSelect();
converterBinder.forField(select)
@Test(expected = IllegalStateException.class)
public void boundGridInBinder_selectionModelChanged_throws() {
- grid.setSelectionModel(new SingleSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.SINGLE);
select.select(TestEnum.ONE);
}
@Test
public void addValueChangeListener_selectionUpdated_eventTriggeredForMultiSelect() {
- Grid<Sex> grid = new Grid<>();
- CustomMultiSelectModel model = new CustomMultiSelectModel(grid);
- grid.setSelectionModel(model);
+ CustomMultiSelectModel model = new CustomMultiSelectModel();
+ Grid<Sex> grid = new Grid<Sex>() {
+ {
+ setSelectionModel(model);
+ }
+ };
grid.setItems(Sex.values());
MultiSelect<Sex> select = grid.asMultiSelect();
import com.vaadin.tests.data.bean.Person;
import com.vaadin.tests.data.bean.Sex;
import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.SingleSelect;
-import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
public class GridAsSingleSelectInBinder
}
}
- private class CustomSingleSelectModel extends SingleSelectionModelImpl<Sex> {
-
- public CustomSingleSelectModel(Grid<Sex> grid) {
- super(grid);
- }
+ private class CustomSingleSelectModel
+ extends SingleSelectionModelImpl<Sex> {
public void setSelectedFromClient(Sex item) {
setSelectedFromClient(itemToKey(item));
@Test(expected = IllegalStateException.class)
public void boundGridInBinder_selectionModelChanged_throws() {
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
select.setValue(Sex.MALE);
}
@Test
public void addValueChangeListener_selectionUpdated_eventTriggeredForSelect() {
GridWithCustomSingleSelectionModel grid = new GridWithCustomSingleSelectionModel();
- CustomSingleSelectModel model = new CustomSingleSelectModel(grid);
+ CustomSingleSelectModel model = new CustomSingleSelectModel();
grid.setSelectionModel(model);
grid.setItems(Sex.values());
select = grid.asSingleSelect();
import com.vaadin.tests.util.MockUI;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.GridSelectionModel;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.UI;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl.SelectAllCheckBoxVisible;
-import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
import elemental.json.JsonObject;
extends MultiSelectionModelImpl<String> {
public final Map<String, Boolean> generatedData = new LinkedHashMap<>();
- public CustomMultiSelectionModel(Grid<String> grid) {
- super(grid);
- }
-
@Override
public void generateData(String item, JsonObject jsonObject) {
super.generateData(item, jsonObject);
}
+ public static class CustomSelectionModelGrid extends Grid<String> {
+ public CustomSelectionModelGrid() {
+ this(new CustomMultiSelectionModel());
+ }
+
+ public CustomSelectionModelGrid(
+ GridSelectionModel<String> selectionModel) {
+ super();
+ setSelectionModel(selectionModel);
+ }
+ }
+
@Before
public void setUp() {
grid = new Grid<>();
- selectionModel = new MultiSelectionModelImpl<>(grid);
- grid.setSelectionModel(selectionModel);
+ selectionModel = (MultiSelectionModelImpl<Person>) grid
+ .setSelectionMode(SelectionMode.MULTI);
+
grid.setItems(PERSON_A, PERSON_B, PERSON_C);
currentSelectionCapture = new Capture<>();
@Test(expected = IllegalStateException.class)
public void selectionModelChanged_usingPreviousSelectionModel_throws() {
- grid.setSelectionModel(new SingleSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.SINGLE);
selectionModel.select(PERSON_A);
}
@Test
public void changingSelectionModel_firesSelectionEvent() {
Grid<String> customGrid = new Grid<>();
- customGrid.setSelectionModel(new MultiSelectionModelImpl<>(customGrid));
+ customGrid.setSelectionMode(SelectionMode.MULTI);
customGrid.setItems("Foo", "Bar", "Baz");
List<String> selectionChanges = new ArrayList<>();
assertEquals(Arrays.asList("Foo", "Bar"), selectionChanges);
selectionChanges.clear();
- customGrid
- .setSelectionModel(new SingleSelectionModelImpl<>(customGrid));
+ customGrid.setSelectionMode(SelectionMode.SINGLE);
assertFalse(customGrid.getSelectionModel().getFirstSelectedItem()
.isPresent());
assertEquals(Arrays.asList(), selectionChanges);
@Test
public void serverSideSelection_GridChangingSelectionModel_sendsUpdatedRowsToClient() {
- Grid<String> customGrid = new Grid<>();
+ Grid<String> customGrid = new CustomSelectionModelGrid();
+ CustomMultiSelectionModel customModel = (CustomMultiSelectionModel) customGrid
+ .getSelectionModel();
customGrid.setItems("Foo", "Bar", "Baz");
- CustomMultiSelectionModel customModel = new CustomMultiSelectionModel(
- customGrid);
- customGrid.setSelectionModel(customModel);
customGrid.getDataCommunicator().beforeClientResponse(true);
Assert.assertFalse("Item should have been updated as selected",
// switch to single to cause event
customModel.generatedData.clear();
- customGrid
- .setSelectionModel(new SingleSelectionModelImpl<>(customGrid));
+ customGrid.setSelectionMode(SelectionMode.SINGLE);
customGrid.getDataCommunicator().beforeClientResponse(false);
// changing selection model should trigger row updates, but the old
@Test
public void select_gridWithStrings() {
Grid<String> gridWithStrings = new Grid<>();
- gridWithStrings.setSelectionModel(
- new MultiSelectionModelImpl<>(gridWithStrings));
+ gridWithStrings.setSelectionMode(SelectionMode.MULTI);
gridWithStrings.setItems("Foo", "Bar", "Baz");
GridSelectionModel<String> model = gridWithStrings.getSelectionModel();
@SuppressWarnings({ "serial" })
@Test
public void addValueChangeListener() {
+ String value = "foo";
+
AtomicReference<MultiSelectionListener<String>> selectionListener = new AtomicReference<>();
Registration registration = Mockito.mock(Registration.class);
- Grid<String> grid = new Grid<>();
- grid.setItems("foo", "bar");
- String value = "foo";
- MultiSelectionModelImpl<String> select = new MultiSelectionModelImpl<String>(
- grid) {
+ MultiSelectionModelImpl<String> model = new MultiSelectionModelImpl<String>() {
@Override
public Registration addSelectionListener(
MultiSelectionListener<String> listener) {
}
};
+ Grid<String> grid = new CustomSelectionModelGrid(model);
+
+ grid.setItems("foo", "bar");
+
AtomicReference<MultiSelectionEvent<String>> event = new AtomicReference<>();
- Registration actualRegistration = select.addSelectionListener(evt -> {
+ Registration actualRegistration = model.addSelectionListener(evt -> {
Assert.assertNull(event.get());
event.set(evt);
});
Assert.assertSame(registration, actualRegistration);
selectionListener.get().accept(new MultiSelectionEvent<>(grid,
- select.asMultiSelect(), Collections.emptySet(), true));
+ model.asMultiSelect(), Collections.emptySet(), true));
Assert.assertEquals(grid, event.get().getComponent());
Assert.assertEquals(new LinkedHashSet<>(Arrays.asList(value)),
@Test
public void selectAllCheckboxVisible__inMemoryDataProvider() {
- Grid<String> grid = new Grid<>();
UI ui = new MockUI();
- ui.setContent(grid);
- MultiSelectionModelImpl<String> model = new MultiSelectionModelImpl<>(
- grid);
- grid.setSelectionModel(model);
+ Grid<String> grid = new Grid<>();
+ MultiSelectionModelImpl<String> model = (MultiSelectionModelImpl<String>) grid
+ .setSelectionMode(SelectionMode.MULTI);
+ ui.setContent(grid);
// no items yet, default data provider is empty not in memory one
Assert.assertFalse(model.isSelectAllCheckBoxVisible());
Assert.assertEquals(SelectAllCheckBoxVisible.DEFAULT,
UI ui = new MockUI();
ui.setContent(grid);
- MultiSelectionModelImpl<String> model = new MultiSelectionModelImpl<>(
- grid);
- grid.setSelectionModel(model);
+ MultiSelectionModelImpl<String> model = (MultiSelectionModelImpl<String>) grid
+ .setSelectionMode(SelectionMode.MULTI);
// no items yet, default data provider is empty not in memory one
Assert.assertFalse(model.isSelectAllCheckBoxVisible());
Assert.assertFalse(model.isSelectAllCheckBoxVisible());
// change back to depends on data provider
- model.setSelectAllCheckBoxVisible(
- SelectAllCheckBoxVisible.DEFAULT);
+ model.setSelectAllCheckBoxVisible(SelectAllCheckBoxVisible.DEFAULT);
Assert.assertFalse(model.isSelectAllCheckBoxVisible());
Assert.assertEquals(SelectAllCheckBoxVisible.DEFAULT,
import com.vaadin.server.data.provider.bov.Person;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.GridSelectionModel;
-import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
-import com.vaadin.ui.components.grid.NoSelectionModel;
-import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
+import com.vaadin.ui.Grid.SelectionMode;
public class GridNoSelectionModelTest {
grid = new Grid<>();
grid.setItems(PERSON_A, PERSON_B, PERSON_C);
- model = new NoSelectionModel<>(grid);
- grid.setSelectionModel(model);
+ model = grid.setSelectionMode(SelectionMode.NONE);
}
@Test
@Test
public void changingToSingleSelectionModel() {
- grid.setSelectionModel(new SingleSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.SINGLE);
grid.getSelectionModel().select(PERSON_B);
Assert.assertEquals(PERSON_B,
@Test
public void changingToMultiSelectionModel() {
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
grid.getSelectionModel().select(PERSON_B);
Assert.assertEquals(new LinkedHashSet<>(Arrays.asList(PERSON_B)),
--- /dev/null
+package com.vaadin.tests.components.grid;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.SelectionMode;
+import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
+import com.vaadin.ui.components.grid.NoSelectionModel;
+import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
+
+public class GridSelectionModeTest {
+
+ private Grid<String> grid;
+
+ @Before
+ public void setup() {
+ grid = new Grid<>();
+ grid.setItems("foo", "bar", "baz");
+ }
+
+ @Test
+ public void testSelectionModes() {
+ Assert.assertEquals(SingleSelectionModelImpl.class,
+ grid.getSelectionModel().getClass());
+
+ Assert.assertEquals(MultiSelectionModelImpl.class,
+ grid.setSelectionMode(SelectionMode.MULTI).getClass());
+ Assert.assertEquals(MultiSelectionModelImpl.class,
+ grid.getSelectionModel().getClass());
+
+ Assert.assertEquals(NoSelectionModel.class,
+ grid.setSelectionMode(SelectionMode.NONE).getClass());
+ Assert.assertEquals(NoSelectionModel.class,
+ grid.getSelectionModel().getClass());
+
+ Assert.assertEquals(SingleSelectionModelImpl.class,
+ grid.setSelectionMode(SelectionMode.SINGLE).getClass());
+ Assert.assertEquals(SingleSelectionModelImpl.class,
+ grid.getSelectionModel().getClass());
+ }
+
+ @Test(expected = NullPointerException.class)
+ public void testNullSelectionMode() {
+ grid.setSelectionMode(null);
+ }
+
+}
import com.vaadin.shared.Registration;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.GridSelectionModel;
-import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
import elemental.json.JsonObject;
extends SingleSelectionModelImpl<String> {
public final Map<String, Boolean> generatedData = new LinkedHashMap<>();
- public CustomSingleSelectionModel(Grid<String> grid) {
- super(grid);
- }
-
@Override
public void generateData(String item, JsonObject jsonObject) {
super.generateData(item, jsonObject);
@Test(expected = IllegalStateException.class)
public void selectionModelChanged_usingPreviousSelectionModel_throws() {
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
selectionModel.select(PERSON_A);
}
customGrid.getSelectionModel().getFirstSelectedItem().get());
assertEquals(Arrays.asList("Foo"), selectionChanges);
- customGrid
- .setSelectionModel(new CustomSingleSelectionModel(customGrid));
+ customGrid.setSelectionMode(SelectionMode.MULTI);
assertEquals(Arrays.asList("Foo", null), selectionChanges);
}
@Test
public void serverSideSelection_GridChangingSelectionModel_sendsUpdatedRowsToClient() {
- Grid<String> customGrid = new Grid<>();
- customGrid.setItems("Foo", "Bar", "Baz");
- CustomSingleSelectionModel customModel = new CustomSingleSelectionModel(
- customGrid);
- customGrid.setSelectionModel(customModel);
+ CustomSingleSelectionModel customModel = new CustomSingleSelectionModel();
+ Grid<String> customGrid = new Grid<String>() {
+ {
+ setSelectionModel(customModel);
+ }
+ };
+ customGrid.setItems("Foo", "Bar", "Baz");
customGrid.getDataCommunicator().beforeClientResponse(true);
// switch to another selection model to cause event
customModel.generatedData.clear();
- customGrid.setSelectionModel(new SingleSelectionModelImpl<>(customGrid));
+ customGrid.setSelectionMode(SelectionMode.MULTI);
customGrid.getDataCommunicator().beforeClientResponse(false);
// since the selection model has been removed, it is no longer a data
Grid<String> grid = new Grid<>();
grid.setItems("foo", "bar");
String value = "foo";
- SingleSelectionModelImpl<String> select = new SingleSelectionModelImpl<String>(
- grid) {
+ SingleSelectionModelImpl<String> select = new SingleSelectionModelImpl<String>() {
@Override
public Registration addSelectionListener(
SingleSelectionListener<String> listener) {
excludedMethods.add(Label.class.getName() + "getDataProviderValue");
excludedMethods.add("getConnectorId");
excludedMethods.add("getContent");
+ excludedMethods.add("com.vaadin.ui.Grid:getSelectAllCheckBoxVisible");
}
@Test
// we still wouldnt know what to put into
continue;
}
- if (excludedMethods
- .contains(clazz.getName() + method.getName())) {
+ if (excludedMethods.contains(
+ clazz.getName() + ":" + method.getName())) {
// blacklisted method for specific classes
continue;
}
public static class MySelectionModel
extends MultiSelectionModelImpl<DataObject> {
- public MySelectionModel(Grid<DataObject> grid) {
- super(grid);
- }
}
private Grid<DataObject> grid;
// Create grid
grid = new Grid<DataObject>() {
{
- MySelectionModel model = new MySelectionModel(this);
- setSelectionModel(model);
- model.extend(this);
+ setSelectionModel(new MySelectionModel());
}
};
grid.setItems(data);
import com.vaadin.tests.components.AbstractReindeerTestUI;
import com.vaadin.ui.Button;
import com.vaadin.ui.Grid;
-import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
+import com.vaadin.ui.Grid.SelectionMode;
public class GridDisabledMultiselect extends AbstractReindeerTestUI {
addButton("Multi", new Button.ClickListener() {
@Override
public void buttonClick(Button.ClickEvent event) {
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
}
});
import com.vaadin.tests.components.grid.basics.DataObject;
import com.vaadin.tests.components.grid.basics.GridBasics;
import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.Layout;
import com.vaadin.ui.VerticalLayout;
-import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
import com.vaadin.ui.renderers.DateRenderer;
import com.vaadin.ui.renderers.HtmlRenderer;
import com.vaadin.ui.renderers.NumberRenderer;
.setCaption(GridBasics.COLUMN_CAPTIONS[5]);
grid.addColumn(DataObject::getBigRandom, new NumberRenderer())
.setCaption(GridBasics.COLUMN_CAPTIONS[6]);
-
- grid.setSelectionModel(new MultiSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.MULTI);
layout.addComponent(grid);
import com.vaadin.tests.components.AbstractTestUI;
import com.vaadin.ui.Button;
import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.RadioButtonGroup;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl.SelectAllCheckBoxVisible;
final Grid<String> grid = new Grid<>();
grid.setItems("Foo 1", "Foo 2");
grid.addColumn(item -> item);
- MultiSelectionModelImpl<String> model = new MultiSelectionModelImpl<>(
- grid);
- grid.setSelectionModel(model);
+ MultiSelectionModelImpl<String> selectionModel = (MultiSelectionModelImpl<String>) grid
+ .setSelectionMode(SelectionMode.MULTI);
+
addComponent(grid);
addComponent(new Button("Select rows",
Arrays.asList(SelectAllCheckBoxVisible.VISIBLE,
SelectAllCheckBoxVisible.HIDDEN,
SelectAllCheckBoxVisible.DEFAULT));
- rbg.setValue(model.getSelectAllCheckBoxVisible());
- rbg.addValueChangeListener(
- event -> model.setSelectAllCheckBoxVisible(event.getValue()));
+ rbg.setValue(selectionModel.getSelectAllCheckBoxVisible());
+ rbg.addValueChangeListener(event -> selectionModel
+ .setSelectAllCheckBoxVisible(event.getValue()));
addComponent(rbg);
}
}
import com.vaadin.ui.Grid.FooterRow;
import com.vaadin.ui.Grid.HeaderRow;
import com.vaadin.ui.Grid.MultiSelectionModel;
+import com.vaadin.ui.Grid.SelectionMode;
import com.vaadin.ui.Label;
import com.vaadin.ui.MenuBar;
import com.vaadin.ui.MenuBar.Command;
import com.vaadin.ui.VerticalLayout;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl;
import com.vaadin.ui.components.grid.MultiSelectionModelImpl.SelectAllCheckBoxVisible;
-import com.vaadin.ui.components.grid.NoSelectionModel;
import com.vaadin.ui.components.grid.SingleSelectionModelImpl;
import com.vaadin.ui.renderers.DateRenderer;
import com.vaadin.ui.renderers.HtmlRenderer;
null);
selectionModelItem.addItem("single", menuItem -> {
selectionListenerRegistration.remove();
- grid.setSelectionModel(new SingleSelectionModelImpl<>(grid));
+ grid.setSelectionMode(SelectionMode.SINGLE);
selectionListenerRegistration = ((SingleSelectionModelImpl<DataObject>) grid
.getSelectionModel())
.addSelectionListener(this::onSingleSelect);
});
selectionModelItem.addItem("none", menuItem -> {
selectionListenerRegistration.remove();
- grid.setSelectionModel(new NoSelectionModel<>(grid));
+ grid.setSelectionMode(SelectionMode.NONE);
});
selectionModelItem.addItem("Select All", menuItem -> {
private void switchToMultiSelect() {
if (!(grid.getSelectionModel() instanceof MultiSelectionModel)) {
selectionListenerRegistration.remove();
- MultiSelectionModelImpl<DataObject> model = new MultiSelectionModelImpl<>(
- grid);
- grid.setSelectionModel(model);
- selectionListenerRegistration = model
- .addSelectionListener(this::onMultiSelect);
+ ((MultiSelectionModelImpl<DataObject>) grid
+ .setSelectionMode(SelectionMode.MULTI))
+ .addSelectionListener(this::onMultiSelect);
}
}
projects / vaadin-framework.git / commitdiff