com.vaadin.event

Class ExpandEvent<T>

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.event.ExpandEvent<T>

Type Parameters:

T - the expanded item's type

All Implemented Interfaces:

HasUserOriginated, Serializable

public class ExpandEvent<T>
extends Component.Event
implements HasUserOriginated

An event that is fired when an item is expanded in a listing component that displays hierarchical data.

Since:

8.1

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExpandEvent.ExpandListener<T> Item expand event listener.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ExpandEvent(Component source, T expandedItem, boolean userOriginated) Construct an expand event.

Method Summary

Modifier and Type	Method and Description
T	getExpandedItem() Get the expanded item that triggered this event.
boolean	isUserOriginated() Returns whether this event was triggered by user interaction, on the client side, or programmatically, on the server side.

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

ExpandEvent

public ExpandEvent(Component source,
                   T expandedItem,
                   boolean userOriginated)

Construct an expand event.

Parameters:

source - the hierarchical component this event originated from

expandedItem - the item that was expanded

userOriginated - whether the expand was triggered by a user interaction or the server

Method Detail

getExpandedItem

public T getExpandedItem()

Get the expanded item that triggered this event.

Returns:

the expanded item

isUserOriginated

public boolean isUserOriginated()

Description copied from interface: HasUserOriginated

Returns whether this event was triggered by user interaction, on the client side, or programmatically, on the server side.

Specified by:

isUserOriginated in interface HasUserOriginated

Returns:

true if this event originates from the client, false otherwise.