<html> <head> <title>Interface XSAXEventKeeper</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="XSAXEventKeeper-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">crypto</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 XSAXEventKeeper</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>* Interface of SAX Event Keeper. * </dd> <dd><p> * This interface is used to manipulate element marks in a SAX event stream. * <p> * There are two kinds of element mark, one is element collector, which is * used to collect a particular element from the SAX event stream; the other * is blocker, which is used to block the SAX event stream. </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="#addElementCollector">addElementCollector</a></td> <td class="imsum_right">* Adds a new element collector on the next element in the SAX event * stream. * * </td> </tr> <tr> <td class="imsum_left"><a href="#removeElementCollector">removeElementCollector</a></td> <td class="imsum_right">* Removes an element collector. * * </td> </tr> <tr> <td class="imsum_left"><a href="#addBlocker">addBlocker</a></td> <td class="imsum_right">* Adds a new blocker on the next element in the SAX event stream. * </td> </tr> <tr> <td class="imsum_left"><a href="#removeBlocker">removeBlocker</a></td> <td class="imsum_right">* Removes a blocker * * </td> </tr> <tr> <td class="imsum_left"><a href="#isBlocking">isBlocking</a></td> <td class="imsum_right">* Checks whether the SAX event stream is blocking. * * </td> </tr> <tr> <td class="imsum_left"><a href="#getElement">getElement</a></td> <td class="imsum_right">* Gets the element of an element mark. * * </td> </tr> <tr> <td class="imsum_left"><a href="#setElement">setElement</a></td> <td class="imsum_right">* Sets the element of an element mark. * </td> </tr> <tr> <td class="imsum_left"><a href="#setNextHandler">setNextHandler</a></td> <td class="imsum_right">* Sets the next document handler in the SAX chain. * </td> </tr> <tr> <td class="imsum_left"><a href="#printBufferNodeTree">printBufferNodeTree</a></td> <td class="imsum_right">* Prints information about all bufferred elements. * * </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentBlockingNode">getCurrentBlockingNode</a></td> <td class="imsum_right">* Gets the element which current blocking happens. * </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="addElementCollector" class="membertitle">addElementCollector</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>addElementCollector</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Adds a new element collector on the next element in the SAX event * stream. * * </dd> <dt><b>Returns</b></dt> <dd>the keeper id of the new element collector </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeElementCollector" class="membertitle">removeElementCollector</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">void</td> </tr> <tr> <td valign="top"><b>removeElementCollector</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Removes an element collector. * * </dd> <dt><b>Parameter id</b></dt> <dd>the keeper id of the element collector to be removed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addBlocker" class="membertitle">addBlocker</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>addBlocker</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Adds a new blocker on the next element in the SAX event stream. * </dd> <dd><p> * No SAX event starting from the next element will be forwarded until * this blocker is removed. * * </dd> <dt><b>Returns</b></dt> <dd>the keeper id of the new blocker </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeBlocker" class="membertitle">removeBlocker</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">void</td> </tr> <tr> <td valign="top"><b>removeBlocker</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Removes a blocker * * </dd> <dt><b>Parameter id</b></dt> <dd>the keeper id of the blocker to be removed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isBlocking" class="membertitle">isBlocking</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>isBlocking</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Checks whether the SAX event stream is blocking. * * </dd> <dt><b>Returns</b></dt> <dd><code>true</code> if blocking, <code>false</code> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getElement" class="membertitle">getElement</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">::com::sun::star::xml::<a href="../../wrapper/module-ix.html">wrapper</a>::<a href="../../wrapper/XXMLElementWrapper.html">XXMLElementWrapper</a></td> </tr> <tr> <td valign="top"><b>getElement</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Gets the element of an element mark. * * </dd> <dt><b>Parameter id</b></dt> <dd>the keeper id of the element mark, it can be a element * collector or a blocker </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setElement" class="membertitle">setElement</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">void</td> </tr> <tr> <td valign="top"><b>setElement</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> id,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::xml::<a href="../../wrapper/module-ix.html">wrapper</a>::<a href="../../wrapper/XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> aElement );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Sets the element of an element mark. * </dd> <dd><p> * When an element is replaced outside of this interface, then uses this method * can restore the link between an element mark and its working element. * * </dd> <dt><b>Parameter id</b></dt> <dd>the keeper id of the element mark to be set * </dd> <dt><b>Parameter aElement</b></dt> <dd>the new element for this element mark. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setNextHandler" class="membertitle">setNextHandler</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">::com::sun::star::xml::<a href="../../sax/module-ix.html">sax</a>::<a href="../../sax/XDocumentHandler.html">XDocumentHandler</a></td> </tr> <tr> <td valign="top"><b>setNextHandler</b>(</td> <td valign="top">[in] ::com::sun::star::xml::<a href="../../sax/module-ix.html">sax</a>::<a href="../../sax/XDocumentHandler.html">XDocumentHandler</a></td> <td valign="bottom"> nextHandler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Sets the next document handler in the SAX chain. * </dd> <dd><p> * This handler will receive SAX events forwarded by the SAXEventKeeper. * * </dd> <dt><b>Parameter nextHandler</b></dt> <dd>the next handler in the SAX chain * </dd> <dt><b>Returns</b></dt> <dd>the old next handler </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="printBufferNodeTree" class="membertitle">printBufferNodeTree</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>printBufferNodeTree</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Prints information about all bufferred elements. * * </dd> <dt><b>Returns</b></dt> <dd>a tree-style string including all buffer informtion </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentBlockingNode" class="membertitle">getCurrentBlockingNode</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">::com::sun::star::xml::<a href="../../wrapper/module-ix.html">wrapper</a>::<a href="../../wrapper/XXMLElementWrapper.html">XXMLElementWrapper</a></td> </tr> <tr> <td valign="top"><b>getCurrentBlockingNode</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Gets the element which current blocking happens. * </dd> <dd><p> * This element is the working element of the first blocker in tree order. * * </dd> <dt><b>Returns</b></dt> <dd>the current blocking element </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
7951
