<w:BasicPageWrapper>

BasicPageWrapper should be used on virtually every page of the application as the outer tag for the page. This widget provides a consistent look and feel to the navigation of all pages of all applications (except, the Login Page). Each application will have a different left-side menu ("toc") and toolbar options ("commands"), and these can be specified per the api listed below.

Bindings

action	See PageWrapperForm	AWResponseGenerating (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 package will suffice. If commands is null or unspecified, the toolbar's commands region will be blank.	String (get)
toc	The toc is the name of the "Table of Contents" component, which is often called the left side menu. You needn't provide the package name of the component, just the component's class name without the package will suffice. If toc is null or unspecified, the left side region will be blank.	String (get)
applicationCSS	see applicationCSS ariba.ui.widgets.DocumentHead.awl	String (get)
debugTitle	TBD	String (get)
metaTags	see metaTags in ariba.ui.widgets.DocumentHead.awl	Map (get)
windowTitle	see windowTitle in ariba.ui.widgets.DocumentHead.awl	String (get)
escapeTitle	see escapeTitle in ariba.ui.widgets.DocumentHead.awl	boolean (get)
sessionless	see sessionless in ariba.ui.widgets.DocumentHead.awl and also ariba.ui.widgets.AWSessionManager	boolean (get)
onLoad	see onLoad in ariba.ui.aribaweb.html.AWBody.awl	String (get)
submitFormDefault	see submitFormDefault in ariba.ui.widgets.PageWrapperForm.awl	boolean (get)
disableLogoutAction	Removes the Logout button from the page wrapper. (see AribaBasicPageWrapper.htm)	boolean (get)
disableHomeAction	Removes the Home button from the page wrapper. (see AribaBasicPageWrapper.htm)	boolean (get)
disableHelpAction	Removes the Help button from the page wrapper. (see AribaBasicPageWrapper.htm)	boolean (get)
disableUndelegateAction	Removes the undelegate icon from the page wrapper. (see AribaBasicPageWrapper.htm)	boolean (get)
disableFooter	Removes the footer from the page wrapper.	boolean (get)
disableProfile	Removes the preferences link.	boolean (get)
hasSidebarNotch	Determines whether or not the SidebarNotch is visible. AribaBasicPageWrapper uses the HasSidebarNotchConditionHandler to evaluate this binding so if no value is provided, this value defaults to true. (see AribaBasicPageWrapper.htm)	boolean (get)
isSidebarVisible	Specifies the initial visibility of the side bar (aka TOC). If hasSidebarNotch is set to $false then the user will not be able to control the visibility of the side bar. (see AribaBasicPageWrapper.htm)	boolean (get)
disableAboutBox	Disables the AboutBox. If set to $true, the userGreeting will still be visible but will not display the AboutBox when clicked. (see AribaBasicPageWrapper.htm)	boolean (get)
isDebugVisible	Controls the visibility of the AWDebugPane.	boolean (get)
isNavigatorVisible	Specifies the visibility of the navigator bar. (see AribaBasicPageWrapper.htm)	boolean (get)
overrideGlobalCommandBar	The template/component from the commands binding will be used instead of the global command bar. (see AribaCommandBar)	boolean (get)
hasForm	If hasForm is true, an html form tag is provided in the page wrapper and will serve as the form container for the entire page.	boolean (get)
formActionUrl	If formActionUrl is not null, the PageWrapperForm will be rendered (even if hasForm=$false). see also ariba.ui.widgets.PageWrapperForm.awl	String (get)
formEncodingType	If formEncodingType is not null, the PageWrapperForm will be rendered (even if hasForm=$false). see also ariba.ui.widgets.PageWrapperForm.awl	String (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)
helpKey	TBD	String (get)
formName	TBD	String (get)
addContentMargin	TBD	boolean (get)
bodyClass	TBD	String (get)

Named Content

body	TBD
styles	Allows for passing CSS styles into the head tag
script	Allows for passing inline javascript into the head tag
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".
toc	Note: see AribaToc. The Include tag is magic in that it will reach up any number of component-levels to locate a named template with the name "toc".

ariba.ui.widgets
Class BasicPageWrapper

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

All Implemented Interfaces:

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

public final class BasicPageWrapper
extends PageWrapper

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

BasicPageWrapper()

Method Summary

boolean	alreadyInPageWrapper()
java.lang.String	applicationType() Gets the module name from the application.
java.lang.String	bodyClass()
java.lang.String	favIconUrl()
java.lang.String	getTestPane()
boolean	hasTestPane()
boolean	omitFormTags()
boolean	omitWrapperBoilerplate()
static void	registerTestPaneComponent(java.lang.String componentName)

Methods inherited from class ariba.ui.widgets.PageWrapper

commands, debugTitle, enableHelpLink, getCurrentMetaValue, getMetaKeys, instance, overrideAction, renderResponse, toc, windowTitle

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, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, invokeAction, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStateless, 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

_formActionUrl

public java.lang.String _formActionUrl

_formName

public java.lang.String _formName

_formEncodingType

public java.lang.String _formEncodingType

_hasForm

public boolean _hasForm

_currentPanel

public java.lang.Object _currentPanel

Constructor Detail

BasicPageWrapper

public BasicPageWrapper()

Method Detail

omitFormTags

public boolean omitFormTags()

omitWrapperBoilerplate

public boolean omitWrapperBoilerplate()

bodyClass

public java.lang.String bodyClass()

applicationType

public java.lang.String applicationType()

Gets the module name from the application.

Returns:

module name.

favIconUrl

public java.lang.String favIconUrl()

alreadyInPageWrapper

public boolean alreadyInPageWrapper()

registerTestPaneComponent

public static void registerTestPaneComponent(java.lang.String componentName)

hasTestPane

public boolean hasTestPane()

getTestPane

public java.lang.String getTestPane()