Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XSAXEventKeeper
Usage Restrictions
not published
Description
* Interface of SAX Event Keeper. *

* This interface is used to manipulate element marks in a SAX event stream. *

* 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.


Methods' Summary
addElementCollector * Adds a new element collector on the next element in the SAX event * stream. * *  
removeElementCollector * Removes an element collector. * *  
addBlocker * Adds a new blocker on the next element in the SAX event stream. *  
removeBlocker * Removes a blocker * *  
isBlocking * Checks whether the SAX event stream is blocking. * *  
getElement * Gets the element of an element mark. * *  
setElement * Sets the element of an element mark. *  
setNextHandler * Sets the next document handler in the SAX chain. *  
printBufferNodeTree * Prints information about all bufferred elements. * *  
getCurrentBlockingNode * Gets the element which current blocking happens. *  
Methods' Details
addElementCollector
long
addElementCollector();

Description
* Adds a new element collector on the next element in the SAX event * stream. * *
Returns
the keeper id of the new element collector
removeElementCollector
void
removeElementCollector( [in] long  id );

Description
* Removes an element collector. * *
Parameter id
the keeper id of the element collector to be removed
addBlocker
long
addBlocker();

Description
* Adds a new blocker on the next element in the SAX event stream. *

* No SAX event starting from the next element will be forwarded until * this blocker is removed. * *

Returns
the keeper id of the new blocker
removeBlocker
void
removeBlocker( [in] long  id );

Description
* Removes a blocker * *
Parameter id
the keeper id of the blocker to be removed
isBlocking
boolean
isBlocking();

Description
* Checks whether the SAX event stream is blocking. * *
Returns
true if blocking, false otherwise
getElement
::com::sun::star::xml::wrapper::XXMLElementWrapper
getElement( [in] long  id );

Description
* Gets the element of an element mark. * *
Parameter id
the keeper id of the element mark, it can be a element * collector or a blocker
setElement
void
setElement( [in] long  id,
[in] ::com::sun::star::xml::wrapper::XXMLElementWrapper  aElement );

Description
* Sets the element of an element mark. *

* 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. * *

Parameter id
the keeper id of the element mark to be set *
Parameter aElement
the new element for this element mark.
setNextHandler
::com::sun::star::xml::sax::XDocumentHandler
setNextHandler( [in] ::com::sun::star::xml::sax::XDocumentHandler  nextHandler );

Description
* Sets the next document handler in the SAX chain. *

* This handler will receive SAX events forwarded by the SAXEventKeeper. * *

Parameter nextHandler
the next handler in the SAX chain *
Returns
the old next handler
printBufferNodeTree
string
printBufferNodeTree();

Description
* Prints information about all bufferred elements. * *
Returns
a tree-style string including all buffer informtion
getCurrentBlockingNode
::com::sun::star::xml::wrapper::XXMLElementWrapper
getCurrentBlockingNode();

Description
* Gets the element which current blocking happens. *

* This element is the working element of the first blocker in tree order. * *

Returns
the current blocking element
Top of Page

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.