Interface IKStringHTMLHyperlink

All Known Implementing Classes:
KStringHTMLHyperlinkExternalTag, KStringHTMLHyperlinkResourceTag, KStringHTMLHyperlinkUITag, KStringHTMLHyperlinkVSTag

public interface IKStringHTMLHyperlink
Interface for all HTML hyperlink tags.
Author:
Christopher Mindus
  • Method Details

    • getType

      KStringTag.Type getType()
      Gets the type of this tag.
      Returns:
      The type of this tag.
    • getSourcePosition

      int getSourcePosition()
      Gets the source position of this tag in the source string.
      Returns:
      The start position of the tag.
    • getSourceEndPosition

      int getSourceEndPosition()
      Gets the ending position of this tag in the source string.
      Returns:
      The end position of the tag.
    • getAttribute

      String getAttribute(String attributeName)
      Gets the attribute value.
      Parameters:
      attributeName - The name of the attribute.
      Returns:
      The value, or null if the attribute is not present.
    • setAttribute

      boolean setAttribute(String attributeName, String value)
      Updates an attribute value or removes it.
      Parameters:
      attributeName - The attribute name.
      value - The value to set, or null to remove the attribute.
      Returns:
      true for changed, false for no change.
    • setReference

      boolean setReference(String ref)
      Sets the reference.
      Parameters:
      ref - The reference.
      Returns:
      true For success (change), false for failure or no change.
    • setTarget

      void setTarget(String target)
      Sets the target reference, if supported.
      Parameters:
      target - The new target.
    • getHTMLString

      String getHTMLString(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.
      Parameters:
      useme - Temporary StringBuilder for any use.
      provider - The information provider or null for none.
      Returns:
      The HTML string.