ariba.ui.widgets
Class PageWrapper

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicPageWrapper, DocumentHead, PunchOutHeader

public abstract class PageWrapper
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

Field Summary

static java.lang.String	ApplicationStringName
java.lang.String	currentMetaKey
static java.lang.String	IsDialogPageKey
static int	PAGE_WRAPPER_NO_COLUMNS

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

ClassObject, ComponentTemplateFileExtension

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

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

PageWrapper()

Method Summary

java.lang.String	commands()
java.lang.String	debugTitle()
boolean	enableHelpLink()
java.lang.String	getCurrentMetaValue()
java.util.List	getMetaKeys()
static PageWrapper	instance(AWComponent component) Static helper method to retrieve the current page wrapper which wraps the component.
ActionHandler	overrideAction(java.lang.String action, ActionHandler defaultHandler, AWRequestContext requestContext)
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
java.lang.String	toc()
java.lang.String	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

ApplicationStringName

public static final java.lang.String ApplicationStringName

See Also:

Constant Field Values

PAGE_WRAPPER_NO_COLUMNS

public static final int PAGE_WRAPPER_NO_COLUMNS

See Also:

Constant Field Values

IsDialogPageKey

public static final java.lang.String IsDialogPageKey

See Also:

Constant Field Values

currentMetaKey

public java.lang.String currentMetaKey

Constructor Detail

PageWrapper

public PageWrapper()

Method Detail

instance

public static PageWrapper instance(AWComponent component)

Static helper method to retrieve the current page wrapper which wraps the component.

Parameters:

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

Returns:

PageWrapper

enableHelpLink

public boolean enableHelpLink()

commands

public java.lang.String commands()

toc

public java.lang.String toc()

windowTitle

public java.lang.String windowTitle()

getMetaKeys

public java.util.List getMetaKeys()

getCurrentMetaValue

public java.lang.String getCurrentMetaValue()

debugTitle

public java.lang.String debugTitle()

overrideAction

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

Specified by:

overrideAction in interface ActionInterceptor

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