Package com.iizigo.prop

Class FolderPropCnr

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.FolderURIPropCnr

com.iizigo.prop.FolderPropCnr

All Implemented Interfaces:

IPropDesigner, ISynchronizeEclipseMarkers, EventListener, IGProp<GProp<?>[]>, IPropCnr, ISelectorExpression, ISynchronizeMarkers, java.lang.Cloneable, org.eclipse.core.runtime.IAdaptable

Direct Known Subclasses:

ModuleFolderPropCnr

public class FolderPropCnr
extends FolderURIPropCnr
implements IPropDesigner, ISynchronizeEclipseMarkers

A PropCnr that can refer to an IFolder object can be loaded and saved as well as checked for modification from last time.

Author:

Christopher Mindus

Field Summary

Fields inherited from class com.iizix.prop.FolderURIPropCnr

FILE_NAME

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
FolderPropCnr()	Creates a FolderPropCnr for the designer with the specified name with a null value.
FolderPropCnr(Atom propertyAtom, org.eclipse.core.resources.IFolder folder)	Creates a FolderPropCnr for the designer with the specified name with a null value.
FolderPropCnr(Atom propertyAtom, org.eclipse.core.resources.IFolder folder, boolean checkPresence)	Creates a FolderPropCnr for the designer with the specified name with a null value.

Method Summary

Modifier and Type	Method	Description
FolderPropCnr	clone()	Clone must be overridden.
ResourceDesignerProp	getDesigner()	Gets the Designer Extension for Properties.
org.eclipse.core.resources.IFolder	getIFolder()	Gets the folder.
EditorFolderSettingsProp	getSettings()	Gets the settings container for the folder.
java.net.URI	getURI()	Gets the file name URI for this property.
boolean	isAssetsFolder()	Checks if this folder is located in the Assets directory.
boolean	isFolderEmpty()	Checks if this folder is empty, i.e.
boolean	isPropFile()	Checks if this is a File property container.
boolean	isPropFolder()	Checks if this is a Folder property container.
void	onEventSelf(GEvent event)	Called when a property event is send to this property.
void	queuePanelsVerification()	Queues verification of all panels in this folder and its subfolders.
boolean	verify(PropVerification verification)	Verifies this property container.

Methods inherited from class com.iizix.prop.FolderURIPropCnr

getDescription, getThemesMask, hasSelector, isSelected

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, 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, 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.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, 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, 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.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, 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, 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, validateClassInstances

Methods inherited from interface com.iizigo.prop.IPropDesigner

findIResource, getAdapter

Methods inherited from interface com.iizigo.prop.ISynchronizeEclipseMarkers

synchronizeEclipseMarkers

Constructor Detail

FolderPropCnr

public FolderPropCnr()

Creates a FolderPropCnr for the designer with the specified name with a null value.

FolderPropCnr

public FolderPropCnr(Atom propertyAtom,
                     org.eclipse.core.resources.IFolder folder)

Creates a FolderPropCnr for the designer with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

folder - the folder.

FolderPropCnr

public FolderPropCnr(Atom propertyAtom,
                     org.eclipse.core.resources.IFolder folder,
                     boolean checkPresence)

Creates a FolderPropCnr for the designer with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

folder - the folder.

checkPresence - flag indicating the folder is checked for presence.

Method Detail

getIFolder

public org.eclipse.core.resources.IFolder getIFolder()

Gets the folder.

Returns:

The folder resource or null if not found.

isAssetsFolder

public boolean isAssetsFolder()

Checks if this folder is located in the Assets directory. This is only handled in the Editor.

getURI

public java.net.URI getURI()

Gets the file name URI for this property.

Overrides:

getURI in class FolderURIPropCnr

getDesigner

public ResourceDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Specified by:

getDesigner in interface IPropDesigner

Returns:

The instance of the Designer Extension.

clone

public FolderPropCnr clone()
                    throws java.lang.CloneNotSupportedException

Clone must be overridden.

Overrides:

clone in class FolderURIPropCnr

Throws:

java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.

isPropFolder

public final boolean isPropFolder()

Checks if this is a Folder property container. It is overridden by FolderPropCnr.

Specified by:

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

Overrides:

isPropFolder in class FolderURIPropCnr

Returns:

true for FolderPropCnr, false otherwise.

isPropFile

public final boolean isPropFile()

Checks if this is a File property container. It is overridden by FilePropCnr.

Specified by:

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

Overrides:

isPropFile in class FolderURIPropCnr

Returns:

true for FilePropCnr, false otherwise.

isFolderEmpty

public boolean isFolderEmpty()

Checks if this folder is empty, i.e. has no files or folders inside.

Returns:

true if folder is empty, false otherwise.

getSettings

public EditorFolderSettingsProp getSettings()

Gets the settings container for the folder.

Overrides:

getSettings in class FolderURIPropCnr

Returns:

null for none, otherwise the settings instance.

queuePanelsVerification

public void queuePanelsVerification()

Queues verification of all panels in this folder and its subfolders.

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:

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

Overrides:

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

Parameters:

event - The property event.

verify

public boolean verify(PropVerification verification)

Verifies this property container. The check performed is the extension of classes and that no circular reference is present. It is recommended to override the method rather than the verify method.

Specified by:

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

Overrides:

verify in class PropCnr

Parameters:

verification - The property verification class.

Returns:

true if verification should proceed, false if disposed of and verification should not take place.