java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- - com.iizix.prop.AbstractReference<TARGET>
  - - com.iizix.prop.AbstractBaseRelativeReference<TARGET>
    - - com.iizix.prop.AbstractClientBaseRelativeReference<TARGET>

All Implemented Interfaces:
EventListener, ICircularRetargetParent, IGProp<ReferenceString>, IPropReference, java.lang.Cloneable
Direct Known Subclasses:
LabelForReference
```
public abstract class AbstractClientBaseRelativeReference<TARGET extends IClientBaseRelativeTarget>
extends AbstractBaseRelativeReference<TARGET>
```
The Client Base Relative Reference property class hold the reference to another property in the same base container.
Author:
Christopher Mindus

Nested Class Summary
- Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference
  IPropReference.ReferenceChangeEvent

Field Summary
- Fields inherited from class com.iizix.prop.AbstractReference
  ERROR_ID, hasBeenValidated, QUICK_FIX_DELETE_PROP, reference
- 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
`AbstractClientBaseRelativeReference()`	Creates a Label For Reference property with no name and with a null value.
`AbstractClientBaseRelativeReference(Atom propertyAtom)`	Creates a Label For Reference property with the specified name with a null value.
`AbstractClientBaseRelativeReference(Atom propertyAtom, java.lang.String newValue)`	Creates a Label For Reference property with the specified name and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`appendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value)`	Overrides the send-transaction to client in order to send the unique label ID in the panel.
`AbstractClientBaseRelativeReference<TARGET>`	`clone()`	Clone overridden to ensure reference is created before cloning to have the "cidValue" cloned.
`protected java.lang.String`	`getScopeErrorMessage()`	Gets the error message when the base container doesn't validate scope.
`protected void`	`informError()`	Called when the property has an error.
`protected void`	`informResolved()`	Called when the property has been resolved.
`boolean`	`initializeValue(PropMgr propertyManager, ReadTransaction trans)`	Fakes processing of initializing the value from the remote part by skipping it in the transaction.
`boolean`	`isPropReferenceTreeValid()`	Verifies if the tree is valid for reference creation.
`void`	`onEventSelf(GEvent event)`	Overridden to check for cache clearing...
`void`	`resetComponentID()`	Resets the component ID referenced.

Methods inherited from class com.iizix.prop.AbstractBaseRelativeReference
doPostResolve, getLookupPropReference, setLookedUpReference, validateReferenceScope

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, 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, getPropBaseReference, 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, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeElement, initializeGElement, initializeGProp, initializeProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropTreeInitialized, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setCreateRequiredProp, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toElementString, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropValue, verify, verifyHasPropertyItem, virtualize, warning, warning, warning

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.ICircularRetargetParent
isCircularRetargetParent

- Constructor Detail
  - AbstractClientBaseRelativeReference
```
public AbstractClientBaseRelativeReference()
```
    Creates a Label For Reference property with no name and with a null value.
  - AbstractClientBaseRelativeReference
```
public AbstractClientBaseRelativeReference(Atom propertyAtom)
```
    Creates a Label For Reference property with the specified name with a null value.
    Parameters:
    propertyAtom - the property atom.
  - AbstractClientBaseRelativeReference
```
public AbstractClientBaseRelativeReference(Atom propertyAtom,
                                           java.lang.String newValue)
```
    Creates a Label For Reference property with the specified name and value.
    Parameters:
    propertyAtom - the property atom.
    newValue - the new string value for the property.
- Method Detail
  - clone
```
public AbstractClientBaseRelativeReference<TARGET> clone()
```
    Clone overridden to ensure reference is created before cloning to have the "cidValue" cloned.
    Overrides:
    clone in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
  - resetComponentID
```
public void resetComponentID()
```
    Resets the component ID referenced. This method is typically used in the Designer to clear existing references when copying or moving components.
  - appendPropValue
```
protected void appendPropValue(PropMgr propertyManager,
                               SendTransaction trans,
                               java.lang.Object value)
```
    Overrides the send-transaction to client in order to send the unique label ID in the panel.
    Overrides:
    appendPropValue in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
    Parameters:
    propertyManager - the property manager instance.
    trans - transaction to append the properties to.
    value - the value to append to the transaction, a reference to the current property value.
  - initializeValue
```
public boolean initializeValue(PropMgr propertyManager,
                               ReadTransaction trans)
```
    Fakes processing of initializing the value from the remote part by skipping it in the transaction. This value is local in the Editor/Server.
    Overrides:
    initializeValue in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
    Parameters:
    propertyManager - the property manager.
    trans - the transaction to initialize the property with.
    Returns:
    true if the value has changed, false otherwise.
  - getScopeErrorMessage
```
protected java.lang.String getScopeErrorMessage()
```
    Gets the error message when the base container doesn't validate scope. Override to produce a better error message for the specialized reference implementation.
    Overrides:
    getScopeErrorMessage in class AbstractBaseRelativeReference<TARGET extends IClientBaseRelativeTarget>
    Returns:
    "Target reference is not a child of the panel".
  - onEventSelf
```
public void onEventSelf(GEvent event)
```
    Overridden to check for cache clearing...
    Specified by:
    onEventSelf in interface IGProp<TARGET extends IClientBaseRelativeTarget>
    Overrides:
    onEventSelf in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
    Parameters:
    event - The property event.
  - informResolved
```
protected void informResolved()
```
    Called when the property has been resolved. Subclasses override this method to implement some behavior. The default implementation performs nothing, i.e. there is no need to call super.informResolved().
    Overrides:
    informResolved in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
  - informError
```
protected void informError()
```
    Called when the property has an error. Subclasses override this method to implement some behavior. The default implementation performs nothing, i.e. there is no need to call super.informError().
    Overrides:
    informError in class AbstractReference<TARGET extends IClientBaseRelativeTarget>
  - isPropReferenceTreeValid
```
public final boolean isPropReferenceTreeValid()
```
    Verifies if the tree is valid for reference creation. This method is typically overridden in a root property that has a Property Manager owner that in turn is checked for a particular configuration (e.g. Client-related references such as LabelForReference that does not create references when communicating).
    Specified by:
    isPropReferenceTreeValid in interface IGProp<TARGET extends IClientBaseRelativeTarget>
    Overrides:
    isPropReferenceTreeValid in class GProp<ReferenceString>
    Returns:
    true if the root property manager is found, false otherwise.

Class AbstractClientBaseRelativeReference<TARGET extends IClientBaseRelativeTarget>

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference

Field Summary

Fields inherited from class com.iizix.prop.AbstractReference

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.AbstractBaseRelativeReference

Methods inherited from class com.iizix.prop.AbstractReference

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.ICircularRetargetParent

Constructor Detail

AbstractClientBaseRelativeReference

AbstractClientBaseRelativeReference

AbstractClientBaseRelativeReference

Method Detail

clone

resetComponentID

appendPropValue

initializeValue

getScopeErrorMessage

onEventSelf

informResolved

informError

isPropReferenceTreeValid