com.vaadin.client.widget.grid.events

Class ColumnVisibilityChangeEvent<T>

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<ColumnVisibilityChangeHandler<T>>

com.vaadin.client.widget.grid.events.ColumnVisibilityChangeEvent<T>

Type Parameters:

T - The row type of the grid. The row type is the POJO type from where the data is retrieved into the column cells.

public class ColumnVisibilityChangeEvent<T>
extends com.google.gwt.event.shared.GwtEvent<ColumnVisibilityChangeHandler<T>>

An event for notifying that the columns in the Grid's have changed visibility.

Since:

7.5.0

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

com.google.gwt.event.shared.GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
ColumnVisibilityChangeEvent(Grid.Column<?,T> column, boolean hidden, boolean userOriginated) Constructs a visibility change event for a grid column.

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(ColumnVisibilityChangeHandler<T> handler)
com.google.gwt.event.shared.GwtEvent.Type<ColumnVisibilityChangeHandler<T>>	getAssociatedType()
Grid.Column<?,T>	getColumn() Returns the column where the visibility change occurred.
static com.google.gwt.event.shared.GwtEvent.Type<ColumnVisibilityChangeHandler<?>>	getType() Returns the associated handler type.
boolean	isHidden() Was the column set hidden or visible.
boolean	isUserOriginated() Is the visibility change triggered by user.

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnVisibilityChangeEvent

public ColumnVisibilityChangeEvent(Grid.Column<?,T> column,
                                   boolean hidden,
                                   boolean userOriginated)

Constructs a visibility change event for a grid column.

Parameters:

column - the updated column

hidden - true if the column is now hidden, false otherwise

userOriginated - true if the event was triggered by user interaction, false otherwise

Method Detail

getType

public static final com.google.gwt.event.shared.GwtEvent.Type<ColumnVisibilityChangeHandler<?>> getType()

Returns the associated handler type.

Returns:

the handler type

getColumn

public Grid.Column<?,T> getColumn()

Returns the column where the visibility change occurred.

Returns:

the column where the visibility change occurred.

isHidden

public boolean isHidden()

Was the column set hidden or visible.

Returns:

true if the column was hidden false if it was set visible

isUserOriginated

public boolean isUserOriginated()

Is the visibility change triggered by user.

Returns:

true if the change was triggered by user, false if not

getAssociatedType

public com.google.gwt.event.shared.GwtEvent.Type<ColumnVisibilityChangeHandler<T>> getAssociatedType()

Overrides:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<ColumnVisibilityChangeHandler<T>>

dispatch

protected void dispatch(ColumnVisibilityChangeHandler<T> handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<ColumnVisibilityChangeHandler<T>>