com.iizix.term.prop

Class TerminalProps

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.SocketCommProps

com.iizix.term.prop.TelnetCommProps

com.iizix.term.prop.TerminalProps

All Implemented Interfaces:

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

Direct Known Subclasses:

EditorTerminalProps

public class TerminalProps
extends TelnetCommProps

This property container contains all properties required for the terminal connector in terms of flags, colors, etc.

Author:

Christopher Mindus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TerminalProps.Type The terminal types.

Field Summary

Fields inherited from class com.iizix.term.prop.TelnetCommProps

DEFAULT_AUTO_RECONNECT_ATTEMPTS, DEFAULT_AUTO_RECONNECT_INTERVAL, DEFAULT_KEEP_ALIVE_INTERVAL

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.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
TerminalProps() Creates the terminal properties container without a name.
TerminalProps(Atom propertyAtom) Creates the terminal properties container with the specified name.

Method Summary

Modifier and Type	Method and Description
TerminalProps	clone() Creates a clone of the terminal properties.
TerminalHost	createTerminalHost(AppSessionGyro appGyro) Creates a terminal host that becomes associated with this property.
String	getCaptureFileName() Gets the EE file name, used when the host session is displaying a single captured screen.
TerminalHost	getCreatedTerminalHost() Gets the terminal host that has been created from this property for the application session gyro instance using createTerminalHost(AppSessionGyro).
String	getDescription() Gets the description of the terminal session configuration.
boolean	getDescription(String descr) Sets the description of the terminal session configuration.
String	getEEMFileName() Gets the EEM file name.
KeyboardRemapper	getKeyboardRemapper() Gets the keyboard mapper to use.
boolean	getPrinterSettings(TerminalPrinterSettings pojo) Gets the printer properties container and initializes the TerminalPrinterSettings POJO class members accordingly.
TerminalProps.Type	getTerminalType() Gets the terminal type.
boolean	isClientLocalFieldEditing() Checks if client-local field editing is enabled for this session.
boolean	isPreStarted() Returns if the terminal session should be pre-started when a user session is started.
boolean	isPrinterAssociated() Checks if a 3270 printer is associated.
boolean	isTypeAheadEnabled() Checks if type-ahead is enabled for this session.
boolean	isUser3270BoxDrawingEnabled() Checks if 3270 box drawing is enabled.
boolean	isUserPCInsertModeEnabled() Checks if PC Insert mode is enabled.
boolean	isUserSmartInsertModeEnabled() Checks if smart-insert mode is enabled (spaces are treated like null's at the end of the field).
protected void	onPropDisposed() Called when the property is disposed of.
void	setCaptureFileName(String fn) Sets the EE file name, used when the host session is displaying a single captured screen.
void	setClientLocalFieldEditing(boolean enabled) Sets if client-local field editing is enabled for this session.
void	setEEMFileName(String fn) Sets the EEM file name.
void	setPrinterAssociated(boolean associate) Sets if a 3270 printer is associated.
boolean	setPrinterSettings(TerminalPrinterSettings pojo) Sets the printer properties container from a TerminalPrinterSettings POJO.
void	setTerminalType(TerminalProps.Type type) Sets the terminal type.
void	setTypeAheadEnabled(boolean enabled) Sets if type-ahead is enabled for this session.
void	setUser3270BoxDrawingEnabled(boolean enabled) Sets if 3270 box drawing is enabled.
void	setUserPCInsertModeEnabled(boolean enabled) Sets if PC Insert mode is enabled.
void	setUserSmartInsertMode(boolean enabled) Sets the smart-insert mode (spaces are treated like null's at the end of the field).

Methods inherited from class com.iizix.term.prop.TelnetCommProps

do3270NumericFieldOverride, doAutoReconnect, doTN3270E, get5250KbdType, getAutoReconnectAttempts, getAutoReconnectInterval, getHostCodepage, getKeepAliveTimeout, getLUName, getTerminalTypes, set3270NumericFieldOverride, set5250KbdType, setAutoReconnect, setAutoReconnectAttempts, setAutoReconnectInterval, setDoTN3270E, setHostCodepage, setKeepAliveNOP, setKeepAliveTimeout, setLUName, setTerminalTypes, useKeepAliveNOP

Methods inherited from class com.iizix.prop.SocketCommProps

createSecureProps, doResolveHostNames, getBindAddress, getHost, getPort, getProxyHost, getProxyPort, getProxyPW, getProxyPW, getProxyType, getProxyUser, getSecureProps, isSecure, isVerbose, setBindAddress, setHost, setPort, setProxyHost, setProxyPort, setProxyType, setProxyUser, setResolveHostNames, setSecure, setSecureProps, setVerbose, setWebSocket, useWebSocket

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, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, 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, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, 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.IPropCnr

canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

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, onEventSelf, onRemoteEvent, 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

Constructor Detail

TerminalProps

public TerminalProps()

Creates the terminal properties container without a name. The name must be set in all cases using the setPropertyAtom call.

TerminalProps

public TerminalProps(Atom propertyAtom)

Creates the terminal properties container with the specified name. All system-reserved names for components begins with "$".

Parameters:

propertyAtom - the name of the component, unique within it's parent.

Method Detail

clone

public TerminalProps clone()

Creates a clone of the terminal properties.

Overrides:

clone in class SocketCommProps

onPropDisposed

protected void onPropDisposed()

Called when the property is disposed of.

isPreStarted

public boolean isPreStarted()

Returns if the terminal session should be pre-started when a user session is started.

Returns:

The flag to prestart session or not.

getDescription

public String getDescription()

Gets the description of the terminal session configuration.

Returns:

The description set, or null for none.

getDescription

public boolean getDescription(String descr)

Sets the description of the terminal session configuration.

Parameters:

descr - The description to set, or null to remove it.

Returns:

true for changed, false for no change.

getTerminalType

public TerminalProps.Type getTerminalType()

Gets the terminal type.

Returns:

The terminal type (if none is set, 3270 is default).

setTerminalType

public void setTerminalType(TerminalProps.Type type)

Sets the terminal type.

Parameters:

type - The terminal type.

getEEMFileName

public String getEEMFileName()

Gets the EEM file name.

Returns:

null for none (default), otherwise the file name that is relative the root of the server.

setEEMFileName

public void setEEMFileName(String fn)

Sets the EEM file name. The file name should be relative the root directory of the server.

Parameters:

fn - The EEM file name or empty string for none.

getCaptureFileName

public String getCaptureFileName()

Gets the EE file name, used when the host session is displaying a single captured screen.

Returns:

File name or null for none.

setCaptureFileName

public void setCaptureFileName(String fn)

Sets the EE file name, used when the host session is displaying a single captured screen.

Parameters:

fn - The file name for EE capture.

isUserSmartInsertModeEnabled

public boolean isUserSmartInsertModeEnabled()

Checks if smart-insert mode is enabled (spaces are treated like null's at the end of the field).

Returns:

true if enabled (default), false otherwise.

setUserSmartInsertMode

public void setUserSmartInsertMode(boolean enabled)

Sets the smart-insert mode (spaces are treated like null's at the end of the field).

Parameters:

enabled - The enabled flag.

isUser3270BoxDrawingEnabled

public boolean isUser3270BoxDrawingEnabled()

Checks if 3270 box drawing is enabled.

Returns:

true if enabled (default), false otherwise.

setUser3270BoxDrawingEnabled

public void setUser3270BoxDrawingEnabled(boolean enabled)

Sets if 3270 box drawing is enabled.

Parameters:

enabled - The enabled flag.

isUserPCInsertModeEnabled

public boolean isUserPCInsertModeEnabled()

Checks if PC Insert mode is enabled.

Returns:

true if enabled (default), false otherwise.

setUserPCInsertModeEnabled

public void setUserPCInsertModeEnabled(boolean enabled)

Sets if PC Insert mode is enabled.

Parameters:

enabled - The enabled flag.

isTypeAheadEnabled

public boolean isTypeAheadEnabled()

Checks if type-ahead is enabled for this session.

Returns:

true if enabled (default), false otherwise.

setTypeAheadEnabled

public void setTypeAheadEnabled(boolean enabled)

Sets if type-ahead is enabled for this session.

Parameters:

enabled - The enabled flag.

isClientLocalFieldEditing

public boolean isClientLocalFieldEditing()

Checks if client-local field editing is enabled for this session.

Returns:

true if enabled (default), false otherwise.

setClientLocalFieldEditing

public void setClientLocalFieldEditing(boolean enabled)

Sets if client-local field editing is enabled for this session.

Parameters:

enabled - The enabled flag.

isPrinterAssociated

public boolean isPrinterAssociated()

Checks if a 3270 printer is associated.

Returns:

true if associated, false (default) otherwise.

setPrinterAssociated

public void setPrinterAssociated(boolean associate)

Sets if a 3270 printer is associated.

Parameters:

associate - true if associated, false otherwise.

getPrinterSettings

public boolean getPrinterSettings(TerminalPrinterSettings pojo)

Gets the printer properties container and initializes the TerminalPrinterSettings POJO class members accordingly.

Parameters:

pojo - The printer properties instance.

Returns:

true if successfully completed the operation, i.e. the printer properties were defined in the TerminalProps.

setPrinterSettings

public boolean setPrinterSettings(TerminalPrinterSettings pojo)

Sets the printer properties container from a TerminalPrinterSettings POJO.

Parameters:

pojo - The printer properties instance.

Returns:

true if successfully completed the operation, i.e. the printer properties were defined in the TerminalProps.

getKeyboardRemapper

public KeyboardRemapper getKeyboardRemapper()

Gets the keyboard mapper to use. This method creates a new KeyboardRemapper instance every time this method is called, so use it carefully!

Returns:

A new instance of the KeyboardRemapper.

createTerminalHost

public TerminalHost createTerminalHost(AppSessionGyro appGyro)

Creates a terminal host that becomes associated with this property.

Parameters:

appGyro - The application gyro for the session.

Returns:

A new instance of the terminal session, or the previously started one.

getCreatedTerminalHost

public TerminalHost getCreatedTerminalHost()

Gets the terminal host that has been created from this property for the application session gyro instance using createTerminalHost(AppSessionGyro).

Returns:

The terminal host created, or null for none.