Package com.iizix.text
Class KStringHTMLDynamicTag<TARGET>
- java.lang.Object
- com.iizix.text.KStringTag<TARGET>
- com.iizix.text.KStringHTMLTag<TARGET>
- com.iizix.text.KStringHTMLDynamicTag<TARGET>
- All Implemented Interfaces:
java.lang.Cloneable
- Direct Known Subclasses:
KStringHTMLHyperlinkExternalTag
,KStringHTMLHyperlinkResourceTag
,KStringHTMLHyperlinkUITag
,KStringHTMLHyperlinkVSTag
,KStringHTMLImageTag
,KStringHTMLTextTableTag
,KStringHTMLTextVirtualSpaceTag
public abstract class KStringHTMLDynamicTag<TARGET> extends KStringHTMLTag<TARGET>
Class for the dynamic HTML tags in the string, i.e. the HTML tags A, IMG and IZ corresponding to Hyperlink, Image, iiziTags (text table, VirtualSpace and Connector) respectively.- 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 KStringHTMLDynamicTag(KStringTag.Type type, int position, int ordinal, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes)
Creates a normal tag.
Method Summary
All Methods Instance Methods Abstract 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.java.lang.String
getHTMLTagText(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the "unparsed" string representation of this tag in the HTML format.abstract java.lang.String
getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the string representation of this tag in the PLAIN format, i.e.abstract java.lang.String
getPLAINTagText(java.lang.StringBuilder useme)
Gets the "unparsed" string representation of this tag in the PLAIN format, i.e.abstract java.lang.String
getReference()
Gets the reference of this tag.boolean
isReferenceTag()
Checks if this tag is of reference type, i.e.abstract boolean
willLoseFormatting()
Checks if this string will lose formatting when translated to PLAIN.Methods inherited from class com.iizix.text.KStringHTMLTag
create, disposeTagReference, equalsName, resolve, setReference
Methods inherited from class com.iizix.text.KStringTag
appendHTMLAttributes, appendHTMLAttributes, appendHTMLAttributesSkip, appendPLAINAttributes, appendPLAINValue, clone, equals, getAttribute, getReferenceClass, getReferenceDescription, getReferenceError, getSourceEndPosition, getSourceLength, getSourcePosition, getType, isReferenceValid, isRefreshRequired, isRefreshRequired, setAttribute, setSourceLocation, verify
Constructor Detail
KStringHTMLDynamicTag
public KStringHTMLDynamicTag(KStringTag.Type type, int position, int ordinal, java.util.LinkedHashMap<java.lang.String,java.lang.String> attributes)
Creates a normal tag.- Parameters:
type
- The tag type.position
- The position of the tag in the parsed string.attributes
- The tag attributes.
Method Detail
isReferenceTag
public final boolean isReferenceTag()
Checks if this tag is of reference type, i.e. for HTML, the tags A, IMG, IZ. For PLAIN KString type, this method always returns true.- Overrides:
isReferenceTag
in classKStringHTMLTag<TARGET>
getReference
public abstract java.lang.String getReference()
Gets the reference of this tag.- Overrides:
getReference
in classKStringTag<TARGET>
- Returns:
- The reference, or null for none.
willLoseFormatting
public abstract boolean willLoseFormatting()
Checks if this string will lose formatting when translated to PLAIN. Note that translating PLAIN to HTML never loses formatting.- Overrides:
willLoseFormatting
in classKStringHTMLTag<TARGET>
- Returns:
- Always true for opened tags.
getPLAINTagText
public abstract 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.- Overrides:
getPLAINTagText
in classKStringHTMLTag<TARGET>
getHTMLTagText
public final java.lang.String getHTMLTagText(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the "unparsed" string representation of this tag in the HTML format.- Overrides:
getHTMLTagText
in classKStringHTMLTag<TARGET>
- Parameters:
useme
- Temporary StringBuilder for any use.provider
- The information provider or null for none.
getPLAINString
public abstract java.lang.String getPLAINString(java.lang.StringBuilder useme, IKStringInfoProvider provider)
Gets the string representation of this tag in the PLAIN format, i.e. returns empty string.- Overrides:
getPLAINString
in classKStringHTMLTag<TARGET>
- Parameters:
useme
- Temporary StringBuilder for any use.provider
- The information provider or null for none.
getHTMLString
public java.lang.String getHTMLString(java.lang.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.- Overrides:
getHTMLString
in classKStringHTMLTag<TARGET>
- Parameters:
useme
- Temporary StringBuilder for any use.provider
- The information provider or null for none.