java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.prop.image.FontIconDefinition

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IFontIconStyle, IImageTarget, IPropCnr, java.lang.Cloneable

Direct Known Subclasses:

EditorFontIconDefinition
```
public class FontIconDefinition
extends PropCnr
implements IImageTarget, IFontIconStyle
```
The definition of a single font icon and how it represent itself in the various states, e.g. hover, focused, etc.

Author:

Christopher Mindus

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CONTENT_RTL`	The content for RTL alternate content.
`static java.lang.String`	`CONTENT_RTL_SELECT`	The content for RTL and Select state alternate content.
`static java.lang.String`	`CONTENT_SELECT`	The content for Select state alternate content.
`static java.lang.String`	`FLIP_HORIZONTALLY_RTL`	The content for RTL should be flipped.

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.image.IFontIconStyle
FIS_capture, FIS_disable, FIS_focus, FIS_hover, FIS_normal, FIS_press, FIS_rtl, FIS_select

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
`FontIconDefinition()`	The single font icon definition constructor.
`FontIconDefinition(Atom atom)`	The single font icon definition constructor with a name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`append(PropMgr propertyManager, SendTransaction trans)`	Appends the font icon data for the client to display in e.g.
`PropCnr`	`clone()`	Clone of image forces creation of the source client image data before cloning.
`ClientImageData`	`getClientImageData()`	Gets the Client image data.
`java.lang.String`	`getKStringFontIcon(ClientImageData cid, KStringHTMLImageTag source, IKStringInfoProvider provider)`	Appends the font icon definition to a KString tag.
`java.lang.String[]`	`getStatesCSS()`	Gets the state CSS'es for Normal, RTL, Disable, Press, Select, Focus, Hover and Capture.
`boolean`	`isHorizontallyFlippedRTL()`	Flag indicating the image should be flipped horizontally when RTL.
`boolean`	`isImageTargetValid()`	Checks if this target is valid.
`void`	`onEventSelf(GEvent event)`	Overridden to check for cache clearing...

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, verify, 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.image.IFontIconStyle
getStyleCSS

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

- Field Detail
  - FLIP_HORIZONTALLY_RTL
```
public static final java.lang.String FLIP_HORIZONTALLY_RTL
```
    The content for RTL should be flipped.
    
    See Also:
    
    Constant Field Values
  - CONTENT_RTL
```
public static final java.lang.String CONTENT_RTL
```
    The content for RTL alternate content.
    
    See Also:
    
    Constant Field Values
  - CONTENT_SELECT
```
public static final java.lang.String CONTENT_SELECT
```
    The content for Select state alternate content.
    
    See Also:
    
    Constant Field Values
  - CONTENT_RTL_SELECT
```
public static final java.lang.String CONTENT_RTL_SELECT
```
    The content for RTL and Select state alternate content.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FontIconDefinition
```
public FontIconDefinition()
```
    The single font icon definition constructor.
  - FontIconDefinition
```
public FontIconDefinition(Atom atom)
```
    The single font icon definition constructor with a name.
    
    Parameters:
    
    atom - Name of the icon.
- Method Detail
  - onEventSelf
```
public void onEventSelf(GEvent event)
```
    Overridden to check for cache clearing...
    
    Specified by:
    
    onEventSelf in interface IGProp<GProp<?>[]>
    
    Overrides:
    
    onEventSelf in class GProp<GProp<?>[]>
    
    Parameters:
    
    event - The property event.
  - clone
```
public PropCnr clone()
              throws java.lang.CloneNotSupportedException
```
    Clone of image forces creation of the source client image data before cloning.
    
    Overrides:
    
    clone in class PropCnr
    
    Throws:
    
    java.lang.CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
  - isImageTargetValid
```
public boolean isImageTargetValid()
```
    Checks if this target is valid.
    
    Specified by:
    
    isImageTargetValid in interface IImageTarget
  - isHorizontallyFlippedRTL
```
public boolean isHorizontallyFlippedRTL()
```
    Flag indicating the image should be flipped horizontally when RTL.
    
    Returns:
    
    The flip flag, default value is false, i.e. same icon for RTL or LTR.
  - getClientImageData
```
public ClientImageData getClientImageData()
```
    Gets the Client image data.
    
    Specified by:
    
    getClientImageData in interface IImageTarget
  - getStatesCSS
```
public java.lang.String[] getStatesCSS()
```
    Gets the state CSS'es for Normal, RTL, Disable, Press, Select, Focus, Hover and Capture.
    
    Returns:
    
    A cached array with the state CSS'es, where an empty setting is assigned an empty string. Do not modify the array!
  - getKStringFontIcon
```
public java.lang.String getKStringFontIcon(ClientImageData cid,
                                           KStringHTMLImageTag source,
                                           IKStringInfoProvider provider)
```
    Appends the font icon definition to a KString tag.
    
    Parameters:
    
    cid - The client image data instance.
    
    source - The source KString tag.
    
    provider - The information provider.
    
    Returns:
    
    String to use.
  - append
```
public void append(PropMgr propertyManager,
                   SendTransaction trans)
```
    Appends the font icon data for the client to display in e.g. a button, menu item, etc.

Class FontIconDefinition

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.image.IFontIconStyle

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.image.IFontIconStyle

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Field Detail

FLIP_HORIZONTALLY_RTL

CONTENT_RTL

CONTENT_SELECT

CONTENT_RTL_SELECT

Constructor Detail

FontIconDefinition

FontIconDefinition

Method Detail

onEventSelf

clone

isImageTargetValid

isHorizontallyFlippedRTL

getClientImageData

getStatesCSS

getKStringFontIcon

append