<html> <head> <title>Interface XXMLDocumentWrapper</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="XXMLDocumentWrapper-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">wrapper</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 XXMLDocumentWrapper</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>* Interface of XML Document Wrapper. * </dd> <dd><p> * When converting SAX events into a DOM tree, this interface is * used to manipulate the DOM data in UNO perspective. * <p> * Every lauguage has its own methods to manipulate its native DOM * data structure, this interface provides a common method set which * each lauguage have to implement. * <p> * In another word, this interface wraps language dependant methods, * then other component can manipulate DOM data through UNO methods. </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="#getCurrentElement">getCurrentElement</a></td> <td class="imsum_right">* Gets the current element. * * </td> </tr> <tr> <td class="imsum_left"><a href="#setCurrentElement">setCurrentElement</a></td> <td class="imsum_right">* Sets the current element. * </td> </tr> <tr> <td class="imsum_left"><a href="#removeCurrentElement">removeCurrentElement</a></td> <td class="imsum_right">* Removes the current element. * </td> </tr> <tr> <td class="imsum_left"><a href="#isCurrent">isCurrent</a></td> <td class="imsum_right">* Checks whether an element is the current element. * * </td> </tr> <tr> <td class="imsum_left"><a href="#isCurrentElementEmpty">isCurrentElementEmpty</a></td> <td class="imsum_right">* Checks whether the current element is empty. * * </td> </tr> <tr> <td class="imsum_left"><a href="#getNodeName">getNodeName</a></td> <td class="imsum_right">* Gets the name of the element. * * </td> </tr> <tr> <td class="imsum_left"><a href="#clearUselessData">clearUselessData</a></td> <td class="imsum_right">* Clears all useless element in a branch of the DOM tree along the * tree order. * * </td> </tr> <tr> <td class="imsum_left"><a href="#collapse">collapse</a></td> <td class="imsum_right">* Collapses a tree path * </td> </tr> <tr> <td class="imsum_left"><a href="#generateSAXEvents">generateSAXEvents</a></td> <td class="imsum_right">* Converts a part of the DOM tree into SAX events. * * </td> </tr> <tr> <td class="imsum_left"><a href="#getTree">getTree</a></td> <td class="imsum_right">* Converts the whole DOM tree into a SAX event stream. * * </td> </tr> <tr> <td class="imsum_left"><a href="#rebuildIDLink">rebuildIDLink</a></td> <td class="imsum_right">* Rebuild the ID attribute in the branch starting from the particular * element. * * </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="getCurrentElement" class="membertitle">getCurrentElement</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"><a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> </tr> <tr> <td valign="top"><b>getCurrentElement</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Gets the current element. * * </dd> <dt><b>Returns</b></dt> <dd>the current element in the SAX event stream </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setCurrentElement" class="membertitle">setCurrentElement</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>setCurrentElement</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> element );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Sets the current element. * </dd> <dd><p> * When the current element is replaced outside of this interface, then * uses this method can update the current element pointer. * * </dd> <dt><b>Parameter element</b></dt> <dd>the new current element </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeCurrentElement" class="membertitle">removeCurrentElement</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>removeCurrentElement</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Removes the current element. * </dd> <dd><p> * When the current element is removed, then its parent element becomes * the new current element. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isCurrent" class="membertitle">isCurrent</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>isCurrent</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> node );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Checks whether an element is the current element. * * </dd> <dt><b>Parameter node</b></dt> <dd>the element to be checked * </dd> <dt><b>Returns</b></dt> <dd><code>true</code> if the node is the current element, * <code>false</code> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isCurrentElementEmpty" class="membertitle">isCurrentElementEmpty</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>isCurrentElementEmpty</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Checks whether the current element is empty. * * </dd> <dt><b>Returns</b></dt> <dd><code>true</code> if the current element is empty, * <code>false</code> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getNodeName" class="membertitle">getNodeName</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>getNodeName</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> node );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Gets the name of the element. * * </dd> <dt><b>Parameter node</b></dt> <dd>the element whose name will be gotten * </dd> <dt><b>Returns</b></dt> <dd>the name of the element </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearUselessData" class="membertitle">clearUselessData</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>clearUselessData</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> node,</td> </tr> <tr> <td/><td valign="top">[in] sequence< <a href="XXMLElementWrapper.html">XXMLElementWrapper</a> ></td> <td valign="bottom"> reservedDescendants,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> stopAtNode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Clears all useless element in a branch of the DOM tree along the * tree order. * * </dd> <dt><b>Parameter node</b></dt> <dd>the start point of the branch to clear * </dd> <dt><b>Parameter reservedDescendants</b></dt> <dd>an array including all elements that * need to be reserved (along their * ancestor path) * </dd> <dt><b>Parameter stopAtNode</b></dt> <dd>the stop element. The operation have * to interrupt when this element is met * during clearing </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="collapse" class="membertitle">collapse</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>collapse</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> node );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Collapses a tree path * </dd> <dd><p> * Each element in the ancestor path of the node will be checked, * if this element is empty, then deletes it. * * </dd> <dt><b>Parameter node</b></dt> <dd>the start point of the path from where the tree * path will be collapsed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="generateSAXEvents" class="membertitle">generateSAXEvents</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>generateSAXEvents</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"> handler,</td> </tr> <tr> <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"> saxEventKeeperHandler,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> startNode,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> endNode )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::xml::<a href="../sax/module-ix.html">sax</a>::<a href="../sax/SAXException.html">SAXException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Converts a part of the DOM tree into SAX events. * * </dd> <dt><b>Parameter handler</b></dt> <dd>the document handler which will receive * generated SAX events * </dd> <dt><b>Parameter saxEventKeeperHandler</b></dt> <dd>the SAXEventKeeper connecting with * this XMLDocumentHandler * </dd> <dt><b>Parameter startNode</b></dt> <dd>the start point to generate SAX events * </dd> <dt><b>Parameter endNode</b></dt> <dd>the end point where to stop generating </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTree" class="membertitle">getTree</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>getTree</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"> handler )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::xml::<a href="../sax/module-ix.html">sax</a>::<a href="../sax/SAXException.html">SAXException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Converts the whole DOM tree into a SAX event stream. * * </dd> <dt><b>Parameter handler</b></dt> <dd>the document handelr which will receive the SAX event * stream </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="rebuildIDLink" class="membertitle">rebuildIDLink</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>rebuildIDLink</b>(</td> <td valign="top">[in] <a href="XXMLElementWrapper.html">XXMLElementWrapper</a></td> <td valign="bottom"> node );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>* Rebuild the ID attribute in the branch starting from the particular * element. * * </dd> <dt><b>Parameter node</b></dt> <dd>the root element of the branch whose ID link will be * built </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
8473
