Class KStringPLAINVirtualSpaceTag

All Implemented Interfaces:
IKStringTextTag, Cloneable

public class KStringPLAINVirtualSpaceTag extends KStringPLAINTag<VSField> implements IKStringTextTag
Class for the VirtualSpace tag for KString that is of type PLAIN.
Author:
Christopher Mindus
  • Constructor Details Link icon

    • KStringPLAINVirtualSpaceTag Link icon

      public KStringPLAINVirtualSpaceTag(String ref, String inputString, int position, LinkedHashMap<String,String> attributes) throws KStringParseException
      Creates a VirtualSpace 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<VSField>
      Returns:
      VSField.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<VSField>
      Parameters:
      useme - Temporary StringBuilder for any use.
      provider - The information provider or null for none.
    • 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<VSField>
      Parameters:
      useme - Temporary StringBuilder for any use.
      provider - The information provider or null for none.
    • isReferenceValid Link icon

      public boolean isReferenceValid(KStringHolder holder, GProp<?> gp)
      Validates a reference.
      Overrides:
      isReferenceValid in class KStringTag<VSField>
      Parameters:
      holder - The KString holder.
      gp - The reference found.
      Returns:
      Validates the reference.
    • isRefreshRequired Link icon

      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.