Class KStringProp

    • Constructor Detail

      • KStringProp

        protected KStringProp()
        Creates a KString property with no name and with a null value.
      • KStringProp

        public KStringProp​(Atom propertyAtom)
        Creates a KString property with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.
      • KStringProp

        public KStringProp​(Atom propertyAtom,
                           KString newValue)
        Creates a KString property with the specified name and value.
        Parameters:
        propertyAtom - the property atom.
        newValue - the new KString value for the property.
      • KStringProp

        public KStringProp​(Atom propertyAtom,
                           java.lang.String newValue)
                    throws PropValidateException
        Creates a KString property with the specified name and value.
        Parameters:
        propertyAtom - the property atom.
        newValue - the new string value for the property.
        Throws:
        PropValidateException - When the constraints are not met.
    • Method Detail

      • clone

        public KStringProp clone()
        Clones the KString property.
        Overrides:
        clone in class GProp<KString>
        Returns:
        A new cloned instance.
      • 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<KString>
        Specified by:
        getValueClasses in class GProp<KString>
        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.
      • setPLAINString

        public boolean setPLAINString​(java.lang.String newValue)
                               throws PropValidateException
        Sets a new PLAIN String value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed. Special iizi-tags may not be included.
        Parameters:
        newValue - the new value.
        Returns:
        boolean true for value has changed, false for same value as current value.
        Throws:
        PropValidateException - When the constraints are not met.
      • setPLAINString

        public boolean setPLAINString​(java.lang.String newValue,
                                      boolean usesTagProcessing)
                               throws PropValidateException,
                                      KStringException,
                                      KStringParseException
        Sets a new PLAIN String value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed.

        The parameter usesTagProcessing is used to control parsing of the string to look-up potential references to e.g. the iiziApp.

        Parameters:
        newValue - The new value.
        usesTagProcessing - Flag indicating special iizi-tags might be included.
        Returns:
        boolean true for value has changed, false for same value as current value.
        Throws:
        PropValidateException - When the constraints are not met.
        KStringException - For string errors.
        KStringParseException - For parsing errors.
      • setHTMLString

        public boolean setHTMLString​(java.lang.String newValue)
                              throws PropValidateException,
                                     KStringException,
                                     KStringParseException
        Sets a new HTML String value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed. It is assumed the string can contain dynamic tags.
        Parameters:
        newValue - The new value.
        Returns:
        boolean true for value has changed, false for same value as current value.
        Throws:
        PropValidateException - When the constraints are not met.
        KStringException - For string errors.
        KStringParseException - For parsing errors.
      • setPropValue

        public boolean setPropValue​(java.lang.String newValue)
                             throws PropValidateException
        Sets a new PLAIN String value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed. Special iizi-tags may not be included.

        This method is identical to setPLAINString(newValue).

        Parameters:
        newValue - the new value.
        Returns:
        boolean true for value has changed, false for same value as current value.
        Throws:
        PropValidateException - When the constraints are not met.
      • setPropValue

        public boolean setPropValue​(KString newValue)
                             throws PropValidateException
        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.
        Throws:
        PropValidateException - When the constraints are not met.
      • validatePropType

        public void validatePropType​(java.lang.Object newValue)
                              throws PropTypeException
        Validates that the value to set is of String 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<KString>
        Specified by:
        validatePropType in class GProp<KString>
        Parameters:
        newValue - The new value to set.
        Throws:
        PropTypeException - when the new value isn't of the correct class.
      • getString

        public java.lang.String getString()
        Gets the current value in PLAIN text format as a String.
        Returns:
        String the value or null for uninitialized value.
      • getString

        public java.lang.String getString​(java.lang.String defaultValue)
        Gets the current value in PLAIN text format as a String using defaultValue for an uninitialized value.
        Parameters:
        defaultValue - the value to return if the current value is uninitialized.
        Returns:
        String the value or defaultValue for uninitialized value.
      • getKString

        public KString getKString()
        Gets the current value in as a KString.
        Specified by:
        getKString in interface IKStringHolder<KString>
        Returns:
        KString the value or null for uninitialized 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<KString>
        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<KString>
        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<KString>
        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<KString>
        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<KString>
        Overrides:
        onEventSelf in class GProp<KString>
        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<KString>
        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<KString>
        Parameters:
        doReCheck - Re-check flag.
        triggerEvent - The triggering property event.
      • 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<KString>
        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<KString>
        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<KString>
        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.
      • isCircularRetargetParent

        public boolean isCircularRetargetParent()
        Checks if the parent is the target or not. E.g. the KStringProp retargets to the parent EXCEPT when the parent is the Text Table.
        Specified by:
        isCircularRetargetParent in interface ICircularRetargetParent
        Returns:
        true to retarget to parent property, except if the parent is TextTable, then false is returned.
      • getReferences

        public int getReferences​(java.util.List<Reference> references)
        Gets the references of this property top others. This method is typically used in the Designer to search for circular references during verification.
        Specified by:
        getReferences in interface IGProp<KString>
        Overrides:
        getReferences in class GProp<KString>
        Parameters:
        references - The references array is filled in by this method.
        Returns:
        The count of references added.
      • onPropValueSet

        protected void onPropValueSet​(java.lang.Object oldValue)
        Called when the property value has been set. This method will clear the "Validated" flag.
        Overrides:
        onPropValueSet in class GProp<KString>
        Parameters:
        oldValue - The old value.
      • isUserValidated

        public boolean isUserValidated()
        Checks if this KStringProp has been validated.
        Returns:
        true if User has validated this KStringProp, false otherwise.
      • setUserValidated

        public boolean setUserValidated​(boolean on)
        Sets the KStringProp as validated or not. If the state is changed, a PropValueEvent is notified with the same KString as the new and old values.
        Parameters:
        on - The validation state.
        Returns:
        true if this changed the validation state, false for no change of state.
      • equalValues

        protected java.lang.Object equalValues​(GProp<?> compareTo,
                                               KString thisValue,
                                               KString 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<KString>
        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).
      • createNewPropValue

        public KString createNewPropValue​(KString ks)
        Builds a new property value from a new externalized KString.
        Specified by:
        createNewPropValue in interface ITextExternalizableProp<KString>
        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.
      • lookupLanguageKStringProp

        public KStringProp lookupLanguageKStringProp​(java.lang.String languageCode)
        Attempts to look-up another KStringProp instead of this instance. This is done when the KStringProp is located in a TextTable that has derived tables, the language code is checked for the matching text table. This processing is quite time consuming is should only be used in the Designer.
        Parameters:
        languageCode - The language code to use for derived tables.
        Returns:
        The KStringProp found in the specified language code with fall-back to derived tables, or null if not found. The return value may be this instance. It may also not be in the requested language code if there was no defined text for the language ID.
      • 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<KString>
        Overrides:
        verify in class GProp<KString>
        Parameters:
        verification - The property verification class.