Class AssetReference
- java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- com.iizix.prop.AbstractReference<TARGET>
- com.iizix.prop.FixedVirtualizedAbstractReference<FileURIPropCnr>
- com.iizix.prop.AssetReference
 
 
 
 
- All Implemented Interfaces:
- EventListener,- ICircularRetargetParent,- IGProp<ReferenceString>,- IPropReference,- java.lang.Cloneable
 - public class AssetReference extends FixedVirtualizedAbstractReference<FileURIPropCnr> The Asset Reference property class hold the reference to a file in the Assets directory.- 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.FixedVirtualizedAbstractReference- fixedTarget
 - 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 - Modifier - Constructor - Description - protected- AssetReference()Creates an Asset Reference property with no name and with a null value.- AssetReference(Atom propertyAtom)Creates an Asset Reference property with the specified name with a null value.- AssetReference(Atom propertyAtom, java.lang.String newValue)Creates an Asset Reference property with the specified name and value.
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - java.lang.String- getClientResourceString()Gets the Client resource string in form "module$/path/filename.ext".- FileURIPropCnr- getFileURIPropCnr()For the Designer, gets the File property for the reference.- FileURIPropCnr- getFileURIPropCnr(GProp<?> anyPropInTree)For the Designer, gets the File property for the reference.- java.net.URL- getFileURL()Gets the file URL for this reference.- java.lang.Class<FileURIPropCnr>- getPropertyClass()Gets the class wanted.- java.lang.String- getReferenceDescription()Gets a short description of this reference.- protected void- informClearError()Called when the property has been cleared from error.- protected void- informError()Called when the property has an error.- protected void- informResolved()Called when the property has been resolved.- boolean- isReferenceValid(GProp<?> property)Validates the property reference that has been looked up.- void- onEventSelf(GEvent event)Called when a property event is send to this property.- FileURIPropCnr- setResolvedURL(java.net.URL url, long modificationTime, long size)Sets the resolved URL in the Jar file.- protected java.lang.String- validateReferenceScope(FileURIPropCnr target)Called when the a property container has been renamed or moved in order to perform validation of the reference, e.g.- Methods inherited from class com.iizix.prop.FixedVirtualizedAbstractReference- clearFixedTarget, getFixedTarget, onBroken, onReferenceDisposed, onResolved, onVirtualizationCompleted, onVirtualized
 - Methods inherited from class com.iizix.prop.AbstractReference- appendPropValue, assignError, assignNotFoundError, changeReference, checkCreateReference, clearError, clone, createUpdateReference, disposeReference, doPostResolve, equalsErrors, equalValues, getAbsoluteReference, getLookupPropReference, getPropValue0, getReference, getReferences, getReferenceString, getTargetReference, getTargetReference, getValueClasses, initializeValue, isValid, onProjectNameChanged, onPropDispose, onPropParentChanged, onRefactored, onReferenceEvent, onReferenceEvent, setLookedUpReference, setPropValue, toNativeValue0, updateReference, validatePropType, wouldValidate
 - 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, isPropReferenceTreeValid, 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, 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- AssetReference- protected AssetReference() Creates an Asset Reference property with no name and with a null value.
 - AssetReference- public AssetReference(Atom propertyAtom) Creates an Asset Reference property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
 
 - AssetReference- public AssetReference(Atom propertyAtom, java.lang.String newValue) Creates an Asset Reference property with the specified name and value.- Parameters:
- propertyAtom- the property atom.
- newValue- the new string value for the property.
 
 
 - Method Detail- onEventSelf- public void onEventSelf(GEvent event) Called when a property event is send to this property.- A subclass can override this method to perform appropriate processing and is not required to call - super.onEventSelf(e).- Specified by:
- onEventSelfin interface- IGProp<ReferenceString>
- Overrides:
- onEventSelfin class- AbstractReference<FileURIPropCnr>
- Parameters:
- event- The property event.
 
 - setResolvedURL- public FileURIPropCnr setResolvedURL(java.net.URL url, long modificationTime, long size) Sets the resolved URL in the Jar file.- Parameters:
- url- The file URL.
- modificationTime- Last modification time.
- size- Size in bytes.
- Returns:
- The FileURIPropCnr instance.
 
 - getFileURL- public java.net.URL getFileURL() Gets the file URL for this reference.- The method first attempts to use the resolved mechanism of getting the VirtualSpace. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower. - Returns:
- The URLinstance, ornullif not found.
 
 - getFileURIPropCnr- public FileURIPropCnr getFileURIPropCnr() For the Designer, gets the File property for the reference.- The method first attempts to use the resolved mechanism of getting the VirtualSpace. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower. - Returns:
- The FileURIPropCnrinstance, ornullif not found.
 
 - getFileURIPropCnr- public FileURIPropCnr getFileURIPropCnr(GProp<?> anyPropInTree) For the Designer, gets the File property for the reference.- The method first attempts to use the resolved mechanism of getting the VirtualSpace. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower. - Parameters:
- anyPropInTree- Any property in tree if this instance is not attached.
- Returns:
- The FileURIPropCnrinstance, ornullif not found.
 
 - informResolved- protected void informResolved() Called when the property has been resolved.- Overrides:
- informResolvedin class- FixedVirtualizedAbstractReference<FileURIPropCnr>
 
 - informError- protected void informError() Called when the property has an error.- Overrides:
- informErrorin class- FixedVirtualizedAbstractReference<FileURIPropCnr>
 
 - informClearError- protected void informClearError() Called when the property has been cleared from error.- Overrides:
- informClearErrorin class- FixedVirtualizedAbstractReference<FileURIPropCnr>
 
 - getReferenceDescription- public java.lang.String getReferenceDescription() Gets a short description of this reference.- Specified by:
- getReferenceDescriptionin interface- IPropReference
- Specified by:
- getReferenceDescriptionin class- AbstractReference<FileURIPropCnr>
- Returns:
- "Asset File".
 
 - getPropertyClass- public java.lang.Class<FileURIPropCnr> getPropertyClass() Gets the class wanted.- Specified by:
- getPropertyClassin class- AbstractReference<FileURIPropCnr>
- Returns:
- FileURIPropCnr.class.
 
 - isReferenceValid- public boolean isReferenceValid(GProp<?> property) Validates the property reference that has been looked up.- Specified by:
- isReferenceValidin interface- IPropReference
- Specified by:
- isReferenceValidin class- AbstractReference<FileURIPropCnr>
- Parameters:
- property- The property to validate.
- Returns:
- true if valid, false otherwise.
 
 - validateReferenceScope- protected java.lang.String validateReferenceScope(FileURIPropCnr target) Called when the a property container has been renamed or moved in order to perform validation of the reference, e.g. if a base property has been moved out of scope. The implementor can assign or clear property errors by returning the error string.- Overrides:
- validateReferenceScopein class- AbstractReference<FileURIPropCnr>
- Parameters:
- target- Target reference to validate the scope of, i.e. the referenced property.
- Returns:
- The error message, or null for valid. Default implementation returns null.
 
 - getClientResourceString- public java.lang.String getClientResourceString() Gets the Client resource string in form "module$/path/filename.ext".- Returns:
- null If not valid.