com.ibm.xsp.page.compiled
Class AbstractCompiledPageDispatcher

java.lang.Object
  com.ibm.xsp.page.compiled.AbstractCompiledPageDispatcher

All Implemented Interfaces:

com.ibm.xsp.page.compiled.CompiledPageDispatcher, FacesPageDispatcher

public abstract class AbstractCompiledPageDispatcher
extends java.lang.Object
implements com.ibm.xsp.page.compiled.CompiledPageDispatcher

The superclass of one of the classes in the generated XPage .java file, not intended to be manually subclassed or used programmatically by application developers or third party Java developers. See FacesPageDispatcher for details.

Constructor Summary

AbstractCompiledPageDispatcher()

AbstractCompiledPageDispatcher(java.lang.String applicationVersion)

Method Summary

protected abstract AbstractCompiledPage	createPage(int pageIndex)
com.ibm.xsp.page.compiled.DispatcherParameter	getDispatcherParameter()
protected java.lang.String[][]	getLibraryTagVersions() Available to be overridden by subclasses, used to indicate which versions of libraries are needed for some of the tags or properties in the XPage.
void	init(com.ibm.xsp.page.compiled.DispatcherParameter param)
protected boolean	isCustomControl() Available to be overridden by subclasses, used to indicate that createViewRoot cannot be invoked on this page, that is, it can only be loaded by another XPage.
FacesPage	loadPage(javax.faces.context.FacesContext context, java.lang.String renderKitId, java.util.Locale locale) Creates the page according to the context, eg.
protected void	setPageDetails(java.lang.String[][] pageDetails) Available to be called by subclasses.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompiledPageDispatcher

public AbstractCompiledPageDispatcher(java.lang.String applicationVersion)

Parameters:

applicationVersion -

AbstractCompiledPageDispatcher

public AbstractCompiledPageDispatcher()

Parameters:

applicationVersion -

Method Detail

setPageDetails

protected void setPageDetails(java.lang.String[][] pageDetails)

Available to be called by subclasses. One inner array per .xsp file in this logical page. The inner array has 2 or more elements; first the platform/render-kit-id, second the locale suffix. If either is not present, it will be the empty string. Later elements are the locale extensions of the corresponding .properties files.

isCustomControl

protected boolean isCustomControl()

Available to be overridden by subclasses, used to indicate that createViewRoot cannot be invoked on this page, that is, it can only be loaded by another XPage. This will not necessarily be true for all custom controls, as controls that were built in the 8.5.0 Designer do not override the method, as the method was not added until 8.5.1.

getLibraryTagVersions

protected java.lang.String[][] getLibraryTagVersions()

Available to be overridden by subclasses, used to indicate which versions of libraries are needed for some of the tags or properties in the XPage.

Returns:

null or a String[][] where each item is a String[] with 2 entries, the first entry is the libraryID, the second entry is the required version, in the standard version format. The versions will be compared to XspLibrary.getTagVersion(). There is no page-level version checking for library tags that are unversioned - the application-level check that the required library is present should suffice.

createPage

protected abstract AbstractCompiledPage createPage(int pageIndex)

init

public void init(com.ibm.xsp.page.compiled.DispatcherParameter param)

Specified by:

init in interface com.ibm.xsp.page.compiled.CompiledPageDispatcher

loadPage

public FacesPage loadPage(javax.faces.context.FacesContext context,
                          java.lang.String renderKitId,
                          java.util.Locale locale)

Description copied from interface: FacesPageDispatcher

Creates the page according to the context, eg. if the current locale is Spanish, the spanish page will be loaded.

Specified by:

loadPage in interface FacesPageDispatcher

Returns:

The FacesPage that corresponds to the relevant xsp page.

getDispatcherParameter

public com.ibm.xsp.page.compiled.DispatcherParameter getDispatcherParameter()