Package com.iizigo.image.prop

Class EditorStyledImageDefinition

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.image.AbstractImageDefinition

com.iizix.prop.image.StyledImageDefinition

com.iizigo.image.prop.EditorStyledImageDefinition

All Implemented Interfaces:

IEditorImage, ILastVerified, IStyledImageBase, IExtendsSelection, IPropDesigner, IPropUndoContext, EventListener, IAssetReferenceListener, IGProp<GProp<?>[]>, IImageSize, IImageTarget, IPropCnr, java.lang.Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorStyledImageDefinition
extends StyledImageDefinition
implements IPropDesigner, IPropUndoContext, IExtendsSelection, ILastVerified, IEditorImage, IStyledImageBase

This Styled Image Definition part property container for the Editor.

Field Summary

Fields inherited from class com.iizix.prop.image.AbstractImageDefinition

ID_MASK_CAPTURE, ID_MASK_DISABLED, ID_MASK_FOCUSED, ID_MASK_HOVERING, ID_MASK_PRESSED, ID_MASK_RTL, ID_MASK_SELECTED, ID_NORMAL, MAX_TYPE_VALUE

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
EditorStyledImageDefinition()	Creates the Styled Image Definition property container without a name.
EditorStyledImageDefinition(Atom propertyAtom)	Creates the Styled Image Definition property container with the specified name.

Method Summary

Modifier and Type	Method	Description
EditorStyledImageDefinition	clone()	Clone must be overridden.
org.eclipse.swt.widgets.Composite	createTooltip(org.eclipse.swt.widgets.Composite parent)	Creates the tooltip.
org.eclipse.swt.graphics.Image	getCNImage()	Gets the image for the Common Navigator.
java.lang.String	getCNText(int column)	Gets the label text for the Common Navigator.
java.lang.String	getCNType()	Gets the type for the Common Navigator.
ImageDesignerProp	getDesigner()	Gets the Designer Extension for Properties.
java.lang.Class<?>[]	getExtendsPossibleClasses()	Gets the possible classes this container supports for the Extends Framework.
LastVerified	getLastVerified()	Gets the last verified instance.
java.lang.Class<?>[]	getPossibleChildren()	Gets the acceptable children property classes that can be used in conjunction with e.g.
java.lang.String	getSelectPropDialogTitle()	Gets the title for selection dialog.
org.eclipse.jface.viewers.ViewerFilter	getSelectPropViewerFilter()	Gets the viewer filter for the tree in the dialog for selecting extends property name.
org.eclipse.core.commands.operations.IUndoContext	getUndoContext()	Gets the undo context.
void	onAssetReferenceChanged(AssetReference ref)	Called when an asset file has been changed, either using new reference or the file contents.
boolean	verify(PropVerification verification)	Verifies this property container.

Methods inherited from class com.iizix.prop.image.StyledImageDefinition

getAssetReference, getClientImageData, getImageSize, getMultipleImageSize, isImageTargetValid, onEventSelf

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, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, 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, 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, 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, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, 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, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, 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.image.prop.IStyledImageBase

getAssetReference, getImageSize

Constructor Detail

EditorStyledImageDefinition

public EditorStyledImageDefinition()

Creates the Styled Image Definition property container without a name. The name must be set in all cases using the setPropertyAtom call.

EditorStyledImageDefinition

public EditorStyledImageDefinition(Atom propertyAtom)

Creates the Styled Image Definition property container with the specified name. All system-reserved names for components begins with "$".

Parameters:

propertyAtom - the name of the component, unique within it's parent.

Method Detail

getLastVerified

public LastVerified getLastVerified()

Gets the last verified instance.

Specified by:

getLastVerified in interface ILastVerified

getDesigner

public ImageDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Specified by:

getDesigner in interface IPropDesigner

Returns:

The instance of the Designer Extension.

getUndoContext

public org.eclipse.core.commands.operations.IUndoContext getUndoContext()

Gets the undo context.

Specified by:

getUndoContext in interface IPropUndoContext

Returns:

The undo context for the Editor part(s) for this container.

clone

public EditorStyledImageDefinition clone()
                                  throws java.lang.CloneNotSupportedException

Clone must be overridden.

Overrides:

clone in class PropCnr

Throws:

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

getPossibleChildren

public java.lang.Class<?>[] getPossibleChildren()

Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.

Specified by:

getPossibleChildren in interface IPropCnr

Overrides:

getPossibleChildren in class PropCnr

Returns:

An array containing the classes of possible children, or null for no support.

getCNImage

public org.eclipse.swt.graphics.Image getCNImage()

Gets the image for the Common Navigator.

Specified by:

getCNImage in interface IEditorImage

getCNType

public java.lang.String getCNType()

Gets the type for the Common Navigator.

Specified by:

getCNType in interface IEditorImage

getCNText

public java.lang.String getCNText(int column)

Gets the label text for the Common Navigator.

Specified by:

getCNText in interface IEditorImage

createTooltip

public org.eclipse.swt.widgets.Composite createTooltip(org.eclipse.swt.widgets.Composite parent)

Creates the tooltip.

Specified by:

createTooltip in interface IEditorImage

getExtendsPossibleClasses

public java.lang.Class<?>[] getExtendsPossibleClasses()

Gets the possible classes this container supports for the Extends Framework. The default implementation is to return null.

Specified by:

getExtendsPossibleClasses in interface IPropCnr

Overrides:

getExtendsPossibleClasses in class PropCnr

Returns:

List of supported classes, or null for none.

getSelectPropDialogTitle

public java.lang.String getSelectPropDialogTitle()

Gets the title for selection dialog.

Specified by:

getSelectPropDialogTitle in interface IExtendsSelection

getSelectPropViewerFilter

public org.eclipse.jface.viewers.ViewerFilter getSelectPropViewerFilter()

Gets the viewer filter for the tree in the dialog for selecting extends property name.

Specified by:

getSelectPropViewerFilter in interface IExtendsSelection

onAssetReferenceChanged

public void onAssetReferenceChanged(AssetReference ref)

Called when an asset file has been changed, either using new reference or the file contents. This enables verification of e.g. image size.

Specified by:

onAssetReferenceChanged in interface IAssetReferenceListener

Overrides:

onAssetReferenceChanged in class StyledImageDefinition

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.

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.