com.iizigo.term.server

Class EditorActiveTerminalSession

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.term.server.ActiveTerminalSession

com.iizigo.term.server.EditorActiveTerminalSession

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IPropCnr, ITerminalStateListener, Cloneable

public class EditorActiveTerminalSession
extends ActiveTerminalSession

The container for an active terminal session for the terminal monitor of each client end-point.

Author:

Christopher Mindus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorActiveTerminalSession.Setup Configuration setup for property editor.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	HEADERS The list of terminal properties copied from TerminalProps.

Fields inherited from class com.iizix.term.server.ActiveTerminalSession

hostSessionProps, NAMES, REMOTE_EVENT_CAPTURE, REMOTE_EVENT_CONNECT, REMOTE_EVENT_DISCONNECT, REMOTE_EVENT_ERROR, REMOTE_EVENT_RESUME, REMOTE_EVENT_SUSPEND

Fields inherited from class com.iizix.prop.PropCnr

EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.term.server.ITerminalStateListener

EMPTY

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Constructor and Description
EditorActiveTerminalSession() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canShowPanelPart() Returns if the right panel part can be shown.
EditorActiveTerminalSession	clone() Clones the instance.
void	doRemoteCapture() Performs a remote capture of screen.
void	doRemoteConnect() Performs a remote connect.
void	doRemoteDisconnect() Performs a remote disconnect.
void	doRemoteResume() Performs a remote connect.
void	doRemoteSuspend() Performs a remote suspend.
int	getCNCategory() Gets the category of this Common Navigator object, used for sorting.
String	getCNDescriptionType() Provide a type description for the status bar view, if available.
Image	getCNImage() Gets the image for the Common Navigator.
String	getCNText() Gets the label text for the Common Navigator.
VirtualizedMonitorDesignerProp	getDesigner() Gets the Designer Extension for Properties.
PropertyEditorSetup	getPropertyEditorSetup() Gets the Setup used for iiziGo, subclasses must override and provide their instance.
List<TooltipItem>	getTooltipPropertyList() Gets the list of property names that should be displayed.
boolean	isConnected() Returns if connected.
void	onEventSelf(GEvent event) Property events go here, and a new terminal session request is received from the monitor (client) side if the HostSessionProps are created.
protected void	onPropDispose() Called when property is disposed of.
void	onRemoteEvent(RemoteEvent event) Processes remote events from the server's ActiveTerminalSession instance.
void	showPanelPart(Composite parent) Requests to show the panel part.

Methods inherited from class com.iizix.term.server.ActiveTerminalSession

onConnectionStateChanged

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Field Detail

HEADERS

protected static final String[] HEADERS

The list of terminal properties copied from TerminalProps.

Constructor Detail

EditorActiveTerminalSession

public EditorActiveTerminalSession()

Constructor.

Method Detail

getDesigner

public VirtualizedMonitorDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Returns:

The instance of the Designer Extension.

getPropertyEditorSetup

public PropertyEditorSetup getPropertyEditorSetup()

Gets the Setup used for iiziGo, subclasses must override and provide their instance.

clone

public EditorActiveTerminalSession clone()

Clones the instance.

Overrides:

clone in class PropCnr

getTooltipPropertyList

public List<TooltipItem> getTooltipPropertyList()

Gets the list of property names that should be displayed. The value is a String with a Tab delimiter for the text prompt, i.e. an item "Text prompt\t$text" will take a property named "$text" shown with the text prompt "Text prompt:". The first item indicates the heading. Special values for an item are:

• "" (only empty string) will add space before next line (4 pixel per empty string),
• "-" for a separator line,
• "MMM\t" for full line width of text "MMM",
• "$" for the property name,
• "&cnText" for the text.
• "&cnDescription" for the property getCNDescription() available on Text prompt side (before \t),
• "&cnDescriptionType" for the property getCNDescriptionType() available on Text prompt side (before \t).

An item that is preceeded with "#" will use bold font.
An item that is preceeded with "%" will use bold font and the image for the property.

Returns:

The list, or null for no tooltip.

getCNCategory

public int getCNCategory()

Gets the category of this Common Navigator object, used for sorting.

Returns:

This method returns zero, i.e. no category.

getCNImage

public Image getCNImage()

Gets the image for the Common Navigator.

Returns:

Image or null if there is no image.

getCNText

public String getCNText()

Gets the label text for the Common Navigator.

getCNDescriptionType

public String getCNDescriptionType()

Provide a type description for the status bar view, if available.

Returns:

A type description for the status bar view, or null if not available.

canShowPanelPart

public boolean canShowPanelPart()

Returns if the right panel part can be shown.

Returns:

false by default, override to handle panel parts.

showPanelPart

public void showPanelPart(Composite parent)

Requests to show the panel part. When called, the composite is initialized to a grid layout of 1 column with standard margins.

Parameters:

parent - The parent composite.

onPropDispose

protected void onPropDispose()

Called when property is disposed of.

Overrides:

onPropDispose in class ActiveTerminalSession

onEventSelf

public void onEventSelf(GEvent event)

Property events go here, and a new terminal session request is received from the monitor (client) side if the HostSessionProps are created. Removal of the remote terminal is also processed here.

Specified by:

onEventSelf in interface IGProp<GProp<?>[]>

Overrides:

onEventSelf in class ActiveTerminalSession

Parameters:

event - The property event.

onRemoteEvent

public void onRemoteEvent(RemoteEvent event)

Processes remote events from the server's ActiveTerminalSession instance.

Specified by:

onRemoteEvent in interface IGProp<GProp<?>[]>

Overrides:

onRemoteEvent in class ActiveTerminalSession

Parameters:

event - The remote event.

isConnected

public boolean isConnected()

Returns if connected.

Returns:

true if connected.

doRemoteConnect

public void doRemoteConnect()

Performs a remote connect.

doRemoteSuspend

public void doRemoteSuspend()

Performs a remote suspend.

doRemoteResume

public void doRemoteResume()

Performs a remote connect.

doRemoteDisconnect

public void doRemoteDisconnect()

Performs a remote disconnect.

doRemoteCapture

public void doRemoteCapture()

Performs a remote capture of screen.