Package com.vaadin.ui

Class Grid.ColumnVisibilityChangeEvent

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.ui.Grid.ColumnVisibilityChangeEvent

All Implemented Interfaces:

Serializable

Enclosing class:

Grid

public static class Grid.ColumnVisibilityChangeEvent
extends Component.Event

An event that is fired when a column's visibility changes.

Since:

7.5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ColumnVisibilityChangeEvent(Grid source, Grid.Column column, boolean hidden, boolean isUserOriginated)	Constructor for a column visibility change event.

Method Summary

Modifier and Type	Method	Description
Grid.Column	getColumn()	Gets the column that became hidden or visible.
boolean	isHidden()	Was the column set hidden or visible.
boolean	isUserOriginated()	Returns true if the column reorder was done by the user, false if not and it was triggered by server side code.

Methods inherited from class com.vaadin.ui.Component.Event

getComponent

Methods inherited from class com.vaadin.event.ConnectorEvent

getConnector

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnVisibilityChangeEvent

public ColumnVisibilityChangeEvent(Grid source,
                                   Grid.Column column,
                                   boolean hidden,
                                   boolean isUserOriginated)

Constructor for a column visibility change event.

Parameters:

source - the grid from which this event originates

column - the column that changed its visibility

hidden - true if the column was hidden, false if it became visible

isUserOriginated - true iff the event was triggered by an UI interaction

Method Detail

getColumn

public Grid.Column getColumn()

Gets the column that became hidden or visible.

Returns:

the column that became hidden or visible.

See Also:

Grid.Column.isHidden()

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()

Returns true if the column reorder was done by the user, false if not and it was triggered by server side code.

Returns:

true if event is a result of user interaction