Package com.iizix.api.ui

Class UIActionEvent

java.lang.Object

com.iizix.api.BaseEvent<UICOMP>

com.iizix.api.ui.UIBaseEvent<IUIAction>

com.iizix.api.ui.UIActionEvent

All Implemented Interfaces:

IMessageBox

public class UIActionEvent
extends UIBaseEvent<IUIAction>

The UI component Action Event.

Author:

Christopher Mindus

Nested Class Summary

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	Description
UIActionEvent(IUIAction source)	Constructs the event for an action without a trigger source.
UIActionEvent(IUIAction source, GProp<?> trigger)	Constructs the event for an action with a property being the trigger source, e.g.
UIActionEvent(IUIAction source, GProp<?> trigger, UIComp contextComponent)	Constructs the event for an action with a property being the trigger source, e.g.

Method Summary

Modifier and Type	Method	Description
UIComp	getContextComponent()	The context UI component that caused the event, when the event is generated from a context menu.
IUIAction	getSource()	Gets the UI component Action that is the source of the event.
GProp<?>	getTrigger()	Gets the trigger property being the source of the event.
protected java.lang.String	paramString()	Gets the parameter string.

Methods inherited from class com.iizix.api.ui.UIBaseEvent

getAppSessionGyro, getClientSessionGyro, getContainerFirstUIComponent, getContainerFirstUIComponentNull, getFirstUIComponent, getFirstUIComponentNull, getPanelUIComponent, getPanelUIComponentNull, getUIPanel, 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

UIActionEvent

public UIActionEvent(IUIAction source)

Constructs the event for an action without a trigger source.

Parameters:

source - The source.

Throws:

java.lang.NullPointerException - If the source is null.

UIActionEvent

public UIActionEvent(IUIAction source,
                     GProp<?> trigger)

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

Parameters:

source - The source.

trigger - The trigger property.

UIActionEvent

public UIActionEvent(IUIAction source,
                     GProp<?> trigger,
                     UIComp contextComponent)

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

Parameters:

source - The source.

trigger - The trigger property.

contextComponent - The context component causing the event, used for context menus.

Method Detail

getTrigger

public GProp<?> getTrigger()

Gets the trigger property being the source of the event.

Returns:

An instance of e.g. an UIButton or null if the trigger is not a property.

getSource

public IUIAction getSource()

Gets the UI component Action that is the source of the event.

Overrides:

getSource in class BaseEvent<IUIAction>

getContextComponent

public UIComp getContextComponent()

The context UI component that caused the event, when the event is generated from a context menu.

Returns:

The UI component, null if not originating from a context menu.

paramString

protected java.lang.String paramString()

Gets the parameter string.

Overrides:

paramString in class BaseEvent<IUIAction>