com.iizix.api.ui

Class UIBaseEvent<UICOMP extends IUIComp>

java.lang.Object

com.iizix.api.BaseEvent<UICOMP>

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

All Implemented Interfaces:

IMessageBox

Direct Known Subclasses:

UIActionEvent, UIBackEvent, UIConnectEvent, UICreateEvent, UIDestroyEvent, UIFocusEvent, UISelectionEvent, UITextChangeEvent, UIValueChangeEvent

public class UIBaseEvent<UICOMP extends IUIComp>
extends BaseEvent<UICOMP>

Base event for all events in the API.

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

Modifier	Constructor and Description
protected	UIBaseEvent(UICOMP source) Constructor called from the subclass.

Method Summary

Modifier and Type	Method and Description
IAppSessionGyro	getAppSessionGyro() Gets the Application Session Gyro instance.
IClientSessionGyro	getClientSessionGyro() Gets the Client Session Gyro instance.
<COMP extends UIComp> COMP	getFirstUIComponent(String name, Class<COMP> uiClass) Gets the first UI component of the specified name and UI class.
<COMP extends UIComp> COMP	getFirstUIComponentNull(String name, Class<COMP> uiClass) Gets the first UI component of the specified name and UI class.
<COMP extends UIComp> COMP	getPanelUIComponent(@UIRef String uiPath, Class<COMP> uiClass) Gets a UI component by UI path reference from the panel.
<COMP extends UIComp> COMP	getPanelUIComponentNull(@UIRef String uiPath, Class<COMP> uiClass) Gets a UI component with relative reference from this container.
UIPanelBase	getUIPanel() Gets the panel of the UI event source component.
VirtualSpace	getVirtualSpace() Gets the VirtualSpace of the UI event source component.

Methods inherited from class com.iizix.api.BaseEvent

getAction, getAction2, getActionNull, getActionNull2, getField, getField2, getFieldNull, getFieldNull2, getGroup, getGroup2, getGroupNull, getGroupNull2, getSource, getTable, getTable2, getTableNull, getTableNull2, getTime, getVirtualizedVirtualSpace, getVSComponent, getVSComponent2, getVSComponentNull, getVSComponentNull2, messageBox, paramString, 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

UIBaseEvent

protected UIBaseEvent(UICOMP source)

Constructor called from the subclass.

Throws:

NullPointerException - If the source is null.

Method Detail

getVirtualSpace

public VirtualSpace getVirtualSpace()

Gets the VirtualSpace of the UI event source component.

Specified by:

getVirtualSpace in class BaseEvent<UICOMP extends IUIComp>

Returns:

The VirtualSpace connected to the panel of this event source component.

getAppSessionGyro

public IAppSessionGyro getAppSessionGyro()

Gets the Application Session Gyro instance.

Overrides:

getAppSessionGyro in class BaseEvent<UICOMP extends IUIComp>

Returns:

The instance.

getClientSessionGyro

public IClientSessionGyro getClientSessionGyro()

Gets the Client Session Gyro instance.

Returns:

The instance.

getUIPanel

public UIPanelBase getUIPanel()

Gets the panel of the UI event source component.

Returns:

The panel.

getPanelUIComponent

public <COMP extends UIComp> COMP getPanelUIComponent(@UIRef String uiPath,
                                                      Class<COMP> uiClass)
                                               throws NotFoundException

Gets a UI component by UI path reference from the panel.

Note: A UI path is not the same as a property path, it omits the UI container UIComps instance from the path.

Parameters:

uiPath - The UI path for the component.

uiClass - The UI class of the component.

Returns:

The component, never null.

Throws:

NotFoundException - The not-found exception is thrown if the component is not found instead of returning null.

getPanelUIComponentNull

public <COMP extends UIComp> COMP getPanelUIComponentNull(@UIRef String uiPath,
                                                          Class<COMP> uiClass)

Gets a UI component with relative reference from this container.

Note: A UI path is not the same as a property path, it omits the UI container UIComps instance from the path.

Parameters:

uiPath - The UI path for the component.

uiClass - The UI class of the component.

Returns:

The component, or null if not found.

getFirstUIComponent

public <COMP extends UIComp> COMP getFirstUIComponent(String name,
                                                      Class<COMP> uiClass)

Gets the first UI component of the specified name and UI class. The search for the component is done from this container and its children containers.

Parameters:

name - The name of the component.

uiClass - The UI class of the component.

Returns:

The component, never null.

Throws:

NotFoundException - The not-found exception is thrown if the component is not found instead of returning null.

getFirstUIComponentNull

public <COMP extends UIComp> COMP getFirstUIComponentNull(String name,
                                                          Class<COMP> uiClass)

Gets the first UI component of the specified name and UI class. The search for the component is done from this container and its children containers.

Parameters:

name - The name of the component.

uiClass - The UI class of the component.

Returns:

The component, or null if not found.