ariba.ui.aribaweb.core
Class AWComponent

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

Direct Known Subclasses:

AribaAboutBox, AribaAction, AribaCondition, AribaContactBox, AribaHelp, AribaImage, AribaNotificationDialog, AribaPrintMenu, AribaResourceUrl, AribaShutdownWarning, AribaSite, AribaString, AWActionCheckbox, AWArea, AWBackTrack, AWBaseImage, AWBaseMonitorStatsPage, AWBody, AWBrowser, AWCatch, AWCheckbox, AWClientSideScript, AWCommunityResponse, AWComponentInclude, AWCurrWindowDecl, AWDebugContent, AWDragContainer, AWDropContainer, AWEditableRegion, AWErrorManagerScope, AWEvaluateTemplateFile, AWExampleComponent, AWExceptionBodyRenderer, AWFileDownload, AWFileUpload, AWFileUploadInternals, AWFocusRegion, AWForm, AWFormRedirect, AWFrame, AWGenericActionTag, AWGroupingRepetition, AWHead, AWHiddenFormParameter, AWHiddenFormValue, AWHighLightedErrorScope, AWHoverContainer, AWHoverControl, AWHyperlink, AWIFrame, AWImageButton, AWImageData, AWIncludeBlock, AWInstanceInclude, AWJSDebug, AWJSListRepetition, AWLabel, AWLazyAction, AWLazyDiv, AWLazyDivInternals, AWMetaContentType, AWMetaRefresh, AWMetaTemplateWrapper, AWMonitorSessionStatsPage, AWMultiTabException, AWPageRedirect, AWPageWrapper, AWPasswordField, AWPollInterval, AWPopup, AWPrivateHyperlink, AWPrivateScript, AWRadioButton, AWRadioButtonEnvironment, AWRedirect, AWRefreshRegion, AWRelocatableDiv, AWRemoteLink, AWRemotePageWrapper, AWRichClientFooter, AWSingleton, AWStyleSheet, AWSubmitButton, AWSwitchTemplate, AWTBatchNavigationBar, AWTDataTable, AWTDataTable.ColumnRenderer, AWTDragList, AWTExportConditional, AWTextArea, AWTextField, AWTMetaContentRenderer, AWTOptionalColumnsPage, AWTOptionsMenuButton, AWTOptionsMenuItems, AWTPivotConfigurationPanel, AWTScrollTableWrapper, AWTSortHeading, AWViewportContainer, AWVModalPageWrapper, AWVTextArea, AWXBasicScriptFunctions, AWXHandleExceptionPage, AWXLogString, AWXSessionRestorationErrorPage, BaseTabSet, BasicNavigator, BrandedComponent, BrandingComponent, BucketHeading, BucketItem, BucketsTOC, Calendar, Chart, ChartData, ChartPivotData, CheckboxList, Chooser, ChooserPanel, ClientPanelWrapper, ComboButton, CommunityContentPane, CompactForm, ComplexRepetition, Confirmation, CueTip, DateField, DefaultCommandBar, DeferredDisplayWrapper, DialogContentWrapper, DialogPageWrapper, EarlyAccessBanner, ErrorBubble, ErrorFlag, FileBrowser, FileUploadChooser, FileUploadStatusBar, FooterIncludes, FooterLinks, FormGroupBlock, FormRow, FormTable, FourZoneLayout, GenericChooser, GoogleAnalyticsFooter, GoogleAnalyticsHeader, GradientBox, HeaderIncludes, HintMessage, HoverCard, HTMLActionFilter, HtmlInclude, ImagePrefetch, MapForEach, MessageBanner, MessagesList, MetaActionList, MetaContentPage, MetaDetailTable, MetaForm, MetaHomePage, MetaInspectorPane, MetaLayout, MetaList, MetaMarkdown, MetaModalPage, MetaNavEditorMenu, MetaNavTabBar, MetaRange, MetaSearch, MetaSearchForm, MetaSideInspector, MetaTable, MetaTableColumnsRenderer, MetaTabs, MimeMessageView, ModalPageWrapper, ModalWindowClose, ModalWindowExceptionPage, ModalWindowLink, ModalWindowScriptFunctions, ModalWindowWrapper, MRUTabList, OutlineBox, OutlineControl, OutlineFolderControl, OutlineInnerRepetition, OutlineMenu, OutlineRepetition, PaddedImage, PageErrorPanel, PageWrapper, PageWrapperForm, PollDialog, PopupCalendar, PopupControl, PopupMenu, PopupMenuButton, PopupMenuHeading, PopupMenuItem, PopupMenuLink, PortletWrapper, PulldownButton, RadioButtonList, RichTextArea, RichTextAreaScript, RoundedBox, RoundedCorners, RoundedStep, SearchBox, SectionBody, SectionHeading, SetterLink, SimpleTocPanel, Spotlight, SpotlightFooter, StepByStepTOC, StepHeader, StepNavigator, StepNavigatorBar, StepNavigatorButton, StepNavigatorButtonContent, Substep, Tab, TableHeaderRow, TabList, TabSet, TestComponentPage, TextButton, TextFormSubmitButton, TocPanel, TocPanelItem, ToggleBox, ToggleImage, TopFrameRedirect, TruncateString, VirtualForm, WaterMark, WidgetInclude, WidgetsJavaScript, WizardAction, WizardButtonsBarBottom, WizardButtonsBarTop, WizardFrameContent, WizardNavigator, WizardPage, WizardPageWrapper, WizardTOC

public class AWComponent
extends AWBaseObject
implements AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution

AWComponent is the key class for template/based interactive content. All "pages", page sub-sections, "wrappers", as well as most controls / widgets, and even control contructs are implemented as subclasses of AWComponent.

Components typically have a template (.awl file) containing "bare html text" mixed with references to other embedded AWComponents (or low level elements). These, in turn, have bindings that refer back to the java instance paired with the template (often using fieldpaths to dynamically push/pull values and invoke actions.

Components may be either stateless (pooled) or stateful (bound to their page instance and stored in the session. (Typically pages, page sub-sections, and particular rich components are stateful, while simple controls are stateless and simply push/pull their needed state from their parent component via bindings).

Simple subclasses of AWComponent typically declare instance variables (possible public for use in bindings) as well as action methods (which return reponses which are usually just other page-level AWComponent instances for the next page (or null to rerender the current page while reflecting any updated state).

Components participate in the AWCycleable request handling lifecycle. In addition to renderResponse(AWRequestContext, AWComponent), applyValues(AWRequestContext, AWComponent), and invokeAction(AWRequestContext, AWComponent), an AWComponent also experiences init(), awake(), sleep(), and even possibly hibernate().

Nested Class Summary

static interface	AWComponent.RenderingFilter Implementers of this interface can be used in conjunction with the rendering listener interfaces below, or anywhere to model a boolean predicate on the 3 rendering argus
static interface	AWComponent.RenderingListener Allow listeners to monitor rendering 'lifecycle' events

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

AWResponseGenerating.ResponseSubstitution

Field Summary

static java.lang.Class	ClassObject
static java.lang.String	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

AWComponent()

Method Summary

void	_topLevelApplyValues(AWRequestContext requestContext, AWComponent component)
AWResponseGenerating	_topLevelInvokeAction(AWRequestContext requestContext, AWComponent component)
void	_topLevelRenderResponse(AWRequestContext requestContext, AWComponent component)
boolean	allowEmbeddedKeyPaths()
boolean	allowsWhitespaceCompression()
AWApplication	application()
void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
AWComponent	awcyclePageAndLog()
AWBinding	bindingForName(java.lang.String bindingName)
AWBinding	bindingForName(java.lang.String bindingName, boolean recursive)
AWBindingDictionary	bindings()
boolean	booleanValueForBinding(AWBinding binding)
boolean	booleanValueForBinding(AWBinding binding, boolean defaultValue)
boolean	booleanValueForBinding(java.lang.String bindingName)
boolean	booleanValueForBinding(java.lang.String bindingName, boolean defaultValue)
java.lang.String	browserMaxWidth()
java.lang.String	browserMinWidth()
AWCharacterEncoding	characterEncoding()
void	clearValidationError(java.lang.Object errorKey) Clear an error in the error manager.
java.util.TimeZone	clientTimeZone()
java.lang.Object	componentConfiguration(java.lang.String configName)
AWComponentDefinition	componentDefinition()
AWFastStringBuffer	componentPath(java.lang.String separatorString)
AWComponentReference	componentReference()
static AWComponent	createPageWithName(java.lang.String pageName)
static AWTemplateParser	defaultTemplateParser()
AWElement	determineInstance(java.lang.String elementName, java.util.Map bindingsHashtable, java.lang.String templateName, int lineNumber)
AWElement	determineInstance(java.lang.String elementName, java.lang.String translatedClassName, java.util.Map bindingsHashtable, java.lang.String templateName, int lineNumber)
java.util.Map	dict()
java.lang.Object	dict(java.lang.String key)
void	dict(java.lang.String key, java.lang.Object value)
double	doubleValueForBinding(AWBinding binding)
double	doubleValueForBinding(java.lang.String bindingName)
double	doubleValueForBinding(java.lang.String bindingName, double defaultValue)
AWEncodedString	encodedStringValueForBinding(AWBinding binding)
AWEncodedString	encodedStringValueForBinding(java.lang.String bindingName)
void	ensureAwake(AWPage page)
void	ensureFieldValuesClear()
AWEnvironmentStack	env()
AWErrorManager	errorManager() Retrieve the error manager for the page.
AWEncodedString	escapeAttribute(AWEncodedString attributeValue)
AWEncodedString	escapeString(java.lang.Object object)
AWEncodedString	escapeUnsafeString(java.lang.Object object)
java.util.Map	extendedFields()
AWFormValueManager	formValueManager()
AWResponse	generateResponse()
AWResponse	generateResponse(AWResponse response)
AWResponse	generateResponse(AWResponse response, AWRequestContext requestContext)
java.lang.String	generateStringContents()
AWParameters	getAWParameter() Allows for parameter field value syntax in AWL files.
java.lang.Object	getDrivingBusinessObject() Note: Should be overwritten in sub-classing page-level components.
int	getFoldInSituOnWindowSizeParam() Get window size on which In Situ pane will fold.
UIRenderMeta.RenderVersion	getPageRenderVersion() Note: Can be overwritten by sub-class if page is always rendered in a certain version.
AWComponent	getThis() This method allows for access to the current component fromthe .awl via "$this"
boolean	hasBinding(AWBinding binding)
boolean	hasBinding(java.lang.String bindingName)
boolean	hasContentForTagName(java.lang.String tagName)
boolean	hasContentNamed(java.lang.String name)
boolean	hasMultipleTemplates()
boolean	hasSubTemplateNamed(java.lang.String templateName) Deprecated. Use hasContentNamed()
javax.servlet.http.HttpSession	httpSession()
void	init()
void	init(AWComponentReference componentReference, AWComponent parentComponent, AWPage page)
static void	initTemplateResourceManager(AWResourceManager manager) We need to use the same resource manager for loading templates.
int	intValueForBinding(AWBinding binding)
int	intValueForBinding(java.lang.String bindingName)
int	intValueForBinding(java.lang.String bindingName, int defaultValue)
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	isBidirectional()
boolean	isBrowserMicrosoft()
boolean	isClientPanel()
boolean	isMacintosh()
boolean	isRenderAW5()
boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
boolean	isStrictTagNaming()
boolean	isUserCommunityEnabled() Provide ability to turn off community features at the application level
boolean	isValidationEnabled()
java.lang.String	languageDirection()
java.lang.String	languageLeft()
java.lang.String	languageRight()
AWTemplate	loadTemplate()
java.lang.String	localizedJavaString(int stringId, java.lang.String originalString)
AWBacktrackState	markBacktrackState()
java.lang.String	name()
java.lang.String	namePath()
void	notifyChange() Only applicable to pageComponents.
AWBindingDictionary	otherBindings()
AWStringDictionary	otherBindingsValues()
AWPage	page()
AWComponent	pageComponent()
<T> T	pageWithClass(java.lang.Class<T> tClass)
<T> T	pageWithClass(java.lang.Class<T> tClass, java.util.Map<java.lang.String,java.lang.Object> assignments)
AWComponent	pageWithName(java.lang.String pageName)
AWComponent	pageWithName(java.lang.String pageName, java.util.Map<java.lang.String,java.lang.Object> assignments)
AWComponent	parent()
void	postTakeValueActions() Deprecated.
java.util.Locale	preferredLocale()
void	recordBacktrackState(int userBacktrackState)
void	recordBacktrackState(java.lang.Object userBacktrackState)
void	recordValidationError(AWErrorInfo error) Record an error to the error manager.
void	recordValidationError(java.lang.Object errorKey, java.lang.String errorMessage, java.lang.Object errantValue) Record an error to the error manager.
void	recordValidationError(java.lang.Throwable exception, java.lang.Object errorKey, java.lang.Object errantValue) Record an error to the error manager.
void	recordValidationErrors(java.util.List errors) Record multiple error to the error manager.
void	recordValidationWarning(java.lang.Object errorKey, java.lang.String warningMessage) Record an error to the error manager.
AWPageRedirect	redirectToPage(AWComponent destinationPage)
static void	registerRenderingListener(AWComponent.RenderingListener listener)
static void	registerXmlNodeWithName(java.lang.String xmlNodeName)
void	removeBacktrackState()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWResponseGenerating	replacementResponse()
AWRequest	request()
AWRequestContext	requestContext()
boolean	requiresPreGlidCompatibility() Override this method to restore the behavior in this page to that of aribaweb-7.
java.lang.String	resourceClassName() Get the name of the class where we get our resources from.
AWResourceManager	resourceManager()
AWResponse	response()
java.lang.Object	restoreFromBacktrackState(java.lang.Object userBacktrackState)
AWSession	session()
AWSession	session(boolean required)
void	setCharacterEncoding(AWCharacterEncoding characterEncoding)
void	setClientPanel(boolean yn)
void	setClientTimeZone(java.util.TimeZone timeZone)
void	setComponentConfiguration(java.lang.String configName, java.lang.Object config)
static void	setDefaultTemplateParser(AWTemplateParser templateParser)
void	setEnv(AWEnvironmentStack environmentStack)
void	setPerfDestinationInfo() Sets the destination page for performance monitoring.
void	setPreferredLocale(java.util.Locale locale)
void	setResourceManager(AWResourceManager resourceManager)
void	setTemplateParser(AWTemplateParser templateParser)
void	setupForNextCycle(AWComponentReference componentReference, AWComponent parentComponent, AWPage page)
void	setValueForBinding(boolean booleanValue, AWBinding binding)
void	setValueForBinding(boolean booleanValue, java.lang.String bindingName)
void	setValueForBinding(int intValue, AWBinding binding)
void	setValueForBinding(int intValue, java.lang.String bindingName)
void	setValueForBinding(java.lang.Object objectValue, AWBinding binding)
void	setValueForBinding(java.lang.Object objectValue, java.lang.String bindingName)
boolean	shouldCachePage()
boolean	shouldCloseElements()
AWStringsThunk	strings()
java.lang.String	stringValueForBinding(AWBinding binding)
java.lang.String	stringValueForBinding(java.lang.String bindingName)
java.lang.String	stringValueForBinding(java.lang.String bindingName, java.lang.String defaultValue)
java.lang.String[]	supportedBindingNames()
AWTemplate	template()
java.lang.String	templateName()
AWTemplateParser	templateParser()
AWResource	templateResource()
static AWResourceManager	templateResourceManager()
void	truncateBacktrackState()
void	truncateBacktrackState(AWBacktrackState backtrackStateMark)
java.lang.String	urlForResourceNamed(java.lang.String resourceName)
java.lang.String	urlForResourceNamed(java.lang.String resourceName, boolean useFullUrl)
java.lang.String	urlForResourceNamed(java.lang.String resourceName, boolean useFullUrl, boolean isVersioned)
boolean	useXmlEscaping()
java.lang.Object	valueForBinding(AWBinding binding)
java.lang.Object	valueForBinding(java.lang.String bindingName)
java.lang.Object	valueForBinding(java.lang.String bindingName, java.lang.Object defaultValue)
AWXmlNode	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

ComponentTemplateFileExtension

public static final java.lang.String ComponentTemplateFileExtension

See Also:

Constant Field Values

ClassObject

public static final java.lang.Class ClassObject

Constructor Detail

AWComponent

public AWComponent()

Method Detail

determineInstance

public AWElement determineInstance(java.lang.String elementName,
                                   java.lang.String translatedClassName,
                                   java.util.Map bindingsHashtable,
                                   java.lang.String templateName,
                                   int lineNumber)

Specified by:

determineInstance in interface AWCycleableReference

determineInstance

public AWElement determineInstance(java.lang.String elementName,
                                   java.util.Map bindingsHashtable,
                                   java.lang.String templateName,
                                   int lineNumber)

Specified by:

determineInstance in interface AWCycleableReference

init

public void init(AWComponentReference componentReference,
                 AWComponent parentComponent,
                 AWPage page)

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWBaseObject

parent

public AWComponent parent()

getThis

public AWComponent getThis()

This method allows for access to the current component fromthe .awl via "$this"

setupForNextCycle

public void setupForNextCycle(AWComponentReference componentReference,
                              AWComponent parentComponent,
                              AWPage page)

componentDefinition

public AWComponentDefinition componentDefinition()

hasMultipleTemplates

public boolean hasMultipleTemplates()

setDefaultTemplateParser

public static void setDefaultTemplateParser(AWTemplateParser templateParser)

defaultTemplateParser

public static AWTemplateParser defaultTemplateParser()

templateParser

public AWTemplateParser templateParser()

setTemplateParser

public void setTemplateParser(AWTemplateParser templateParser)

componentReference

public AWComponentReference componentReference()

createPageWithName

public static AWComponent createPageWithName(java.lang.String pageName)

ensureFieldValuesClear

public void ensureFieldValuesClear()

Overrides:

ensureFieldValuesClear in class AWBaseObject

requestContext

public AWRequestContext requestContext()

application

public AWApplication application()

page

public AWPage page()

pageComponent

public AWComponent pageComponent()

getDrivingBusinessObject

public java.lang.Object getDrivingBusinessObject()

Note: Should be overwritten in sub-classing page-level components.

Returns:

The driving business logic.

getPageRenderVersion

public UIRenderMeta.RenderVersion getPageRenderVersion()

Note: Can be overwritten by sub-class if page is always rendered in a certain version.

Returns:

The rendering version of this page.

isRenderAW5

public boolean isRenderAW5()

session

public AWSession session()

session

public AWSession session(boolean required)

httpSession

public javax.servlet.http.HttpSession httpSession()

request

public AWRequest request()

response

public AWResponse response()

isBrowserMicrosoft

public boolean isBrowserMicrosoft()

isMacintosh

public boolean isMacintosh()

browserMinWidth

public java.lang.String browserMinWidth()

browserMaxWidth

public java.lang.String browserMaxWidth()

resourceManager

public AWResourceManager resourceManager()

setResourceManager

public void setResourceManager(AWResourceManager resourceManager)

setCharacterEncoding

public void setCharacterEncoding(AWCharacterEncoding characterEncoding)

characterEncoding

public AWCharacterEncoding characterEncoding()

setClientTimeZone

public void setClientTimeZone(java.util.TimeZone timeZone)

clientTimeZone

public java.util.TimeZone clientTimeZone()

setEnv

public void setEnv(AWEnvironmentStack environmentStack)

env

public AWEnvironmentStack env()

setPreferredLocale

public void setPreferredLocale(java.util.Locale locale)

preferredLocale

public java.util.Locale preferredLocale()

name

public java.lang.String name()

namePath

public java.lang.String namePath()

templateName

public java.lang.String templateName()

resourceClassName

public java.lang.String resourceClassName()

Get the name of the class where we get our resources from. This is the class in which we resolve AWLocal references.

Returns:

the full class name of the resource class

template

public AWTemplate template()

isClientPanel

public boolean isClientPanel()

setClientPanel

public void setClientPanel(boolean yn)

replacementResponse

public AWResponseGenerating replacementResponse()

Specified by:

replacementResponse in interface AWResponseGenerating.ResponseSubstitution

isValidationEnabled

public boolean isValidationEnabled()

isStrictTagNaming

public boolean isStrictTagNaming()

allowsWhitespaceCompression

public boolean allowsWhitespaceCompression()

templateResource

public AWResource templateResource()

templateResourceManager

public static AWResourceManager templateResourceManager()

initTemplateResourceManager

public static void initTemplateResourceManager(AWResourceManager manager)

We need to use the same resource manager for loading templates. Otherwise, each component instances can potential get templates with a different structure (ie, AWIncludeComponent maps)

hasContentNamed

public boolean hasContentNamed(java.lang.String name)

hasSubTemplateNamed

public boolean hasSubTemplateNamed(java.lang.String templateName)

Deprecated. Use hasContentNamed()

hasContentForTagName

public boolean hasContentForTagName(java.lang.String tagName)

loadTemplate

public AWTemplate loadTemplate()

allowEmbeddedKeyPaths

public boolean allowEmbeddedKeyPaths()

isStateless

public boolean isStateless()

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.

applyValues

public void applyValues(AWRequestContext requestContext,
                        AWComponent component)

Description copied from interface: AWCycleable

The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().

Specified by:

applyValues in interface AWCycleable

Parameters:

requestContext - the context for the current request.

component - the current parent component

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

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

Parameters:

requestContext - the context for the current request.

component - the current parent component

_topLevelApplyValues

public void _topLevelApplyValues(AWRequestContext requestContext,
                                 AWComponent component)

_topLevelInvokeAction

public AWResponseGenerating _topLevelInvokeAction(AWRequestContext requestContext,
                                                  AWComponent component)

_topLevelRenderResponse

public void _topLevelRenderResponse(AWRequestContext requestContext,
                                    AWComponent component)

escapeAttribute

public AWEncodedString escapeAttribute(AWEncodedString attributeValue)

escapeString

public AWEncodedString escapeString(java.lang.Object object)

escapeUnsafeString

public AWEncodedString escapeUnsafeString(java.lang.Object object)

shouldCloseElements

public boolean shouldCloseElements()

useXmlEscaping

public boolean useXmlEscaping()

recordBacktrackState

public void recordBacktrackState(java.lang.Object userBacktrackState)

recordBacktrackState

public void recordBacktrackState(int userBacktrackState)

removeBacktrackState

public void removeBacktrackState()

truncateBacktrackState

public void truncateBacktrackState()

truncateBacktrackState

public void truncateBacktrackState(AWBacktrackState backtrackStateMark)

markBacktrackState

public AWBacktrackState markBacktrackState()

restoreFromBacktrackState

public java.lang.Object restoreFromBacktrackState(java.lang.Object userBacktrackState)

shouldCachePage

public boolean shouldCachePage()

generateResponse

public AWResponse generateResponse(AWResponse response,
                                   AWRequestContext requestContext)

generateResponse

public AWResponse generateResponse(AWResponse response)

generateResponse

public AWResponse generateResponse()

Specified by:

generateResponse in interface AWResponseGenerating

generateStringContents

public java.lang.String generateStringContents()

Specified by:

generateStringContents in interface AWResponseGenerating

ensureAwake

public void ensureAwake(AWPage page)

supportedBindingNames

public java.lang.String[] supportedBindingNames()

bindings

public AWBindingDictionary bindings()

otherBindings

public AWBindingDictionary otherBindings()

otherBindingsValues

public AWStringDictionary otherBindingsValues()

bindingForName

public AWBinding bindingForName(java.lang.String bindingName)

bindingForName

public AWBinding bindingForName(java.lang.String bindingName,
                                boolean recursive)

hasBinding

public boolean hasBinding(java.lang.String bindingName)

hasBinding

public boolean hasBinding(AWBinding binding)

doubleValueForBinding

public double doubleValueForBinding(AWBinding binding)

doubleValueForBinding

public double doubleValueForBinding(java.lang.String bindingName)

doubleValueForBinding

public double doubleValueForBinding(java.lang.String bindingName,
                                    double defaultValue)

intValueForBinding

public int intValueForBinding(AWBinding binding)

intValueForBinding

public int intValueForBinding(java.lang.String bindingName)

intValueForBinding

public int intValueForBinding(java.lang.String bindingName,
                              int defaultValue)

booleanValueForBinding

public boolean booleanValueForBinding(AWBinding binding)

booleanValueForBinding

public boolean booleanValueForBinding(java.lang.String bindingName)

booleanValueForBinding

public boolean booleanValueForBinding(AWBinding binding,
                                      boolean defaultValue)

booleanValueForBinding

public boolean booleanValueForBinding(java.lang.String bindingName,
                                      boolean defaultValue)

valueForBinding

public java.lang.Object valueForBinding(AWBinding binding)

valueForBinding

public java.lang.Object valueForBinding(java.lang.String bindingName)

valueForBinding

public java.lang.Object valueForBinding(java.lang.String bindingName,
                                        java.lang.Object defaultValue)

stringValueForBinding

public java.lang.String stringValueForBinding(AWBinding binding)

stringValueForBinding

public java.lang.String stringValueForBinding(java.lang.String bindingName)

stringValueForBinding

public java.lang.String stringValueForBinding(java.lang.String bindingName,
                                              java.lang.String defaultValue)

encodedStringValueForBinding

public AWEncodedString encodedStringValueForBinding(AWBinding binding)

encodedStringValueForBinding

public AWEncodedString encodedStringValueForBinding(java.lang.String bindingName)

setValueForBinding

public void setValueForBinding(java.lang.Object objectValue,
                               AWBinding binding)

setValueForBinding

public void setValueForBinding(java.lang.Object objectValue,
                               java.lang.String bindingName)

setValueForBinding

public void setValueForBinding(int intValue,
                               AWBinding binding)

setValueForBinding

public void setValueForBinding(int intValue,
                               java.lang.String bindingName)

setValueForBinding

public void setValueForBinding(boolean booleanValue,
                               AWBinding binding)

setValueForBinding

public void setValueForBinding(boolean booleanValue,
                               java.lang.String bindingName)

registerXmlNodeWithName

public static void registerXmlNodeWithName(java.lang.String xmlNodeName)

xml

public AWXmlNode xml()

pageWithName

public AWComponent pageWithName(java.lang.String pageName)

pageWithName

public AWComponent pageWithName(java.lang.String pageName,
                                java.util.Map<java.lang.String,java.lang.Object> assignments)

pageWithClass

public <T> T pageWithClass(java.lang.Class<T> tClass)

pageWithClass

public <T> T pageWithClass(java.lang.Class<T> tClass,
                           java.util.Map<java.lang.String,java.lang.Object> assignments)

componentConfiguration

public java.lang.Object componentConfiguration(java.lang.String configName)

setComponentConfiguration

public void setComponentConfiguration(java.lang.String configName,
                                      java.lang.Object config)

extendedFields

public java.util.Map extendedFields()

dict

public java.util.Map dict()

dict

public void dict(java.lang.String key,
                 java.lang.Object value)

dict

public java.lang.Object dict(java.lang.String key)

redirectToPage

public AWPageRedirect redirectToPage(AWComponent destinationPage)

awcyclePageAndLog

public AWComponent awcyclePageAndLog()

componentPath

public AWFastStringBuffer componentPath(java.lang.String separatorString)

errorManager

public AWErrorManager errorManager()

Retrieve the error manager for the page.

Returns:

error manager

formValueManager

public AWFormValueManager formValueManager()

recordValidationError

public void recordValidationError(java.lang.Object errorKey,
                                  java.lang.String errorMessage,
                                  java.lang.Object errantValue)

Record an error to the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the setErrorMessageAndValue().

Parameters:

errorKey - The object that identifies the error. This is typically a string.

errorMessage - The message that describes the error.

errantValue - The unparsable value that the user entered. Since the parsing failed, we cannot store this value in the field. We stash it away here so we can display in the UI later.

recordValidationError

public void recordValidationError(AWErrorInfo error)

Record an error to the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the setErrorMessageAndValue().

Parameters:

error - The error object.

recordValidationErrors

public void recordValidationErrors(java.util.List errors)

Record multiple error to the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the setErrorMessageAndValue().

Parameters:

errors - a list of AWErrorInfo objects

recordValidationError

public void recordValidationError(java.lang.Throwable exception,
                                  java.lang.Object errorKey,
                                  java.lang.Object errantValue)

Record an error to the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the setErrorMessageAndValue().

Parameters:

exception -

errorKey - The object that identifies the error. This is typically a string.

errantValue - The unparsable value that the user entered. Since the parsing failed, we cannot store this value in the field. We stash it away here so we can display in the UI later.

recordValidationWarning

public void recordValidationWarning(java.lang.Object errorKey,
                                    java.lang.String warningMessage)

Record an error to the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the setErrorMessageAndValue().

Parameters:

errorKey - The object that identifies the error. This is typically a string.

warningMessage - The message that describes the warning.

clearValidationError

public void clearValidationError(java.lang.Object errorKey)

Clear an error in the error manager. To avoid confusion between the current and new ErrorManagers, this is the only way to access the clearErrorForKey().

Parameters:

errorKey -

localizedJavaString

public java.lang.String localizedJavaString(int stringId,
                                            java.lang.String originalString)

strings

public AWStringsThunk strings()

urlForResourceNamed

public java.lang.String urlForResourceNamed(java.lang.String resourceName)

urlForResourceNamed

public java.lang.String urlForResourceNamed(java.lang.String resourceName,
                                            boolean useFullUrl)

urlForResourceNamed

public java.lang.String urlForResourceNamed(java.lang.String resourceName,
                                            boolean useFullUrl,
                                            boolean isVersioned)

isBidirectional

public boolean isBidirectional()

languageDirection

public java.lang.String languageDirection()

languageRight

public java.lang.String languageRight()

languageLeft

public java.lang.String languageLeft()

requiresPreGlidCompatibility

public boolean requiresPreGlidCompatibility()

Override this method to restore the behavior in this page to that of aribaweb-7. This only applies to page-level components

postTakeValueActions

public void postTakeValueActions()

Deprecated.

Method called after applyValues phase is completed. This method is highly dangerous. Note that whenever this method is called no bindings may be evaluated because all components are out of band.

getAWParameter

public AWParameters getAWParameter()

Allows for parameter field value syntax in AWL files. See AWParameters for more information. example: $AWParameters.System.UI.Table.MinHeight

notifyChange

public void notifyChange()

Only applicable to pageComponents. Called by AWPage when AWPage receives a change notification. See AWPage.notifyChange()

setPerfDestinationInfo

public void setPerfDestinationInfo()

Sets the destination page for performance monitoring. This method is defined to allow component subclasses to control the setting of the perf. logging fields.

isUserCommunityEnabled

public boolean isUserCommunityEnabled()

Provide ability to turn off community features at the application level

Returns:

getFoldInSituOnWindowSizeParam

public int getFoldInSituOnWindowSizeParam()

Get window size on which In Situ pane will fold.

Returns:

int

registerRenderingListener

public static void registerRenderingListener(AWComponent.RenderingListener listener)