WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsISAXAttributes

IID:e347005e-6cd0-11da-be43-001422106990
Inherits From:nsISupports

Interface for a list of XML attributes.

This interface allows access to a list of attributes in three different ways:

1.) by attribute index; 2.) by Namespace-qualified name; or 3.) by XML qualified name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default).

The order of attributes in the list is unspecified.

This interface is implemented by the following components:

Properties

readonly PRInt32 length

Return the number of attributes in the list. Once you know the number of attributes, you can iterate through the list.

Methods

PRInt32 getIndexFromName ( AString uri , AString localName ) PRInt32 getIndexFromQName ( AString qName ) AString getLocalName ( PRUint32 index ) AString getQName ( PRUint32 index ) AString getType ( PRUint32 index ) AString getTypeFromName ( AString uri , AString localName ) AString getTypeFromQName ( AString qName ) AString getURI ( PRUint32 index ) AString getValue ( PRUint32 index ) AString getValueFromName ( AString uri , AString localName ) AString getValueFromQName ( AString qName )

PRInt32 getIndexFromName ( AString uri , AString localName )

Look up the index of an attribute by Namespace name.

Arguments:
uri: The Namespace URI, or the empty string if the name has no Namespace URI.
localName: The attribute's local name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

PRInt32 getIndexFromQName ( AString qName )

Look up the index of an attribute by XML qualified name.

Arguments:
qName: The qualified name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

AString getLocalName ( PRUint32 index )

Look up an attribute's local name by index.

Arguments:
index: The attribute index (zero-based).
Returns:
The local name, or null if the index is out of range.

AString getQName ( PRUint32 index )

Look up an attribute's XML qualified name by index.

Arguments:
index: The attribute index (zero-based).
Returns:
The XML qualified name, or the empty string if none is available, or null if the index is out of range.

AString getType ( PRUint32 index )

Look up an attribute's type by index. The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case). If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization"). For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Arguments:
index: The attribute index (zero-based).
Returns:
The attribute's type as a string, or null if the index is out of range.

AString getTypeFromName ( AString uri , AString localName )

Look up an attribute's type by Namespace name.

Arguments:
uri: The Namespace URI, or the empty string if the name has no Namespace URI.
localName: The attribute's local name.
Returns:
The attribute type as a string, or null if the attribute is not in the list.

AString getTypeFromQName ( AString qName )

Look up an attribute's type by XML qualified name.

Arguments:
qName: The qualified name.
Returns:
The attribute type as a string, or null if the attribute is not in the list.

AString getURI ( PRUint32 index )

Look up an attribute's Namespace URI by index.

Arguments:
index: The attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.

AString getValue ( PRUint32 index )

Look up an attribute's value by index. If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Arguments:
index: The attribute index (zero-based).
Returns:
The attribute's value as a string, or null if the index is out of range.

AString getValueFromName ( AString uri , AString localName )

Look up an attribute's value by Namespace name. If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Arguments:
uri: The Namespace URI, or the empty string if the name has no Namespace URI.
localName: The attribute's local name.
Returns:
The attribute's value as a string, or null if the attribute is not in the list.

AString getValueFromQName ( AString qName )

Look up an attribute's value by XML qualified (prefixed) name. If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Arguments:
qName: The qualified (prefixed) name.
Returns:
The attribute's value as a string, or null if the attribute is not in the list.

References

This interface is the type of the following properties:

nsIFeedElementBase.attributes

This interface is passed as an argument to the following methods:

nsISAXContentHandler.startElement, nsISAXMutableAttributes.setAttributes

Reference documentation is generated from Mozilla's source.