Class TooltipProp

    • 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

      • equalValues

        protected java.lang.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 java.lang.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​(java.lang.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​(java.lang.Object oldValue)
        Value has been set.
        Overrides:
        onPropValueSet in class GProp<KTooltip>
        Parameters:
        oldValue - The old value.
      • appendPropValue

        protected void appendPropValue​(PropMgr propertyManager,
                                       SendTransaction trans,
                                       java.lang.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,
                                       ReadTransaction 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​(org.w3c.dom.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​(org.w3c.dom.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.
      • 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 java.lang.Object getPropValue0​(java.lang.Object value,
                                                 int index)
                                          throws java.lang.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:
        java.lang.Exception - Other exceptions that could occur.
      • toNativeValue0

        protected java.lang.Object toNativeValue0​(java.lang.Object value,
                                                  int index)
                                           throws java.lang.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:
        java.lang.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.