com.ibm.portal.spa.parser
Interface StaticPageContentHandler

All Known Implementing Classes:

DefaultStaticPageContentHandler

public interface StaticPageContentHandler

Callback handler interface that is called by the parser to signal the semantical structure of the markup document. Only those tags that are important for SPA are signaled.

Since:

6.1.0

Note:

This interface is designed to be implemented by clients.

Method Summary

void	characters(char[] ch, int start, int length) Signals a character sequence that does not contain any important semantic.
void	endDocument() Signaled after the parsing is complete.
void	endPortletContainer(java.lang.String name) Signals the end of a portlet container.
void	endPortletWindow(java.lang.String name) Signals the end of a portlet window.
void	startDocument(boolean bIsPageEmbedType) Signaled before any other event is thrown.
void	startPortletContainer(java.lang.String name, org.xml.sax.Attributes attrs) Signals the start of a portlet container.
void	startPortletWindow(java.lang.String name, java.lang.String definition, org.xml.sax.Attributes attrs) Signals the start of a portlet window.

Method Detail

characters

void characters(char[] ch,
                int start,
                int length)
                throws java.io.IOException

Signals a character sequence that does not contain any important semantic. This array must not be modified by the handler and must not be referenced outside of this method. The parser is free to reuse the same buffer for multiple character sequences.

Parameters:

ch - backing character array

start - position of the first character in the array

length - length of the valid sequence.

Throws:

java.io.IOException

endDocument

void endDocument()
                 throws java.io.IOException

Signaled after the parsing is complete.

Throws:

java.io.IOException

endPortletContainer

void endPortletContainer(java.lang.String name)
                         throws java.io.IOException

Signals the end of a portlet container.

Parameters:

name - name of the container, unique across the markup document

Throws:

java.io.IOException

endPortletWindow

void endPortletWindow(java.lang.String name)
                      throws java.io.IOException

Signals the end of a portlet window.

Parameters:

name - name of the window, unique across the markup document

Throws:

java.io.IOException

startDocument

void startDocument(boolean bIsPageEmbedType)
                   throws java.io.IOException

Signaled before any other event is thrown. If the same handler instance is used multiple times each parsing process starts with this callback.

Parameters:

bIsPageEmbedType - true, if the parsed file contains html element. Otherwise return false.

Throws:

java.io.IOException

startPortletContainer

void startPortletContainer(java.lang.String name,
                           org.xml.sax.Attributes attrs)
                           throws java.io.IOException

Signals the start of a portlet container.

Parameters:

name - name of the container, unique across the markup document

attrs - optional attribute map

Throws:

java.io.IOException

startPortletWindow

void startPortletWindow(java.lang.String name,
                        java.lang.String definition,
                        org.xml.sax.Attributes attrs)
                        throws java.io.IOException

Signals the start of a portlet window.

Parameters:

name - name of the window, unique across the markup document

definition - identification of the portlet definition

attrs - optional attribute map

Throws:

java.io.IOException