com.iizix.api.vs

Class VSStateEvent

java.lang.Object

com.iizix.api.BaseEvent<VSCOMP>

com.iizix.api.vs.VSBaseEvent<VSCOMP>

com.iizix.api.vs.VSBaseEventWithTrigger<IVSComponent>

com.iizix.api.vs.VSStateEvent

All Implemented Interfaces:

IMessageBox, IVSComponentState

public class VSStateEvent
extends VSBaseEventWithTrigger<IVSComponent>
implements IVSComponentState

The VirtualSpace State Event is fired when the VirtualSpace state changes for a component, or when connected to the VirtualSpace, for every child item in it.

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState

IVSComponentState.State

Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox

IMessageBox.Icon

Field Summary

Fields inherited from class com.iizix.api.BaseEvent

source

Fields inherited from interface com.iizix.gyro.IMessageBox

ICON_ERROR, ICON_INFORMATION, ICON_MAP, ICON_NONE, ICON_QUESTION, ICON_WARNING

Constructor Summary

Constructors

Constructor and Description
VSStateEvent(IVSComponent source, IVSComponentState.State state, boolean stateValue, GProp<?> trigger) Constructs the event for a change event with a property being the trigger source, e.g.

Method Summary

Modifier and Type	Method and Description
IVSComponent	getSource() Gets the VirtualSpace item that is the source of the event, i.e.
IVSComponentState.State	getState() Returns the state that changed.
boolean	getStateValue() Returns the state value that changed.
protected String	paramString() Gets the parameter string.

Methods inherited from class com.iizix.api.vs.VSBaseEventWithTrigger

getTrigger, getTriggerClientSessionGyro, getTriggerUIComp

Methods inherited from class com.iizix.api.vs.VSBaseEvent

getAppSessionGyro, getVirtualSpace

Methods inherited from class com.iizix.api.BaseEvent

getAction, getAction2, getActionNull, getActionNull2, getField, getField2, getFieldNull, getFieldNull2, getGroup, getGroup2, getGroupNull, getGroupNull2, getTable, getTable2, getTableNull, getTableNull2, getTime, getVirtualizedVirtualSpace, getVSComponent, getVSComponent2, getVSComponentNull, getVSComponentNull2, messageBox, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.iizix.gyro.IMessageBox

messageBox, messageBox

Constructor Detail

VSStateEvent

public VSStateEvent(IVSComponent source,
                    IVSComponentState.State state,
                    boolean stateValue,
                    GProp<?> trigger)

Constructs the event for a change event with a property being the trigger source, e.g. an UIButton or UICheckBox.

Parameters:

source - The source.

state - The state that changed.

stateValue - The new state value.

trigger - The trigger property.

Method Detail

getSource

public IVSComponent getSource()

Gets the VirtualSpace item that is the source of the event, i.e. the item that changes selection state.

Overrides:

getSource in class BaseEvent<IVSComponent>

Returns:

The VSComponent with the selection state changed.

getState

public IVSComponentState.State getState()

Returns the state that changed.

Returns:

The state changed.

getStateValue

public boolean getStateValue()

Returns the state value that changed.

For IVSComponentState.State.MESSAGE the value is the validity flag, i.e. validity = true means no message.

Returns:

The new component state value.

paramString

protected String paramString()

Gets the parameter string.

Overrides:

paramString in class VSBaseEventWithTrigger<IVSComponent>