com.ibm.xsp.component
Interface FacesPageProvider

All Known Implementing Classes:

UIInclude, UIIncludeComposite, UIViewRootEx, UIViewRootEx2

public interface FacesPageProvider

A UIComponent that can act as an alias for the root of a page during the createView phase. The methods from this interface are invoked in the generated XPage .java file, in the initIncluderAsRoot method. The implementations will usually either handle the functionality themselves (as with setBeforePageLoad(MethodBinding)) or will pass the parameters up to the actual page root control (as with addResource(Resource)). This interface is only published because it is used in the generated .java file. It is not intended for 3rd parties to provide their own implementations, as the interface methods change frequently, so their implementation would break when upgrading to a more recent release. Not intended to be subclassed.

Method Summary

void	addNavigationRule(NavigationRule rule) Add a NavigationRule instance to the root of the control tree.
void	addResource(Resource resource) Add a Resource instance to the root of the control tree.
void	setAcl(ACL acl) Set the ACL
void	setAfterPageLoad(javax.faces.el.MethodBinding afterPageLoad) Triggered after a page is loaded, or where it is set on an included custom control, triggered after the custom control is included.
void	setAfterRenderResponse(javax.faces.el.MethodBinding afterRenderResponse) A server-only event triggered after the render response phase of the JSF lifecycle.
void	setAfterRestoreView(javax.faces.el.MethodBinding afterRestoreView) A server-only event triggered after the restore view phase of the JSF lifecycle.
void	setBeforePageLoad(javax.faces.el.MethodBinding beforePageLoad) Triggered before a page is loaded, or where it is set on an included custom control, triggered before the custom control is included.
void	setBeforeRenderResponse(javax.faces.el.MethodBinding beforeRenderResponse) A server-only event triggered before the render response phase of the JSF lifecycle.
void	setDojoForm(boolean dojoForm)
void	setDojoParseOnLoad(boolean dojoParseOnLoad) Flag to indicate whether or not the Dojo parser should run when the page is loaded in the web browser or client, defaults to false, will be set on the root of the control tree.
void	setDojoTheme(boolean dojoTheme) Flag to indicate whether or not the Dojo theme resources (CSS files) should be loaded, defaults to false, will be set on the root of the control tree.
void	setEnableModifiedFlag(boolean enableModifiedFlag)
void	setModifiedControl(java.lang.String modifiedControl)
void	setModifiedMessage(java.lang.String modifiedMessage)
void	setOnClientLoad(java.lang.String onClientLoad) Sets the client JavaScript that was set for the onClientLoad event in the All Properties tab of the XPages Editor's Properties view, which is unusual because events are normally handled in the Events view.
void	setPageBaseUrl(ViewRootBaseUrl pageBaseUrl)
void	setPageManifest(java.lang.String pageManifest)

Method Detail

addResource

void addResource(Resource resource)

Add a Resource instance to the root of the control tree.

Parameters:

resource -

addNavigationRule

void addNavigationRule(NavigationRule rule)

Add a NavigationRule instance to the root of the control tree.

Parameters:

rule -

setAfterPageLoad

void setAfterPageLoad(javax.faces.el.MethodBinding afterPageLoad)

Triggered after a page is loaded, or where it is set on an included custom control, triggered after the custom control is included.

Parameters:

afterPageLoad - afterPageLoad the afterPageLoad to set

setOnClientLoad

void setOnClientLoad(java.lang.String onClientLoad)

Sets the client JavaScript that was set for the onClientLoad event in the All Properties tab of the XPages Editor's Properties view, which is unusual because events are normally handled in the Events view.

Parameters:

onClientLoad - client JavaScript to execute when the page loads in the client or browser

setBeforePageLoad

void setBeforePageLoad(javax.faces.el.MethodBinding beforePageLoad)

Triggered before a page is loaded, or where it is set on an included custom control, triggered before the custom control is included.

Parameters:

beforePageLoad - the beforePageLoad to set

setAfterRenderResponse

void setAfterRenderResponse(javax.faces.el.MethodBinding afterRenderResponse)

A server-only event triggered after the render response phase of the JSF lifecycle. Since it does not occur during processing of the control tree for the phase, the event will not have access to data published by controls in the XPage.

Parameters:

afterRenderResponse - the afterRenderResponse.

setAfterRestoreView

void setAfterRestoreView(javax.faces.el.MethodBinding afterRestoreView)

A server-only event triggered after the restore view phase of the JSF lifecycle. Since it does not occur during processing of the control tree for the phase, the event will not have access to data published by controls in the XPage. There is no "before restore view" phase because these event actions are saved in the view control tree, so the action would not be available before the control tree is restored.

Parameters:

afterRestoreView - the afterRenderResponse to be set.

setBeforeRenderResponse

void setBeforeRenderResponse(javax.faces.el.MethodBinding beforeRenderResponse)

A server-only event triggered before the render response phase of the JSF lifecycle. Since it does not occur during processing of the control tree for the phase, the event will not have access to data published by controls in the XPage.

Parameters:

beforeRenderResponse - The beforeRenderResponse to set.

setDojoTheme

void setDojoTheme(boolean dojoTheme)

Flag to indicate whether or not the Dojo theme resources (CSS files) should be loaded, defaults to false, will be set on the root of the control tree.

Parameters:

dojoTheme - true is the dojo theme should be used

setDojoParseOnLoad

void setDojoParseOnLoad(boolean dojoParseOnLoad)

Flag to indicate whether or not the Dojo parser should run when the page is loaded in the web browser or client, defaults to false, will be set on the root of the control tree.

Parameters:

dojoParseOnLoad - true is the dojo parser should be triggered on load

setEnableModifiedFlag

void setEnableModifiedFlag(boolean enableModifiedFlag)

setModifiedMessage

void setModifiedMessage(java.lang.String modifiedMessage)

setModifiedControl

void setModifiedControl(java.lang.String modifiedControl)

setDojoForm

void setDojoForm(boolean dojoForm)

setPageBaseUrl

void setPageBaseUrl(ViewRootBaseUrl pageBaseUrl)

setPageManifest

void setPageManifest(java.lang.String pageManifest)

setAcl

void setAcl(ACL acl)

Set the ACL