com.opensymphony.module.sitemesh.html

Interface Tag

All Known Implementing Classes:

CustomTag, Parser.ReusableToken

public interface Tag

Tag returned by HTMLTagTokenizer. Allows easy access to element name and attributes. This interface supports read-only operations on the tag. To change a tag, use CustomTag.

Author:

Joe Walnes

See Also:

TokenHandler, TagTokenizer, CustomTag

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE
static int	CLOSE_MAGIC_COMMENT
static int	EMPTY
static int	OPEN
static int	OPEN_MAGIC_COMMENT

Method Summary

Modifier and Type	Method and Description
int	getAttributeCount() Number of attributes in tag.
int	getAttributeIndex(java.lang.String name, boolean caseSensitive) Determine which attribute has the specified name.
java.lang.String	getAttributeName(int index) Get name of attribute.
java.lang.String	getAttributeValue(int index) Get value of an attribute.
java.lang.String	getAttributeValue(java.lang.String name, boolean caseSensitive) Get value of an attribute.
java.lang.String	getContents() Get the complete tag in its original form, preserving original formatting.
int	getLength() The length of the tag
java.lang.String	getName() Name of tag (ie.
int	getPosition() The position of the tag
int	getType() Type of tag: <blah> - Tag.OPEN </blah> - Tag.CLOSE <blah/> - Tag.EMPTY
boolean	hasAttribute(java.lang.String name, boolean caseSensitive) Determine if an attribute is present.
void	writeTo(SitemeshBufferFragment.Builder fragment, int position) Write out the complete tag in its original form, preserving original formatting.

Field Detail

OPEN

static final int OPEN

See Also:

Constant Field Values

CLOSE

static final int CLOSE

See Also:

Constant Field Values

EMPTY

static final int EMPTY

See Also:

Constant Field Values

OPEN_MAGIC_COMMENT

static final int OPEN_MAGIC_COMMENT

See Also:

Constant Field Values

CLOSE_MAGIC_COMMENT

static final int CLOSE_MAGIC_COMMENT

See Also:

Constant Field Values

Method Detail

getContents

java.lang.String getContents()

Get the complete tag in its original form, preserving original formatting. This has a slight overhead in that it needs to construct a String. For improved performance, use writeTo() instead.

writeTo

void writeTo(SitemeshBufferFragment.Builder fragment,
             int position)

Write out the complete tag in its original form, preserving original formatting.

getName

java.lang.String getName()

Name of tag (ie. element name).

getType

int getType()

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

getAttributeCount

int getAttributeCount()

Number of attributes in tag.

getAttributeIndex

int getAttributeIndex(java.lang.String name,
                      boolean caseSensitive)

Determine which attribute has the specified name.

getAttributeName

java.lang.String getAttributeName(int index)

Get name of attribute.

getAttributeValue

java.lang.String getAttributeValue(int index)

Get value of an attribute. If this is an empty attribute (i.e. just a name, without a value), null is returned.

getAttributeValue

java.lang.String getAttributeValue(java.lang.String name,
                                   boolean caseSensitive)

Get value of an attribute. If this is an empty attribute (i.e. just a name, without a value), null is returned.

hasAttribute

boolean hasAttribute(java.lang.String name,
                     boolean caseSensitive)

Determine if an attribute is present.

getPosition

int getPosition()

The position of the tag

getLength

int getLength()

The length of the tag