Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: xml :: sax ::

unpublished interface XFastAttributeList
Usage Restrictions
not published
Description
a container for the attributes of an xml element.
Attributes are seperated into known attributes and unknown attributes.

Known attributes have a local name that is known to the registered at the XFastParser which created the sax event containing this attributes. If an attribute also has a namespace, that must be registered at the XFastParser, else this attribute is also unknown even if the local name is known.

Methods' Summary
hasAttribute checks if an attribute is available.
 
getValueToken retrieves the token of an attributes value.
 
getOptionalValueToken retrieves the token of an attributes value.
 
getValue retrieves the value of an attributes.
 
getOptionalValue retrieves the value of an attributes.
 
getUnknownAttributes returns a sequence of attributes which names and or namespaces URLS can not be translated to tokens.  
getFastAttributes returns a sequence of attributes which names and or namespaces URLS are translated to tokens.  
Methods' Details
hasAttribute
boolean
hasAttribute( [in] long  Token );
Description
checks if an attribute is available.
Parameter Token
contains the integer token from the XFastTokenHandler registered at the XFastParser.
If the attribute name has a namespace that was registered with the XFastParser, Token contains the integer token of the attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic or operation.
Returns
true, if the attribute is available
getValueToken
long
getValueToken( [in] long  Token )
raises( SAXException );
Description
retrieves the token of an attributes value.
Parameter Token
contains the integer token from the XFastTokenHandler registered at the XFastParser.
If the attribute name has a namespace that was registered with the XFastParser, Token contains the integer token of the attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic or operation.
Returns
The integer token of the value from the attribute or FastToken::Invalid
Throws
SAXEXception if the attribute is not available
getOptionalValueToken
long
getOptionalValueToken( [in] long  Token,
[in] long  Default );
Description
retrieves the token of an attributes value.
Parameter Token
contains the integer token from the XFastTokenHandler registered at the XFastParser.
If the attribute name has a namespace that was registered with the XFastParser, Token contains the integer token of the attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic or operation.
Parameter Default
This value will be returned if the attribute is not available
Returns
If the attribute is available it returns the integer token of the value from the attribute or FastToken::Invalid. If not the value of Default is returned.
getValue
string
getValue( [in] long  Token )
raises( SAXException );
Description
retrieves the value of an attributes.
Parameter Token
contains the integer token from the XFastTokenHandler registered at the XFastParser.
If the attribute name has a namespace that was registered with the XFastParser, Token contains the integer token of the attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic or operation.
Returns
The string value from the attribute.
Throws
SAXEXception if the attribute is not available
getOptionalValue
string
getOptionalValue( [in] long  Token );
Description
retrieves the value of an attributes.
Parameter Token
contains the integer token from the XFastTokenHandler registered at the XFastParser.
If the attribute name has a namespace that was registered with the XFastParser, Token contains the integer token of the attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic or operation.
Returns
The string value from the attribute or an empty string if the attribute is not available.
getUnknownAttributes
sequence< ::com::sun::star::xml::Attribute >
getUnknownAttributes();
Description
returns a sequence of attributes which names and or namespaces URLS can not be translated to tokens.
getFastAttributes
sequence< ::com::sun::star::xml::FastAttribute >
getFastAttributes();
Description
returns a sequence of attributes which names and or namespaces URLS are translated to tokens.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.