com.iizix.text

Interface IKStringTextTag

All Known Implementing Classes:

KStringHTMLTextTableTag, KStringHTMLTextVirtualSpaceTag, KStringPLAINTextTableTag, KStringPLAINVirtualSpaceTag

public interface IKStringTextTag

Interface for all Text tags, for HTML and Plain Text.

Author:

Christopher Mindus

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String attributeName) Gets the attribute value.
String	getReference() Gets the reference.
int	getSourceEndPosition() Gets the ending position of this tag in the source string.
int	getSourcePosition() Gets the source position of this tag in the source string.
KStringTag.Type	getType() Gets the type of this tag.
boolean	setAttribute(String attributeName, String value) Updates an attribute value or removes it.
boolean	setReference(String ref) Updates the reference for the tag.

Method Detail

getType

KStringTag.Type getType()

Gets the type of this tag.

getSourcePosition

int getSourcePosition()

Gets the source position of this tag in the source string.

Returns:

The start position of the tag.

getSourceEndPosition

int getSourceEndPosition()

Gets the ending position of this tag in the source string.

Returns:

The end position of the tag.

getReference

String getReference()

Gets the reference.

Returns:

The reference string to the property.

setReference

boolean setReference(String ref)

Updates the reference for the tag.

Parameters:

ref - The new reference string.

Returns:

true for changed, false for no change.

getAttribute

String getAttribute(String attributeName)

Gets the attribute value.

Parameters:

attributeName - The name of the attribute.

Returns:

The value, or null if the attribute is not present.

setAttribute

boolean setAttribute(String attributeName,
                     String value)

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