com.iizix.text

Class KStringHTMLHyperlinkUITag

java.lang.Object

com.iizix.text.KStringTag<TARGET>

com.iizix.text.KStringHTMLTag<TARGET>

com.iizix.text.KStringHTMLDynamicTag<IUIFocusComp>

com.iizix.text.KStringHTMLHyperlinkUITag

All Implemented Interfaces:

IKStringHTMLHyperlink, Cloneable

public class KStringHTMLHyperlinkUITag
extends KStringHTMLDynamicTag<IUIFocusComp>
implements IKStringHTMLHyperlink

Class for the dynamic HTML hyperlink A tag that refers to a Panel when the user clicks on a hyperlink in HTML text.

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 and Description
KStringHTMLHyperlinkUITag(int position, int ordinal, LinkedHashMap<String,String> attributes, String inputString, int parsePosition) Creates a Panel hyperlink tag and resolves the name attribute.

Method Summary

Modifier and Type	Method and Description
String	getHTMLString(StringBuilder useme, IKStringInfoProvider provider) Gets the string representation of this tag in the HTML format.
String	getPLAINString(StringBuilder useme, IKStringInfoProvider provider) Gets the string representation of this tag in the PLAIN format, i.e.
String	getPLAINTagText(StringBuilder useme) Gets the "unparsed" string representation of this tag in the PLAIN format, i.e.
String	getReference() Gets the reference of this tag.
Class<?>	getReferenceClass() Returns the reference class used by this tag, e.g.
boolean	setReference(String ref) Sets the "ref" Panel reference.
void	setTarget(String target) Sets the target reference, if supported.
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, isRefreshRequired, isRefreshRequired, 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.IKStringHTMLHyperlink

getAttribute, getSourceEndPosition, getSourcePosition, getType, setAttribute

Constructor Detail

KStringHTMLHyperlinkUITag

public KStringHTMLHyperlinkUITag(int position,
                                 int ordinal,
                                 LinkedHashMap<String,String> attributes,
                                 String inputString,
                                 int parsePosition)
                          throws KStringParseException

Creates a Panel hyperlink 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

setTarget

public void setTarget(String target)

Sets the target reference, if supported.

Specified by:

setTarget in interface IKStringHTMLHyperlink

Parameters:

target - The new target.

setReference

public boolean setReference(String ref)

Sets the "ref" Panel reference.

Specified by:

setReference in interface IKStringHTMLHyperlink

Overrides:

setReference in class KStringHTMLTag<IUIFocusComp>

Parameters:

ref - The Panel reference.

Returns:

true for changed, false for no change.

getReference

public String getReference()

Gets the reference of this tag.

Specified by:

getReference in class KStringHTMLDynamicTag<IUIFocusComp>

Returns:

The reference, or null for none.

getReferenceClass

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<IUIFocusComp>

Returns:

null for now!

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 class KStringHTMLDynamicTag<IUIFocusComp>

Returns:

Always true.

getPLAINTagText

public String getPLAINTagText(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 class KStringHTMLDynamicTag<IUIFocusComp>

Parameters:

useme - Temporary StringBuilder for any use.

Returns:

Empty string always: there is no conversion possible.

getPLAINString

public String getPLAINString(StringBuilder useme,
                             IKStringInfoProvider provider)

Gets the string representation of this tag in the PLAIN format, i.e. returns empty string.

Specified by:

getPLAINString in class KStringHTMLDynamicTag<IUIFocusComp>

Parameters:

useme - Temporary StringBuilder for any use.

provider - The information provider or null for none.

Returns:

Empty string always: no contents for this tag.

getHTMLString

public 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.

Specified by:

getHTMLString in interface IKStringHTMLHyperlink

Overrides:

getHTMLString in class KStringHTMLDynamicTag<IUIFocusComp>

Parameters:

useme - Temporary StringBuilder for any use.

provider - The information provider or null for none.

Returns:

The HTML string.