com.haulmont.cuba.gui.components

Class Tree.SelectionEvent<E extends Entity>

java.lang.Object

java.util.EventObject

com.haulmont.cuba.gui.components.Tree.SelectionEvent<E>

All Implemented Interfaces:

HasUserOriginated, java.io.Serializable

Enclosing interface:

Tree<E extends Entity>

public static class Tree.SelectionEvent<E extends Entity>
extends java.util.EventObject
implements HasUserOriginated

Event sent when the selection changes. It specifies what in a selection has changed, and where the selection took place.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<E>	oldSelection
protected java.util.Set<E>	selected
protected boolean	userOriginated

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
SelectionEvent(Tree<E> component, java.util.Set<E> oldSelection, boolean userOriginated) Constructor for a selection event.

Method Summary

Modifier and Type	Method and Description
java.util.Set<E>	getAdded() A Set of all the items that became selected.
java.util.Set<E>	getOldSelection() A Set of all the items that were selected before the selection was changed.
java.util.Set<E>	getRemoved() A Set of all the items that became deselected.
java.util.Set<E>	getSelected() A Set of all the items that are currently selected.
Tree<E>	getSource()
boolean	isUserOriginated() Returns whether this event was triggered by user interaction or programmatically.

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

selected

protected final java.util.Set<E extends Entity> selected

oldSelection

protected final java.util.Set<E extends Entity> oldSelection

userOriginated

protected final boolean userOriginated

Constructor Detail

SelectionEvent

public SelectionEvent(Tree<E> component,
                      java.util.Set<E> oldSelection,
                      boolean userOriginated)

Constructor for a selection event.

Parameters:

component - the DataGrid from which this event originates

oldSelection - the old set of selected items

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

Method Detail

getSource

public Tree<E> getSource()

Overrides:

getSource in class java.util.EventObject

getAdded

public java.util.Set<E> getAdded()

A Set of all the items that became selected. Note: this excludes all items that might have been previously selected.

Returns:

a set of the items that became selected

getRemoved

public java.util.Set<E> getRemoved()

A Set of all the items that became deselected. Note: this excludes all items that might have been previously deselected.

Returns:

a set of the items that became deselected

getSelected

public java.util.Set<E> getSelected()

A Set of all the items that are currently selected.

Returns:

a set of the items that are currently selected

getOldSelection

public java.util.Set<E> getOldSelection()

A Set of all the items that were selected before the selection was changed.

Returns:

a set of items selected before the selection was changed

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.