ariba.ui.aribaweb.core
Class AWPage

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

All Implemented Interfaces:

AWRequestContext._SubcomponentLookup, AWDisposable, AWObject

public final class AWPage
extends AWBaseObject
implements AWDisposable, AWRequestContext._SubcomponentLookup

Nested Class Summary

static class	AWPage.BrowserState
static interface	AWPage.LifecycleListener

Field Summary

static boolean	AllowCrossPageRefresh
static boolean	AllowParentFrame
static java.lang.String	ARIBA_DIFF_TOOL_COMMAND
static boolean	DEBUG_REFRESH_REGION_TOP_LEVEL_CHANGE
static int	NewPageForceFPRThreshold
static java.lang.String	PrevPageHasValidationDisplayError
static int	SamePageForceFPRThreshold

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

AWPage(AWComponent pageComponent, AWRequestContext requestContext)

Method Summary

java.lang.String	_computePageRefreshCause(boolean isComplete)
java.util.List	_pageScriptList()
AWResourceManager	_resourceManager()
void	_setResourceManager(AWResourceManager resourceManager)
void	addModalPanel(AWComponent panel)
static boolean	AllowIncrementalScriptLoading()
void	appendPageScrollingScript()
void	applyValues()
void	awake()
AWCharacterEncoding	characterEncoding()
java.util.TimeZone	clientTimeZone()
boolean	debug_prevPageHasValidationDisplayError()
void	debug_setPrevPageHasValidationDisplayError(boolean state)
static int	defaultPollInterval()
static boolean	DeferGlobalScopeScript()
void	dispose()
AWResponse	downloadResponse()
void	ensureAwake(AWRequestContext requestContext)
AWErrorManager	errorManager()
AWErrorManager	foregroundErrorManager()
AWFormValueManager	formValueManager()
java.lang.String	fullPageRefreshCause()
java.lang.Object	get(java.lang.Object key)
AWChangeNotifier	getChangeNotifier()
AWCommunityContext	getCommunityContext() Fetch the community context
java.lang.String	getDefaultFormId()
AWArrayManager	getFormIds(java.lang.String formId) Given the element id of a form, returns the list of form input element id's for the form.
AWComponent	getPerfComponent() Returns the component that should be used for performance logging.
int	getPollInterval() Returns the poll interval for this page.
AWBaseResponse	getPreviousResponse()
AWComponent	getStatefulComponent(AWElementIdPath elementIdPath)
boolean	hasChangeNotifier()
boolean	hasFormValueManager()
boolean	hasMultipleForms()
boolean	hasScript(java.lang.String scriptName)
AWHiddenFormValueManager	hiddenFormValueManager()
AWResponseGenerating	invokeAction()
boolean	isPollingInitiated() Determines if polling should be initiated for this page.
boolean	isScrolled()
AWBacktrackState	markBacktrackState()
java.util.List	modalPanels()
boolean	notifyChange() Notify that AWPoll-relevant changes have taken place (and client should be updated)
AWStringDictionary	otherBindingsValuesScratch()
AWComponent	pageComponent()
java.lang.String	pageScrollLeft()
java.lang.String	pageScrollTop()
java.lang.String	perfPageName()
boolean	pollOnError()
java.lang.Object	popErrorManager(java.lang.Object state)
AWComponent	popModalPanel()
java.util.Locale	preferredLocale()
AWPage	previousPage()
java.lang.Object	pushErrorManager(java.lang.Object stored)
void	put(java.lang.Object key, java.lang.Object value)
void	putFormIds(java.lang.String formId, AWArrayManager array) Maintains the lists of element id's for each form elements keyed by the id of the form itself.
void	putStatefulComponent(AWElementIdPath elementIdPath, AWComponent subcomponent)
void	recordCurrentScript(java.lang.String scriptName)
static void	registerLifecycleListener(AWPage.LifecycleListener listener)
void	renderResponse()
AWRequestContext	requestContext()
void	resetHasChanged()
void	setCharacterEncoding(AWCharacterEncoding characterEncoding)
void	setClientTimeZone(java.util.TimeZone timeZone)
void	setDownloadResponse(AWResponse response)
void	setPageScrollLeft(java.lang.String offset)
void	setPageScrollTop(java.lang.String offset)
void	setPollingInitiated(boolean pollEnabled) Set the flag to initiate polling for this page.
void	setPollInterval(int pollInterval) Overrides the default poll interval as defined by AWApplication.
void	setTemplateParser(AWTemplateParser templateParser)
void	sleep()
AWTemplateParser	templateParser()
AWComponent	topPanel()
java.lang.String	toString()
void	truncateBacktrackState()
void	truncateBacktrackState(AWBacktrackState backtrackStateMark)
AWValidationContext	validationContext()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

AllowCrossPageRefresh

public static boolean AllowCrossPageRefresh

AllowParentFrame

public static boolean AllowParentFrame

NewPageForceFPRThreshold

public static final int NewPageForceFPRThreshold

See Also:

Constant Field Values

SamePageForceFPRThreshold

public static final int SamePageForceFPRThreshold

See Also:

Constant Field Values

DEBUG_REFRESH_REGION_TOP_LEVEL_CHANGE

public static boolean DEBUG_REFRESH_REGION_TOP_LEVEL_CHANGE

ARIBA_DIFF_TOOL_COMMAND

public static java.lang.String ARIBA_DIFF_TOOL_COMMAND

PrevPageHasValidationDisplayError

public static final java.lang.String PrevPageHasValidationDisplayError

See Also:

Constant Field Values

Constructor Detail

AWPage

public AWPage(AWComponent pageComponent,
              AWRequestContext requestContext)

Method Detail

AllowIncrementalScriptLoading

public static boolean AllowIncrementalScriptLoading()

DeferGlobalScopeScript

public static boolean DeferGlobalScopeScript()

dispose

public void dispose()

Specified by:

dispose in interface AWDisposable

pageComponent

public AWComponent pageComponent()

requestContext

public AWRequestContext requestContext()

_setResourceManager

public void _setResourceManager(AWResourceManager resourceManager)

_resourceManager

public AWResourceManager _resourceManager()

templateParser

public AWTemplateParser templateParser()

setTemplateParser

public void setTemplateParser(AWTemplateParser templateParser)

downloadResponse

public AWResponse downloadResponse()

setDownloadResponse

public void setDownloadResponse(AWResponse response)

setCharacterEncoding

public void setCharacterEncoding(AWCharacterEncoding characterEncoding)

characterEncoding

public AWCharacterEncoding characterEncoding()

setClientTimeZone

public void setClientTimeZone(java.util.TimeZone timeZone)

clientTimeZone

public java.util.TimeZone clientTimeZone()

preferredLocale

public java.util.Locale preferredLocale()

otherBindingsValuesScratch

public AWStringDictionary otherBindingsValuesScratch()

isScrolled

public boolean isScrolled()

setPageScrollTop

public void setPageScrollTop(java.lang.String offset)

pageScrollTop

public java.lang.String pageScrollTop()

setPageScrollLeft

public void setPageScrollLeft(java.lang.String offset)

pageScrollLeft

public java.lang.String pageScrollLeft()

hiddenFormValueManager

public AWHiddenFormValueManager hiddenFormValueManager()

errorManager

public AWErrorManager errorManager()

pushErrorManager

public java.lang.Object pushErrorManager(java.lang.Object stored)

popErrorManager

public java.lang.Object popErrorManager(java.lang.Object state)

foregroundErrorManager

public AWErrorManager foregroundErrorManager()

modalPanels

public java.util.List modalPanels()

topPanel

public AWComponent topPanel()

perfPageName

public java.lang.String perfPageName()

getPerfComponent

public AWComponent getPerfComponent()

Returns the component that should be used for performance logging. Typically this is the topPanel() but if that is null, it falls back to the page component.

Returns:

addModalPanel

public void addModalPanel(AWComponent panel)

popModalPanel

public AWComponent popModalPanel()

applyValues

public void applyValues()

invokeAction

public AWResponseGenerating invokeAction()

fullPageRefreshCause

public java.lang.String fullPageRefreshCause()

_computePageRefreshCause

public java.lang.String _computePageRefreshCause(boolean isComplete)

renderResponse

public void renderResponse()

appendPageScrollingScript

public void appendPageScrollingScript()

truncateBacktrackState

public void truncateBacktrackState()

truncateBacktrackState

public void truncateBacktrackState(AWBacktrackState backtrackStateMark)

markBacktrackState

public AWBacktrackState markBacktrackState()

previousPage

public AWPage previousPage()

registerLifecycleListener

public static void registerLifecycleListener(AWPage.LifecycleListener listener)

awake

public void awake()

ensureAwake

public void ensureAwake(AWRequestContext requestContext)

sleep

public void sleep()

debug_setPrevPageHasValidationDisplayError

public void debug_setPrevPageHasValidationDisplayError(boolean state)

debug_prevPageHasValidationDisplayError

public boolean debug_prevPageHasValidationDisplayError()

getStatefulComponent

public AWComponent getStatefulComponent(AWElementIdPath elementIdPath)

Specified by:

getStatefulComponent in interface AWRequestContext._SubcomponentLookup

putStatefulComponent

public void putStatefulComponent(AWElementIdPath elementIdPath,
                                 AWComponent subcomponent)

Specified by:

putStatefulComponent in interface AWRequestContext._SubcomponentLookup

put

public void put(java.lang.Object key,
                java.lang.Object value)

Specified by:

put in interface AWRequestContext._SubcomponentLookup

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface AWRequestContext._SubcomponentLookup

putFormIds

public void putFormIds(java.lang.String formId,
                       AWArrayManager array)

Maintains the lists of element id's for each form elements keyed by the id of the form itself. Used during applyValues to allow element id tree skipping.

Parameters:

formId - element id of the AWForm

array - list of element id's of all input elements in the AWForm

getFormIds

public AWArrayManager getFormIds(java.lang.String formId)

Given the element id of a form, returns the list of form input element id's for the form.

Parameters:

formId -

hasMultipleForms

public boolean hasMultipleForms()

getDefaultFormId

public java.lang.String getDefaultFormId()

_pageScriptList

public java.util.List _pageScriptList()

hasScript

public boolean hasScript(java.lang.String scriptName)

recordCurrentScript

public void recordCurrentScript(java.lang.String scriptName)

validationContext

public AWValidationContext validationContext()

notifyChange

public final boolean notifyChange()

Notify that AWPoll-relevant changes have taken place (and client should be updated)

Returns:

true if a changeNotifier is in effect

resetHasChanged

public void resetHasChanged()

getChangeNotifier

public AWChangeNotifier getChangeNotifier()

hasChangeNotifier

public boolean hasChangeNotifier()

isPollingInitiated

public boolean isPollingInitiated()

Determines if polling should be initiated for this page.

Returns:

boolean true if polling is enabled.

setPollingInitiated

public void setPollingInitiated(boolean pollEnabled)

Set the flag to initiate polling for this page.

defaultPollInterval

public static int defaultPollInterval()

getPollInterval

public int getPollInterval()

Returns the poll interval for this page. If the value has not been explicitly set, then this method will return the default poll interval value defined by AWApplication.

Returns:

int poll interval in seconds

setPollInterval

public void setPollInterval(int pollInterval)

Overrides the default poll interval as defined by AWApplication.

Parameters:

pollInterval - interval in seconds

pollOnError

public boolean pollOnError()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPreviousResponse

public AWBaseResponse getPreviousResponse()

formValueManager

public AWFormValueManager formValueManager()

hasFormValueManager

public boolean hasFormValueManager()

getCommunityContext

public AWCommunityContext getCommunityContext()

Fetch the community context