Package com.iizix.text

Class KStringHTMLTextVirtualSpaceTag

    • Constructor Detail

      • KStringHTMLTextVirtualSpaceTag

        public KStringHTMLTextVirtualSpaceTag​(int position,
                                      int ordinal,
                                      java.util.LinkedHashMap<java.lang.String,​java.lang.String> attributes,
                                      java.lang.String inputString,
                                      int parsePosition)
                               throws KStringParseException
        Creates a VirtualSpace text tag and resolves the name attribute. The "format" attributes is also retrieved.
        Parameters:
        position - The position of the tag in the parsed string.
        attributes - The tag attributes.
        inputString - The input string to KString.
        parsePosition - The parsing position where tag starts.
        Throws:
        KStringParseException - For missing attributes.

    • Method Detail

      • setReference

        public boolean setReference​(java.lang.String ref)
        Updates the reference for the tag.
        Specified by:
        setReference in interface IKStringTextTag
        Overrides:
        setReference in class KStringHTMLTag<VSField>
        Parameters:
        ref - The new reference string.
        Returns:
        true for changed, false for no change.

      • getReferenceClass

        public java.lang.Class<?> getReferenceClass()
        Returns the reference class used by this tag, e.g. KStringProp for text table, or the image class IImageTarget.class.
        Overrides:
        getReferenceClass in class KStringTag<VSField>
        Returns:
        VSField.class.

      • willLoseFormatting

        public boolean willLoseFormatting()
        Checks if this string will lose formatting when translated to PLAIN. Note that translating PLAIN to HTML never loses formatting.
        Specified by:
        willLoseFormatting in class KStringHTMLDynamicTag<VSField>
        Returns:
        Always false.

      • getPLAINTagText

        public java.lang.String getPLAINTagText​(java.lang.StringBuilder useme)
        Gets the "unparsed" string representation of this tag in the PLAIN format, i.e. this HTML tag will reformat or translate itself for PLAIN. For the basic HTML tags, this results in an empty string.
        Specified by:
        getPLAINTagText in class KStringHTMLDynamicTag<VSField>

      • getPLAINString

        public java.lang.String getPLAINString​(java.lang.StringBuilder useme,
                                       IKStringInfoProvider provider)
        Gets the string representation of this tag in the PLAIN format, i.e. returns empty string.
        Specified by:
        getPLAINString in class KStringHTMLDynamicTag<VSField>
        Parameters:
        useme - Temporary StringBuilder for any use.
        provider - The information provider or null for none.

      • getHTMLString

        public java.lang.String getHTMLString​(java.lang.StringBuilder useme,
                                      IKStringInfoProvider provider)
        Gets the string representation of this tag in the HTML format. Method needs to be overridden for IZ that replaces the entire tag with an HTML string.
        Overrides:
        getHTMLString in class KStringHTMLDynamicTag<VSField>
        Parameters:
        useme - Temporary StringBuilder for any use.
        provider - The information provider or null for none.

      • isRefreshRequired

        public boolean isRefreshRequired​(GEvent event,
                                 VSField field)
        Upon a property event received on the target reference property (or its children), this method verifies if the event would affect the KString contents needing to be refreshed.
        Overrides:
        isRefreshRequired in class KStringTag<VSField>
        Parameters:
        event - The event.
        field - The target property for the tag.
        Returns:
        true to refresh the KString, false not to.