diff options
author | Aleksi Hietanen <aleksi@vaadin.com> | 2016-09-19 17:01:20 +0300 |
---|---|---|
committer | Denis Anisimov <denis@vaadin.com> | 2016-09-20 11:23:53 +0000 |
commit | 79132bcb6d498322ce8cb0f554658f96b13b29d9 (patch) | |
tree | efe187599b0825d20c7e3812fd9110b911e03c77 /server/src/main/java | |
parent | 8939d3257f2f48ce5525b908c3d3450cee837aaf (diff) | |
download | vaadin-framework-79132bcb6d498322ce8cb0f554658f96b13b29d9.tar.gz vaadin-framework-79132bcb6d498322ce8cb0f554658f96b13b29d9.zip |
Reintroduce grid column hiding
Change-Id: I8a0344dffe3f2ef84f8134e05d9b7340d9b603a0
Diffstat (limited to 'server/src/main/java')
-rw-r--r-- | server/src/main/java/com/vaadin/ui/Grid.java | 230 |
1 files changed, 227 insertions, 3 deletions
diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index 806f0d270f..b77e2ca7f7 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -73,6 +73,12 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { private static final Method ITEM_CLICK_METHOD = ReflectTools .findMethod(ItemClickListener.class, "accept", ItemClick.class); + @Deprecated + private static final Method COLUMN_VISIBILITY_METHOD = ReflectTools + .findMethod(ColumnVisibilityChangeListener.class, + "columnVisibilityChanged", + ColumnVisibilityChangeEvent.class); + /** * An event fired when an item in the Grid has been clicked. * @@ -243,6 +249,85 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { } /** + * An event listener for column visibility change events in the Grid. + * + * @since 7.5.0 + */ + public interface ColumnVisibilityChangeListener extends Serializable { + + /** + * Called when a column has become hidden or unhidden. + * + * @param event + */ + void columnVisibilityChanged(ColumnVisibilityChangeEvent event); + } + + /** + * An event that is fired when a column's visibility changes. + * + * @since 7.5.0 + */ + public static class ColumnVisibilityChangeEvent extends Component.Event { + + private final Column<?, ?> column; + private final boolean userOriginated; + private final boolean hidden; + + /** + * Constructor for a column visibility change event. + * + * @param source + * the grid from which this event originates + * @param column + * the column that changed its visibility + * @param hidden + * <code>true</code> if the column was hidden, + * <code>false</code> if it became visible + * @param isUserOriginated + * <code>true</code> iff the event was triggered by an UI + * interaction + */ + public ColumnVisibilityChangeEvent(Grid<?> source, Column<?, ?> column, + boolean hidden, boolean isUserOriginated) { + super(source); + this.column = column; + this.hidden = hidden; + userOriginated = isUserOriginated; + } + + /** + * Gets the column that became hidden or visible. + * + * @return the column that became hidden or visible. + * @see Column#isHidden() + */ + public Column<?, ?> getColumn() { + return column; + } + + /** + * Was the column set hidden or visible. + * + * @return <code>true</code> if the column was hidden <code>false</code> + * if it was set visible + */ + public boolean isHidden() { + return hidden; + } + + /** + * Returns <code>true</code> if the column reorder was done by the user, + * <code>false</code> if not and it was triggered by server side code. + * + * @return <code>true</code> if event is a result of user interaction + */ + public boolean isUserOriginated() { + return userOriginated; + } + } + + /** * A callback interface for generating description texts for an item. * * @param <T> @@ -370,9 +455,13 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { } @Override - public void columnVisibilityChanged(String id, boolean hidden, - boolean userOriginated) { - // TODO Auto-generated method stub + public void columnVisibilityChanged(String id, boolean hidden) { + Column<T, ?> column = getColumn(id); + ColumnState columnState = column.getState(false); + if (columnState.hidden != hidden) { + columnState.hidden = hidden; + fireColumnVisibilityChangeEvent(column, hidden, true); + } } @Override @@ -852,6 +941,119 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { public DescriptionGenerator<T> getDescriptionGenerator() { return descriptionGenerator; } + + /** + * Sets the caption of the hiding toggle for this column. Shown in the + * toggle for this column in the grid's sidebar when the column is + * {@link #isHidable() hidable}. + * <p> + * The default value is <code>null</code>, and in that case the column's + * {@link #getHeaderCaption() header caption} is used. + * <p> + * <em>NOTE:</em> setting this to empty string might cause the hiding + * toggle to not render correctly. + * + * @since 7.5.0 + * @param hidingToggleCaption + * the text to show in the column hiding toggle + * @return the column itself + */ + public Column<T, V> setHidingToggleCaption(String hidingToggleCaption) { + if (hidingToggleCaption != getHidingToggleCaption()) { + getState().hidingToggleCaption = hidingToggleCaption; + } + return this; + } + + /** + * Gets the caption of the hiding toggle for this column. + * + * @since 7.5.0 + * @see #setHidingToggleCaption(String) + * @return the caption for the hiding toggle for this column + */ + public String getHidingToggleCaption() { + return getState(false).hidingToggleCaption; + } + + /** + * Hides or shows the column. By default columns are visible before + * explicitly hiding them. + * + * @since 7.5.0 + * @param hidden + * <code>true</code> to hide the column, <code>false</code> + * to show + * @return this column + * @throws IllegalStateException + * if the column is no longer attached to any grid + */ + public Column<T, V> setHidden(boolean hidden) { + checkColumnIsAttached(); + if (hidden != isHidden()) { + getState().hidden = hidden; + getParent().fireColumnVisibilityChangeEvent(this, hidden, + false); + } + return this; + } + + /** + * Returns whether this column is hidden. Default is {@code false}. + * + * @since 7.5.0 + * @return <code>true</code> if the column is currently hidden, + * <code>false</code> otherwise + */ + public boolean isHidden() { + return getState(false).hidden; + } + + /** + * Sets whether this column can be hidden by the user. Hidable columns + * can be hidden and shown via the sidebar menu. + * + * @since 7.5.0 + * @param hidable + * <code>true</code> iff the column may be hidable by the + * user via UI interaction + * @return this column + */ + public Column<T, V> setHidable(boolean hidable) { + if (hidable != isHidable()) { + getState().hidable = hidable; + } + return this; + } + + /** + * Returns whether this column can be hidden by the user. Default is + * {@code false}. + * <p> + * <em>Note:</em> the column can be programmatically hidden using + * {@link #setHidden(boolean)} regardless of the returned value. + * + * @since 7.5.0 + * @return <code>true</code> if the user can hide the column, + * <code>false</code> if not + */ + public boolean isHidable() { + return getState(false).hidable; + } + + /** + * Checks whether this column is attached and throws an + * {@link IllegalStateException} if it is not. + * + * @throws IllegalStateException + * if the column is no longer attached to any grid + */ + protected void checkColumnIsAttached() throws IllegalStateException { + if (getParent() == null) { + throw new IllegalStateException( + "Column is no longer attached to a grid."); + } + } } private final class SingleSelection extends AbstractSingleSelection { @@ -923,6 +1125,12 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { }); } + public <V> void fireColumnVisibilityChangeEvent(Column<T, V> column, + boolean hidden, boolean userOriginated) { + fireEvent(new ColumnVisibilityChangeEvent(this, column, hidden, + userOriginated)); + } + /** * Adds a new column to this {@link Grid} with given header caption, typed * renderer and value provider. @@ -1256,6 +1464,22 @@ public class Grid<T> extends AbstractSingleSelect<T> implements HasComponents { return () -> removeListener(ItemClick.class, listener); } + /** + * Registers a new column visibility change listener + * + * @param listener + * the listener to register, not null + * @return a registration for the listener + */ + public Registration addColumnVisibilityChangeListener( + ColumnVisibilityChangeListener listener) { + Objects.requireNonNull(listener, "listener cannot be null"); + addListener(ColumnVisibilityChangeEvent.class, listener, + COLUMN_VISIBILITY_METHOD); + return () -> removeListener(ColumnVisibilityChangeEvent.class, listener, + COLUMN_VISIBILITY_METHOD); + } + @Override protected GridState getState() { return getState(true); |