Package com.iizigo.font.prop

Class EditorFontFiles

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.font.FontFiles

com.iizigo.font.prop.EditorFontFiles

All Implemented Interfaces:

IEditorFont, IPropDesigner, EventListener, IClientCachePreload, IClientCacheResource, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorFontFiles
extends FontFiles
implements IPropDesigner, IEditorFont

Font icon files property container for the Editor.

Field Summary

Fields inherited from class com.iizix.prop.font.FontFiles

ADDITIONAL, FONT_FACE_CSS, LOCAL, STANDARD_FONTS, STYLE_DEFAULT, STYLES, UNDEFINED, WEIGHT_BOLD, WEIGHT_DEFAULT, WEIGHTS, WEIGHTS_DESCR

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

CACHES

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	assignValue(java.lang.String value, Atom propName, java.lang.String[] array, java.lang.String descr, java.lang.String defaultValueDescr)	Helper function that assigns a value from a string to a property depending on a String array.
EditorFontFiles	clone()	Clone must be overridden.
org.eclipse.swt.widgets.Composite	createTooltip(org.eclipse.swt.widgets.Composite parent)	Creates the tooltip.
java.lang.String	getAvailableGlyphs(java.util.Collection<java.io.File> failedFontFiles)	Builds the string for available glyphs (range 32 to 0x10FFFF).
org.eclipse.swt.graphics.Image	getCNImage()	Gets the image for the Common Navigator.
java.lang.String	getCNText()	Gets the label text for the Common Navigator.
java.lang.String	getCNType()	Gets the type for the Common Navigator.
FontDesignerProp	getDesigner()	Gets the Designer Extension for Properties.
EditorFontFile[]	getFontFiles()	Gets the font icon files.
java.lang.String	getLocalFontFaceCSS(java.lang.String httpRef)	Gets the font face style declaration for the Eclipse internal browser.
java.lang.Class<?>[]	getPossibleChildren()	Gets the acceptable children property classes that can be used in conjunction with e.g.
void	onEventSelf(GEvent event)	Overridden to check for cache clearing...
boolean	verify(PropVerification verification)	Verifies this property container.

Methods inherited from class com.iizix.prop.font.FontFiles

getCacheOperation, getDescriptiveFontWeight, getFontFaceBaseDeclaration, getFontFamily, getFontFile, getFontFile, getFontIdentification, getFontStyle, getFontStyleIndex, getFontWeight, getFontWeightIndex, getLocalNames, getPreloadClientCacheResources, isCachedOnClient, isCachePreloaded, isPropPrivateAtCreation, isStandardFontFamily, usesPropIndex

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

Constructor Detail

EditorFontFiles

public EditorFontFiles()

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

EditorFontFiles

public EditorFontFiles(Atom propertyAtom)

Creates the 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

getCNImage

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

Gets the image for the Common Navigator.

Specified by:

getCNImage in interface IEditorFont

getCNType

public java.lang.String getCNType()

Gets the type for the Common Navigator.

Specified by:

getCNType in interface IEditorFont

getCNText

public java.lang.String getCNText()

Gets the label text for the Common Navigator.

Specified by:

getCNText in interface IEditorFont

getDesigner

public FontDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Specified by:

getDesigner in interface IPropDesigner

Returns:

The instance of the Designer Extension.

onEventSelf

public void onEventSelf(GEvent event)

Overridden to check for cache clearing...

Specified by:

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

Overrides:

onEventSelf in class FontFiles

Parameters:

event - The property event.

clone

public EditorFontFiles clone()

Clone must be overridden.

Overrides:

clone in class FontFiles

getFontFiles

public EditorFontFile[] getFontFiles()

Gets the font icon files.

Overrides:

getFontFiles in class FontFiles

createTooltip

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

Creates the tooltip.

Specified by:

createTooltip in interface IEditorFont

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.

assignValue

public java.lang.String assignValue(java.lang.String value,
                                    Atom propName,
                                    java.lang.String[] array,
                                    java.lang.String descr,
                                    java.lang.String defaultValueDescr)

Helper function that assigns a value from a string to a property depending on a String array.

Parameters:

value - The string value to convert to an index in the array.

propName - The name of the property to set.

descr - Description of the value to set.

defaultValueDescr - The default value description if set.

Returns:

Warning message that value is not found, null for success (OK).

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.

getLocalFontFaceCSS

public java.lang.String getLocalFontFaceCSS(java.lang.String httpRef)

Gets the font face style declaration for the Eclipse internal browser.

Parameters:

httpRef - The HTTP reference before "/$module$/path...", null for file references.

Returns:

The font face declaration, or empty string for error.

getAvailableGlyphs

public java.lang.String getAvailableGlyphs(java.util.Collection<java.io.File> failedFontFiles)

Builds the string for available glyphs (range 32 to 0x10FFFF).

Parameters:

failedFontFiles - Collection to store failed font files, null for none.

Returns:

The string with all glyphs, null for error or no True/OpenType font found.