Package com.iizix.text
Class KStringHTMLTextTableTag
- java.lang.Object
- com.iizix.text.KStringTag<TARGET>
- com.iizix.text.KStringHTMLTag<TARGET>
- com.iizix.text.KStringHTMLDynamicTag<KStringProp>
- com.iizix.text.KStringHTMLTextTableTag
- All Implemented Interfaces:
IKStringTextTag
,java.lang.Cloneable
public class KStringHTMLTextTableTag extends KStringHTMLDynamicTag<KStringProp> implements IKStringTextTag
Class for the dynamic HTML tag IZ that refers to the text table.- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from class com.iizix.text.KStringTag
KStringTag.Type
Field Summary
Fields inherited from class com.iizix.text.KStringHTMLTag
isClosed, ordinal
Constructor Summary
Constructors Constructor Description KStringHTMLTextTableTag(int position, int ordinal, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes, java.lang.String inputString, int parsePosition)
Creates a text table tag and resolves the name attribute.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getHTMLString(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the string representation of this tag in the HTML format, i.e.java.lang.String
getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the string representation of this tag in the PLAIN format.java.lang.String
getPLAINTagText(java.lang.StringBuilder useme)
Gets the "unparsed" string representation of this tag in the PLAIN format, i.e.java.lang.String
getReference()
Gets the reference.java.lang.Class<?>
getReferenceClass()
Returns the reference class used by this tag, e.g.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.boolean
isRefreshRequired(RefreshEvent event)
Returns whether the tags needs a refresh for the specified refresh type.boolean
setReference(java.lang.String ref)
Updates the reference for the tag.boolean
willLoseFormatting()
Checks if this string will lose formatting when translated to PLAIN.Methods inherited from class com.iizix.text.KStringHTMLDynamicTag
getHTMLTagText, isReferenceTag
Methods inherited from class com.iizix.text.KStringHTMLTag
create, disposeTagReference, equalsName, resolve
Methods inherited from class com.iizix.text.KStringTag
appendHTMLAttributes, appendHTMLAttributes, appendHTMLAttributesSkip, appendPLAINAttributes, appendPLAINValue, clone, equals, getAttribute, getReferenceDescription, getReferenceError, getSourceEndPosition, getSourceLength, getSourcePosition, getType, isReferenceValid, setAttribute, setSourceLocation, verify
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.iizix.text.IKStringTextTag
getAttribute, getSourceEndPosition, getSourcePosition, getType, setAttribute
Constructor Detail
KStringHTMLTextTableTag
public KStringHTMLTextTableTag(int position, int ordinal, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes, java.lang.String inputString, int parsePosition) throws KStringParseException
Creates a text table tag and resolves the name attribute.- 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
getReference
public java.lang.String getReference()
Gets the reference.- Specified by:
getReference
in interfaceIKStringTextTag
- Specified by:
getReference
in classKStringHTMLDynamicTag<KStringProp>
- Returns:
- The reference string to the property.
setReference
public boolean setReference(java.lang.String ref)
Updates the reference for the tag.- Specified by:
setReference
in interfaceIKStringTextTag
- Overrides:
setReference
in classKStringHTMLTag<KStringProp>
- 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 classKStringTag<KStringProp>
- Returns:
- KStringProp.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 classKStringHTMLDynamicTag<KStringProp>
- 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 classKStringHTMLDynamicTag<KStringProp>
getPLAINString
public java.lang.String getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the string representation of this tag in the PLAIN format.- Specified by:
getPLAINString
in classKStringHTMLDynamicTag<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
public java.lang.String getHTMLString(java.lang.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.- Overrides:
getHTMLString
in classKStringHTMLDynamicTag<KStringProp>
- Parameters:
useme
- Temporary StringBuilder for any use.provider
- The information provider or null for none.
isRefreshRequired
public boolean isRefreshRequired(RefreshEvent event)
Returns whether the tags needs a refresh for the specified refresh type.- Overrides:
isRefreshRequired
in classKStringTag<KStringProp>
- Parameters:
event
- The refresh event.- Returns:
- true for refresh needed, false otherwise.
isRefreshRequired
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 classKStringTag<KStringProp>
- Parameters:
event
- The event.ksp
- The target property for the tag.- Returns:
- true to refresh the KString, false not to.