<w:ModalPageWrapper>

Primary page wrapper for wrapping page with modal behavior (i.e. the user must ultimately complete the page and return to the previous page.

ModalPageWrapper enables its content to be either rendered as page-level content (in which case it disables app level navigation controls) or (if AWCompoent.setClientPanel(true) is in effect) to render as a modal panel (over the previous page's content).

ModalPageWrapper automatically remembers it predecessor page and provides default implementations of the okAction and cancelAction which will return to that page.

Bindings

action	See PageWrapperForm	AWResponseGenerating (get)
title	The title to be displayed as the document / panel title.	String (get)
disableHelpAction	Override to disableHelpAction binding on BasicPageWrapper.	boolean (get)
disableLogoutAction	Depreciated. Logout action will always be disabled.	boolean (get)
disableHomeAction	Depreciated. Home action will always be disabled.	boolean (get)
hasSidebarNotch	See BasicPageWrapper	boolean (get)
isSidebarVisible	See BasicPageWrapper	boolean (get)
toc	See BasicPageWrapper	String (get)
formEncodingType	See BasicPageWrapper	String (get)
hasForm	See BasicPageWrapper	boolean (get)
submitFormDefault	See BasicPageWrapper	boolean (get)
editable	If true, separate "Ok" and "Cancel" buttons are rendered. If not, a single "Done" button is provided.	boolean (get)
okHint	Hover tip on the Ok button	String (get)
okTitle	Label for the Ok button	String (get)
okButtonClass	TextButton buttonClass for the Ok button.	String (get)
okButtonWrapperStyle	TBD	String (get)
cancelHint	TBD	String (get)
okAction	TBD	AWResponseGenerating (get)
okButtonRight	By default, the ok button is on the left of the cancel button. Set this to true to layout the ok button on the right of the cancel button.	boolean (get)
cancelAction	TBD	AWResponseGenerating (get)
cancelTitle	TBD	String (get)
cancelButtonClass	TBD	String (get)
cancelButtonWrapperStyle	TBD	String (get)
doneHint	TBD	String (get)
doneTitle	TBD	String (get)
submitForm	TBD	boolean (get)
helpKey	TBD	String (get)
showTopButtons	See BasicNavigator	boolean (get)
showBottomButtons	See BasicNavigator	boolean (get)
commands	The commands is the name of the "Toolbar" component. You needn't provide the package name of the component, just the component's class name without the packag will suffice. If commands is null or unspecified, the toolbar's commands region will be blank.	String (get)
preventBackTrack	Prevents the user from using the browser back button to move off the modal page.	boolean (get)
omitWrapperFrame	If omitWrapperFrame is true, the top and left side regions of the page wrapper will not be rendered. However, the form container will still be rendered if it otherwise would have been rendered. By default, this turned off, however, if the "isPrintMode" flag is enabled on the requestContext, then the wrapper frame is omitted regardless of the setting of this flag.	boolean (get)

Named Content

buttons	Additional buttons to be display in the button area
titleArea	Additional title area content
bodyArea	The body of the page wrapper (same as the unnamed/main content area, if named a:Content areas are not used)
commands	Note: see AribaCommandBar. The Include tag is magic in that it will reach up any number of component-levels to locate a named template with the name "commands".

ariba.ui.widgets
Class ModalPageWrapper

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.widgets.ModalPageWrapper

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject, ActionInterceptor

public class ModalPageWrapper
extends AWComponent
implements ActionInterceptor

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

ModalPageWrapper()

Method Summary

AWComponent	cancelClicked()
static boolean	inClientPanel(AWComponent component)
void	init()
static ModalPageWrapper	instance(AWComponent component) Static helper method to retrieve the current modal page wrapper which wraps the component.
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
AWComponent	okClicked()
ActionHandler	overrideAction(java.lang.String action, ActionHandler defaultHandler, AWRequestContext requestContext) Action interceptor interface
AWEncodedString	panelId()
static ModalPageWrapper	peekInstance(AWComponent component)
void	prepareToExit()
static void	prepareToExit(AWComponent component) Utility method which should be called by any custom actions which exit the modal page.
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWComponent	returnPage()
static AWComponent	returnPage(AWComponent component) Returns the page that preceded the current modal page.
void	setPanelId(AWEncodedString id)

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, applyValues, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, supportedBindingNames, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Field Detail

DisabledActionHandler

public static final ActionHandler DisabledActionHandler

EnvironmentKey

public static final java.lang.String EnvironmentKey

See Also:

Constant Field Values

PreventBackTrackBindingName

public static final java.lang.String PreventBackTrackBindingName

See Also:

Constant Field Values

_hasBodyAreaSubTemplate

public boolean _hasBodyAreaSubTemplate

_hasBottomLeftAreaSubTemplate

public boolean _hasBottomLeftAreaSubTemplate

_panelId

public AWEncodedString _panelId

_inClientPanel

public boolean _inClientPanel

Constructor Detail

ModalPageWrapper

public ModalPageWrapper()

Method Detail

isStateless

public boolean isStateless()

Description copied from class: AWComponent

Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e. are "stateful") or can be pooled and reused for each phase of request processing (i.e. are stateless) Default is to be stateless unless the component is used as the top-level (page) component.

Overrides:

isStateless in class AWComponent

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWComponent

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

The receiver should render its content to the AWRequestContext.response()

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

instance

public static ModalPageWrapper instance(AWComponent component)

Static helper method to retrieve the current modal page wrapper which wraps the component. If there is no modal page wrapper wrapping the component, a FatalAssertionException will be thrown.

Parameters:

component - one of the components which is contained in the template / template hierarchy of the modal page wrapper

Returns:

ModalPageWrapper

peekInstance

public static ModalPageWrapper peekInstance(AWComponent component)

inClientPanel

public static boolean inClientPanel(AWComponent component)

returnPage

public static AWComponent returnPage(AWComponent component)

Returns the page that preceded the current modal page. If there is no modal page wrapper wrapping the component, a FatalAssertionException will be thrown.

Parameters:

component - one of the components which is contained in the template / template hierarchy of the modal page wrapper

Returns:

the preceeding page component

returnPage

public AWComponent returnPage()

overrideAction

public ActionHandler overrideAction(java.lang.String action,
                                    ActionHandler defaultHandler,
                                    AWRequestContext requestContext)

Action interceptor interface

Specified by:

overrideAction in interface ActionInterceptor

prepareToExit

public static void prepareToExit(AWComponent component)

Utility method which should be called by any custom actions which exit the modal page. For example, if the buttons template is used to add custom buttons to the button area of the modal page.

Parameters:

component - one of the components which is contained in the template / template hierarchy of the modal page wrapper

prepareToExit

public void prepareToExit()

okClicked

public AWComponent okClicked()

cancelClicked

public AWComponent cancelClicked()

setPanelId

public void setPanelId(AWEncodedString id)

panelId

public AWEncodedString panelId()