info.informatica.report
Interface ReportScopeHandler

All Known Implementing Classes:

ReportDocumentHandler.CarteHandler

public interface ReportScopeHandler

This interface exports some methods from the report content handler, so they can be used by foreign handlers.

Author:

Carlos Amengual (amengual at informatica.info)

Method Summary

Element	addElement(String uri, String localName, Attributes attributes) Adds a new element for processing.
void	doReportElementEnd() Do block-end management.
void	doReportElementStart(String localName, Attributes attributes) Do block-start management for a new ReportElement with the given local name and attributes.
Element	getCurrentElement() Gets the element currently being processed by the handler, regardless of it being XHTML Element or ReportElement.
ReportElement	getCurrentReportElement() Gets the report element currently being processed by the handler.
Element	popElement() Removes the current block from stack and prepares the next one for processing, if any.
void	pushElement(Element element) Look at Block stack for signing the Block with main Report or as Nested Block.
void	setRootElement(String localName, Attributes attributes) Set the Object Model root element.

Method Detail

getCurrentElement

Element getCurrentElement()

Gets the element currently being processed by the handler, regardless of it being XHTML Element or ReportElement.

Returns:

the current Element.

getCurrentReportElement

ReportElement getCurrentReportElement()

Gets the report element currently being processed by the handler.

Returns:

the current ReportElement, or null if none.

setRootElement

void setRootElement(String localName,
                    Attributes attributes)
                    throws SAXException

Set the Object Model root element.

Parameters:

localName - the local name of the OM root element.

attributes - the attributes of the OM root element.

Throws:

SAXException - if root element was already set.

addElement

Element addElement(String uri,
                   String localName,
                   Attributes attributes)

Adds a new element for processing.

Parameters:

uri - the namespace URI.

localName - the local name.

attributes - the attributes.

Returns:

the new element.

pushElement

void pushElement(Element element)

Look at Block stack for signing the Block with main Report or as Nested Block.

Parameters:

element - the block to push to Report.

popElement

Element popElement()

Removes the current block from stack and prepares the next one for processing, if any.

Returns:

the removed element.

doReportElementStart

void doReportElementStart(String localName,
                          Attributes attributes)
                          throws SAXException

Do block-start management for a new ReportElement with the given local name and attributes.

Parameters:

localName - the local name.

attributes -

Throws:

SAXException - if the creation of the new element with the given attributes fail.

doReportElementEnd

void doReportElementEnd()
                        throws SAXException

Do block-end management.

Throws:

SAXException - if initialization of the current block fails.