Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.spa.parser
Interface StaticPageContentHandler
- All Known Subinterfaces:
- StaticPageContentHandlerEx
- All Known Implementing Classes:
- DefaultStaticPageContentHandler
public interface StaticPageContentHandlerCallback 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.
Field Summary static java.lang.String ATTR_SCOPE
Name of the attribute that identifies the scope in which a container or window are rendered.static java.lang.String ATTR_SKIN
Name of the attribute that identifies the skinstatic java.lang.String IWIDGET_DEFINITION
indicator that a control is an iWidget
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.org.xml.sax.ContentHandler startPortletWindow(java.lang.String name, java.lang.String definition, org.xml.sax.Attributes attrs)
Signals the start of a portlet window (or a different type of control).
Field Detail ATTR_SCOPE
static final java.lang.String ATTR_SCOPE
- Name of the attribute that identifies the scope in which a container or window are rendered. Valid scopes contain "head" or "body".
- Since:
- 8.5
- See Also:
- Constant Field Values
IWIDGET_DEFINITION
static final java.lang.String IWIDGET_DEFINITION
- indicator that a control is an iWidget
- Since:
- 7.0
- See Also:
- Constant Field Values
ATTR_SKIN
static final java.lang.String ATTR_SKIN
- Name of the attribute that identifies the skin
- Since:
- 7.0
- See Also:
- Constant Field Values
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
- Since:
- 7.0
startPortletWindow
org.xml.sax.ContentHandler 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 (or a different type of control). If iWidgets are contained on a page, they are also signaled via this method, the portlet definition contains the special identifier IWIDGET_DEFINITION. The microformat is passed on to the ContentHandler that is returned by the method. List of known attributes:
- Parameters:
- name - name of the window, unique across the markup document
- definition - identification of the portlet definition.
- attrs - optional attribute map
- Returns:
- an optional ContentHandler that receives events that describe the payload of the window.
- Throws:
- java.io.IOException
- Since:
- 7.0
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD