Class FilePropCnr
java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.FileURIPropCnr
com.iizigo.prop.FilePropCnr
- All Implemented Interfaces:
IPropDesigner, ISynchronizeEclipseMarkers, EventListener, IGProp<GProp<?>[]>, IPropCnr, ISynchronizeMarkers, Cloneable, Runnable, IAdaptable
public class FilePropCnr extends FileURIPropCnr implements IPropDesigner, Runnable, ISynchronizeEclipseMarkers
A PropCnr that can refer to an IFile object can be loaded and saved as well as checked for modification from last time. An exception can also be set for load errors.
- Author:
- Christopher Mindus
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceThe save of a file that its owner writes itself: the Module settings file, which the Module model writes.Field Summary
Fields inherited from class FileURIPropCnr
EMPTY_ARRAYFields inherited from class PropCnr
EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_IDFields inherited from class 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_PROVENANCE, PROP_ATTR_STRING_READ_ONLY, PROP_ATTR_STRING_SECRET, PROP_USER_1, PROP_USER_2Fields inherited from interface IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_INCLUDE_PRIVATE, EQC_SAVE_FILE, EQC_SAVE_RELEVANT_ONLY, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATEConstructor Summary
ConstructorsConstructorDescriptionCreates a FilePropCnr for the designer with the specified name with a null value.FilePropCnr(Atom propertyAtom, IFile file) Creates a FilePropCnr for the designer with the specified name with a null value.Method Summary
Modifier and TypeMethodDescriptionvoidattachEditor(PropEditorPart editor) Attaches an Editor to this file.clone()Clone must be overridden.voiddetachEditor(PropEditorPart editor) Detaches an Editor from this file.static FilePropCnrfromProperty(GProp<?> property) Gets a FilePropCnr from a property that should be the FilePropCnr itself or a child.Gets the active or topmost attached editor.Gets the attached editors.Gets the data property container for the file.Gets the Designer Extension for Properties.getFile()Gets the file for this property.Gets the file name (full path name) for this property.getIFile()Gets the file.longGets the file modification stamp of the resource if found.longReturns the modification time of the resource.Gets the Saveable instance for this file.longgetSize()Returns the size of the resource in bytes.getURL()Gets the file name URL for this property.booleanChecks for active editors.booleanChecks if this file is located in the Assets directory.booleanisLastDiskContent(byte[] content) Tells whether bytes are what the file held on disk when the Designer last loaded or saved it.voidonCompletedLoading(PropCnr dataContainerToBe) Called when the file completed its loading from the Module model.voidonCompletedLoadingOf(PropCnr dataContainerToBe, byte[] content) Called when the file completed its loading from the Module model, with the bytes it was loaded from:onCompletedLoading(PropCnr), and the bytes are remembered as the file's content on disk (CC-FIX-RELOAD-KEEPS-UNSAVED).voidonEventSelf(GEvent event) Called when a property event is send to this property.protected voidCalled when a property is disposed of by delete/remove in a container, or by the dispose method.protected StringparamString(boolean includeFullProperties) Returns the parameter string representing the state of this event.voidrun()Invoked to check for dirty flag.voidsaveFile(IProgressMonitor monitor) Saves the file if a Shell is not available.voidMakes this the container of a file that holds its properties in this container itself and that its owner writes: the Module settings file.Methods inherited from class FileURIPropCnr
equalsTree, equalsTree, getChildReferencePropName, getClientResourceString, getPropFromReference, getPropReferenceTarget, isPropFile, isPropFolder, setResolvedURLMethods inherited from class PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, enablePropCommunication, enablePropHashMap, 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, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializePropTree, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isPropValueTreeLockNeeded, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropRemoved, onPropTreeInitialized, onReferenceEvent, onVirtualContainerCreated, onVirtualizationCompleted, 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, virtualizeMethods inherited from class GProp
addPropError, addPropListener, appendProp, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, 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, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getReferencePropNameNoAssert, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParentNoAssert, getTreeLock, hasChanged, hasCircularReferencesError, hashCode, hasPrivateChangeEventProp, hasPropError, hasPropProvenance, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropErrorPersisted, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropForEditor, isPropForEditorAtCreation, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropSaveRelevant, isPropSecret, isPropSecretCapable, isPropUSER, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, isSibling, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onInitialize, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropProvenance, setPropReadOnly, setPropSecret, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toShortString, toShortString, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, warning, warning, warningMethods inherited from interface 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, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasCircularReferencesError, 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, isSibling, 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, verify, warning, warning, warningMethods inherited from interface 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, 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, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, 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, validateClassInstancesMethods inherited from interface IPropDesigner
findIResource, getAdapterMethods inherited from interface ISynchronizeEclipseMarkers
synchronizeEclipseMarkers
Constructor Details
FilePropCnr
public FilePropCnr()Creates a FilePropCnr for the designer with the specified name with a null value. This constructor is only used by the factory to check validity, and nothing else. Never instantiate this class.FilePropCnr
Method Details
fromProperty
Gets a FilePropCnr from a property that should be the FilePropCnr itself or a child.- Parameters:
property- The property.- Returns:
- The FilePropCnr of the property, null if not found.
getDataContainer
Gets the data property container for the file.- Returns:
- The data property container (Atom.DATA_CONTAINER), or null for none.
getSaveable
Gets the Saveable instance for this file.- Returns:
- The Saveable instance, null when file hasn't been loaded yet (thus this call is too early and this shouldn't happen, otherwise the Editor requesting the Saveable has a problem with its delayed start-up when projects are loaded or workbench started).
onCompletedLoading
Called when the file completed its loading from the Module model.- Parameters:
dataContainerToBe- The FilePropCnr data container to-be, not yet added, null for default.
onPropDispose
protected void onPropDispose()Called when a property is disposed of by delete/remove in a container, or by the dispose method.This call is done just at the end of the delete/remove routine in the container, without synchronization.
During this call, whatever components that e.g. the client needs to disposed of is done.
Subclasses needing to perform some intelligent operations upon deletion should do it by overloading this method and always call the
super.onPropDispose()method.- Overrides:
onPropDisposein classPropCnr
attachEditor
Attaches an Editor to this file.detachEditor
Detaches an Editor from this file.hasActiveEditors
public boolean hasActiveEditors()Checks for active editors.getAttachedEditors
Gets the attached editors.getActiveEditor
Gets the active or topmost attached editor.- Returns:
- The editor part, or null for none.
getURL
Gets the file name URL for this property.- Overrides:
getURLin classFileURIPropCnr- Returns:
- The URL or null for none.
getFile
Gets the file for this property.- Overrides:
getFilein classFileURIPropCnr- Returns:
- null if not found.
getModificationStamp
public long getModificationStamp()Gets the file modification stamp of the resource if found.- Returns:
- -1 if not found.
getIFile
getFileName
Gets the file name (full path name) for this property.getDesigner
Gets the Designer Extension for Properties.- Specified by:
getDesignerin interfaceIPropDesigner- Returns:
- The instance of the Designer Extension.
isAssetFile
public boolean isAssetFile()Checks if this file is located in the Assets directory. This is only handled in the Editor.- Overrides:
isAssetFilein classFileURIPropCnr- Returns:
- Always true in the Server or Client.
clone
Clone must be overridden.- Overrides:
clonein classFileURIPropCnr- Throws:
CloneNotSupportedException- If a subclass doesn't allow cloning, e.g. the client properties.
onEventSelf
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 interfaceIGProp<GProp<?>[]>- Overrides:
onEventSelfin classGProp<GProp<?>[]>- Parameters:
event- The property event.
run
saveFile
Saves the file if a Shell is not available.- Parameters:
monitor- The progress monitor.- Throws:
CoreException- For file errors.
getSize
public long getSize()Returns the size of the resource in bytes.- Overrides:
getSizein classFileURIPropCnr- Returns:
- The size, or -1 if resource is not found.
getModificationTime
public long getModificationTime()Returns the modification time of the resource.- Overrides:
getModificationTimein classFileURIPropCnr- Returns:
- The modification time, or zero if resource is not found.
paramString
Returns the parameter string representing the state of this event. This string is useful for debugging. Subclasses adds extra information to the string by preceding it with a comma followed by the extra information.- Overrides:
paramStringin classFileURIPropCnr- Parameters:
includeFullProperties- Flag to include full properties or not.- Returns:
- the parameter string of this event.
onCompletedLoadingOf
Called when the file completed its loading from the Module model, with the bytes it was loaded from:onCompletedLoading(PropCnr), and the bytes are remembered as the file's content on disk (CC-FIX-RELOAD-KEEPS-UNSAVED). These members are declared here, at the end of the class, so that no line above moved when they were added.- Parameters:
dataContainerToBe- The FilePropCnr data container to-be, not yet added, null for default.content- The bytes of the file the data container was loaded from, null when not known.
isLastDiskContent
public boolean isLastDiskContent(byte[] content) Tells whether bytes are what the file held on disk when the Designer last loaded or saved it. A change of the file on disk that brings exactly these bytes again - the file was written again with a new time, and nothing in it changed - is no change for the Designer: what it holds for the file is what it loaded or saved, and the changes made to it since that are not saved.- Parameters:
content- The bytes the file holds on disk now.- Returns:
- true if they are the bytes last loaded or saved, false if they differ, if the file never completed a load, or if the bytes of its last load are not known.
setOwnContent
Makes this the container of a file that holds its properties in this container itself and that its owner writes: the Module settings file. With it the file is a member of the unsaved set like a file of a Module folder - once its owner has told what the file holds (onCompletedLoadingOf(PropCnr, byte[])with this container), it has a Saveable that is changed while the container differs from what the file held then, Save All and the questions of a close, a rename, a delete and the exit save it through its owner, and a change of the file on disk finds its changed content kept (UnsavedFiles).- Parameters:
save- The owner's save of the file.- Throws:
NullPointerException- If the save is null.