UIConnectEvent (IIZI - 2.1.0.15885 Java API Specification)

java.lang.Object
- com.iizix.api.BaseEvent<UICOMP>
- - com.iizix.api.ui.UIBaseEvent<UIComp>
  - - com.iizix.api.ui.UIConnectEvent

All Implemented Interfaces:
IMessageBox
```
public class UIConnectEvent
extends UIBaseEvent<UIComp>
```
The UI Connect Event. This event is fired when a new user session connects (i.e. not reconnects) to an existing session. The VirtualSpace instances remains, but the new connection is started fresh on this particular panel and would perhaps need custom initialization.
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
UIConnectEvent(UIPanelBase panel, IClientSessionGyro clientGyro)
Constructs the event for a component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IClientSessionGyro`	`getClientSessionGyro()`	Gets the client session gyro that started the new connection to an existing instance of the virtualized application with a shared VirtualSpace.
`UIPanelBase`	`getSource()`	Gets the UI component that is the source, always a `UIPanelBase` instance.

Methods inherited from class com.iizix.api.ui.UIBaseEvent
getAppSessionGyro, 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, 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
  - UIConnectEvent
```
public UIConnectEvent(UIPanelBase panel,
                      IClientSessionGyro clientGyro)
```
    Constructs the event for a component.
    Parameters:
    panel - The source.
    clientGyro - The client session gyro.
    Throws:
    java.lang.NullPointerException - If the source is null.
- Method Detail
  - getSource
```
public UIPanelBase getSource()
```
    Gets the UI component that is the source, always a UIPanelBase instance.
    Overrides:
    getSource in class BaseEvent<UIComp>
    Returns:
    The UIPanelBase instance.
  - getClientSessionGyro
```
public IClientSessionGyro getClientSessionGyro()
```
    Gets the client session gyro that started the new connection to an existing instance of the virtualized application with a shared VirtualSpace.
    Overrides:
    getClientSessionGyro in class UIBaseEvent<UIComp>
    Returns:
    The client session gyro.