Package com.iizix.text

Class KStringPLAINTextTableTag

java.lang.Object
com.iizix.text.KStringTag<KStringProp>
com.iizix.text.KStringPLAINTag<KStringProp>
com.iizix.text.KStringPLAINTextTableTag
All Implemented Interfaces:
IKStringTextTag, Cloneable
public class KStringPLAINTextTableTag extends KStringPLAINTag<KStringProp> implements IKStringTextTag
Class for the text table tag for KString that is of type PLAIN.
Author:
Christopher Mindus

  • Constructor Details Link icon

    • KStringPLAINTextTableTag Link icon

      public KStringPLAINTextTableTag(String ref, String inputString, int position, LinkedHashMap<String,String> attributes) throws KStringParseException
      Creates a text table tag for KString that is of type PLAIN.
      Parameters:
      ref - The reference value.
      inputString - The input string.
      position - The position in the character based and parsed string.
      attributes - The attributes for the tag.
      Throws:
      KStringParseException

  • Method Details Link icon

    • getReferenceClass Link icon

      public 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<KStringProp>
      Returns:
      KStringProp.class.

    • getPLAINString Link icon

      public String getPLAINString(StringBuilder useme, IKStringInfoProvider provider)
      Gets the string representation of this tag in the PLAIN format.
      Specified by:
      getPLAINString in class KStringTag<KStringProp>
      Parameters:
      useme - Temporary StringBuilder for any use.
      provider - The information provider or null for none.
      Returns:
      The Plain string resolved, or with error.

    • getHTMLString Link icon

      public String getHTMLString(StringBuilder useme, IKStringInfoProvider provider)
      Gets the string representation of this tag in the HTML format, i.e. return the text table item escaped for HTML.
      Specified by:
      getHTMLString in class KStringTag<KStringProp>
      Parameters:
      useme - Temporary StringBuilder for any use.
      provider - The information provider or null for none.

    • isRefreshRequired Link icon

      public boolean isRefreshRequired(RefreshEvent event)
      Returns whether the tags needs a refresh for the specified refresh type.
      Overrides:
      isRefreshRequired in class KStringTag<KStringProp>
      Parameters:
      event - The refresh event.
      Returns:
      true for refresh needed, false otherwise.

    • isRefreshRequired Link icon

      public boolean isRefreshRequired(GEvent event, KStringProp ksp)
      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<KStringProp>
      Parameters:
      event - The event.
      ksp - The target property for the tag.
      Returns:
      true to refresh the KString, false not to.