io.jmix.ui.component

Class DataGrid.ColumnCollapsingChangeEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.component.DataGrid.AbstractDataGridEvent

io.jmix.ui.component.DataGrid.ColumnCollapsingChangeEvent

All Implemented Interfaces:

HasUserOriginated, java.io.Serializable

Enclosing interface:

DataGrid<E>

public static class DataGrid.ColumnCollapsingChangeEvent
extends DataGrid.AbstractDataGridEvent
implements HasUserOriginated

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	collapsed
protected DataGrid.Column	column
protected boolean	userOriginated

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ColumnCollapsingChangeEvent(DataGrid component, DataGrid.Column column, boolean collapsed) Constructor for a column visibility change event.
ColumnCollapsingChangeEvent(DataGrid component, DataGrid.Column column, boolean collapsed, boolean userOriginated) Constructor for a column visibility change event.

Method Summary

Modifier and Type	Method and Description
DataGrid.Column	getColumn() Gets the column that became hidden or visible.
boolean	isCollapsed()
boolean	isUserOriginated() Returns whether this event was triggered by user interaction or programmatically.

Methods inherited from class io.jmix.ui.component.DataGrid.AbstractDataGridEvent

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Field Detail

column

protected final DataGrid.Column column

collapsed

protected final boolean collapsed

userOriginated

protected final boolean userOriginated

Constructor Detail

ColumnCollapsingChangeEvent

public ColumnCollapsingChangeEvent(DataGrid component,
                                   DataGrid.Column column,
                                   boolean collapsed)

Constructor for a column visibility change event.

Parameters:

component - the DataGrid from which this event originates

column - the column that changed its visibility

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

ColumnCollapsingChangeEvent

public ColumnCollapsingChangeEvent(DataGrid component,
                                   DataGrid.Column column,
                                   boolean collapsed,
                                   boolean userOriginated)

Constructor for a column visibility change event.

Parameters:

component - the DataGrid from which this event originates

column - the column that changed its visibility

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

userOriginated - true if an event is a result of user interaction, false if from the API call

Method Detail

getColumn

public DataGrid.Column getColumn()

Gets the column that became hidden or visible.

Returns:

the column that became hidden or visible.

See Also:

DataGrid.Column.isCollapsed()

isCollapsed

public boolean isCollapsed()

Returns:

true if the column was collapsed, false if it was set visible

isUserOriginated

public boolean isUserOriginated()

Description copied from interface: HasUserOriginated

Returns whether this event was triggered by user interaction or programmatically.

Specified by:

isUserOriginated in interface HasUserOriginated

Returns:

true if this event originates by user interaction, false otherwise.