PlainKString (IIZI(R) 4.2.2.17923 Java API Specification)

java.lang.Object

com.iizix.text.KString

com.iizix.text.PlainKString

All Implemented Interfaces:: Cloneable, Comparable<KString>

public class PlainKString extends KString

A Plain version of KString allowing a string to contain tags.

Author:: Christopher Mindus

Nested Class Summary
Nested classes/interfaces inherited from class com.iizix.text.KString
KString.Type
Field Summary
Fields inherited from class com.iizix.text.KString
DEFAULT, EMPTY
Constructor Summary
Constructors
Constructor
Description
PlainKString(String inputString, boolean usesTagProcessing)
Creates the parsed KString.
Method Summary
Modifier and Type
Method
Description
PlainKString
toPlainKString()
Gets a PlainKString from this PlainKString instance, i.e.
String
toString()
Formats to a String.
Methods inherited from class com.iizix.text.KString
clone, compareTo, createKString, createKStringForEditor, dispose, equals, equalsOmitReferenceRefreshCheck, finalize, format, format, format, format, format, format, format, format, formatPLAIN, formatPLAIN, formatPLAIN, formatPLAIN, formatPLAIN, formatPLAIN, formatPLAIN, formatPLAIN, getDirectReferencedTargetSet, getHTMLString, getPLAINString, getPLAINString, getRawDebugString, getRawHTMLDebugString, getRawHTMLString, getRawHTMLStringForEditor, getRawHTMLStringForEditor, getRawPLAINDebugString, getRawPLAINString, getRawString, getSource, getTag, getTags, getType, hashCode, hasImageReferenceTags, hasReferenceTags, hasTags, hasTextTableReferenceTags, isEmpty, isEmptyBlankResolved, isHTML, isPLAIN, isRefreshRequired, newPlainKString, toDebugString, toElement, usesTagProcessing, willLoseFormatting
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- PlainKString
  public PlainKString(String inputString, boolean usesTagProcessing) throws KStringException
  Creates the parsed KString.
  The parameter usesTagProcessing is used to control parsing of the string to look-up potential references to e.g. the iiziApp. An HTML string will be parsed for security reasons in all cases.
  Parameters:
  inputString - The input string in correct format.
  usesTagProcessing - Flag indicating special IIZI tags might be included.
  Throws:
  KStringException - For string errors.
  KStringParseException - For parsing errors.
  IllegalArgumentException - If type or inputString is null.
Method Details
- toPlainKString
  public PlainKString toPlainKString()
  Gets a PlainKString from this PlainKString instance, i.e. the same instance (this) is returned.
  Overrides:
  toPlainKString in class KString
  Returns:
  A new PlainKString.
- toString
  public String toString()
  Formats to a String.
  Overrides:
  toString in class KString
  Returns:
  A string as KString[<i>type</i>,tags=<i>boolean</i>] = "<i>rawString</i>" where type is HTML or plain, tags indicates if tag support is enabled or not and rawString is the raw string representation of the KString data.