TooltipProp

java.lang.Object
- com.iizix.prop.GProp<KTooltip>
- - com.iizix.prop.ui.TooltipProp

All Implemented Interfaces:

EventListener, IGProp<KTooltip>, IKStringHolder<KTooltip>, IKStringInfoProvider, IKStringValuePropHolder<KTooltip>, ITextExternalizableProp<KTooltip>, Cloneable
```
public class TooltipProp
extends GProp<KTooltip>
implements IKStringValuePropHolder<KTooltip>
```
The tooltip property is a container that holds various information for the tooltip, e.g. the KString text, the type of tooltip used for messages and how it is displayed. A tooltip can be attached to any UI component. A "message" TooltipProp can be attached to the same component, in which case that property is shown instead of the "tooltip" until canceled. The distinction between the "message" and the "tooltip" is the Atom.TOOLTIP or Atom.MESSAGE.
The tooltip behaves differently when used on a touch device such as tablet or mobile as opposed to mouse being present for a desktop device.

Author:

Christopher Mindus

Field Summary
- 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 and Description
`TooltipProp()` Constructs an unnamed property without contents.
`TooltipProp(Atom atom)` Constructs a named property without contents.
`TooltipProp(Atom atom, KTooltip tooltip)` Constructs a named property with contents.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendPropValue(PropMgr propertyManager, Transaction trans, Object value)` Appends the KString property value as an HTML string.
`TooltipProp`	`clone()` Clones the KString property.
`KTooltip`	`createNewPropValue(KString ks)` Builds a new property value from a new externalized KString.
`protected Object`	`equalValues(GProp<?> compareTo, KTooltip thisValue, KTooltip compareValue, int how)` Checks for property value equality.
`KString`	`getExternalizableKString()` Returns if KString if it is a candidate for externalizing its text to a text table.
`KString`	`getKString()` Gets the current value in as a KString.
`protected Object`	`getPropValue0(Object value, int index)` Gets the property value in another class form than the "native" one.
`Class<?>[]`	`getValueClasses()` Gets the list of possible native Java classes that can be used to set a value using `setPropertyValue`, in order of importance.
`protected void`	`initializeElement(Element element)` Called when the XML file for the property tree is serialized from properties.
`protected void`	`initializeProp(Element element)` Called to initialize the property from an `Element`.
`boolean`	`initializeValue(PropMgr propertyManager, Transaction trans)` Initializes the property value from a transaction as a KString in HTML format.
`void`	`onEventSelf(GEvent event)` Called when a property event is send to this property.
`void`	`onKStringRefactored(KStringHolder holder, GEvent triggerEvent)` Called when a KString tag changed due to refactoring.
`protected void`	`onPropDispose()` Called when disposed of.
`protected void`	`onPropValueSet(Object oldValue)` Value has been set.
`protected void`	`onReferenceEvent(ResolveReferencesEvent event)` Called to perform reference resolving.
`void`	`onRemoteEvent(RemoteEvent event)` Processes remote hyperlink events.
`void`	`resolveKStrings(boolean doReCheck, GEvent triggerEvent)` Resolves the references to KString's in all held KString's.
`boolean`	`setPropValue(KTooltip newValue)` Sets a new value for this property.
`protected Object`	`toNativeValue0(Object value, int index)` Tries conversion of possibly accepted properties values using the `setPropertyValue` method into the most preferred property value type.
`void`	`validatePropType(Object newValue)` Validates that the value to set is of KTooltip instance.
`void`	`verify(PropVerification verification)` Verifies this property.

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalsTree, 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, getParent, getParent, getProjectName, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getReferences, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, 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, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropTreeInitialized, onVirtualizationCompleted, onVirtualized, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setCreateRequiredProp, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toElementString, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropValue, verifyHasPropertyItem, virtualize, warning, warning, warning

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.text.IKStringValuePropHolder
doAddReference, getDPR, getHTTPServer, getImageTarget, getResolveReferenceProperty, getResourcePrefix, getTargetLanguageCode, installFont, installFonts, shouldResolve

Methods inherited from interface com.iizix.text.IKStringInfoProvider
getKStringInfoProviderInstance, installFonts

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, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, 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, 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, validatePropValue, verifyHasPropertyItem, warning, warning, warning

- Constructor Detail
  - TooltipProp
```
public TooltipProp()
```
    Constructs an unnamed property without contents.
  - TooltipProp
```
public TooltipProp(Atom atom)
```
    Constructs a named property without contents.
    
    Parameters:
    
    atom - The name.
  - TooltipProp
```
public TooltipProp(Atom atom,
                   KTooltip tooltip)
```
    Constructs a named property with contents.
    
    Parameters:
    
    atom - The name.
    
    tooltip - The tooltip.
- Method Detail
  - clone
```
public TooltipProp clone()
```
    Clones the KString property.
    
    Overrides:
    
    clone in class GProp<KTooltip>
    
    Returns:
    
    A new cloned instance.
  - equalValues
```
protected Object equalValues(GProp<?> compareTo,
                             KTooltip thisValue,
                             KTooltip compareValue,
                             int how)
```
    Checks for property value equality. The object is of the correct type for the respective property type. The Atoms and other properties such as Private/Extends has already been checked for equality or correctness.
    
    Overrides:
    
    equalValues in class GProp<KTooltip>
    
    Parameters:
    
    compareTo - The comparing-to property that contains the value.
    
    thisValue - This property value (for synchronization reasons).
    
    compareValue - Another property value.
    
    how - Flags EQC_* values for equal checking.
    
    Returns:
    
    The property not being equal, null for equal (both values null).
  - getValueClasses
```
public Class<?>[] getValueClasses()
```
    Gets the list of possible native Java classes that can be used to set a value using setPropertyValue, in order of importance. Note that loss of precision in data if e.g. an Float property accepts a Double. However, the setPropertyValue throws IllegalArgumentException if the range in invalid, e.g. conversion of a Integer to a Byte, and the value is not -127 to 128.
    
    Specified by:
    
    getValueClasses in interface IGProp<KTooltip>
    
    Specified by:
    
    getValueClasses in class GProp<KTooltip>
    
    Returns:
    
    The array of Java classes that can be accepted in the setPropertyValue method. The first type is the "native" or most preferred type. The array is at least one item in length and never null.
  - setPropValue
```
public boolean setPropValue(KTooltip newValue)
```
    Sets a new value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed.
    
    Parameters:
    
    newValue - the new value.
    
    Returns:
    
    boolean true for value has changed, false for same value as current value.
  - validatePropType
```
public void validatePropType(Object newValue)
                      throws PropTypeException
```
    Validates that the value to set is of KTooltip instance.
    Note: When this method is called, synchronization is done at the property itself, so no synchronization on the tree should be done.
    
    Specified by:
    
    validatePropType in interface IGProp<KTooltip>
    
    Specified by:
    
    validatePropType in class GProp<KTooltip>
    
    Parameters:
    
    newValue - The new value to set.
    
    Throws:
    
    PropTypeException - when the new value isn't of the correct class.
  - getKString
```
public KString getKString()
```
    Gets the current value in as a KString.
    
    Specified by:
    
    getKString in interface IKStringHolder<KTooltip>
    
    Returns:
    
    KString the value or null for uninitialized value.
  - onPropValueSet
```
protected void onPropValueSet(Object oldValue)
```
    Value has been set.
    
    Overrides:
    
    onPropValueSet in class GProp<KTooltip>
    
    Parameters:
    
    oldValue - The old value.
  - appendPropValue
```
protected void appendPropValue(PropMgr propertyManager,
                               Transaction trans,
                               Object value)
```
    Appends the KString property value as an HTML string. If uninitialized, an empty string is appended.
    
    Specified by:
    
    appendPropValue in class GProp<KTooltip>
    
    Parameters:
    
    propertyManager - the property manager instance.
    
    trans - transaction to append the properties to.
    
    value - the value to append to the transaction, a reference to the current property value.
  - initializeValue
```
public boolean initializeValue(PropMgr propertyManager,
                               Transaction trans)
                        throws PropException
```
    Initializes the property value from a transaction as a KString in HTML format.
    
    Specified by:
    
    initializeValue in class GProp<KTooltip>
    
    Parameters:
    
    propertyManager - the property manager.
    
    trans - the transaction to initialize the property with.
    
    Returns:
    
    true if the value has changed, false otherwise.
    
    Throws:
    
    PropException
  - initializeElement
```
protected void initializeElement(Element element)
```
    Called when the XML file for the property tree is serialized from properties. The property should fill attributes and nodes with appropriate information.
    
    Overrides:
    
    initializeElement in class GProp<KTooltip>
    
    Parameters:
    
    element - The Element to initialize.
  - initializeProp
```
protected void initializeProp(Element element)
                       throws PropException
```
    Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.
    
    Overrides:
    
    initializeProp in class GProp<KTooltip>
    
    Parameters:
    
    element - The Element.
    
    Throws:
    
    PropException - when the initialization fails.
  - 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<KTooltip>
    
    Overrides:
    
    onEventSelf in class GProp<KTooltip>
    
    Parameters:
    
    event - The property event.
  - onReferenceEvent
```
protected void onReferenceEvent(ResolveReferencesEvent event)
```
    Called to perform reference resolving. A property should override this method if it needs to perform reference resolving and validation.
    Subclasses override this method and only subclasses extending PropCnr needs to call super.onReferenceEvent(ResolveReferenceEvent event).
    
    Overrides:
    
    onReferenceEvent in class GProp<KTooltip>
    
    Parameters:
    
    event - The resolve references event.
  - resolveKStrings
```
public void resolveKStrings(boolean doReCheck,
                            GEvent triggerEvent)
```
    Resolves the references to KString's in all held KString's.
    
    Specified by:
    
    resolveKStrings in interface IKStringHolder<KTooltip>
    
    Parameters:
    
    doReCheck - Re-check flag.
    
    triggerEvent - The triggering property event.
  - onPropDispose
```
protected void onPropDispose()
```
    Called when disposed of.
    
    Overrides:
    
    onPropDispose in class GProp<KTooltip>
  - onRemoteEvent
```
public void onRemoteEvent(RemoteEvent event)
```
    Processes remote hyperlink events.
    
    Specified by:
    
    onRemoteEvent in interface IGProp<KTooltip>
    
    Overrides:
    
    onRemoteEvent in class GProp<KTooltip>
    
    Parameters:
    
    event - The remote event.
  - getExternalizableKString
```
public KString getExternalizableKString()
```
    Returns if KString if it is a candidate for externalizing its text to a text table.
    
    Specified by:
    
    getExternalizableKString in interface IKStringValuePropHolder<KTooltip>
    
    Specified by:
    
    getExternalizableKString in interface ITextExternalizableProp<KTooltip>
    
    Returns:
    
    The KString that can be externalized, or null if not.
  - createNewPropValue
```
public KTooltip createNewPropValue(KString ks)
```
    Builds a new property value from a new externalized KString.
    
    Specified by:
    
    createNewPropValue in interface ITextExternalizableProp<KTooltip>
    
    Parameters:
    
    ks - The new KString.
    
    Returns:
    
    The new property based on the current property value with it's additional settings, but with the new KString contents.
  - onKStringRefactored
```
public void onKStringRefactored(KStringHolder holder,
                                GEvent triggerEvent)
```
    Called when a KString tag changed due to refactoring. An event is send to the property itself notifying that it needs a refresh. This event is fired only in the Designer.
    
    Specified by:
    
    onKStringRefactored in interface IKStringHolder<KTooltip>
    
    Parameters:
    
    holder - The KStringHolder instance.
    
    triggerEvent - Event that triggered the refactoring.
  - getPropValue0
```
protected Object getPropValue0(Object value,
                               int index)
                        throws Exception
```
    Gets the property value in another class form than the "native" one. This method tries conversion of a "native" property value into another class type. This method is used when filling in a POJO variable (Plain Old Java Object Field) from a "native" property value.
    
    Specified by:
    
    getPropValue0 in class GProp<KTooltip>
    
    Parameters:
    
    value - The property value.
    
    index - The index in the Class array returned by getValueClasses().
    
    Returns:
    
    The property value in the requested class, after conversion.
    
    Throws:
    
    Exception - Other exceptions that could occur.
  - toNativeValue0
```
protected Object toNativeValue0(Object value,
                                int index)
                         throws Exception
```
    Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.
    
    Specified by:
    
    toNativeValue0 in class GProp<KTooltip>
    
    Parameters:
    
    value - The input value to convert to native value.
    
    index - The index in the array returned by getValueClasses(), or -1 if not found.
    
    Returns:
    
    The converted input value in the preferred property value object type.
    
    Throws:
    
    Exception - For conversion exceptions.
  - verify
```
public void verify(PropVerification verification)
```
    Verifies this property. The check performed is the extension of classes and that no circular reference is present.
    
    Specified by:
    
    verify in interface IGProp<KTooltip>
    
    Overrides:
    
    verify in class GProp<KTooltip>
    
    Parameters:
    
    verification - The property verification class.

Class TooltipProp

Field Summary

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.text.IKStringValuePropHolder

Methods inherited from interface com.iizix.text.IKStringInfoProvider

Methods inherited from interface com.iizix.prop.IGProp

Constructor Detail

TooltipProp

TooltipProp

TooltipProp

Method Detail

clone

equalValues

getValueClasses

setPropValue

validatePropType

getKString

onPropValueSet

appendPropValue

initializeValue

initializeElement

initializeProp

onEventSelf

onReferenceEvent

resolveKStrings

onPropDispose

onRemoteEvent

getExternalizableKString

createNewPropValue

onKStringRefactored

getPropValue0

toNativeValue0

verify