java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.prop.vs.AbstractVSVariable<VSField,VSFieldReference>
    - - com.iizix.db.prop.InputVariable

All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IVSComponentListener, IVSComponentState, IVSFieldListener, java.lang.Cloneable
Direct Known Subclasses:
EditorInputVariable
```
public class InputVariable
extends AbstractVSVariable<VSField,VSFieldReference>
implements IVSFieldListener
```
The Input Variable connects a VSField with an input variable or parameter to an SQL query statement.
Author:
Christopher Mindus

Nested Class Summary
- Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState
  IVSComponentState.State

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

Constructor Summary

Constructors
Constructor	Description
`InputVariable()`	Creates an input variable property container with the specified name with a null value.
`InputVariable(Atom propertyAtom)`	Creates an input variable property container with the specified name with a null value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InputVariable`	`clone()`	Clones this variable instance.
`Value.Type`	`getBestVSFieldValueType(VSRelativeReference<?> reference)`	Requests the value type that would best suit the listener.
`java.lang.String`	`getDescription()`	Gets the column description.
`int`	`getSQLDataType()`	Gets the SQL data type.
`java.lang.String`	`getSQLDataTypeString()`	Gets the SQL data type string.
`VSField`	`getVSField()`	Gets the VSField.
`java.lang.Class<VSField>`	`getVSPropertyClass()`	Gets the class wanted for the VS component being referenced.
`java.lang.Class<VSFieldReference>`	`getVSReferenceClass()`	Gets the class wanted for VS references.
`void`	`onBroken(VSRelativeReference<?> reference, VSField field)`	Called when the property reference has been broken, i.e.
`void`	`onParentStateChanged(IVSComponent parent, IVSComponentState.State state, boolean on)`	Called when the column changes state.
`void`	`onResolved(VSRelativeReference<?> reference, VSField field)`	Called when the property reference has been resolved.
`void`	`onStateChanged(VSField field, IVSComponentState.State state, boolean on)`	Called when the field changes state.
`void`	`onValueChanged(VSField field, Value value, GProp<?> trigger, IPostEventProcessing postProcessing)`	Called when the field value is set.
`protected boolean`	`setSQLDataType(int type)`	Sets the SQL data type.

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, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, 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, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, 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, shouldSerializeToXML, 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, getModuleFolder, getModuleFolder, 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.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, 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

Methods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

- Constructor Detail
  - InputVariable
```
public InputVariable()
```
    Creates an input variable property container with the specified name with a null value.
  - InputVariable
```
public InputVariable(Atom propertyAtom)
```
    Creates an input variable property container with the specified name with a null value.
    Parameters:
    propertyAtom - the property atom.
- Method Detail
  - clone
```
public InputVariable clone()
```
    Clones this variable instance.
    Overrides:
    clone in class AbstractVSVariable<VSField,VSFieldReference>
  - getVSPropertyClass
```
public java.lang.Class<VSField> getVSPropertyClass()
```
    Gets the class wanted for the VS component being referenced.
    Specified by:
    getVSPropertyClass in class AbstractVSVariable<VSField,VSFieldReference>
    Returns:
    VSField.class, VSColumnHeader.class or VSTable.class.
  - getVSReferenceClass
```
public java.lang.Class<VSFieldReference> getVSReferenceClass()
```
    Gets the class wanted for VS references.
    Specified by:
    getVSReferenceClass in class AbstractVSVariable<VSField,VSFieldReference>
    Returns:
    VSFieldReference.class.
  - getVSField
```
public VSField getVSField()
```
    Gets the VSField.
    Returns:
    The VSField associated, or null for none (or unresolved).
  - setSQLDataType
```
protected boolean setSQLDataType(int type)
```
    Sets the SQL data type.
    This method is used internally by the Designer during creation of the SQL statement and should not be called elsewhere.
    Parameters:
    type - The SQL data type for the column as defined by Types.
    Returns:
    true for changed, false for no change.
  - getSQLDataType
```
public int getSQLDataType()
```
    Gets the SQL data type.
    Returns:
    The SQL data type for the column as defined by Types, or 0 if SQL statement is not yet parsed in the Designer, or if the column has been left "hanging around" and not yet deleted (this is a problem with warning severity level). This value should NEVER be 0 in the Server, unless it's running in Development Mode!
  - getSQLDataTypeString
```
public java.lang.String getSQLDataTypeString()
```
    Gets the SQL data type string.
    Returns:
    The SQL data type for the column as defined by Types, or "unknown" if not found or undefined
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the column description.
    Returns:
    A description, or null for none.
  - getBestVSFieldValueType
```
public Value.Type getBestVSFieldValueType(VSRelativeReference<?> reference)
```
    Requests the value type that would best suit the listener.
    Specified by:
    getBestVSFieldValueType in interface IVSFieldListener
    Parameters:
    reference - The VSRelativeReference instance holding the reference.
    Returns:
    null if none is available.
  - onResolved
```
public void onResolved(VSRelativeReference<?> reference,
                       VSField field)
```
    Called when the property reference has been resolved. UI components use this method to set its state according to the field.
    Specified by:
    onResolved in interface IVSFieldListener
    Parameters:
    reference - The VSRelativeReference instance holding the reference.
    field - The target reference.
  - onBroken
```
public void onBroken(VSRelativeReference<?> reference,
                     VSField field)
```
    Called when the property reference has been broken, i.e. unresolved.
    Specified by:
    onBroken in interface IVSFieldListener
    Parameters:
    reference - The VSRelativeReference instance holding the reference.
    field - The target reference.
  - onStateChanged
```
public void onStateChanged(VSField field,
                           IVSComponentState.State state,
                           boolean on)
```
    Called when the field changes state.
    Specified by:
    onStateChanged in interface IVSFieldListener
    Parameters:
    field - The VS field.
    state - The state change.
    on - New state.
  - onParentStateChanged
```
public void onParentStateChanged(IVSComponent parent,
                                 IVSComponentState.State state,
                                 boolean on)
```
    Called when the column changes state.
    Specified by:
    onParentStateChanged in interface IVSComponentListener
    Parameters:
    parent - The parent who's state was changed.
    state - The state change, possible values PARENT_ENABLED, PARENT_READONLY, PARENT_VISIBLE.
    on - New state.
  - onValueChanged
```
public void onValueChanged(VSField field,
                           Value value,
                           GProp<?> trigger,
                           IPostEventProcessing postProcessing)
```
    Called when the field value is set.
    Specified by:
    onValueChanged in interface IVSFieldListener
    Parameters:
    field - The VS field.
    value - The value, never null, but value.isNull() could be true.
    trigger - The trigger property that may be null.
    postProcessing - Post-processing instance.

Class InputVariable

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

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

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Constructor Detail

InputVariable

InputVariable

Method Detail

clone

getVSPropertyClass

getVSReferenceClass

getVSField

setSQLDataType

getSQLDataType

getSQLDataTypeString

getDescription

getBestVSFieldValueType

onResolved

onBroken

onStateChanged

onParentStateChanged

onValueChanged