Package com.vaadin.ui

Class AbstractSplitPanel.SplitPositionChangeEvent

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeEvent

All Implemented Interfaces:

HasUserOriginated, Serializable

Enclosing class:

AbstractSplitPanel

public static class AbstractSplitPanel.SplitPositionChangeEvent
extends Component.Event
implements HasUserOriginated

Event that indicates a change in SplitPanel's splitter position.

Since:

7.5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SplitPositionChangeEvent(Component source, boolean userOriginated, float oldPosition, Sizeable.Unit oldUnit, float position, Sizeable.Unit unit)	Creates a split position change event.

Method Summary

Modifier and Type	Method	Description
float	getOldSplitPosition()	Returns the position of the split before this change event occurred.
Sizeable.Unit	getOldSplitPositionUnit()	Returns the position unit of the split before this change event occurred.
float	getSplitPosition()	Returns the new split position that triggered this change event.
Sizeable.Unit	getSplitPositionUnit()	Returns the new split position unit that triggered this change 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

SplitPositionChangeEvent

public SplitPositionChangeEvent(Component source,
                                boolean userOriginated,
                                float oldPosition,
                                Sizeable.Unit oldUnit,
                                float position,
                                Sizeable.Unit unit)

Creates a split position change event.

Parameters:

source - split panel from which the event originates

userOriginated - true if the event is directly based on user actions

oldPosition - old split position

oldUnit - old unit of split position

position - new split position

unit - new split position unit

Since:

8.1

Method Detail

getSplitPosition

public float getSplitPosition()

Returns the new split position that triggered this change event.

Returns:

the new value of split position

getSplitPositionUnit

public Sizeable.Unit getSplitPositionUnit()

Returns the new split position unit that triggered this change event.

Returns:

the new value of split position

getOldSplitPosition

public float getOldSplitPosition()

Returns the position of the split before this change event occurred.

Returns:

the split position previously set to the source of this event

Since:

8.1

getOldSplitPositionUnit

public Sizeable.Unit getOldSplitPositionUnit()

Returns the position unit of the split before this change event occurred.

Returns:

the split position unit previously set to the source of this event

Since:

8.1

isUserOriginated

public boolean isUserOriginated()

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.

Since:

8.1