com.ibm.xsp.component
Class UIViewRootEx

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIViewRoot
              com.ibm.xsp.component.UIViewRootEx

All Implemented Interfaces:

FacesAutoForm, FacesComponent, FacesDataProvider, FacesPageProvider, ThemeControl, javax.faces.component.StateHolder

Direct Known Subclasses:

UIViewRootEx2

public class UIViewRootEx
extends javax.faces.component.UIViewRoot
implements FacesComponent, FacesDataProvider, FacesPageProvider, FacesAutoForm, ThemeControl

Superclass of UIViewRootEx (the xp:view tag, the XPage root control). Not intended to be subclassed, methods beginning with "_" are intended to be used only by the XPages runtime.

Nested Class Summary

static class

UIViewRootEx.StateMapImpl Not intended to be used except by the XPages runtime.

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	ALL_PARTIAL_PHASE_ID Related to FacesContextEx.getPartialRefreshId()
static java.lang.String	COMPONENT_TYPE
static java.lang.String	NO_PARTIAL_PHASE_ID Related to FacesContextEx.getPartialRefreshId()
static java.lang.String	STATE_FULLTREE Possible value of getViewState()
static java.lang.String	STATE_LASTTREE Possible value of getViewState()
static java.lang.String	STATE_NOSTATE Possible value of getViewState()
static java.lang.String	STATE_STATEMAP Possible value of getViewState()

Fields inherited from class javax.faces.component.UIViewRoot

_viewScope, COMPONENT_FAMILY, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Fields inherited from interface com.ibm.xsp.component.FacesDataProvider

DATA, DATA_CONTEXTS

Constructor Summary

UIViewRootEx()

Method Summary

protected void	_invokePartialRefresh(FacesContextEx context, java.lang.String refreshId)
protected void	_renderView(FacesContextEx context)
void	_xspCleanTransientData() Clear the view transient state.
UIViewRootEx.StateMapImpl	_xspCreateStateMap()
java.lang.String	_xspGetQueryString()
UIViewRootEx.StateMapImpl	_xspGetStateMap() Not intended to be used anywhere except by the XPages runtime.
void	_xspRestoreState(javax.faces.component.UIComponent.StateMap stateMap)
void	_xspSaveState(javax.faces.component.UIComponent.StateMap stateMap)
void	addData(DataSource data) Add a DataSource instance to the set associated with this component.
void	addDataContext(DataContext dataContext) Add a DataContext instance to the set associated with this component.
void	addEncodeResource(javax.faces.context.FacesContext context, Resource resource)
void	addEncodeResource(Resource resource) Adds a resource to be rendered by the viewRoot, but only during this encode phase.
void	addModifiedSaveAction(UIFormEx form)
void	addNavigationRule(NavigationRule rule) Add a NavigationRule instance to the set associated with this component.
void	addProperty(Parameter property) Invoked by the generated XPage .java file, not intended to be invoked directly, as the property parameters are processed early after the view is created, and not re-evaluated after that.
void	addResource(int index, Resource resource)
void	addResource(Resource resource) Add a Resource instance to the set associated with this component.
void	addResourceFromStyleKit(int index, Resource resource)
void	addScript(java.lang.String newScript)
void	addScriptOnce(java.lang.String newScript)
void	addScriptOnLoad(java.lang.String newScript)
void	broadcast(javax.faces.event.FacesEvent event)
void	buildContents(javax.faces.context.FacesContext context, FacesComponentBuilder builder) Build the component children and facets, the default implementation is usually: builder.buildAll(context, this, true); // includeFacets=true
protected void	buildContents(javax.faces.context.FacesContext context, FacesComponentBuilder builder, javax.faces.component.UIComponent parent)
protected void	checkUserAccess(javax.faces.context.FacesContext context, int minRights) Check does user have access to the current page
void	clearDataContainers() Clear all data containers scoped to this view
void	clearEncodeResources()
protected UIFormEx	createAutoForm()
java.lang.String	createUniqueId()
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
ACL	getAcl() Return the ACL
javax.faces.el.MethodBinding	getAfterPageLoad() Triggered after a page is loaded.
javax.faces.el.MethodBinding	getAfterRenderResponse()
javax.faces.el.MethodBinding	getAfterRestoreView()
javax.faces.el.MethodBinding	getBeforePageLoad() Triggered before a page is loaded.
javax.faces.el.MethodBinding	getBeforeRenderResponse()
java.util.List<DataSource>	getData() Returns the list of component data objects.
java.util.Map<java.lang.String,DataContainer>	getDataContainers() Return the data containers scoped to this view
java.util.List<DataContext>	getDataContexts() Returns the list of component data context objects.
java.lang.String	getDefaultLinkTarget()
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getDocType() This is not a property in the XPages editor All Properties tab, it reads the doctype setting from the xsp.properties file, normalizing it for the difference in expected format between 8.5.1 and 8.5.2.
java.lang.Object	getEncodeProperty(java.lang.String name)
java.util.List<Resource>	getEncodeResources()
java.lang.String	getModifiedControl()
java.lang.String	getModifiedMessage()
java.util.List<NavigationRule>	getNavigationRules()
java.lang.String	getOnClientLoad() Triggers client code after a page is loaded.
ViewRootBaseUrl	getPageBaseUrl()
java.lang.String	getPageIcon()
java.lang.String	getPageManifest()
java.lang.String	getPageName() Return the value of the pageName property.
java.lang.String	getPageTitle()
java.util.List<Parameter>	getProperties() Not intended to be used directly, use getViewProperty(String) instead.
int	getRenderingSequence()
java.lang.String	getRequestUrl() Return the value of the requestUrl property.
java.util.List<Resource>	getResources()
int	getScrollX()
int	getScrollY()
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
java.lang.String	getUniqueViewId()
java.lang.String	getViewProperty(java.lang.String name) Get a view property, for the given configuration property (where the property is named like the options in the xsp.properties file), this returns the value that was set for that property in the XPage root control's All Properties tab, in the property named "properties".
java.util.Map	getViewScope() Deprecated.
java.lang.String	getViewState() The value of the "viewState" property set in the XPage source on the XPage root control, or else it finds the value of the configuration option configured in the Application Properties, XPages tab, Performance section, the "Server page persistence:" setting.
boolean	hasEncodeProperty(java.lang.String name)
protected boolean	hasUserAccess(javax.faces.context.FacesContext context, int minRights) Check does user have access to this panel
void	initAfterContents(javax.faces.context.FacesContext context) Perform component initialization after it's children and facets are added.
void	initBeforeContents(javax.faces.context.FacesContext context) Perform component initialization before its children and facets are added.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
void	invokePhaseMethodBinding(javax.faces.context.FacesContext context, javax.faces.event.PhaseEvent event, boolean isAfter) Invoke a method binding while ensuring that the view data sources are available This make the different phases work like the after/before load events
boolean	isCreateForm() Returns true if a form will be created if none already exists.
boolean	isDocTypeHtml()
boolean	isDocTypeXhtml()
boolean	isDojoForm() Returns true if this view root should generate a dojo form type to the Form.
boolean	isDojoParseOnLoad() Returns true if this view root should trigger the dojo parser on load.
boolean	isDojoTheme() Returns true if this view root should generate a reference to a Dojo theme.
boolean	isEnableModifiedFlag()
boolean	isLoadXspClientDojoUI()
boolean	isLocaleChanged() Not a property in the XPages Editor's All Properties tab, set and used by the infrastructure.
boolean	isPreferredContentTypeXhtml()
boolean	isReadonly()
boolean	isRendered()
boolean	isRenderingPhase()
protected void	notifyResourceAdded(Resource resource) A callback for the subclasses, invoked when a unique resource has been added.
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
protected java.util.List<DataPublisher.ShadowedObject>	publishControlData(javax.faces.context.FacesContext context)
void	putEncodeProperty(java.lang.String name, java.lang.Object value)
void	putViewProperty(java.lang.String name, java.lang.String value) Not intended to be invoked directly, this is used by the infrastructure to set up the property values available through getViewProperty(String).
void	queueEvent(javax.faces.event.FacesEvent event)
void	removeModifiedSaveAction(UIFormEx form)
void	renderMarkup(javax.faces.context.FacesContext context, RenderCallback callback) Used by AajxUtil.renderMarkup.
void	renderView(javax.faces.context.FacesContext context)
protected void	restoredState(javax.faces.context.FacesContext context) Should be invoked by the restoreState(FacesContext, Object) method after the property values are restored.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
protected void	revokeControlData(java.util.List<DataPublisher.ShadowedObject> shadowedData, javax.faces.context.FacesContext context)
boolean	save() Calling this method will cause all data sources contained within this form to have their contents saved and also have the associated data model removed from the associated bean manager.
boolean	save(boolean removeFromManager) Calling this method will cause all data sources contained within this form to have their contents saved and optionally have the associated data model removed from the associated bean manager.
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAcl(ACL acl) Set the ACL
void	setAfterPageLoad(javax.faces.el.MethodBinding afterPageLoad) Triggered after a page is loaded.
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.
void	setBeforeRenderResponse(javax.faces.el.MethodBinding beforeRenderResponse) A server-only event triggered before the render response phase of the JSF lifecycle.
void	setCreateForm(boolean createForm) Flag to indicate whether or not a form will be created if none already exists.
void	setDefaultLinkTarget(java.lang.String defaultLinkTarget)
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setDocType(java.lang.String docType)
void	setDojoForm(boolean dojoForm) Flag to indicate whether or not a dojo form is being used.
void	setDojoParseOnLoad(boolean dojoParseOnLoad) Flag to indicate whether or not a dojo theme is being used.
void	setDojoTheme(boolean dojoTheme) Flag to indicate whether or not a dojo theme is being used.
void	setEnableModifiedFlag(boolean enableModifiedFlag)
void	setLoadXspClientDojoUI(boolean loadXspClientDojoUI) Does not correspond to a property in the All Properties tab of the editor, internal setting used by some of the XPages runtime provided controls to determine whether to use one of the XPages runtime Dojo layers, should not be used by 3rd parties.
void	setLocaleChanged(boolean changed)
void	setModifiedControl(java.lang.String modifiedControl)
void	setModifiedMessage(java.lang.String dirtyMessage)
void	setOnClientLoad(java.lang.String onClientLoad) Triggers client code after a page is loaded.
void	setPageBaseUrl(ViewRootBaseUrl pageBaseUrl)
void	setPageIcon(java.lang.String pageIcon)
void	setPageManifest(java.lang.String pageManifest)
void	setPageName(java.lang.String pageName) Set the value of the pageName property.
void	setPageTitle(java.lang.String viewTitle)
void	setReadonly(boolean readOnly)
void	setRequestUrl(java.lang.String requestUrl) Set the value of the requestUrl property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setUniqueViewId(java.lang.String uniqueViewId)
void	setViewState(java.lang.String viewState) Set the value of the viewState property.
boolean	shouldSaveState(javax.faces.context.FacesContext context)
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.UIViewRoot

broadcastEvents, clearEventList, getFamily, getLocale, getRenderKitId, getViewId, getViewMap, getViewMap, processApplication, setLocale, setRenderKitId, setViewId

Methods inherited from class javax.faces.component.UIComponentBase

_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspRestoreAttribute, isVisitable, markInitialState, setControlState

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

NO_PARTIAL_PHASE_ID

public static final java.lang.String NO_PARTIAL_PHASE_ID

Related to FacesContextEx.getPartialRefreshId()

See Also:

Constant Field Values

ALL_PARTIAL_PHASE_ID

public static final java.lang.String ALL_PARTIAL_PHASE_ID

Related to FacesContextEx.getPartialRefreshId()

See Also:

Constant Field Values

STATE_FULLTREE

public static final java.lang.String STATE_FULLTREE

Possible value of getViewState()

See Also:

Constant Field Values

STATE_NOSTATE

public static final java.lang.String STATE_NOSTATE

Possible value of getViewState()

See Also:

Constant Field Values

STATE_LASTTREE

public static final java.lang.String STATE_LASTTREE

Possible value of getViewState()

See Also:

Constant Field Values

STATE_STATEMAP

public static final java.lang.String STATE_STATEMAP

Possible value of getViewState()

See Also:

Constant Field Values

Constructor Detail

UIViewRootEx

public UIViewRootEx()

Method Detail

createUniqueId

public java.lang.String createUniqueId()

Overrides:

createUniqueId in class javax.faces.component.UIViewRoot

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getUniqueViewId

public java.lang.String getUniqueViewId()

setUniqueViewId

public void setUniqueViewId(java.lang.String uniqueViewId)

_xspCleanTransientData

public void _xspCleanTransientData()

Clear the view transient state. This should be done right after the view is serialized

Overrides:

_xspCleanTransientData in class javax.faces.component.UIViewRoot

_xspGetQueryString

public java.lang.String _xspGetQueryString()

Overrides:

_xspGetQueryString in class javax.faces.component.UIViewRoot

_xspCreateStateMap

public UIViewRootEx.StateMapImpl _xspCreateStateMap()

_xspSaveState

public void _xspSaveState(javax.faces.component.UIComponent.StateMap stateMap)

Overrides:

_xspSaveState in class javax.faces.component.UIComponent

_xspRestoreState

public void _xspRestoreState(javax.faces.component.UIComponent.StateMap stateMap)

Overrides:

_xspRestoreState in class javax.faces.component.UIComponent

isEnableModifiedFlag

public boolean isEnableModifiedFlag()

setEnableModifiedFlag

public void setEnableModifiedFlag(boolean enableModifiedFlag)

Specified by:

setEnableModifiedFlag in interface FacesPageProvider

getModifiedMessage

public java.lang.String getModifiedMessage()

setModifiedMessage

public void setModifiedMessage(java.lang.String dirtyMessage)

Specified by:

setModifiedMessage in interface FacesPageProvider

getModifiedControl

public java.lang.String getModifiedControl()

setModifiedControl

public void setModifiedControl(java.lang.String modifiedControl)

Specified by:

setModifiedControl in interface FacesPageProvider

getPageTitle

public java.lang.String getPageTitle()

Returns:

String representing the title applied to the page on a web server. This has no effect on Portal.

setPageTitle

public void setPageTitle(java.lang.String viewTitle)

Parameters:

viewTitle - Value to be displayed as the page title

getPageIcon

public java.lang.String getPageIcon()

Returns:

String representing the title applied to the page on a web server. This has no effect on Portal.

setPageIcon

public void setPageIcon(java.lang.String pageIcon)

Parameters:

viewTitle - Value to be displayed as the page title

getPageManifest

public java.lang.String getPageManifest()

Returns:

String representing the manifest attribute added to the HTML tag, when applicable

setPageManifest

public void setPageManifest(java.lang.String pageManifest)

Specified by:

setPageManifest in interface FacesPageProvider

Parameters:

manifest - Value of the manifest attribute of the HTML tag

getPageBaseUrl

public ViewRootBaseUrl getPageBaseUrl()

Returns:

ViewRootBaseUrl The base URL to generate in the HTML header

setPageBaseUrl

public void setPageBaseUrl(ViewRootBaseUrl pageBaseUrl)

Specified by:

setPageBaseUrl in interface FacesPageProvider

Parameters:

pageBaseUrl - the new base url to assign to the head tag

isReadonly

public boolean isReadonly()

setReadonly

public void setReadonly(boolean readOnly)

isRendered

public boolean isRendered()

Overrides:

isRendered in class javax.faces.component.UIComponentBase

addProperty

public void addProperty(Parameter property)

Invoked by the generated XPage .java file, not intended to be invoked directly, as the property parameters are processed early after the view is created, and not re-evaluated after that. These are the same property options that are set in the xsp.properties configuration file, but here they are configured in the XPage source on the XPage root control. Also not all of the properties work when set at the view (XPage root) level, since some are only used at the application level or the server level. The evaluated parameters values are available through getViewProperty(String).

Parameters:

property - the property to add to the list

getProperties

public java.util.List<Parameter> getProperties()

Not intended to be used directly, use getViewProperty(String) instead. See the comments in addProperty(Parameter).

Returns:

Return the list of parameters that were set in the XPage, corresponding to xsp.properties configuration properties.

getData

public java.util.List<DataSource> getData()

Returns the list of component data objects.

Specified by:

getData in interface FacesDataProvider

Returns:

The list ofcomponent data objects.

addData

public void addData(DataSource data)

Add a DataSource instance to the set associated with this component.

Specified by:

addData in interface FacesDataProvider

Parameters:

data - The component data to add.

getDataContexts

public java.util.List<DataContext> getDataContexts()

Returns the list of component data context objects.

Specified by:

getDataContexts in interface FacesDataProvider

Returns:

The list of component data context objects.

addDataContext

public void addDataContext(DataContext dataContext)

Add a DataContext instance to the set associated with this component.

Specified by:

addDataContext in interface FacesDataProvider

Parameters:

dataContexts - The component data context to add.

getAcl

public ACL getAcl()

Return the ACL

setAcl

public void setAcl(ACL acl)

Set the ACL

Specified by:

setAcl in interface FacesPageProvider

getNavigationRules

public java.util.List<NavigationRule> getNavigationRules()

Returns:

Returns the list of navigation rules associated with this component.

addNavigationRule

public void addNavigationRule(NavigationRule rule)

Add a NavigationRule instance to the set associated with this component.

Specified by:

addNavigationRule in interface FacesPageProvider

Parameters:

rule -

getResources

public java.util.List<Resource> getResources()

Returns:

Returns the list of resources associated with this component.

addResource

public void addResource(Resource resource)

Add a Resource instance to the set associated with this component.

Specified by:

addResource in interface FacesPageProvider

Parameters:

rule -

addResource

public void addResource(int index,
                        Resource resource)

addResourceFromStyleKit

public void addResourceFromStyleKit(int index,
                                    Resource resource)

notifyResourceAdded

protected void notifyResourceAdded(Resource resource)

A callback for the subclasses, invoked when a unique resource has been added.

Parameters:

resource -

isDojoTheme

public boolean isDojoTheme()

Returns true if this view root should generate a reference to a Dojo theme.

Returns:

true if a access to a dojo theme will be generated

setDojoTheme

public void setDojoTheme(boolean dojoTheme)

Flag to indicate whether or not a dojo theme is being used.

Specified by:

setDojoTheme in interface FacesPageProvider

Parameters:

dojoTheme - true is the dojo theme should be used

isDojoForm

public boolean isDojoForm()

Returns true if this view root should generate a dojo form type to the Form.

Returns:

true if the form should generate a dojo form

setDojoForm

public void setDojoForm(boolean dojoForm)

Flag to indicate whether or not a dojo form is being used.

Specified by:

setDojoForm in interface FacesPageProvider

Parameters:

dojoTheme - true is the dojo form should be used

isDojoParseOnLoad

public boolean isDojoParseOnLoad()

Returns true if this view root should trigger the dojo parser on load.

Returns:

true if the dojo parser should be triggered on load

setDojoParseOnLoad

public void setDojoParseOnLoad(boolean dojoParseOnLoad)

Flag to indicate whether or not a dojo theme is being used.

Specified by:

setDojoParseOnLoad in interface FacesPageProvider

Parameters:

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

setLoadXspClientDojoUI

public void setLoadXspClientDojoUI(boolean loadXspClientDojoUI)

Does not correspond to a property in the All Properties tab of the editor, internal setting used by some of the XPages runtime provided controls to determine whether to use one of the XPages runtime Dojo layers, should not be used by 3rd parties.

Parameters:

loadXspClientDojoUI - true if the control requires xspClientDojoUI to be loaded

isLoadXspClientDojoUI

public boolean isLoadXspClientDojoUI()

Returns:

loadXspClientDojoUI

See Also:

setLoadXspClientDojoUI(boolean)

isCreateForm

public boolean isCreateForm()

Returns true if a form will be created if none already exists.

Specified by:

isCreateForm in interface FacesAutoForm

Returns:

true if a form will be created if none already exists.

See Also:

UIFormEx

setCreateForm

public void setCreateForm(boolean createForm)

Flag to indicate whether or not a form will be created if none already exists.

Specified by:

setCreateForm in interface FacesAutoForm

Parameters:

createForm - true to create a form if none already exists.

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

getPageName

public java.lang.String getPageName()

Return the value of the pageName property.

setPageName

public void setPageName(java.lang.String pageName)

Set the value of the pageName property.

getRequestUrl

public java.lang.String getRequestUrl()

Return the value of the requestUrl property.

setRequestUrl

public void setRequestUrl(java.lang.String requestUrl)

Set the value of the requestUrl property.

getOnClientLoad

public java.lang.String getOnClientLoad()

Triggers client code after a page is loaded.

Returns:

Returns the on client load method binding.

setOnClientLoad

public void setOnClientLoad(java.lang.String onClientLoad)

Triggers client code after a page is loaded.

Specified by:

setOnClientLoad in interface FacesPageProvider

Parameters:

onClientLoad - The on client load

getAfterPageLoad

public javax.faces.el.MethodBinding getAfterPageLoad()

Triggered after a page is loaded.

Returns:

Returns the after page load method binding.

setAfterPageLoad

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

Triggered after a page is loaded.

Specified by:

setAfterPageLoad in interface FacesPageProvider

Parameters:

afterPageLoad - The after page load method binding to set.

getBeforePageLoad

public javax.faces.el.MethodBinding getBeforePageLoad()

Triggered before a page is loaded.

Returns:

Returns the before page load method binding.

setBeforePageLoad

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

Triggered before a page is loaded.

Specified by:

setBeforePageLoad in interface FacesPageProvider

Parameters:

beforePageLoad - The before page load method binding to set.

getAfterRenderResponse

public javax.faces.el.MethodBinding getAfterRenderResponse()

Returns:

Returns the afterRenderResponse.

setAfterRenderResponse

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

Description copied from interface: FacesPageProvider

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.

Specified by:

setAfterRenderResponse in interface FacesPageProvider

Parameters:

afterRenderResponse - The afterRenderResponse to set.

getAfterRestoreView

public javax.faces.el.MethodBinding getAfterRestoreView()

Returns:

Returns the afterRestoreView.

setAfterRestoreView

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

Description copied from interface: FacesPageProvider

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.

Specified by:

setAfterRestoreView in interface FacesPageProvider

Parameters:

afterRestoreView - The afterRestoreView to set.

getBeforeRenderResponse

public javax.faces.el.MethodBinding getBeforeRenderResponse()

Returns:

Returns the beforeRenderResponse.

setBeforeRenderResponse

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

Description copied from interface: FacesPageProvider

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.

Specified by:

setBeforeRenderResponse in interface FacesPageProvider

Parameters:

beforeRenderResponse - The beforeRenderResponse to set.

isLocaleChanged

public boolean isLocaleChanged()

Not a property in the XPages Editor's All Properties tab, set and used by the infrastructure.

Returns:

setLocaleChanged

public void setLocaleChanged(boolean changed)

save

public boolean save()
             throws javax.faces.FacesException

Calling this method will cause all data sources contained within this form to have their contents saved and also have the associated data model removed from the associated bean manager.

Throws:

javax.faces.FacesException

save

public boolean save(boolean removeFromManager)
             throws javax.faces.FacesException

Calling this method will cause all data sources contained within this form to have their contents saved and optionally have the associated data model removed from the associated bean manager.

Throws:

javax.faces.FacesException

getScrollX

public int getScrollX()

getScrollY

public int getScrollY()

renderView

public void renderView(javax.faces.context.FacesContext context)
                throws java.io.IOException

Throws:

java.io.IOException

publishControlData

protected java.util.List<DataPublisher.ShadowedObject> publishControlData(javax.faces.context.FacesContext context)

Parameters:

context -

Returns:

revokeControlData

protected void revokeControlData(java.util.List<DataPublisher.ShadowedObject> shadowedData,
                                 javax.faces.context.FacesContext context)

Parameters:

shadowedData -

context -

_renderView

protected void _renderView(FacesContextEx context)
                    throws java.io.IOException

Throws:

java.io.IOException

_invokePartialRefresh

protected void _invokePartialRefresh(FacesContextEx context,
                                     java.lang.String refreshId)
                              throws java.io.IOException

Throws:

java.io.IOException

renderMarkup

public void renderMarkup(javax.faces.context.FacesContext context,
                         RenderCallback callback)
                  throws java.io.IOException

Used by AajxUtil.renderMarkup. Do not use it directly.

Throws:

java.io.IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIViewRoot

Throws:

java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIViewRoot

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIViewRoot

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIViewRoot

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIViewRoot

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIComponent

Throws:

javax.faces.FacesException

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIComponent

initBeforeContents

public void initBeforeContents(javax.faces.context.FacesContext context)
                        throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization before its children and facets are added.

Specified by:

initBeforeContents in interface FacesComponent

Throws:

javax.faces.FacesException

buildContents

public void buildContents(javax.faces.context.FacesContext context,
                          FacesComponentBuilder builder)
                   throws javax.faces.FacesException

Description copied from interface: FacesComponent

Build the component children and facets, the default implementation is usually:
builder.buildAll(context, this, true); // includeFacets=true

Specified by:

buildContents in interface FacesComponent

Throws:

javax.faces.FacesException

buildContents

protected void buildContents(javax.faces.context.FacesContext context,
                             FacesComponentBuilder builder,
                             javax.faces.component.UIComponent parent)
                      throws javax.faces.FacesException

Throws:

javax.faces.FacesException

createAutoForm

protected UIFormEx createAutoForm()

addModifiedSaveAction

public void addModifiedSaveAction(UIFormEx form)

removeModifiedSaveAction

public void removeModifiedSaveAction(UIFormEx form)

initAfterContents

public void initAfterContents(javax.faces.context.FacesContext context)
                       throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization after it's children and facets are added.

Specified by:

initAfterContents in interface FacesComponent

Throws:

javax.faces.FacesException

invokePhaseMethodBinding

public void invokePhaseMethodBinding(javax.faces.context.FacesContext context,
                                     javax.faces.event.PhaseEvent event,
                                     boolean isAfter)

Invoke a method binding while ensuring that the view data sources are available This make the different phases work like the after/before load events

getViewScope

public final java.util.Map getViewScope()

Deprecated.

Get the viewScope - Maintained for compatibility.

getViewProperty

public java.lang.String getViewProperty(java.lang.String name)

Get a view property, for the given configuration property (where the property is named like the options in the xsp.properties file), this returns the value that was set for that property in the XPage root control's All Properties tab, in the property named "properties". If the property value was configured as a computed value, it will have been evaluated soon after the XPage root control was created, and will not be re-evaluated when this method is called.

putViewProperty

public void putViewProperty(java.lang.String name,
                            java.lang.String value)

Not intended to be invoked directly, this is used by the infrastructure to set up the property values available through getViewProperty(String). Put a view property.

checkUserAccess

protected void checkUserAccess(javax.faces.context.FacesContext context,
                               int minRights)

Check does user have access to the current page

shouldSaveState

public boolean shouldSaveState(javax.faces.context.FacesContext context)

getViewState

public java.lang.String getViewState()

The value of the "viewState" property set in the XPage source on the XPage root control, or else it finds the value of the configuration option configured in the Application Properties, XPages tab, Performance section, the "Server page persistence:" setting. For details see the xsp.properties.sample file, the option "xsp.persistence.viewstate".

Returns:

the view state

setViewState

public void setViewState(java.lang.String viewState)

Set the value of the viewState property.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

getDocType

public java.lang.String getDocType()

This is not a property in the XPages editor All Properties tab, it reads the doctype setting from the xsp.properties file, normalizing it for the difference in expected format between 8.5.1 and 8.5.2.

setDocType

public void setDocType(java.lang.String docType)

isDocTypeHtml

public boolean isDocTypeHtml()

isDocTypeXhtml

public boolean isDocTypeXhtml()

isPreferredContentTypeXhtml

public boolean isPreferredContentTypeXhtml()

getRenderingSequence

public int getRenderingSequence()

isRenderingPhase

public boolean isRenderingPhase()

getDataContainers

public java.util.Map<java.lang.String,DataContainer> getDataContainers()

Return the data containers scoped to this view

clearDataContainers

public void clearDataContainers()

Clear all data containers scoped to this view

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIViewRoot

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIViewRoot

restoredState

protected void restoredState(javax.faces.context.FacesContext context)

Should be invoked by the restoreState(FacesContext, Object) method after the property values are restored.

Parameters:

context -

hasUserAccess

protected boolean hasUserAccess(javax.faces.context.FacesContext context,
                                int minRights)

Check does user have access to this panel

addEncodeResource

public void addEncodeResource(Resource resource)

Adds a resource to be rendered by the viewRoot, but only during this encode phase. That is, it will not be re-rendered the next time this view is encoded, unless it is re-added during the next encode phase.

Parameters:

resource -

addEncodeResource

public void addEncodeResource(javax.faces.context.FacesContext context,
                              Resource resource)

getEncodeResources

public java.util.List<Resource> getEncodeResources()

Returns:

the encodeResources

clearEncodeResources

public void clearEncodeResources()

hasEncodeProperty

public boolean hasEncodeProperty(java.lang.String name)

getEncodeProperty

public java.lang.Object getEncodeProperty(java.lang.String name)

putEncodeProperty

public void putEncodeProperty(java.lang.String name,
                              java.lang.Object value)

addScriptOnce

public void addScriptOnce(java.lang.String newScript)

addScript

public void addScript(java.lang.String newScript)

addScriptOnLoad

public void addScriptOnLoad(java.lang.String newScript)

_xspGetStateMap

public UIViewRootEx.StateMapImpl _xspGetStateMap()

Not intended to be used anywhere except by the XPages runtime.

Overrides:

_xspGetStateMap in class javax.faces.component.UIComponent

getDefaultLinkTarget

public java.lang.String getDefaultLinkTarget()

setDefaultLinkTarget

public void setDefaultLinkTarget(java.lang.String defaultLinkTarget)