Package com.iizix.text
Interface IKStringHTMLHyperlink
- All Known Implementing Classes:
- KStringHTMLHyperlinkExternalTag,- KStringHTMLHyperlinkResourceTag,- KStringHTMLHyperlinkUITag,- KStringHTMLHyperlinkVSTag
public interface IKStringHTMLHyperlink
Interface for all HTML hyperlink tags.
- Author:
- Christopher Mindus
- Method SummaryModifier and TypeMethodDescription- getAttribute- (String attributeName) Gets the attribute value.- getHTMLString- (StringBuilder useme, IKStringInfoProvider provider) Gets the string representation of this tag in the HTML format.- intGets the ending position of this tag in the source string.- intGets the source position of this tag in the source string.- getType()Gets the type of this tag.- boolean- setAttribute- (String attributeName, String value) Updates an attribute value or removes it.- boolean- setReference- (String ref) Sets the reference.- voidSets the target reference, if supported.
- Method Details- getTypeKStringTag.Type getType()Gets the type of this tag.- Returns:
- The type of this tag.
 
- getSourcePositionint getSourcePosition()Gets the source position of this tag in the source string.- Returns:
- The start position of the tag.
 
- getSourceEndPositionint getSourceEndPosition()Gets the ending position of this tag in the source string.- Returns:
- The end position of the tag.
 
- getAttributeGets the attribute value.- Parameters:
- attributeName- The name of the attribute.
- Returns:
- The value, or null if the attribute is not present.
 
- setAttributeUpdates 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.
 
- setReferenceSets the reference.- Parameters:
- ref- The reference.
- Returns:
- true For success (change), false for failure or no change.
 
- setTargetSets the target reference, if supported.- Parameters:
- target- The new target.
 
- getHTMLStringGets 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.