<html> <head> <title>Interface XDocumentHandler</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="XDocumentHandler-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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">interface XDocumentHandler</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>receives notification of general document events. </dd> <dd><p>This interface is an IDL version of the Java interface <em>org.xml.sax.DocumentHandler</em> with some smaller adaptations.</p> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Writing_the_Filtering_Component">OfficeDev - Writing the Filtering Component</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Writing_the_Filtering_Component#XDocumentHandler">OfficeDev - Writing the Filtering Component - XDocumentHandler</a></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="#startDocument">startDocument</a></td> <td class="imsum_right">receives notification of the beginning of a document. </td> </tr> <tr> <td class="imsum_left"><a href="#endDocument">endDocument</a></td> <td class="imsum_right">receives notification of the end of a document. </td> </tr> <tr> <td class="imsum_left"><a href="#startElement">startElement</a></td> <td class="imsum_right">receives notification of the beginning of an element . </td> </tr> <tr> <td class="imsum_left"><a href="#endElement">endElement</a></td> <td class="imsum_right">receives notification of the end of an element. </td> </tr> <tr> <td class="imsum_left"><a href="#characters">characters</a></td> <td class="imsum_right">receives notification of character data. </td> </tr> <tr> <td class="imsum_left"><a href="#ignorableWhitespace">ignorableWhitespace</a></td> <td class="imsum_right">receives notification of white space that can be ignored. </td> </tr> <tr> <td class="imsum_left"><a href="#processingInstruction">processingInstruction</a></td> <td class="imsum_right">receives notification of a processing instruction. </td> </tr> <tr> <td class="imsum_left"><a href="#setDocumentLocator">setDocumentLocator</a></td> <td class="imsum_right">receives an object for locating the origin of SAX document events. </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="startDocument" class="membertitle">startDocument</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>startDocument</b>()</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>receives notification of the beginning of a document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endDocument" class="membertitle">endDocument</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>endDocument</b>()</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>receives notification of the end of a document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="startElement" class="membertitle">startElement</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>startElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XAttributeList.html">XAttributeList</a></td> <td valign="bottom"> xAttribs )</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>receives notification of the beginning of an element . </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endElement" class="membertitle">endElement</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>endElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName )</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>receives notification of the end of an element. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="characters" class="membertitle">characters</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>characters</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aChars )</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>receives notification of character data. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ignorableWhitespace" class="membertitle">ignorableWhitespace</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>ignorableWhitespace</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWhitespaces )</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>receives notification of white space that can be ignored. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="processingInstruction" class="membertitle">processingInstruction</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>processingInstruction</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aTarget,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aData )</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>receives notification of a processing instruction. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDocumentLocator" class="membertitle">setDocumentLocator</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>setDocumentLocator</b>(</td> <td valign="top">[in] <a href="XLocator.html">XLocator</a></td> <td valign="bottom"> xLocator )</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>receives an object for locating the origin of SAX document events. </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>