com.ibm.portal.spa.parser.helper
Class DefaultStaticPageContentHandler

java.lang.Object
  com.ibm.portal.spa.parser.helper.DefaultStaticPageContentHandler

All Implemented Interfaces:

StaticPageContentHandler

public class DefaultStaticPageContentHandler
extends java.lang.Object
implements StaticPageContentHandler

Default implementation of a StaticPageContentHandler that simply ignores all events. This class is meant to be subclassed by real handlers.

Since:

6.1.0

Note:

This interface is designed to be implemented by clients.

Constructor Summary

DefaultStaticPageContentHandler()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultStaticPageContentHandler

public DefaultStaticPageContentHandler()

Method Detail

characters

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

Description copied from interface: StaticPageContentHandler

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.

Specified by:

characters in interface StaticPageContentHandler

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

public void endDocument()
                 throws java.io.IOException

Description copied from interface: StaticPageContentHandler

Signaled after the parsing is complete.

Specified by:

endDocument in interface StaticPageContentHandler

Throws:

java.io.IOException

endPortletContainer

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

Description copied from interface: StaticPageContentHandler

Signals the end of a portlet container.

Specified by:

endPortletContainer in interface StaticPageContentHandler

Parameters:

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

Throws:

java.io.IOException

endPortletWindow

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

Description copied from interface: StaticPageContentHandler

Signals the end of a portlet window.

Specified by:

endPortletWindow in interface StaticPageContentHandler

Parameters:

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

Throws:

java.io.IOException

startDocument

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

Description copied from interface: StaticPageContentHandler

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

Specified by:

startDocument in interface StaticPageContentHandler

Parameters:

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

Throws:

java.io.IOException

startPortletContainer

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

Description copied from interface: StaticPageContentHandler

Signals the start of a portlet container.

Specified by:

startPortletContainer in interface StaticPageContentHandler

Parameters:

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

attrs - optional attribute map

Throws:

java.io.IOException

startPortletWindow

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

Description copied from interface: StaticPageContentHandler

Signals the start of a portlet window.

Specified by:

startPortletWindow in interface StaticPageContentHandler

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