com.sapportals.wcm.util.html

Interface IHTMLElementStart

All Superinterfaces:

IHTMLElement

public interface IHTMLElementStart

extends IHTMLElement

Extends IHTMLElement to handle attributes.

This class extends IHTMLElement with the capabilities to handle element attributes which can appear in start elements.

It is possible to change the attributes of an element, to remove attributes and to add new ones. Note that namespace declarations will appear as normal attributes on an element. The name of an attribute is the Qualified Name . So it will include possible namespace prefixes.

Copyright (c) SAP AG 2001-2003

Method Summary

void	addAttribute(String name, String value) Add a new attribute with given name and value.
int	getIndexOf(String attributeName) Find the index of the attribute of given name or -1 .
String	getNameOf(int attributeIndex) Retrieve the name of the attribute with given index.
int	getNumberOfAttributes() Return the number of attributes this element has.
String	getValueOf(int attributeIndex) Retrieve the value of the attribute with given index.
boolean	isEmpty() Determines if this element is an empty element, e.g. ending with '/>'.
void	removeAttribute(int attributeIndex) Remove attribute with given index.
void	setValueOf(int attributeIndex, String value) Set the value of attribute with given index to a new value.

Methods inherited from interface com.sapportals.wcm.util.html.IHTMLElement

copyTo, getName, getNameLength, hasName, length, writeTo

Method Detail

isEmpty

public boolean isEmpty()

Determines if this element is an empty element, e.g. ending with '/>'. Note that an empty element can have attributes.

Returns:

if element is empty

getNumberOfAttributes

public int getNumberOfAttributes()

Return the number of attributes this element has.

Returns:

number of attributes

getIndexOf

public int getIndexOf(String attributeName)

Find the index of the attribute of given name or -1 .

Parameters:

attributeName - of attribute to find

Returns:

the index of attribute or -1 if not found

getNameOf

public String getNameOf(int attributeIndex)

Retrieve the name of the attribute with given index.

Parameters:

attributeIndex - of attribute

Returns:

name of attribute

getValueOf

public String getValueOf(int attributeIndex)

Retrieve the value of the attribute with given index. Note that the value of an attribute does not include surrounding quotes.

Parameters:

attributeIndex - of attribute

Returns:

value of attribute

setValueOf

public void setValueOf(int attributeIndex,
                       String value)

Set the value of attribute with given index to a new value.

Parameters:

attributeIndex - of attribute

value - new value

removeAttribute

public void removeAttribute(int attributeIndex)

Remove attribute with given index. Indexes of remaining attributes are recalculated.

Parameters:

attributeIndex - of attribute

addAttribute

public void addAttribute(String name,
                         String value)
                  throws HTMLException

Add a new attribute with given name and value.

Parameters:

name - of new attribute

value - of new attribute

Throws:

HTMLException - if attribute with same name already exists