Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 8445

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XFastAttributeList</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XFastAttributeList-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">xml</a> :: <a href="module-ix.html" class="namechain">sax</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XFastAttributeList</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>a container for the attributes of an xml element. 

 <br>Attributes are seperated into known attributes and unknown attributes.
 </dd>
<dd><p>Known attributes have a local name that is known to the </token>
 registered at the <a href="XFastParser.html">XFastParser</a> which created the sax event containing
 this attributes. If an attribute also has a namespace, that must be registered
 at the <a href="XFastParser.html">XFastParser</a>, else this attribute is also unknown even if
 the local name is known.
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#hasAttribute">hasAttribute</a></td>
<td class="imsum_right">checks if an attribute is available.<br>

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getValueToken">getValueToken</a></td>
<td class="imsum_right">retrieves the token of an attributes value.<br>

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getOptionalValueToken">getOptionalValueToken</a></td>
<td class="imsum_right">retrieves the token of an attributes value.<br>

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getValue">getValue</a></td>
<td class="imsum_right">retrieves the value of an attributes.<br>

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getOptionalValue">getOptionalValue</a></td>
<td class="imsum_right">retrieves the value of an attributes.<br>

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUnknownAttributes">getUnknownAttributes</a></td>
<td class="imsum_right">returns a sequence of attributes which names and or namespaces URLS
 can not be translated to tokens.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFastAttributes">getFastAttributes</a></td>
<td class="imsum_right">returns a sequence of attributes which names and or namespaces URLS
 are translated to tokens.
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="hasAttribute" class="membertitle">hasAttribute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>hasAttribute</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Token );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>checks if an attribute is available.<br>

 </dd>
<dt><b>Parameter Token</b></dt>
<dd>contains the integer token from the <a href="XFastTokenHandler.html">XFastTokenHandler</a>
 registered at the <a href="XFastParser.html">XFastParser</a>.<br>

 If the attribute name has a namespace that was registered with the
 <a href="XFastParser.html">XFastParser</a>, Token contains the integer token of the
 attributes local name from the <a href="XFastTokenHandler.html">XFastTokenHandler</a> and
 the integer token of the namespace combined with an arithmetic
 <b>or</b> operation.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b>, if the attribute is available
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getValueToken" class="membertitle">getValueToken</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getValueToken</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Token )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SAXException.html">SAXException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the token of an attributes value.<br>

 </dd>
<dt><b>Parameter Token</b></dt>
<dd>contains the integer token from the <a href="XFastTokenHandler.html">XFastTokenHandler</a>
 registered at the <a href="XFastParser.html">XFastParser</a>.<br>

 If the attribute name has a namespace that was registered with the
 <a href="XFastParser.html">XFastParser</a>, Token contains the integer token of the
 attributes local name from the <a href="XFastTokenHandler.html">XFastTokenHandler</a> and
 the integer token of the namespace combined with an arithmetic
 <b>or</b> operation.

 </dd>
<dt><b>Returns</b></dt>
<dd>The integer token of the value from the attribute or <b>FastToken::Invalid</b>

 @raises SAXEXception
 if the attribute is not available

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getOptionalValueToken" class="membertitle">getOptionalValueToken</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getOptionalValueToken</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Token,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Default );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the token of an attributes value.<br>

 </dd>
<dt><b>Parameter Token</b></dt>
<dd>contains the integer token from the <a href="XFastTokenHandler.html">XFastTokenHandler</a>
 registered at the <a href="XFastParser.html">XFastParser</a>.<br>

 If the attribute name has a namespace that was registered with the
 <a href="XFastParser.html">XFastParser</a>, Token contains the integer token of the
 attributes local name from the <a href="XFastTokenHandler.html">XFastTokenHandler</a> and
 the integer token of the namespace combined with an arithmetic
 <b>or</b> operation.

 </dd>
<dt><b>Parameter Default</b></dt>
<dd>This value will be returned if the attribute is not available

 </dd>
<dt><b>Returns</b></dt>
<dd>If the attribute is available it returns the integer token of the value
 from the attribute or <b>FastToken::Invalid</b>.
 If not the value of <param>Default</param> is returned.

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getValue" class="membertitle">getValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getValue</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Token )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SAXException.html">SAXException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the value of an attributes.<br>

 </dd>
<dt><b>Parameter Token</b></dt>
<dd>contains the integer token from the <a href="XFastTokenHandler.html">XFastTokenHandler</a>
 registered at the <a href="XFastParser.html">XFastParser</a>.<br>

 If the attribute name has a namespace that was registered with the
 <a href="XFastParser.html">XFastParser</a>, Token contains the integer token of the
 attributes local name from the <a href="XFastTokenHandler.html">XFastTokenHandler</a> and
 the integer token of the namespace combined with an arithmetic
 <b>or</b> operation.

 </dd>
<dt><b>Returns</b></dt>
<dd>The string value from the attribute.

 @raises SAXEXception
 if the attribute is not available

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getOptionalValue" class="membertitle">getOptionalValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getOptionalValue</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;Token );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the value of an attributes.<br>

 </dd>
<dt><b>Parameter Token</b></dt>
<dd>contains the integer token from the <a href="XFastTokenHandler.html">XFastTokenHandler</a>
 registered at the <a href="XFastParser.html">XFastParser</a>.<br>

 If the attribute name has a namespace that was registered with the
 <a href="XFastParser.html">XFastParser</a>, Token contains the integer token of the
 attributes local name from the <a href="XFastTokenHandler.html">XFastTokenHandler</a> and
 the integer token of the namespace combined with an arithmetic
 <b>or</b> operation.

 </dd>
<dt><b>Returns</b></dt>
<dd>The string value from the attribute or an empty string if the
 attribute is not available.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUnknownAttributes" class="membertitle">getUnknownAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::<a href="../module-ix.html">xml</a>::<a href="../Attribute.html">Attribute</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getUnknownAttributes</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a sequence of attributes which names and or namespaces URLS
 can not be translated to tokens.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFastAttributes" class="membertitle">getFastAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::<a href="../module-ix.html">xml</a>::<a href="../FastAttribute.html">FastAttribute</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getFastAttributes</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a sequence of attributes which names and or namespaces URLS
 are translated to tokens.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>