com.iizigo.ws.prop

Class EditorOutputVariable

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.vs.AbstractVSVariable<VSField,VSFieldReference>

com.iizix.ws.prop.OutputVariable

com.iizigo.ws.prop.EditorOutputVariable

All Implemented Interfaces:

ILinkCapable, IJavaInterfaceLinkEnabler, IPropDesigner, IWSPropDesigner, EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, Cloneable, IAdaptable

public class EditorOutputVariable
extends OutputVariable
implements IWSPropDesigner, IJavaInterfaceLinkEnabler

Editor version of the Output Variable connects a reference variable from the reply output with a VSField.

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizigo.link.java.IJavaInterfaceLinkEnabler

IJavaInterfaceLinkEnabler.InterfaceDefinition

Field Summary

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

Fields inherited from interface com.iizigo.link.ILinkCapable

STATUS_LINK_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
EditorOutputVariable() Creates the property container without a name.
EditorOutputVariable(Atom propertyAtom) Creates the property container with the specified name.

Method Summary

Modifier and Type	Method and Description
EditorOutputVariable	clone() Clone must be overridden.
Composite	createCNToolTip(Composite parent) Creates a tooltip for the result set.
Composite	createCNToolTip(Composite parent, int columnIndex) Requests creates of the Composite used to show the tooltip.
String	getCNDescriptionType() Provide a type description for the status bar view, if available.
Image	getCNImage() Gets the image for the Common Navigator.
Image	getCNImage(int columnIndex) Gets the image for the Common Navigator.
String	getCNText() Gets the label text for the Common Navigator.
String	getCNText(int columnIndex) Gets the label text for the Common Navigator.
WebServiceDesignerProp	getDesigner() Gets the Designer Extension for Properties.
String	getDragDropText() Gets the link text to display when drag-dropping into JavaScript Panel Editor.
IJavaInterfaceLinkEnabler.InterfaceDefinition[]	getInterfaceDefinitions() Gets the interface definitions for the property used for drag-drop or linking in the Designer.
EditorOutputProps	getOutputProps() Gets the output properties.
EditorOutputVariables	getOutputVariables() Gets the output variables properties container.
EditorVSField	getVSField() Gets the VSField.
void	onEventSelf(GEvent event) Processes events that may change wrapped elements.
void	setIdentification(boolean on) Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.
void	verify(PropVerification verification) Verifies this property container.

Methods inherited from class com.iizix.ws.prop.OutputVariable

getClassReference, getDescription, getNullReplacement, getOutputVariableConverter, getVSPropertyClass, getVSReferenceClass, isIdentification, isNullOmit, setVSRelativeReference

Methods inherited from class com.iizix.prop.vs.AbstractVSVariable

getVariableName, getVSTarget, getVSVariableReference, setVariableName

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, 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, 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.iizigo.prop.IPropDesigner

findIResource, getAdapter

Methods inherited from interface com.iizix.prop.IPropCnr

addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, 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, usePropHashMap, usesPropIndex, validateClassInstances

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, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizigo.link.java.IJavaInterfaceLinkEnabler

getLinkOperations, isLinkCapable

Methods inherited from interface com.iizigo.link.ILinkCapable

getDragDropHTML

Methods inherited from interface com.iizix.prop.IClassInstantiationAtResolve

shouldInstantiateAtResolve

Constructor Detail

EditorOutputVariable

public EditorOutputVariable()

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

EditorOutputVariable

public EditorOutputVariable(Atom propertyAtom)

Creates the property 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

getDesigner

public WebServiceDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Specified by:

getDesigner in interface IPropDesigner

Returns:

The instance of the Designer Extension.

getOutputVariables

public EditorOutputVariables getOutputVariables()

Gets the output variables properties container.

Overrides:

getOutputVariables in class OutputVariable

Returns:

The instance, or null if orphaned.

getOutputProps

public EditorOutputProps getOutputProps()

Gets the output properties.

Overrides:

getOutputProps in class OutputVariable

Returns:

The instance, or null if orphaned.

clone

public EditorOutputVariable clone()

Clone must be overridden.

Overrides:

clone in class OutputVariable

setIdentification

public void setIdentification(boolean on)

Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.

Parameters:

on - Flag for identification.

onEventSelf

public void onEventSelf(GEvent event)

Processes events that may change wrapped elements.

Specified by:

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

Overrides:

onEventSelf in class GProp<GProp<?>[]>

Parameters:

event - The property event.

getVSField

public EditorVSField getVSField()

Gets the VSField.

Overrides:

getVSField in class OutputVariable

Returns:

The VSField associated, or null for none (or unresolved).

getCNImage

public Image getCNImage()

Gets the image for the Common Navigator.

Specified by:

getCNImage in interface IWSPropDesigner

Returns:

Image or null if there is no image.

getCNText

public String getCNText()

Gets the label text for the Common Navigator.

Specified by:

getCNText in interface IWSPropDesigner

Returns:

The text.

getCNDescriptionType

public String getCNDescriptionType()

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

Specified by:

getCNDescriptionType in interface IWSPropDesigner

Returns:

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

getCNImage

public Image getCNImage(int columnIndex)

Gets the image for the Common Navigator.

Specified by:

getCNImage in interface IWSPropDesigner

Parameters:

columnIndex - Index of column.

Returns:

Image or null if there is no image.

getDragDropText

public String getDragDropText()

Gets the link text to display when drag-dropping into JavaScript Panel Editor.

Specified by:

getDragDropText in interface ILinkCapable

Returns:

The drag-drop text to use.

getCNText

public String getCNText(int columnIndex)

Gets the label text for the Common Navigator.

Specified by:

getCNText in interface IWSPropDesigner

Parameters:

columnIndex - Index of column.

Returns:

The column text.

createCNToolTip

public Composite createCNToolTip(Composite parent,
                                 int columnIndex)

Requests creates of the Composite used to show the tooltip.

Specified by:

createCNToolTip in interface IWSPropDesigner

Parameters:

parent - The parent composite.

columnIndex - Index of column.

Returns:

The created composite in the parent, or null for none.

createCNToolTip

public Composite createCNToolTip(Composite parent)

Creates a tooltip for the result set.

Specified by:

createCNToolTip in interface IWSPropDesigner

Parameters:

parent - The parent composite.

Returns:

The created composite in the parent.

getInterfaceDefinitions

public IJavaInterfaceLinkEnabler.InterfaceDefinition[] getInterfaceDefinitions()

Gets the interface definitions for the property used for drag-drop or linking in the Designer.

Specified by:

getInterfaceDefinitions in interface IJavaInterfaceLinkEnabler

Returns:

An array of the definitions, not null.

verify

public void verify(PropVerification verification)

Verifies this property container. The check performed is the extension of classes and that no circular reference is present.

Specified by:

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

Overrides:

verify in class PropCnr

Parameters:

verification - The property verification class.