OracleJavaScript API Reference for Oracle ADF Faces

 

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlPage

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfPage
               |
               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPage

public class AdfDhtmlPage
extends AdfPage
Page Management class specific to DHTML Implementation



Field Summary

private Object
_accessibilityMode
private static Object
_ACTIVE_DATA_HOT_KEY
private static Object
_ACTIVE_DATA_HOT_KEY_TEXT
public static Object
ACTIVE_DOM_ELEMENT_PROPERTY
private Object
_activeDomNode
private Object
_animationEnabled
private Object
_automationEnabled
private Object
_autoPPRComponents
private static Object
_BLOCKING_DIV_ID
private static Object
_BLOCKING_OPACITY
private static Object
_BROWSER_RESIZE_CHECKPOINT
private Object
_busyCounts
private static Object
_CALLBACK_CHECKPOINT
private Object
_canReceiveActiveDataCount
private Object
_clientIdToComponentMap
private Object
_componentsUpdatedByPollEvent
private Object
_cssSelectorsUncompressed
private static Object
_CUSTOM_PPR_URL_EXPANDO
public static Object
DEFAULT_ACCESSIBILITY_MODE
private Object
_defaultMessageKey
private static Object
_DELAYED_RESIZE_TIMEOUT
private Object
_delayedMessages
private Object
_descendantResizeNotifyList
private Object
_dirtyStateService
private Object
_document
private static Object
_DOCUMENT_STYLE_HOLDER
private Object
_documentClientId
private Object
_dragLastX
private Object
_dragLastY
private Object
_dragStartX
private Object
_dragStartY
private static Object
_ECID
private static Object
_EDITABLE_STYLE
private Object
_editableCallback
private Object
_editableCallbackContext
private Object
_editableSubtreeId
private Object
_editedComponentId
private Object
_eventQueue
private Object
_globalMessagesResetStrategy
private Object
_haveOutstandingPPRRequest
public static Object
INACCESSIBLE_ACCESSIBILITY_MODE
private static Object
_INCOMPLETE_IMAGE_CLASS_NAME
private Object
_inLayout
private Object
_inlineEditor
private Object
_interpretEmptyString
private Object
_jsfAjaxInit
private static Object
_KEYSTROKE_OVERRIDES
private Object
_keyStrokeToCallbackContextMap
private Object
_keyStrokeToCallbackMap
private Object
_lastDomEvent
private static Object
_LAZY_FETCH_ID_PARAM
private static Object
_LOAD_CHECKPOINT
private Object
_loadingComponents
private Object
_messages
private static Object
_MSG_RESET_CLIENT_AND_SERVER
private static Object
_MSG_RESET_SERVER
private static Object
_NAVIGATION_QUERY_PARAMS
private static Object
_NAVIGATION_VIEW_ROOT
private static Object
_NAVIGATION_WRAPPER_ID
public static Object
OUPUTMODE_ATTACHMENT
private static Object
_PAGE_STATE_ID
private Object
_pageProperties
private static Object
_PARSER_DIV_ID
private Object
_pendingStreamingIDs
private Object
_perfProfileEnabled
private Object
_perfProfileLogClosed
private Object
_perfProfileTimingEnabled
private Object
_poppedUpComponentInfo
private Object
_portlet
private Object
_positionBlockingGlassPaneCallback
private static Object
_POSTBACK_CHECKPOINT
private static Object
_POSTSCRIPT_ID_SUFFIX
public static Object
PPR_NAVIGATION_FORCE_PPR
public static Object
PPR_NAVIGATION_ON
private Object
_preloadImages
private static Object
_PRINTABLE_STATE
private static Object
_PRINTABLE_WINDOW_NAME
protected static Object
PushChannelStates
private static Object
_REMOVED_STREAMING_IDS_PARAM
private Object
_replaceJsfAjaxFunctions
private Object
_resizeNotifyMap
private Object
_resizeNotifyTree
private Object
_responseId
private static Object
_RICH_UPDATE_FLAG
private Object
_rootClientId
public static Object
SCREEN_READER_ACCESSIBILITY_MODE
private Object
_scriptLoadingPolicy
private static Object
_SELECTABLE_STYLE
private Object
_selectedEditingComponents
private Object
_seleniumRC
private Object
_serverQueue
private Object
_sessionId
 Object
__shouldTracePPRRequestId
private Object
_startADSClientIdCount
private Object
_startADSClientIds
private static Object
_STATE_PARAM_NAME
private Object
_stopADSClientIds
private Object
_stopGlobalActiveData
private static Object
_STREAMING_COMPLETE
private static Object
_STREAMING_IDS_PARAM
private static Object
_STREAMING_REQUEST_SENT
private static Object
_STREAMING_STARTED
private static Object
_TIMER_CALLBACK
private static Object
_TIMER_CONTEXT
private static Object
_TIMER_DOM_ID
private static Object
_TIMER_ID
private static Object
_TIMER_IS_SYNCHRONIZED
private static Object
_TIMER_STATE
private static Object
_UI_BLOCK_REASON_PPR
private static Object
_UI_BLOCK_REASON_SCRIPT_LOADING
private Object
_uiBlocks
private Object
_validateEmptyFields
private Object
_window
private Object
_windowDetectionStrategy


Fields inherited from oracle.adf.view.js.base.AdfPage

ACTIVE_COMPONENT_PROPERTY, CREATE_VIEW_PHASE, DELIVER_EVENTS_PHASE, EDITABLE_SUBTREE_PROPERTY, EDITED_COMPONENT_PROPERTY, SELECTED_EDITING_COMPONENTS_PROPERTY, UPDATE_VIEW_PHASE, WAITING_FOR_USER_INPUT_PHASE


Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass


Fields inherited from org.ecmascript.object.Object

prototype


Constructor Summary

public
AdfDhtmlPage(Object lookAndFeel, Object domWindow)
Page Management class specific to DHTML Implementation


Method Summary

public Object
addBusyStateListener(Object instance, Function listener)
Adds a listener to be invoked whenever there is a busy state event.
public Object
addComponents(Object components)
Add the list of components as varargs to be managed by the Page
private Object
_addDelayedMessages(Object showMessages)
Allow lazy content loaded components to ensure all messages for its children components are added once the children's client components are loaded.
public Object
addEventListener(Object eventType, Object listener, Object instance)
public Object
addMessage(String componentId, AdfFacesMessage facesMessage, Object toBeRemoved)
Adds a Message to AdfDhtmlPage's message queue.
private Object
_addPageId(Object headerParams)
private Object
_addPageStateIdField(Object id)
private static Object
_addPageStateIdParameter(Object formElem, Object params)
public Object
addPartialTargets(Object components)
Adds the components to the set of components that will be redrawn on the next communication with the server.
private Object
_addPendingStreamingIDs(Object arr, Object params)
Object
__addPopupInfo(Object component, Object popupInfo)
Called by AdfRichUIPeer to inform the page of popped up content
public Object
addPropertyChangeListener(Object instance, Function listener)
Adds a PropertyChangeListener with the specified instance and listener function
public Object
addResource(Object type, Object value)
Adds either a JavaScript script or CSS link to the page.
static Object
__addServerParamsToEvent(Object event, Object params)
A back door for a peer to add extra parameters to an event by attaching them to the event object.
private static Object
_addStateParameter(Object formElem, Object params)
boolean
__alert(String title, String message, Function callback)
Launches a modal inline popup alert dialog.
public Object
announceToAssistiveTechnology(Object message, Object onlyIfChanged)
Issues an announcement for AT users using our "status" live region.
private Object
_appendParameter(Object form, Object name, Object value)
private Object
_appendResponseId(Object url)
Append response identifier to the URL.
private static Object
_appendUrlFormEncoded(Object buffer, Object key, Object value)
Object
__applyNewPageStyleSheets(Object newStyleSheetURIs)
Called by the server to apply any new skin stylesheets when ppr navigating This function determines the current set of skin style sheets, intersects the result with the new set of style sheets and makes any changes.
private Object
_applyRichResponse(Object documentElement, Object needsUnescape, Object isStreaming, Object reqContext)
Applies rich postback response
private Object
_areComponentsLoaded()
Loop over the loading components, returning true if all of them are loaded.
public Object
areCssSelectorsUncompressed()
Tests if css selector compression is disabled for the page.
private Object
_areSynchronousTimersCleared()
Used in isSynchronizedWithServer to wait for timers which need to considered.
private Object
_attemptToRelayoutForNewlyCompleteImages()
private Object
_blockUI(Object block, Object reason)
Prevents the user from interacting with the client UI.
private Object
_broadcastBusyStateEvent(Boolean newBusyState)
=-= Unsupported, internal implementation method.
static Object
__callTimerCallback(Object timerId)
Calls the callback specified for the timer in the correct state.
public static Object
cancelAllPopupsCallback(Object currComponent, Object callbackParameters)
This callback can be passed to ComponentsInSubtreeCallback in order to cancel popups
public Object
cancelTimer(Object timerId)
Cancels the firing of the specified timer.
private Object
_checkCoreBackgroundLoaded(Object forceLoad)
private Object
_checkDirtyDataComponents()
public Object
checkRegionUncommittedData(Object regionClientIds, Object message)
Displays uncommitted data warning for regions.
private Object
_checkResizeNotifyCallback()
private Object
_checkResizeNotifyDelayed()
Object
__checkRichResponseDirty()
public Object
checkUncommittedData(Object regionMessageCallback)
Displays uncommitted data warning if <af:document> has uncommittedDataWarning="on", and the page contains uncommitted data (either on the client or on the server).
private Object
_clearAllDelayedMessages()
Clears all of the delayed messages for a particular page.
public Object
clearAllMessages()
Clears all of the messages for a particular page.
private Object
_clearDelayedMessages(String componentId)
Clears delayed messages array for a component id
Object
__clearDnDContext()
private Object
_clearFloatingDiv(Object floatingDiv)
Removes the conteiner content of the floating div
public Object
clearMessages(String componentId)
Clears a messages for a particular component id.
private Object
_clearStatusRegion()
public Object
clearSubtreeMessages(String rootId)
Clear the messages for a subtree of components, including the root of the subtree
private Object
_collectCss()
private Object
_collectPostbackParams(Object actionForm, Object eventTargets)
protected Object
ComponentsInSubtreeCallback(Object targetDomElement, Object callback, Object callbackParameters)
Calls the callback for components in the subtree
boolean
__confirm(String title, String message, Function callback, int timeout, Object disableCancel)
Launches a modal inline popup confirm dialog.
public Object
confirmNavigation(Object token, Object isPartial)
This method gets called when the user should be asked to confirm server-side navigation.
public Object
createFloatingDiv(Object parent, Object zIndex, Object className)
Creates a floating div with the specified zIndex and style class for the included span
private Object
_createGlassPane(Object ownerDocument)
private Object
_createLink(Object href, Object extraProps)
Creates a link with the specified href, adding on any extra properties as attributes
public Object
createMaskingFrame(HTMLElement element)
Creates a masking IFrame underneath a floating element.
private Object
_createStyle(Object content)
public Object
decrementPendingAnimation()
Remove one from the number of pending animations.
private Object
_delayedOnResize()
private Object
_delayMessageForComponent(Object componentId, Object facesMessage, Object title)
Add a message as delayed since the target client component is not available
private Object
_deliverAllQueuedEvents()
public Object
deliverEventToNewWindow(Object event)
Delivers a single event synchronously to a new window.
private Object
_deliverQueuedEvents()
Deliver queued events to their sources for broadcast
private void
_deliverQueuedServerEvents(boolean checkEventAndDelta, boolean pageUnloading)
Deliver all of the events in the server event queue.
private static Object
_descendantResizeNotifyListComparator(Object itemA, Object itemB)
private Object
_detectSeleniumRC()
private Object
_disableUncommittedWarnings()
private Object
_displayRegionUncommittedDataWarning(Object message)
private Object
_displayUncommittedDataWarning(Object message)
protected Object
Dispose()
Tear down the Rich Client environment
private static Object
_disposeIFrames(Object domDocument)
Cleanup code to remove all IFrames This cleans up IFrame leaks in IE
private Object
_disposeTimers()
Clean up all of the outstanding timers
Object
__doDescendantResizeNotify()
=-= Unsupported, internal method per Andy and Blake discussion.
private Object
_doDescendantResizeNotifyOnQueue(Object descendantResizeNotifyQueue)
private static Object
_doFrameBusting(Object newLocation)
private Object
_doFullPostback(Object formElement, Object params, Object blockUI, Object responseExpected)
public Object
doRedirect(Object url, Object noNavigation)
Redirects to a supplied url
public Object
doResizeNotify(AdfUIComponent component)
Performs the resize notify traversal on the subtree rooted at the specified component.
private Object
_doResizeNotify(Object domNodes)
private static Object
_doResizeNotify(Object node, Object forceResize, Object checkAll)
public Object
doResizeNotifyDom(Object domNode, Object forceResize)
Performs a resize notify traversal for the subtree rooted at the specified DOM node.
private Object
_doResizeNotifyDomChildren(Object domNode, Object resizeNotifyNode, Object checkDescendents)
private Object
_doRichPostback(HTMLElement formElement, Object params, Object headerParams, Object blockUI, Object context, Array<String> eventTargets)
Perform a rich postback
private Object
_dragKeyDown(Object evt)
private Object
_dragMouseMove(Object evt)
private Object
_dragMouseUp(Object evt)
private Object
_dtsStateChanged()
Object
__enableDirtyPostbackPayloads()
Object
__ensureCoreBackgroundLoaded()
private static Object
_eraseCookie(Object domDocument, Object name)
Erase the cookie, by setting its expiration to a past time.
private Object
_eventLoopDeliverEvents()
Called from the event loop to dispatch events to the components and server
private static Object
_extractInstructionXML(Object responseText, Object element)
private Object
_filterComponent(Object component, Object domElement, Object filterFunction, Object filterContext)
private Object
_filterEditableSubtree(Object subtree, Object filterFunction, Object filterContext)
Recursively add all of selectable and editable the styles from a subtree
public AdfUIComponent
findComponent(String clientId)
Retrieves a component by its clientID.
public AdfUIComponent
findComponentByAbsoluteLocator(String absoluteLocator)
Retrieves a component by its absolute locator.
private Object
_findComponentByAbsoluteLocator(Object componentId, Object absoluteLocator)
Given a componentId and absoluteLocator, return the component with that absolute locator.
public AdfUIComponent
findComponentOrAncestorByAbsoluteLocator(String absoluteLocator)
Retrieves a component or one of its ancestors by its absolute locator.
private HtmlElement
_findFirstAdfForm()
private Object
_fixupLinkOnClick(Object element)
public Object
flushToAssistiveTechnology()
private static Object
_forceGC(Object count)
Code for forcing a GC
private Object
_forcePreloadOfAllImages()
static Object
__frameBusting(Object frameBusting)
public Object
getAccessibilityMode()
Returns the accessibility mode.
public AdfUIComponent
getActiveComponent()
Returns the AdfUIComponent with the current focus
public String
getActiveComponentId()
Returns the id of the currently focused component on the page.
public Object
getActiveDataSupport()
public Node
getActiveDomElement()
Returns the DOM Element with the current DOM focus
public Object
getAllMessages()
Return an object containing all messages keyed by componentID and containing an array of FacesMessages.
private Object
_getAndClearDeltas(Object doClear)
public String
getAsynchronousUpdatesState()
Gets the state of Asynchronous updates for the page.
public AdfAutoDismissalManager
getAutoDismissalManager()
Returns the autoDismissal manager for this page.
private Object
_getClientIdFromComment(Object comment)
Returns the clientId, if any, represented by a DOM comment Node
public Object
getClientIdsWithMessages(Object rootId)
Return an array of the client identifiers for which at least one FacesMessage has been queued.
public Object
getClientIdToComponentMap()
Internal function for retrieving a named map of client IDs to client components.
private Object
_getComponentFromComment(Object comment)
Returns the component, if any, represented by a DOM comment Node
public Object
getComponentIdsUpdatedByPollEvent()
Returns a list of components ID that were update by the last Poll event.
public Object
getComponentsByType(Object componentType)
Returns an array of component instances, whose component type matches the argument.
private static Object
_getCookie(Object domDocument, Object name)
Returns the value of a cookie or null if the cookie doesn't exist.
public AdfDataTransferService
getDataTransferService(Object noCreate, Object adsDTS, Object uploadDTS)
Returns the AdfDataTransferService instance for this page.
public String
getDefaultMessageHandlerComponentId()
Retrieves the component ID that is the default message handler (for global messages).
private Object
_getDefaultPostbackURL()
private Object
_getDelayedResizeCallback()
private Object
_getDirtyRegionIds()
Returns an array or client Ids for regions that have uncommitted data or null if there is none
public Object
getDirtyStateService()
public Object
getDnDContext()
Returns the current Drag and Drop context, associated with the page
public Object
getDocument()
Returns the DOM Document that the AdfPage is associated with
public String
getDocumentClientId()
Internal function to retrieve the document component's client ID.
public Object
getDomDocument()
public Object
getDomWindow()
private Object
_getEditableEventTargetComponents(Array<String> eventTargets)
Given an array of event target ids, returns a non-null array containing any corresponding AdfUIEditableValue components.
public AdfUIComponent
getEditableSubtree()
Returns the root of the component subtree that inline-editing is allowed on
private Object
_getEditableSubtrees(String subtreeId, boolean returnAnchors)
Given a DOM id, return all of the subtrees that should be inside this subtree.
public AdfUIComponent
getEditedComponent()
Returns the current component being edited.
private Object
_getExistingStyleSheetElements()
returns the array of stylesheet LINK elements in the head
public Object
getFacesPath()
Internal method to retrieve the faces path for the page.
public Object
getFailedConnectionText()
Gets the text to display in an alert if the XMLHttpRequest fails.
private Object
_getFilterResult(Object component, Object filterFunction, Object filterContext)
private Object
_getFirstElementFromFragment(Object fragmentNode, Object needsUnescape)
private static Object
_getFirstElementWithId(Object domNode)
private Array<HTMLElement>
_getFocusPath()
Returns the current focus path, divorced of the actual DOM elements, so that the focus can be reapplied after the DOM has changed.
private static Object
_getFormElement(Object component)
Returns the form element for a component
public Object
getGlassPane()
Returns the GlassPane, creating it if it hasn't already been created
private Object
_getHead()
Object
__getLastDomEvent()
Get access to the last DOM event that was fired by the browser
public HTMLElement
getLastFocusedElement(Object element)
Gets the last focused element.
public Object
getLazyFetchURI(Object id)
Returns a URI for a lazy fetch request (used for loading Rich Text Editor's IFRAME)
private Object
_getLinkChildren(Object ancestor)
private Object
_getMaxType()
public String
getMessageHandlerSlaveComponentId()
Retrieves the component ID that is the slave to the default message handler (provides configuration attributes that the default handler can consume).
public Array
getMessages(Object componentId)
Get FacesMessage objects associated with a particular component.
public AdfDhtmlModalityManager
getModalityManager()
Returns the modality manager for this page.
public Object
getOutputMode()
Called by server to set the outputMode
public Object
getPageId()
get the page instance Id
public Object
getPageProperty(Object propertyName)
Gets the value of a page property.
public int
getPageStateId()
private Object
_getParameterElement(Object form, Object name)
public AdfDhtmlPositionManager
getPositionManager()
Returns the position manager for this page.
private Object
_getPostbackContent(HTMLElement actionForm, Object params, Array<String> eventTargets)
Returns the payload to include in the rich postback
public Object
getPPRNavigationOptions()
Retrieves PPR Navigation options
private Object
_getPPRURL(Object element)
private Object
_getPublicAncestor(Object component)
private Object
_getQueryParamsFromActionUrl()
public Object
getResourceURL(Object path)
Returns the resource URL for the given path.
public Object
getResponseIdentifier()
Returns an identifier for the previous response if one is available.
public String
getRootClientId()
Returns the value of the rootClientId, if set
private Object
_getScriptLoadingService()
public Array<AdfUIComponent>
getSelectedEditingComponents()
Returns the array of AdfUIComponents currently selected for inline editing, or null if no AdfUIComponents are selected.
public Object
getSessionIdentifier()
Returns an identifier for the current middle-tier session if one is available.
Object
__getSessionTimeoutHelper()
Gets the helper object that manages session timeout
private Object
_getSubtreeRootNode(Object rootId)
public Object
getUncommittedRegionIds()
Determines which regions (if any) contain uncommitted data.
Object
__getUserInactivityTimeoutHelper()
Return an instance of AdfUserInactivityTimeoutHelper if user inactivity timeout feature is enabled.
public Object
getViewId()
Returns an identifier for the current view being displayed in the page.
public Object
getWindowId()
convenience method for getting the window ID, i.e.
public AdfDhtmlZOrderManager
getZOrderManager()
Returns the z-order manager for this page.AdfDhtmlPage().
private Object
_handleBeforeUnload(Object evt)
the onbeforeunload event handler we attach to window
Object
__handleGlobalError(String msg, String url, int line)
This method is caleld from the onerror handler used when test automation is enabled (see bug #9939286)
private Object
_handleInvalidPprResponse(Object responseText, Object requestContext, Object requestEvent)
Called when we receive invalid (non-XML) response to PPR or streaming request
private Object
_handleKey(Object event)
Checks whether the key matches a registered global key handler
private Object
_handleNavigation(Object url, Object target)
Handle GET request triggered by clicking Faces navigation components.
Object
__handleNavigationClick(Object evt, Object url, Object target)
onclick event handler for Faces navigation components with GET request, here we only handle it if left button is clicked by clalling _handleNavigation, otherwise let the browser to handle it.
void
__handleReload()
This is called from two locations to force the page to be reloaded:
private Object
_handleResize()
Called when the window is resized
private Object
_handleRichResponse(Object responseDocument, Object reqContext)
Object
__handleRichResponseAction(Object action, Object pprAction)
private Object
_handleRichResponseFragment(Node fragmentNode, Array<HTMLElement> resizeDomNodes, Object domReplacedIds, Boolean needsUnescape, Array<HTMLElement> savedFocusPath, Boolean isStreaming)
Handles a single fragment node in a rich response.
private Object
_handleRichResponseLibrary(Object scriptNode)
private Object
_handleRichResponseScript(Object scriptNode)
public Object
handleStreamingResponse(Object doc, Object id, Object needsUnescape)
Called when a single streaming data fragment has arrived This function will be called form a script block embedded in the XHTML content sent over the streaming IFRAME
public Boolean
hasMessages(String componentId)
Returns true if this particular component has messages or false if it does not.
public Object
hideFloatingDiv(Object floatingDiv)
Hide's a floating Div and cleans out its content
public Object
hideGlassPane(Object listenerMap)
Hide the GlassPane, removing all of the listeners in the listener map
public Object
incrementPendingAnimation()
Add one to the number of pending animations.
protected Object
Init(Object lookAndFeel, Object domWindow)
Initializes the instance.
protected static Object
InitClass()
Initializes the AdfDhtmlPage class
Object
__initializeSessionTimeoutTimer(Object timeout, Object warningBeforeTimeout, Object newSessionURL)
Initializes the session timer on the client side, and shedules showing the session timeout warning and final timeout dialog.
Object
__initUncommittedDataWarningForDocument(Object enabled)
Initializes uncommitted data warning facility for the document
Object
__initUserInactivityTimeout(Object userInactivityTimeout)
Called by "DocumentRenderer" to initialize the user inactivity timeout for active components, like and ADS.
private Object
_inlineSelectionListener(Object event)
Event capture listener used to select and start editing of components when we are in editing mode
private static Object
_inlineSelectionStub(Object event)
Event capture stub used with in-place editing.
private static Object
_insertReduce(Object state, Object createURL)
Reduce callback for inserting new skin stylesheets
private Object
_installBlockingHandler(HTMLDocument ownerDocument)
Creates a blocking pane, masking frame and installs keyboard blocking.
private Object
_intersectSelectionWithEditableSubtree(AdfUIComponent editableSubtree, Object selection)
Given the proposed selected components, returns an array of those that are in the editable subtree.
private Object
_intersectSelectionWithEditableSubtreeDom(Object editableSubtreeDom, Object selection)
Given the proposed selected components, returns an array of those that are in the editable subtree.
public Object
isActiveDataSupported()
private Object
_isAdfForm(Object form)
private Boolean
_isAncestorComponent(AdfUIComponent possibleAncestor, AdfUIComponent possibleChild)
Returns true if the possibleAncestor is an ancestor of component
private Boolean
_isAncestorComponentOrSelf(AdfUIComponent possibleAncestor, AdfUIComponent possibleChild)
Returns true if the possibleAncestor is an ancestor of component or the component iself.
public Object
isAnimationEnabled()
Tests if animation is enabled for the page.
public Object
isAttachmentMode()
Tests whether the page is running in attachment output mode.
public Object
isAutomationEnabled()
Tests if automation is enabled for the page.
private Boolean
_isComponentInlineSelectable(HTMLElement componentDomElement)
Determines whether the component is inline selectable based on the presence of style classes on the component's DOM
public boolean
isCoreBackgroundScriptLoaded()
Object
__isDirtyPostbackPayloadsEnabled()
public Object
isDragging()
Determines whether a drag operation is in progress
public Boolean
isPageFullyLoaded()
Automation tools such as selenium use this function to verify that our rich page has successfully loaded.
public Boolean
isPageOnloadCalled()
public Boolean
isPerformingFullSubmit()
public Boolean
isPortlet()
Returns whether or not this Page is in a Portlet context based on an internal flag.
public Boolean
isPPRNavigationEnabled()
Returns whether or not PPR-Navigation is enabled.
private boolean
_isPrintablePage()
public Object
isProcessingIndicatorDisplayed()
Returns whether the processing indicator is displayed or not
private Object
_isRichResponseDirty()
public Object
isScreenReaderMode()
Tests whether the page is running in screen reader mode.
Object
__isSeleniumRC()
Tests whether we are running under Selenium RC.
private Object
_isSeleniumRCWindow(Object domWindow)
public Object
isStreamingDisabled()
Determines whether table data streaming is disabled
public Object
isStreamingRequestPending(Object id)
public Boolean
isSynchronizedWithServer()
The logic for checking for completion of a full page postback has been combining with the logic to check for a partial page postback.
private Object
_isTrackingDirtyData()
private Object
_isTrackingDocumentUncommittedData()
private Object
_isTrackingRegionClientUncommittedData()
private Object
_isTrackingRegionUncommittedData()
private Boolean
_isUIBlocked(Object reason)
Returns whether the UI is currently blocked in the rich page.
private Object
_isUncheckedInput(Object inputElement)
public Object
isUserActivityMonitoringOn()
private Object
_jsfAjaxAddOnError(Object callback)
private Object
_jsfAjaxAddOnEvent(Object callback)
private Object
_jsfAjaxRequest(Object source, Object event, Object options)
private static Object
_keyEventCallback(Object event)
Static stub callback for ensuring that we have an event and using the correct "this"
public Object
launchHelpWindow(Object url)
Method that will launch the help window given a url.
private Object
_loadBackgroundScript(Object source)
Object
__loadCoreBackgroundScript(Object url)
private Object
_loadCss(Object source)
private Object
_loadScript(Object source)
private Object
_loadSynchronousScript(Object source)
public Object
loadView(Object viewId, Object params, Object loadId, Object pageId)
This function is called by AdfNavigationHistoryAgent when it needs to load a new view
public Object
localNavigate(String uri)
Issue a GET request for a local page and perform a page transition.
public Object
logAsGlobalError(Object e)
private Object
_logAsGlobalError(Object e)
public Object
mapComponent(Object clientId, Object component)
Adds a component to the clientID map.
private Object
_mapInputElementToComponent(Object inputElement)
Object
__markSeleniumRC()
Called our Selenium RC-specific user-extensions.js code to let us know that we are running under RC.
private Object
_marshallMultipleEventParameters(Object paramList)
private Object
_mergeFormParamValues(Object oldValue, Object newValue)
public Object
moveMaskingFrame(Object element, Object maskFrame)
Moves a masking IFrame underneath a floating element.
private Object
_navResetPage()
public Object
needsWindowUnload()
Mark that this page needs windowUnloaded events.
private Object
_nodeListToArray(Object nodeList)
private Object
_notifyComponent(Object componentId, Object messageArray)
Notifies a component that it's message queue has changed
private Object
_notifyComponentEventListeners(Object componentEvent)
void
__notifyReturnFromDialog()
Called when the DialogService closes the dilaog programmatically within a partial request.
Object
__notifyWindowCloseImmediately(Object windowClosed, Object returnId)
this method notifies the server about window closed event.
private Object
_notifyWindowEvent(Object isWindowOpen, Object windowId, Object pageId, Object isDialog)
build the notify window open/unregister event and queue the event this function puts the event information into the global variable _windowEventHeaderMap, which afterwards got cleaned up by deliverQueuedServerEvents()
private Object
_notifyWindowOpened(Object isDialog)
public void
notifyWindowUnloaded()
Send window-unloaded notification if necessary
private Object
_notifyWindowUnregistered(Object windowId, Object pageId)
Object
__onLoad()
Called when the window first loads.
private Object
_onLoadPerfTimings()
private Object
_onResize()
private Object
_onSelectStart()
Cancel drag selection if we're already dragging
public Object
pageIdNotSavedWithURI()
Specifies that page Id should not be saved with the URI
Object
__perfTimings(Boolean closeRecord, Boolean closeBefore, Boolean timing, String str1, String str2)
For performance timings.
private Object
_positionBlockingGlassPane(Boolean assumeVisible)
Position the blocking pane to fill the visible area of the window.
private Object
_positionGlassPane(Boolean assumeVisible)
Position the GlassPane to fill the visible area of the window.
private Object
_postOrderPopulate(Object targetNode, Object depth, Object depthArrays, Object ignoreHidden)
private Object
_postOrderPopulateComponent(Object clientId, Object depth, Object depthArrays)
public Object
preloadImages()
Requests that the page attempt to preload/force loading for all images present in the DOM on document ready.
private Object
_prepareForIncompleteImages()
public void
prepareMaskingFrame(HTMLElement element)
Makes sure that a masking frame is available in the maskFramePool, in anticipation of an upcoming call to createMaskingFrame method.
private Object
_processValidators(Object sourceComponent, Object eventRoots, Object onlyImmediate)
private Object
_pushEditableComponent(Array<AdfUIEditableComponent> editableComponents, String clientId)
Determines whether the specified client id corresponds to an AdfUIEdtiable component and if so pushes it into an array.
Object
__queueDescendantResizeNotifySource(AdfUIComponent component)
=-= Unsupported, internal method per Andy and Blake discussion.
public Object
queueEvent(Object event)
Queues the specified event for delivery during the next event delivery phase.
Object
__queueEventTimerIfNeeded(Object timeout)
Queue a timer to run the event thread.
public Object
queueEventToServer(Object event)
Queues an event for later delivery to the server
private void
_reattachInlineEditing(Array pendingEditableSubtrees)
Filters pending editable subtree notes after the complete response has been applied to the document.
private void
_redistribute(HTMLDomEvent event)
Converts the native dom event into a AdfComponentEvent that is queueed and then sent to the target component.
Object
__registerDescendantResizeNotifyComponent(AdfUIComponent component)
=-= Unsupported, internal method per Andy and Blake discussion.
public Object
registerDirtyDataComponent(AdfUIComponent component, Object level)
Registers a component with special dirty data handling.
private Object
_registerGetRequestNavigationTracking()
public Object
registerKeyStroke(AdfKeyStroke keystroke, Function callback, Object callbackContext)
Registers a global keyboard shortcut/accelerator.
public Object
registerLoadingComponent(AdfUIComponent component)
Registers a component that isn't fully loaded on creation with the framework.
Object
__registerRegionClientUncommittedDataTracking(Object clientId)
public Object
registerResizeNotifyComponent(AdfUIComponent component)
Register a component to recieve resize notification when the browser window is resized.
private static Object
_removeAllFormElements(Object formObject)
remove all form elements, such as inputs requires a valid form object to be passed in
private Object
_removeBlockingHandler(HTMLDocument ownerDocument)
Removes the blocking pane and masking frame.
public Object
removeBusyStateListener(Object instance, Function listener)
Removes a listener so that it will no longer be invoked whenever there is a busy state event.
public Object
removeComponentsInSubtree(Object targetDomElement)
Removes all of the componetns in the subtree specified by the clientId
public Object
removeEventListener(Object eventType, Object listener, Object instance)
public Object
removeMaskingFrame(Object maskFrame)
Removes the masking IFrame underneath a floating element.
public Object
removePageResources()
Removes CSS resources added to the page via af:resource during a PPR navigation to ensure styles from one page are not carried over to the next.
Object
__removePopupInfo(Object component, Object popupId)
Called by AdfRichUIPeer to inform the page that a component is no longer popped up
public Object
removePropertyChangeListener(Object instance, Function listener)
Removes a PropertyChangeListener with the specified instance and listener function
private static Object
_removeResourcesByTagName(Object tagName, Object head)
Removes all of the resources with the specified name form the head section
public Object
removeResourceURL(Object resourcePath)
Returns the URL minus the resourceURL for the given path Note:
private Boolean
_removeStyleFromComponent(String clientId, String styleClass)
Removes the style class from the component with the specified client id and returns whether it actually removed the style class
Object
__replaceDomElement(HTMLElement newElement, HTMLElement oldElement)
Replaces the a dom element contained in a peer.
private Object
_replaceJsfAjaxFunctions()
Replaces the jsf.ajax public API functions so that we can have JSF2 requests and responses channel through the rich client framework and honer queuing, client events and other rich framework architecture
public Object
requestStatusChanged(Object requestEvent)
public Object
rescheduleTimer(Object timerId, Number delay)
Reschedules the timer to fire delay</coee> milliseconds in the future
private Object
_resetPendingStreamingIDs()
private void
_resetPerformingFullSubmit()
Called from a scheduled timeout from a full page postback that doesn't expect a response to reset the flag.
private Object
_resetUncommittedIds()
private Object
_resolveMessageComponentId(String componentId, Boolean useDefaultAsFallback)
Calculate the id of the component to show message associated with component whose id is componentId.
private Object
_restoreFocusPath(Array<HTMLElement> focusPath, Object maxIndex)
Restores the focus to the best focusable element based on the focusPath
private Object
_restorePreviousUserActivityData()
Called during onload or when a PPR navigation of the entire view root / document occurs.
private Object
_richResponseComplete(Object reqContext)
private Object
_richResponseCompleteCallback(Object reqContext)
private Object
_richUpdateComplete(Object resizeDomNodes, Object domReplacedIds, Object pprNavParams, Object reqContext, Object savedFocusPath, Object pendingEditableSubtrees, Object oldActiveComponents)
private Object
_richUpdateCompleteCallback(Object state)
public Object
scheduleTimer(Object context, Function callback, Object state, Object delay, Object options)
Schedules a callback to be fired in the future.
private Object
_scriptLoadingStatusChange(Object status)
static Object
__scrollComponentIntoView(Object clientId, Object focus)
Private function used from the server to scroll a component into view.
private static Object
_scrollComponentIntoView(Object argObj)
Private function to be called from a timer
private Object
_scrubPartialTargets(Object oldPartialTargets)
Returns a scrubbed partial targets array with any clientIds that are no longer in the DOM removed.
private Object
_sendJsfAjaxEvent(Object type, Object params)
private Object
_sendRichPayload(Object params, Object context)
public Object
sendStreamingRequest(Object pageStateId, Object iDs)
sends streaming requtest over an IFRAME
public Object
setAccessibilityMode(Object mode)
Sets the accessibility mode.
private Object
_setActiveComponentId(Object clientId)
Sets the page's active component to the component with the specified id.
Object
__setActiveDomNodeInfo(HTMLElement domNode, string clientId)
Sets the currently focused DOM Node and the clientID of the focused component Package private method, needed for cases where there's another document and the _redistribute method is not called.
private Object
_setActiveTimeout(Object argObj)
public Object
setAnimationEnabled(Boolean enabled)
Sets the accessibility mode.
Object
__setAsynchronousUpdatesState(String state)
Sets the asynchronous update's state
Object
__setAutomationEnabled(Boolean enabled)
Sets the automation mode.
private static Object
_setCookie(Object domDocument, Object name, Object value, Object expiresAfter, Object path)
Sets the value of a cookie on the page.
Object
__setCssSelectorsUncompressed(Object disabled)
Sets the compression mode for css selectors.
public Object
setDataDirty(Object isDirty)
public Object
setDefaultMessageHandlerComponentId(String id, String slaveId)
Sets the component id for global messages.
Object
__setDirtyRegions()
This method is called by the DirtyRegionTracker on each request.
public Object
setDocumentClientId(Object documentClientId)
public Object
setEditableSubtree(AdfUIComponent newEditableSubtree)
Sets the root of the component subtree that inline-editing is allowed on.
public Object
setEditableSubtreeFilter(Function callback, Object context)
Sets the filter applied to all components in the editable subtree.
public Object
setEditedComponent(AdfUIComponent newEditedComponent, Event event)
Attempts to start editing on the specified component with an option DOM event as the editing trigger.
public Object
setExpectedWindowId(Object windowId)
public Object
setFacesPath(Object path)
This method is called by the DocumentRenderer during page initialization
Object
__setGlobalMessagesResetStrategy(Object strategy)
Sets the strategy that determines when global messages are to be cleared
public Object
setHelpWindowName(String windowName)
Method that will set the help window name.
public Object
setLastFocusedElement(Object element)
Sets the last focused element.
static Object
__setNonHtmlResponse(Object event)
Forces an event to be submitted as a full-page event and mark it as one whose response will never be received by this framework (Excel export, file download)
static Object
__setNonHtmlResponsePartialSubmit(Object event)
In some instances an event will need to be forced to partial (ExportCollectionActionListener is one such case).
public Object
setOnLoadCallback(Object onLoadCallback)
Sets the onLoad callback to fire when the AdfPage has finished loading.
Object
__setOutputMode(Object outputMode)
Called by server to set the outputMode
public Object
setPageId(String pageId)
set the page instance id
public Object
setPageProperty(Object propertyName, Object propertyValue)
Sets the value of a page property.
public Object
setPageStateId(Object id)
Updates the client with the new Page object id
private Object
_setParameter(Object form, Object name, Object value)
public Object
setPortlet(Boolean flag, Object rootClientId)
Setter for internal variable
public Object
setPPRNavigationOptions(Object options)
Sets PPR Navigation options
public Object
setProcessedRoots(Object ids, Object immediateOnly)
Object
__setResponseIdentifier(Object responseId)
Called by response handling code to save the ECID
private Object
_setRichResponseDirty(Object isDirty)
public Object
setScriptLoadingPolicy(Object policy)
Sets the library loading policy used by AdfScriptLoadingService.
public Object
setSelectedEditingComponents(Array<AdfUIComponent> newSelection)
Sets the array of AdfUIComponents for inline selection.
private Object
_setSelectedEditingComponents(Array<AdfUIComponent> newSelection)
Sets the array of AdfUIComponents for inline selection.
Object
__setSessionIdentifier(Object sessionId)
Called by server to set the session indentifier
Object
__setShouldInterpretEmptyStringSubmittedValuesAsNull(Object interpretEmptyString)
Called by server to specify if the client validation should interpret an submitted empty strung as NULL
Object
__setShouldTracePPRRequestId(Object tracePPRRequestId)
Set the flag to control whether we should trace request id on PPR request.
Object
__setShouldValidateEmptyFields(Object validateEmptyFields)
Called by server to specify if the client validation should validate empty fields
public Object
setStreamingDisabled(Object disabled)
Specifies whether table data streaming should be disabled
Object
__setViewId(Object viewId)
Called from the server DocumentRenderer when a full page render or a PPR Navigation occurs.
void
__setWindowDetectionStrategy(Object option)
This page flag is used to determine the strategy used by window detection.
public Object
setWindowId(String windowId)
set the window id
public Object
shouldInterpretEmptyStringSubmittedValuesAsNull()
Checks if the client validation should interpret an empty submitted value should be handle as .NULL.
private Object
_shouldPostbackValue(Object inputElement, Object editableEventTargetComponents)
public Object
shouldTracePPRRequestId()
Checks whether we should trace request id on PPR request.
public Object
shouldValidateEmptyFields()
Checks if the client validation should handle empty field validation.
public Object
showFloatingDiv(Object floatingDiv, Object floatingContent)
Shows the content from the floating content in the specified floating Div at the specified location
public Object
showGlassPane(Object listenerMap, Object cursor)
Show the GlassPane, adding all of the listeners in the listener map and setting the cursor to the specified CSS-3 cursor
public Object
showMessages(String componentId)
Displays the messages to the user.
public Object
showPageProcessingIndicator(Object show)
Displays a processing indicator for the entire page that is useful when and application developer wants to relayout the entire page
public Object
startActiveData()
public Object
startDrag(Object evt, Object moveCallback, Object dropCallback, Object abortCallback, Object showGlassPane)
Initiates drag operation
private Object
_startGlobalActiveData()
Part of interlock called by components to prevent active data from being delivered until the component is in its initial state ready to receive data
public Object
stopActiveData()
private Object
_stopAutoPPR(Object clientId)
notifies the active data manager to stop delivering events for the specified autoPPR component
public void
stopDrag()
Terminates the drag operation.
private Object
_stopGlobalActiveData()
Part of interlock called by components to prevent active data from being delivered until the component is in its initial state ready to receive data.
public Object
streamingResponseComplete()
Called after all streaming fragments have arrived This function will be called from the IFRAME's onload handler
public Object
streamingResponseStarted()
A call to this script is rendered at the beginning of the streaming document.
public Object
streamingResponseWritten()
A call to this script is rendered just before the end of the streaming document.
private Object
_stripSubId(Object id)
private static Object
_styleSheetMapper(Object map, Object value)
Reduce callback for building a map of href->element for skin links
private Object
_throwSavedErrors()
private static Object
_timerDeliverEvents()
Static function called from timer to dispatch events to the components and server if no UI event has occurred recently
private Object
_toUrlEncodedForm(Object formParams)
private Object
_unfilterEditableSubtree(Object subtree)
Recursively remove all of selectable and editable the styles from a subtree
public Object
unmapComponent(Object clientId)
Removes a component from the clientID map
Object
__unregisterDescendantResizeNotifyComponent(AdfUIComponent component)
=-= Unsupported, internal method per Andy and Blake discussion.
private Object
_unregisterGetRequestNavigationTracking()
public Object
unregisterKeyStroke(Object keystroke, Object clientId)
Unregisters a global keyboard shortcut/accelerator.
public Object
unregisterLoadingComponent(AdfUIComponent component)
Unregisters a component registered with registerLoadingComponent.
Object
__unregisterRegionClientUncommittedDataTracking(Object clientId)
public Object
unregisterResizeNotifyComponent(AdfUIComponent component)
Unregister a component so that it will no longer receive resize notifications.
public Object
updateAutoPPRComponents(Object pageId, Object clientIds)
Called by server to register one or more clientIds as representing server components on which auto-PPR will be performed.
private Object
_updateDeliveryTimer(Object timeout)
Called to reset the timer that will deliver the events
public Object
updateStartActiveDataStateChange(Boolean modelChanged, String clientId)
Updates the sets of components to start active data on, ensuring that the sets of components to start active data on and stop active data on are disjoint.
public Object
updateStopActiveDataStateChange(String clientId)
Updates the sets of components to stop active data on, ensuring that the sets of components to start active data on and stop active data on are disjoint and queueing a stop event if necessary
public Object
updateStreamingViewState(Object doc, Object id)
Called after the block with the current view state has been delivered over the streaming IFRAME This function will be called from a script block embedded in the XHTML content sent over the streaming IFRAME
private Object
_updateViewState(Object fragmentNode)
boolean
__validateWindowId(Object id)
This function is called from the onload script of the document for the IE browser to capture a Ctrl+N that has loaded a cached page.
private static Object
_valueMapper(Object map, Object value)
Reduce callback for adding the value to a map
private Object
_waitingForAnimation()
private Object
_waitingForDescendantResize()
private Object
_waitingForIncompleteImages()
public Object
whyIsNotSynchronizedWithServer()


Methods inherited from oracle.adf.view.js.base.AdfPage

addChangedComponent, ClearChangesList, findComponentByAbsoluteId, getBaseResourceUrl, GetChangedComponents, getLocaleContext, getLookAndFeel, getPhase, getTwoDigitYearStart, getTzOffsetMinutes, removeChangedComponent, setBaseResourceUrl, setFailedConnectionText, setInstance, SetPhase, setTwoDigitYearStart, setTzOffsetMinutes


Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString


Field Detail


_accessibilityMode

private Object _accessibilityMode

_ACTIVE_DATA_HOT_KEY

private static Object _ACTIVE_DATA_HOT_KEY

_ACTIVE_DATA_HOT_KEY_TEXT

private static Object _ACTIVE_DATA_HOT_KEY_TEXT

ACTIVE_DOM_ELEMENT_PROPERTY

public static Object ACTIVE_DOM_ELEMENT_PROPERTY

_activeDomNode

private Object _activeDomNode

_animationEnabled

private Object _animationEnabled

_automationEnabled

private Object _automationEnabled

_autoPPRComponents

private Object _autoPPRComponents

_BLOCKING_DIV_ID

private static Object _BLOCKING_DIV_ID

_BLOCKING_OPACITY

private static Object _BLOCKING_OPACITY

_BROWSER_RESIZE_CHECKPOINT

private static Object _BROWSER_RESIZE_CHECKPOINT

_busyCounts

private Object _busyCounts

_CALLBACK_CHECKPOINT

private static Object _CALLBACK_CHECKPOINT

_canReceiveActiveDataCount

private Object _canReceiveActiveDataCount

_clientIdToComponentMap

private Object _clientIdToComponentMap

_componentsUpdatedByPollEvent

private Object _componentsUpdatedByPollEvent

_cssSelectorsUncompressed

private Object _cssSelectorsUncompressed

_CUSTOM_PPR_URL_EXPANDO

private static Object _CUSTOM_PPR_URL_EXPANDO

DEFAULT_ACCESSIBILITY_MODE

public static Object DEFAULT_ACCESSIBILITY_MODE

_defaultMessageKey

private Object _defaultMessageKey

_DELAYED_RESIZE_TIMEOUT

private static Object _DELAYED_RESIZE_TIMEOUT

_delayedMessages

private Object _delayedMessages

_descendantResizeNotifyList

private Object _descendantResizeNotifyList

_dirtyStateService

private Object _dirtyStateService

_document

private Object _document

_DOCUMENT_STYLE_HOLDER

private static Object _DOCUMENT_STYLE_HOLDER

_documentClientId

private Object _documentClientId

_dragLastX

private Object _dragLastX

_dragLastY

private Object _dragLastY

_dragStartX

private Object _dragStartX

_dragStartY

private Object _dragStartY

_ECID

private static Object _ECID

_EDITABLE_STYLE

private static Object _EDITABLE_STYLE

_editableCallback

private Object _editableCallback

_editableCallbackContext

private Object _editableCallbackContext

_editableSubtreeId

private Object _editableSubtreeId

_editedComponentId

private Object _editedComponentId

_eventQueue

private Object _eventQueue

_globalMessagesResetStrategy

private Object _globalMessagesResetStrategy

_haveOutstandingPPRRequest

private Object _haveOutstandingPPRRequest

INACCESSIBLE_ACCESSIBILITY_MODE

public static Object INACCESSIBLE_ACCESSIBILITY_MODE

_INCOMPLETE_IMAGE_CLASS_NAME

private static Object _INCOMPLETE_IMAGE_CLASS_NAME

_inLayout

private Object _inLayout

_inlineEditor

private Object _inlineEditor

_interpretEmptyString

private Object _interpretEmptyString

_jsfAjaxInit

private Object _jsfAjaxInit

_KEYSTROKE_OVERRIDES

private static Object _KEYSTROKE_OVERRIDES

_keyStrokeToCallbackContextMap

private Object _keyStrokeToCallbackContextMap

_keyStrokeToCallbackMap

private Object _keyStrokeToCallbackMap

_lastDomEvent

private Object _lastDomEvent

_LAZY_FETCH_ID_PARAM

private static Object _LAZY_FETCH_ID_PARAM

_LOAD_CHECKPOINT

private static Object _LOAD_CHECKPOINT

_loadingComponents

private Object _loadingComponents

_messages

private Object _messages

_MSG_RESET_CLIENT_AND_SERVER

private static Object _MSG_RESET_CLIENT_AND_SERVER

_MSG_RESET_SERVER

private static Object _MSG_RESET_SERVER

_NAVIGATION_QUERY_PARAMS

private static Object _NAVIGATION_QUERY_PARAMS

_NAVIGATION_VIEW_ROOT

private static Object _NAVIGATION_VIEW_ROOT

_NAVIGATION_WRAPPER_ID

private static Object _NAVIGATION_WRAPPER_ID

OUPUTMODE_ATTACHMENT

public static Object OUPUTMODE_ATTACHMENT

_PAGE_STATE_ID

private static Object _PAGE_STATE_ID

_pageProperties

private Object _pageProperties

_PARSER_DIV_ID

private static Object _PARSER_DIV_ID

_pendingStreamingIDs

private Object _pendingStreamingIDs

_perfProfileEnabled

private Object _perfProfileEnabled

_perfProfileLogClosed

private Object _perfProfileLogClosed

_perfProfileTimingEnabled

private Object _perfProfileTimingEnabled

_poppedUpComponentInfo

private Object _poppedUpComponentInfo

_portlet

private Object _portlet

_positionBlockingGlassPaneCallback

private Object _positionBlockingGlassPaneCallback

_POSTBACK_CHECKPOINT

private static Object _POSTBACK_CHECKPOINT

_POSTSCRIPT_ID_SUFFIX

private static Object _POSTSCRIPT_ID_SUFFIX

PPR_NAVIGATION_FORCE_PPR

public static Object PPR_NAVIGATION_FORCE_PPR

PPR_NAVIGATION_ON

public static Object PPR_NAVIGATION_ON

_preloadImages

private Object _preloadImages

_PRINTABLE_STATE

private static Object _PRINTABLE_STATE

_PRINTABLE_WINDOW_NAME

private static Object _PRINTABLE_WINDOW_NAME

PushChannelStates

protected static Object PushChannelStates

_REMOVED_STREAMING_IDS_PARAM

private static Object _REMOVED_STREAMING_IDS_PARAM

_replaceJsfAjaxFunctions

private Object _replaceJsfAjaxFunctions

_resizeNotifyMap

private Object _resizeNotifyMap

_resizeNotifyTree

private Object _resizeNotifyTree

_responseId

private Object _responseId

_RICH_UPDATE_FLAG

private static Object _RICH_UPDATE_FLAG

_rootClientId

private Object _rootClientId

SCREEN_READER_ACCESSIBILITY_MODE

public static Object SCREEN_READER_ACCESSIBILITY_MODE

_scriptLoadingPolicy

private Object _scriptLoadingPolicy

_SELECTABLE_STYLE

private static Object _SELECTABLE_STYLE

_selectedEditingComponents

private Object _selectedEditingComponents

_seleniumRC

private Object _seleniumRC

_serverQueue

private Object _serverQueue

_sessionId

private Object _sessionId

__shouldTracePPRRequestId

Object __shouldTracePPRRequestId

_startADSClientIdCount

private Object _startADSClientIdCount

_startADSClientIds

private Object _startADSClientIds

_STATE_PARAM_NAME

private static Object _STATE_PARAM_NAME

_stopADSClientIds

private Object _stopADSClientIds

_stopGlobalActiveData

private Object _stopGlobalActiveData

_STREAMING_COMPLETE

private static Object _STREAMING_COMPLETE

_STREAMING_IDS_PARAM

private static Object _STREAMING_IDS_PARAM

_STREAMING_REQUEST_SENT

private static Object _STREAMING_REQUEST_SENT

_STREAMING_STARTED

private static Object _STREAMING_STARTED

_TIMER_CALLBACK

private static Object _TIMER_CALLBACK

_TIMER_CONTEXT

private static Object _TIMER_CONTEXT

_TIMER_DOM_ID

private static Object _TIMER_DOM_ID

_TIMER_ID

private static Object _TIMER_ID

_TIMER_IS_SYNCHRONIZED

private static Object _TIMER_IS_SYNCHRONIZED

_TIMER_STATE

private static Object _TIMER_STATE

_UI_BLOCK_REASON_PPR

private static Object _UI_BLOCK_REASON_PPR

_UI_BLOCK_REASON_SCRIPT_LOADING

private static Object _UI_BLOCK_REASON_SCRIPT_LOADING

_uiBlocks

private Object _uiBlocks

_validateEmptyFields

private Object _validateEmptyFields

_window

private Object _window

_windowDetectionStrategy

private Object _windowDetectionStrategy

Constructor Detail


AdfDhtmlPage

public AdfDhtmlPage(Object lookAndFeel,
                    Object domWindow)

Page Management class specific to DHTML Implementation

Parameters:
lookAndFeel  -  The AdfLookAndFeel to create this instance with.
domWindow    

Method Detail


addBusyStateListener

public Object addBusyStateListener(Object instance,
                                   Function listener)

Adds a listener to be invoked whenever there is a busy state event. For example a component might be implemented with native machine code instead of web standards and would not be able to automatically convey to the user that the page is currently busy. Such a component would require special code for this purpose. Application developers should not need to call this method explicitly. Components which are interested in busy state events will automatically register themselves, typically in their InitDomElement peer implementation.

Parameters:
instance  -  the object to use as 'this' when invoking the handler
listener  -  the listener to be invoked if there is a busy state event, the first parameter will be an AdfBusyStateEvent object
Return:
Object
See also:
removeBusyStateListener(Object, Function)
_broadcastBusyStateEvent(Boolean)
Overrides:
AdfPage.addBusyStateListener(Object, Function)

addComponents

public Object addComponents(Object components)

Add the list of components as varargs to be managed by the Page

Parameters:
components    
Return:
Object
Overrides:
AdfPage.addComponents(Object)

_addDelayedMessages

private Object _addDelayedMessages(Object showMessages)

Allow lazy content loaded components to ensure all messages for its children components are added once the children's client components are loaded.

Parameters:
showMessages    
Return:
Object

addEventListener

public Object addEventListener(Object eventType,
                               Object listener,
                               Object instance)

Parameters:
eventType    
listener    
instance    
Return:
Object

addMessage

public Object addMessage(String componentId,
                         AdfFacesMessage facesMessage,
                         Object toBeRemoved)

Adds a Message to AdfDhtmlPage's message queue.

Parameters:
componentId  -  the id of the component to add this message to or null for a global message
facesMessage  -  the message
toBeRemoved    
Return:
Object
Overrides:
AdfPage.addMessage(String, AdfFacesMessage, Object)

_addPageId

private Object _addPageId(Object headerParams)

Parameters:
headerParams    
Return:
Object

_addPageStateIdField

private Object _addPageStateIdField(Object id)

Parameters:
id    
Return:
Object

_addPageStateIdParameter

private static Object _addPageStateIdParameter(Object formElem,
                                               Object params)

Parameters:
formElem    
params    
Return:
Object

addPartialTargets

public Object addPartialTargets(Object components)

Adds the components to the set of components that will be redrawn on the next communication with the server.

Parameters:
components    
Return:
Object
Overrides:
AdfPage.addPartialTargets(Object)

_addPendingStreamingIDs

private Object _addPendingStreamingIDs(Object arr,
                                       Object params)

Parameters:
arr    
params    
Return:
Object

__addPopupInfo

Object __addPopupInfo(Object component,
                       Object popupInfo)

Called by AdfRichUIPeer to inform the page of popped up content

Parameters:
component    
popupInfo    
Return:
Object

addPropertyChangeListener

public Object addPropertyChangeListener(Object instance,
                                        Function listener)

Adds a PropertyChangeListener with the specified instance and listener function

Parameters:
instance  -  Object to use as "this" when calling the listener
listener  -  Function to call when an AdfDhtmlPage property changes
Return:
Object
See also:
AdfPage.EDITABLE_SUBTREE_PROPERTY
AdfPage.SELECTED_EDITING_COMPONENTS_PROPERTY
AdfPage.EDITED_COMPONENT_PROPERTY
Overrides:
AdfPage.addPropertyChangeListener(Object, Function)

addResource

public Object addResource(Object type,
                          Object value)

Adds either a JavaScript script or CSS link to the page.

Parameters:
type  -  Either 'javascript' or 'css'
value  -  the URI of the resource or the in-line style content
Return:
Object

__addServerParamsToEvent

static Object __addServerParamsToEvent(Object event,
                                        Object params)

A back door for a peer to add extra parameters to an event by attaching them to the event object. This is used to implement f:param support on commandLink.

Parameters:
event    
params    
Return:
Object

_addStateParameter

private static Object _addStateParameter(Object formElem,
                                         Object params)

Parameters:
formElem    
params    
Return:
Object

__alert

boolean __alert(String title,
                 String message,
                 Function callback)

Launches a modal inline popup alert dialog. This is a singleton instance so only one can be open at a time.

Parameters:
title  -  of the dialog
message  -  displayed in the body of the dialog
callback  -  function that has a single actual parameter that is an AdfDialogEvent.
Return:
boolean - true if the alert dialog was open; false if the alert/confirm message dialog was already open.

announceToAssistiveTechnology

public Object announceToAssistiveTechnology(Object message,
                                            Object onlyIfChanged)

Issues an announcement for AT users using our "status" live region.

Parameters:
message  -  the message to announce
onlyIfChanged  -  an optional parameter that if true, causes the message to be announced only if the message is different from the previous status message. This provides a simple way to prune out duplicate messages (eg. a progressIndicator that has not progressed since the last update).
Return:
Object
Overrides:
AdfPage.announceToAssistiveTechnology(Object, Object)

_appendParameter

private Object _appendParameter(Object form,
                                Object name,
                                Object value)

Parameters:
form    
name    
value    
Return:
Object

_appendResponseId

private Object _appendResponseId(Object url)

Append response identifier to the URL.

Parameters:
url    
Return:
Object

_appendUrlFormEncoded

private static Object _appendUrlFormEncoded(Object buffer,
                                            Object key,
                                            Object value)

Parameters:
buffer    
key    
value    
Return:
Object

__applyNewPageStyleSheets

Object __applyNewPageStyleSheets(Object newStyleSheetURIs)

Called by the server to apply any new skin stylesheets when ppr navigating This function determines the current set of skin style sheets, intersects the result with the new set of style sheets and makes any changes. Note, that to avoid a flash, we won't have removed any of the old style sheets that are no longer needed when this function returns. Those style sheets will be removed by a timer, later, hopefully after the new stylesheets have been loaded and applied.

Parameters:
newStyleSheetURIs    
Return:
Object

_applyRichResponse

private Object _applyRichResponse(Object documentElement,
                                  Object needsUnescape,
                                  Object isStreaming,
                                  Object reqContext)

Applies rich postback response

Parameters:
documentElement  -  {HTMLElement} root node of the response
needsUnescape  -  {Boolean}
isStreaming  -  true if this is a streaming response, false otherwise
reqContext  -  {Object} XMLHTTP request context
Return:
Object - boolean true indicating whether a redirect is imminent (usually the case when a redirect node was encountered in the partial response.

_areComponentsLoaded

private Object _areComponentsLoaded()

Loop over the loading components, returning true if all of them are loaded.

Return:
Object

areCssSelectorsUncompressed

public Object areCssSelectorsUncompressed()

Tests if css selector compression is disabled for the page.

Return:
Object
Overrides:
AdfPage.areCssSelectorsUncompressed()

_areSynchronousTimersCleared

private Object _areSynchronousTimersCleared()

Used in isSynchronizedWithServer to wait for timers which need to considered.

Return:
Object - true if there are any pending timers with isSynchronized flag set to true

_attemptToRelayoutForNewlyCompleteImages

private Object _attemptToRelayoutForNewlyCompleteImages()

Return:
Object

_blockUI

private Object _blockUI(Object block,
                        Object reason)

Prevents the user from interacting with the client UI.

Parameters:
block  -  boolean indicating whether to block/unblock the ui
reason  -  Optional param that identifies the reason for this block. One of _UI_BLOCK_REASON_PPR or _UI_BLOCK_REASON_SCRIPT_LOADING. If unspecified, defaults to _UI_BLOCK_REASON_PPR.
Return:
Object
See also:
_isUIBlocked(Object)
_removeBlockingHandler(HTMLDocument)
_installBlockingHandler(HTMLDocument)

_broadcastBusyStateEvent

private Object _broadcastBusyStateEvent(Boolean newBusyState)

=-= Unsupported, internal implementation method. This method is called to deliver busy state events to listeners registered with the page.

Parameters:
newBusyState  -  the new busy state to send along to the registered listeners
Return:
Object
See also:
addBusyStateListener(Object, Function)
removeBusyStateListener(Object, Function)

__callTimerCallback

static Object __callTimerCallback(Object timerId)

Calls the callback specified for the timer in the correct state. The only reason why this isn't private is so that the obfuscator doesn't get confused, since it is referenced in a String that is evaluated into a function.

Parameters:
timerId  -  identifier for timer to run
Return:
Object

cancelAllPopupsCallback

public static Object cancelAllPopupsCallback(Object currComponent,
                                             Object callbackParameters)

This callback can be passed to ComponentsInSubtreeCallback in order to cancel popups

Parameters:
currComponent    
callbackParameters    
Return:
Object

cancelTimer

public Object cancelTimer(Object timerId)

Cancels the firing of the specified timer.

Parameters:
timerId  -  identifier for timer to cancel
Return:
Object
See also:
scheduleTimer(Object, Function, Object, Object, Object)
rescheduleTimer(Object, Number)

_checkCoreBackgroundLoaded

private Object _checkCoreBackgroundLoaded(Object forceLoad)

Parameters:
forceLoad    
Return:
Object

_checkDirtyDataComponents

private Object _checkDirtyDataComponents()

Return:
Object

checkRegionUncommittedData

public Object checkRegionUncommittedData(Object regionClientIds,
                                         Object message)

Displays uncommitted data warning for regions.

Parameters:
regionClientIds    
message    
Return:
Object
Overrides:
AdfPage.checkRegionUncommittedData(Object, Object)

_checkResizeNotifyCallback

private Object _checkResizeNotifyCallback()

Return:
Object

_checkResizeNotifyDelayed

private Object _checkResizeNotifyDelayed()

Return:
Object

__checkRichResponseDirty

Object __checkRichResponseDirty()

Return:
Object

checkUncommittedData

public Object checkUncommittedData(Object regionMessageCallback)

Displays uncommitted data warning if <af:document> has uncommittedDataWarning="on", and the page contains uncommitted data (either on the client or on the server).

Parameters:
regionMessageCallback    
Return:
Object - true if the navigation should proceed, false otherwise
Overrides:
AdfPage.checkUncommittedData(Object)

_clearAllDelayedMessages

private Object _clearAllDelayedMessages()

Clears all of the delayed messages for a particular page.

Return:
Object

clearAllMessages

public Object clearAllMessages()

Clears all of the messages for a particular page.

Return:
Object
Overrides:
AdfPage.clearAllMessages()

_clearDelayedMessages

private Object _clearDelayedMessages(String componentId)

Clears delayed messages array for a component id

Parameters:
componentId  -  a componentId
Return:
Object

__clearDnDContext

Object __clearDnDContext()

Return:
Object

_clearFloatingDiv

private Object _clearFloatingDiv(Object floatingDiv)

Removes the conteiner content of the floating div

Parameters:
floatingDiv    
Return:
Object

clearMessages

public Object clearMessages(String componentId)

Clears a messages for a particular component id. If component Id is null then the Global messages are cleared.

Parameters:
componentId  -  a componentId or null for global messages
Return:
Object
Overrides:
AdfPage.clearMessages(String)

_clearStatusRegion

private Object _clearStatusRegion()

Return:
Object

clearSubtreeMessages

public Object clearSubtreeMessages(String rootId)

Clear the messages for a subtree of components, including the root of the subtree

Parameters:
rootId  -  the client id of the root of the subtree to clear
Return:
Object

_collectCss

private Object _collectCss()

Return:
Object

_collectPostbackParams

private Object _collectPostbackParams(Object actionForm,
                                      Object eventTargets)

Parameters:
actionForm    
eventTargets    
Return:
Object

ComponentsInSubtreeCallback

protected Object ComponentsInSubtreeCallback(Object targetDomElement,
                                             Object callback,
                                             Object callbackParameters)

Calls the callback for components in the subtree

Parameters:
targetDomElement    
callback    
callbackParameters    
Return:
Object

__confirm

boolean __confirm(String title,
                   String message,
                   Function callback,
                   int timeout,
                   Object disableCancel)

Launches a modal inline popup confirm dialog. This is a singleton instance so only one can be open at a time.

Parameters:
title  -  of the dialog
message  -  displayed in the body of the dialog
callback  -  function that has a single actual parameter that is an AdfDialogEvent.
timeout  -  period in milliseconds that the dialog will be displayed before auto-dismissing with a cancel dialog outcome.
Default value = null
disableCancel    
Return:
boolean - true if the confirmation dialog was open; false if it was already open.

confirmNavigation

public Object confirmNavigation(Object token,
                                Object isPartial)

This method gets called when the user should be asked to confirm server-side navigation.

Parameters:
token  -  token identifying navigation action
isPartial  -  a boolean indicating whether the script was sent during PPR request
Return:
Object

createFloatingDiv

public Object createFloatingDiv(Object parent,
                                Object zIndex,
                                Object className)

Creates a floating div with the specified zIndex and style class for the included span

Parameters:
parent    
zIndex    
className    
Return:
Object

_createGlassPane

private Object _createGlassPane(Object ownerDocument)

Parameters:
ownerDocument    
Return:
Object

_createLink

private Object _createLink(Object href,
                           Object extraProps)

Creates a link with the specified href, adding on any extra properties as attributes

Parameters:
href    
extraProps    
Return:
Object

createMaskingFrame

public Object createMaskingFrame(HTMLElement element)

Creates a masking IFrame underneath a floating element. The iframe is used to mask any OS drawn controls underneath the element.

Parameters:
element  -  the element underneath which to create the masking frame
Return:
Object

_createStyle

private Object _createStyle(Object content)

Parameters:
content    
Return:
Object

decrementPendingAnimation

public Object decrementPendingAnimation()

Remove one from the number of pending animations.

Return:
Object
See also:
decrementPendingAnimation()

_delayedOnResize

private Object _delayedOnResize()

Return:
Object

_delayMessageForComponent

private Object _delayMessageForComponent(Object componentId,
                                         Object facesMessage,
                                         Object title)

Add a message as delayed since the target client component is not available

Parameters:
componentId    
facesMessage    
title    
Return:
Object

_deliverAllQueuedEvents

private Object _deliverAllQueuedEvents()

Return:
Object

deliverEventToNewWindow

public Object deliverEventToNewWindow(Object event)

Delivers a single event synchronously to a new window. This method runs outside of the normal cycle to avoid delvering any other events to that window.

Parameters:
event    
Return:
Object

_deliverQueuedEvents

private Object _deliverQueuedEvents()

Deliver queued events to their sources for broadcast

Return:
Object

_deliverQueuedServerEvents

private void _deliverQueuedServerEvents(boolean checkEventAndDelta,
                                        boolean pageUnloading)

Deliver all of the events in the server event queue.

Parameters:
checkEventAndDelta  -  : boolean false: if we don't have any events to deliver, we will skip true: we will only skip when we don't have either events or deltas
pageUnloading  -  optional parameter that indicates that we are calling from the unload of the document and it's a property delta sync.
Return:
void - null

_descendantResizeNotifyListComparator

private static Object _descendantResizeNotifyListComparator(Object itemA,
                                                            Object itemB)

Parameters:
itemA    
itemB    
Return:
Object

_detectSeleniumRC

private Object _detectSeleniumRC()

Return:
Object

_disableUncommittedWarnings

private Object _disableUncommittedWarnings()

Return:
Object

_displayRegionUncommittedDataWarning

private Object _displayRegionUncommittedDataWarning(Object message)

Parameters:
message    
Return:
Object

_displayUncommittedDataWarning

private Object _displayUncommittedDataWarning(Object message)

Parameters:
message    
Return:
Object

Dispose

protected Object Dispose()

Tear down the Rich Client environment

Return:
Object
Overrides:
AdfPage.Dispose()

_disposeIFrames

private static Object _disposeIFrames(Object domDocument)

Cleanup code to remove all IFrames This cleans up IFrame leaks in IE

Parameters:
domDocument    
Return:
Object

_disposeTimers

private Object _disposeTimers()

Clean up all of the outstanding timers

Return:
Object

__doDescendantResizeNotify

Object __doDescendantResizeNotify()

=-= Unsupported, internal method per Andy and Blake discussion. Performs the descendant resize notify traversal on all of the subtrees rooted at the registered components.

Return:
Object

_doDescendantResizeNotifyOnQueue

private Object _doDescendantResizeNotifyOnQueue(Object descendantResizeNotifyQueue)

Parameters:
descendantResizeNotifyQueue    
Return:
Object

_doFrameBusting

private static Object _doFrameBusting(Object newLocation)

Parameters:
newLocation    
Return:
Object

_doFullPostback

private Object _doFullPostback(Object formElement,
                               Object params,
                               Object blockUI,
                               Object responseExpected)

Parameters:
formElement    
params    
blockUI    
responseExpected    
Return:
Object

doRedirect

public Object doRedirect(Object url,
                         Object noNavigation)

Redirects to a supplied url

Parameters:
url  -  The URL to redirect to
noNavigation    
Return:
Object

doResizeNotify

public Object doResizeNotify(AdfUIComponent component)

Performs the resize notify traversal on the subtree rooted at the specified component. If component is null a complete traversal is performed. At the moment, the component is assumed to be a geometry managing component that has expressed interest in receiving resize notifications.

Parameters:
component    
Return:
Object
Overrides:
AdfPage.doResizeNotify(Object)

_doResizeNotify

private Object _doResizeNotify(Object domNodes)

Parameters:
domNodes    
Return:
Object

_doResizeNotify

private static Object _doResizeNotify(Object node,
                                      Object forceResize,
                                      Object checkAll)

Parameters:
node    
forceResize    
checkAll    
Return:
Object

doResizeNotifyDom

public Object doResizeNotifyDom(Object domNode,
                                Object forceResize)

Performs a resize notify traversal for the subtree rooted at the specified DOM node.

Parameters:
domNode  -  The dom node which is at the root of the tree that requires resize notification.
forceResize  -  boolean indicating whether or not the resize should occur even if the size of the root dom node has not changed. Normally if the resize notification traversal detects that a node has not changed in size since the previous traversal, the traversal is short-circuited. In some cases (eg. child replacement) the parent peer may find it necessary to invoke a resize traversal even though its own size has not changed. In cases (visibility changes), we do not want to force a resize notify traversal if the size is unchanged. Thus, forceResize is exposed to allow the caller to control this behavior.
Return:
Object

_doResizeNotifyDomChildren

private Object _doResizeNotifyDomChildren(Object domNode,
                                          Object resizeNotifyNode,
                                          Object checkDescendents)

Parameters:
domNode    
resizeNotifyNode    
checkDescendents    
Return:
Object

_doRichPostback

private Object _doRichPostback(HTMLElement formElement,
                               Object params,
                               Object headerParams,
                               Object blockUI,
                               Object context,
                               Array<String> eventTargets)

Perform a rich postback

Parameters:
formElement  -  Form element to use a destination
params  -  Name/value pairs to post
headerParams    
blockUI    
context  -  XMLHTTP request context
eventTargets  -  array containing client ids of event target components
Return:
Object

_dragKeyDown

private Object _dragKeyDown(Object evt)

Parameters:
evt    
Return:
Object

_dragMouseMove

private Object _dragMouseMove(Object evt)

Parameters:
evt    
Return:
Object

_dragMouseUp

private Object _dragMouseUp(Object evt)

Parameters:
evt    
Return:
Object

_dtsStateChanged

private Object _dtsStateChanged()

Return:
Object

__enableDirtyPostbackPayloads

Object __enableDirtyPostbackPayloads()

Return:
Object

__ensureCoreBackgroundLoaded

Object __ensureCoreBackgroundLoaded()

Return:
Object

_eraseCookie

private static Object _eraseCookie(Object domDocument,
                                   Object name)

Erase the cookie, by setting its expiration to a past time.

Parameters:
domDocument  -  document object
name  -  cookie name to expire.
Return:
Object

_eventLoopDeliverEvents

private Object _eventLoopDeliverEvents()

Called from the event loop to dispatch events to the components and server

Return:
Object

_extractInstructionXML

private static Object _extractInstructionXML(Object responseText,
                                             Object element)

Parameters:
responseText    
element    
Return:
Object

_filterComponent

private Object _filterComponent(Object component,
                                Object domElement,
                                Object filterFunction,
                                Object filterContext)

Parameters:
component    
domElement    
filterFunction    
filterContext    
Return:
Object

_filterEditableSubtree

private Object _filterEditableSubtree(Object subtree,
                                      Object filterFunction,
                                      Object filterContext)

Recursively add all of selectable and editable the styles from a subtree

Parameters:
subtree    
filterFunction    
filterContext    
Return:
Object

findComponent

public AdfUIComponent findComponent(String clientId)

Retrieves a component by its clientID. Page authors should rarely need to call this function and should usually call AdfPage.findComponentByAbsoluteId instead.

Because this function uses the clientId, which isn't guaranteed to be stable across runs, to locate the component, it should never be passed a hard-coded String. Rather, it is typically passed the clientId retrieved from a component instance.

The structure of the clientId passed to this function is identical to the structure passed to UIViewRoot.invokeOnComponent on the server.


Parameters:
clientId  -  Id of component instance to find on the page
Return:
AdfUIComponent - returns the component with the specified id, if any
See also:
AdfPage.findComponentByAbsoluteId(String)
findComponent(String)
Overrides:
AdfPage.findComponent(String)

findComponentByAbsoluteLocator

public AdfUIComponent findComponentByAbsoluteLocator(String absoluteLocator)

Retrieves a component by its absolute locator.

Parameters:
absoluteLocator  -  an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.
Return:
AdfUIComponent - the matching component instance, or null if no component matching that absolute locator exists.
See also:
AdfPage.findComponentOrAncestorByAbsoluteLocator(String)
AdfUIComponent.getAbsoluteLocator()
Overrides:
AdfPage.findComponentByAbsoluteLocator(String)

_findComponentByAbsoluteLocator

private Object _findComponentByAbsoluteLocator(Object componentId,
                                               Object absoluteLocator)

Given a componentId and absoluteLocator, return the component with that absolute locator.

Parameters:
componentId    
absoluteLocator    
Return:
Object

findComponentOrAncestorByAbsoluteLocator

public AdfUIComponent findComponentOrAncestorByAbsoluteLocator(String absoluteLocator)

Retrieves a component or one of its ancestors by its absolute locator. If a component with exactly the specified absolute locator isn't found, the nearest locatable ancestor is searched for by truncating the absolute locator from the end. This can help with backwards compatibility with obsolete locators.

Parameters:
absoluteLocator  -  an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.
Return:
AdfUIComponent - the matching component instance, or undefined if no component or ancestor matching that absolute locator exists.
See also:
AdfPage.findComponentOrAncestorByAbsoluteLocator(String)
AdfUIComponent.getAbsoluteLocator()
Overrides:
AdfPage.findComponentOrAncestorByAbsoluteLocator(String)

_findFirstAdfForm

private HtmlElement _findFirstAdfForm()

Return:
HtmlElement - returns the first form that is backed by a rich component or null if one can not be found.

_fixupLinkOnClick

private Object _fixupLinkOnClick(Object element)

Parameters:
element    
Return:
Object

flushToAssistiveTechnology

public Object flushToAssistiveTechnology()

Return:
Object

_forceGC

private static Object _forceGC(Object count)

Code for forcing a GC

Parameters:
count    
Return:
Object

_forcePreloadOfAllImages

private Object _forcePreloadOfAllImages()

Return:
Object

__frameBusting

static Object __frameBusting(Object frameBusting)

Parameters:
frameBusting    
Return:
Object

getAccessibilityMode

public Object getAccessibilityMode()

Returns the accessibility mode. One of: AdfDhtmlPage.SCREEN_READER_ACCESSIBILITY_MODE, AdfDhtmlPage.DEFAULT_ACCESSIBILITY_MODE, or AdfDhtmlPage.INACCESSIBLE_MODE. Note: this is method is not yet exposed on AdfPage, only AdfDhtmlPage.

Return:
Object

getActiveComponent

public AdfUIComponent getActiveComponent()

Returns the AdfUIComponent with the current focus

Return:
AdfUIComponent - The focused AdfUIComponent, if any
See also:
getActiveComponentId()
getActiveComponent()
AdfPage.ACTIVE_COMPONENT_PROPERTY
Overrides:
AdfPage.getActiveComponent()

getActiveComponentId

public String getActiveComponentId()

Returns the id of the currently focused component on the page.

Return:
String - The clientId of the focused component on the page, if any.
See also:
getActiveDomElement()
getActiveComponent()
Overrides:
AdfPage.getActiveComponentId()

getActiveDataSupport

public Object getActiveDataSupport()

Return:
Object

getActiveDomElement

public Node getActiveDomElement()

Returns the DOM Element with the current DOM focus

Return:
Node - The focused DOM element or document, if any
See also:
getActiveComponentId()
getActiveComponent()
ACTIVE_DOM_ELEMENT_PROPERTY

getAllMessages

public Object getAllMessages()

Return an object containing all messages keyed by componentID and containing an array of FacesMessages. Messages for non-visible and non-existing components will not be returned

Return:
Object - an object containing arrays of FacesMessages which are keyed by componentId.
Overrides:
AdfPage.getAllMessages()

_getAndClearDeltas

private Object _getAndClearDeltas(Object doClear)

Parameters:
doClear    
Return:
Object

getAsynchronousUpdatesState

public String getAsynchronousUpdatesState()

Gets the state of Asynchronous updates for the page. Asynchronous updates can be in "on" state or in "onDemand" state in automation mode In non-automation mode, this property is not set.

Return:
String - state of asynchronous updates
Overrides:
AdfPage.getAsynchronousUpdatesState()

getAutoDismissalManager

public AdfAutoDismissalManager getAutoDismissalManager()

Returns the autoDismissal manager for this page.

Return:
AdfAutoDismissalManager - null

_getClientIdFromComment

private Object _getClientIdFromComment(Object comment)

Returns the clientId, if any, represented by a DOM comment Node

Parameters:
comment    
Return:
Object

getClientIdsWithMessages

public Object getClientIdsWithMessages(Object rootId)

Return an array of the client identifiers for which at least one FacesMessage has been queued. If there are no such client identifiers, an empty array is returned. If any messages have been queued that were not associated with any specific client identifier, a null value will be included in the array of values.

ids for non-visible and non-existing components will not be returned

It is possible to only search for client ids with messages within a subtree by passing in a rootId. When a rootId is passed in a null value will not be included for messages not associated with any specific client identifier.


Parameters:
rootId    
Return:
Object
Overrides:
AdfPage.getClientIdsWithMessages(String)

getClientIdToComponentMap

public Object getClientIdToComponentMap()

Internal function for retrieving a named map of client IDs to client components.

Internal use only, intended to be used by the browser debugging extensions.


Return:
Object - object with string keys mapped to client components.

_getComponentFromComment

private Object _getComponentFromComment(Object comment)

Returns the component, if any, represented by a DOM comment Node

Parameters:
comment    
Return:
Object

getComponentIdsUpdatedByPollEvent

public Object getComponentIdsUpdatedByPollEvent()

Returns a list of components ID that were update by the last Poll event.

Return:
Object

getComponentsByType

public Object getComponentsByType(Object componentType)

Returns an array of component instances, whose component type matches the argument.

Parameters:
componentType  -  String type of the component.
Return:
Object
Overrides:
AdfPage.getComponentsByType(Object)

_getCookie

private static Object _getCookie(Object domDocument,
                                 Object name)

Returns the value of a cookie or null if the cookie doesn't exist.

Parameters:
domDocument  -  document object
name  -  cookie name string
Return:
Object

getDataTransferService

public AdfDataTransferService getDataTransferService(Object noCreate,
                                                     Object adsDTS,
                                                     Object uploadDTS)

Returns the AdfDataTransferService instance for this page.

Parameters:
noCreate  -  pass in true for not creating a DTS if it is gone
adsDTS  -  pass in true to get the ADS specific DTS.
uploadDTS  -  pass in true to get the multi-file upload specific DTS. Passing in false (or nothing) returns the default DTS.
Return:
AdfDataTransferService - null

getDefaultMessageHandlerComponentId

public String getDefaultMessageHandlerComponentId()

Retrieves the component ID that is the default message handler (for global messages).

Return:
String - the ID of the component that handles the global messages
Overrides:
AdfPage.getDefaultMessageHandlerComponentId()

_getDefaultPostbackURL

private Object _getDefaultPostbackURL()

Return:
Object

_getDelayedResizeCallback

private Object _getDelayedResizeCallback()

Return:
Object

_getDirtyRegionIds

private Object _getDirtyRegionIds()

Returns an array or client Ids for regions that have uncommitted data or null if there is none

Return:
Object

getDirtyStateService

public Object getDirtyStateService()

Return:
Object

getDnDContext

public Object getDnDContext()

Returns the current Drag and Drop context, associated with the page

Return:
Object
Overrides:
AdfPage.getDnDContext()

getDocument

public Object getDocument()

Returns the DOM Document that the AdfPage is associated with

Return:
Object

getDocumentClientId

public String getDocumentClientId()

Internal function to retrieve the document component's client ID.

Used by the browser debugging extensions to locate the document component. Internal use only.


Return:
String - the document client ID, if set

getDomDocument

public Object getDomDocument()

Return:
Object

getDomWindow

public Object getDomWindow()

Return:
Object

_getEditableEventTargetComponents

private Object _getEditableEventTargetComponents(Array<String> eventTargets)

Given an array of event target ids, returns a non-null array containing any corresponding AdfUIEditableValue components.

Parameters:
eventTargets  -  array containing client ids of event target components
Return:
Object - an array of AdfUIEditableValue components, or an empty array if none of the event targets correspond to editable components.

getEditableSubtree

public AdfUIComponent getEditableSubtree()

Returns the root of the component subtree that inline-editing is allowed on

Return:
AdfUIComponent - null
Overrides:
AdfPage.getEditableSubtree()

_getEditableSubtrees

private Object _getEditableSubtrees(String subtreeId,
                                    boolean returnAnchors)

Given a DOM id, return all of the subtrees that should be inside this subtree. This will normally return the root dom element of the subtreeId, but if content inside the subtree is currently popped up, this will return the popped up content dom as well. Depending on the value of the returnAnchors elements, the extra popup subtrees could be either the anchored subtrees or the popped up content subtrees.

Parameters:
subtreeId  -  id of DOM element to treat as the root
returnAnchors  -  true if the unmoved DOM elements should be returned
Return:
Object

getEditedComponent

public AdfUIComponent getEditedComponent()

Returns the current component being edited.

Return:
AdfUIComponent - null
See also:
setEditedComponent(AdfUIComponent, Event)
Overrides:
AdfPage.getEditedComponent()

_getExistingStyleSheetElements

private Object _getExistingStyleSheetElements()

returns the array of stylesheet LINK elements in the head

Return:
Object

getFacesPath

public Object getFacesPath()

Internal method to retrieve the faces path for the page.

Intended to be used by the browser debugging extensions. Internal use only.


Return:
Object

getFailedConnectionText

public Object getFailedConnectionText()

Gets the text to display in an alert if the XMLHttpRequest fails.

Return:
Object
Overrides:
AdfPage.getFailedConnectionText()

_getFilterResult

private Object _getFilterResult(Object component,
                                Object filterFunction,
                                Object filterContext)

Parameters:
component    
filterFunction    
filterContext    
Return:
Object

_getFirstElementFromFragment

private Object _getFirstElementFromFragment(Object fragmentNode,
                                            Object needsUnescape)

Parameters:
fragmentNode    
needsUnescape    
Return:
Object

_getFirstElementWithId

private static Object _getFirstElementWithId(Object domNode)

Parameters:
domNode    
Return:
Object

_getFocusPath

private Array<HTMLElement> _getFocusPath()

Returns the current focus path, divorced of the actual DOM elements, so that the focus can be reapplied after the DOM has changed.

Return:
Array<HTMLElement> - An associative array of HTML elements with ids from the active element to the document. For each element, there is also a property with the id of the element and the index of the element with that id, making it easy to determine which elements are in the array.
See also:
_restoreFocusPath(Array<HTMLElement>, Object)

_getFormElement

private static Object _getFormElement(Object component)

Returns the form element for a component

Parameters:
component    
Return:
Object

getGlassPane

public Object getGlassPane()

Returns the GlassPane, creating it if it hasn't already been created

Return:
Object

_getHead

private Object _getHead()

Return:
Object

__getLastDomEvent

Object __getLastDomEvent()

Get access to the last DOM event that was fired by the browser

Return:
Object

getLastFocusedElement

public HTMLElement getLastFocusedElement(Object element)

Gets the last focused element.

Parameters:
element    
Return:
HTMLElement - The last focused element

getLazyFetchURI

public Object getLazyFetchURI(Object id)

Returns a URI for a lazy fetch request (used for loading Rich Text Editor's IFRAME)

Parameters:
id    
Return:
Object

_getLinkChildren

private Object _getLinkChildren(Object ancestor)

Parameters:
ancestor    
Return:
Object

_getMaxType

private Object _getMaxType()

Return:
Object

getMessageHandlerSlaveComponentId

public String getMessageHandlerSlaveComponentId()

Retrieves the component ID that is the slave to the default message handler (provides configuration attributes that the default handler can consume).

Return:
String - the ID of the component that provides attributes to the messages handler
Overrides:
AdfPage.getMessageHandlerSlaveComponentId()

getMessages

public Array getMessages(Object componentId)

Get FacesMessage objects associated with a particular component. If componentId is null then the system-wide messages will be returned.

Parameters:
componentId    
Return:
Array - an array of FacesMessages for the particular component or undefinied if there are no messages.
Overrides:
AdfPage.getMessages(Object)

getModalityManager

public AdfDhtmlModalityManager getModalityManager()

Returns the modality manager for this page.

Return:
AdfDhtmlModalityManager - null

getOutputMode

public Object getOutputMode()

Called by server to set the outputMode

Return:
Object

getPageId

public Object getPageId()

get the page instance Id

Return:
Object - Returns {String} pageId

getPageProperty

public Object getPageProperty(Object propertyName)

Gets the value of a page property. These properties are scoped to the page for the application's use. For almost all uses, this api should be use in preference to using native host objects as the relationship between and lifetimes of AdfPages and native host objects such as a browser's DOM window object aren't guaranteed.

Parameters:
propertyName    
Return:
Object - The value of this property or undefined if this property isn't set
See also:
setPageProperty(Object, Object)
Overrides:
AdfPage.getPageProperty(Object)

getPageStateId

public int getPageStateId()

Return:
int - page object id

_getParameterElement

private Object _getParameterElement(Object form,
                                    Object name)

Parameters:
form    
name    
Return:
Object

getPositionManager

public AdfDhtmlPositionManager getPositionManager()

Returns the position manager for this page.

Return:
AdfDhtmlPositionManager - null

_getPostbackContent

private Object _getPostbackContent(HTMLElement actionForm,
                                   Object params,
                                   Array<String> eventTargets)

Returns the payload to include in the rich postback

Parameters:
actionForm  -  Form to build up input elements for post in. This parameter can be null.
params  -  Name/value pairs to ensure that the form contains
eventTargets  -  array containing client ids of event target components
Return:
Object - Content encoded correctly in String form

getPPRNavigationOptions

public Object getPPRNavigationOptions()

Retrieves PPR Navigation options

Return:
Object - a bitwise combination of the possible PPR Navigation options

_getPPRURL

private Object _getPPRURL(Object element)

Parameters:
element    
Return:
Object

_getPublicAncestor

private Object _getPublicAncestor(Object component)

Parameters:
component    
Return:
Object

_getQueryParamsFromActionUrl

private Object _getQueryParamsFromActionUrl()

Return:
Object

getResourceURL

public Object getResourceURL(Object path)

Returns the resource URL for the given path. Note: Resource paths starting with "/" are relative to the base resource url, resource paths starting with "//" are absolute and all other resource paths are not changed.

Parameters:
path    
Return:
Object
See also:
removeResourceURL(Object)
Overrides:
AdfPage.getResourceURL(Object)

getResponseIdentifier

public Object getResponseIdentifier()

Returns an identifier for the previous response if one is available. Depending on how the system is configured, this may return null or an identifier that doesn't exactly match the identifier used by the middle tier.

Return:
Object - An identifier for the previous response, if available
Overrides:
AdfPage.getResponseIdentifier()

getRootClientId

public String getRootClientId()

Returns the value of the rootClientId, if set

Return:
String - value of the page's root client id
Overrides:
AdfPage.getRootClientId()

_getScriptLoadingService

private Object _getScriptLoadingService()

Return:
Object

getSelectedEditingComponents

public Array<AdfUIComponent> getSelectedEditingComponents()

Returns the array of AdfUIComponents currently selected for inline editing, or null if no AdfUIComponents are selected.

Return:
Array<AdfUIComponent> - null
See also:
setSelectedEditingComponents(Array<AdfUIComponent>)
getEditableSubtree()
setEditableSubtree(AdfUIComponent)
Overrides:
AdfPage.getSelectedEditingComponents()

getSessionIdentifier

public Object getSessionIdentifier()

Returns an identifier for the current middle-tier session if one is available. Depending on how the system is configured, this may return null or an identifier that doesn't exactly match the identifier used by the middle tier.

Return:
Object - An identifier for this user session, if available
Overrides:
AdfPage.getSessionIdentifier()

__getSessionTimeoutHelper

Object __getSessionTimeoutHelper()

Gets the helper object that manages session timeout

Return:
Object

_getSubtreeRootNode

private Object _getSubtreeRootNode(Object rootId)

Parameters:
rootId    
Return:
Object

getUncommittedRegionIds

public Object getUncommittedRegionIds()

Determines which regions (if any) contain uncommitted data.

Return:
Object
Overrides:
AdfPage.getUncommittedRegionIds()

__getUserInactivityTimeoutHelper

Object __getUserInactivityTimeoutHelper()

Return an instance of AdfUserInactivityTimeoutHelper if user inactivity timeout feature is enabled. If a page has <af:poll> component or supports ADS, the function returns an AdfUserInactivityTimeoutHelper object. Otherwise, the returned value is undefined.

Return:
Object

getViewId

public Object getViewId()

Returns an identifier for the current view being displayed in the page. The viewId is typically set when either a full page render or a PPR Navigation occurs.

Return:
Object - the current logical view identifier for the page or an empty String if a viewId is unavailable.
Overrides:
AdfPage.getViewId()

getWindowId

public Object getWindowId()

convenience method for getting the window ID, i.e. window.name

Return:
Object - Returns {String} this window's window Id

getZOrderManager

public AdfDhtmlZOrderManager getZOrderManager()

Returns the z-order manager for this page.AdfDhtmlPage().

Return:
AdfDhtmlZOrderManager - null

_handleBeforeUnload

private Object _handleBeforeUnload(Object evt)

the onbeforeunload event handler we attach to window

Parameters:
evt    
Return:
Object

__handleGlobalError

Object __handleGlobalError(String msg,
                            String url,
                            int line)

This method is caleld from the onerror handler used when test automation is enabled (see bug #9939286)

Parameters:
msg    
url    
line    
Return:
Object

_handleInvalidPprResponse

private Object _handleInvalidPprResponse(Object responseText,
                                         Object requestContext,
                                         Object requestEvent)

Called when we receive invalid (non-XML) response to PPR or streaming request

Parameters:
responseText    
requestContext    
requestEvent    
Return:
Object

_handleKey

private Object _handleKey(Object event)

Checks whether the key matches a registered global key handler

Parameters:
event    
Return:
Object

_handleNavigation

private Object _handleNavigation(Object url,
                                 Object target)

Handle GET request triggered by clicking Faces navigation components. If PPR-Navigation is enabled and navigation is within the application, it will be processed as a PPR-Navigation. Called by following components af:goLink af:goButton af:goImage af:commandNavigationItem af:goMenuItem

Parameters:
url  -  fully qualified URL or a relative URL of the application
target  -  target to load the url, possible values _blank Open the linked document in a new window _self Open the linked document in the same frame as it was clicked (this is default) _parent Open the linked document in the parent frameset _top Open the linked document in the full body of the window framename Open the linked document in a named frame
Return:
Object - false so the default handler is skipped

__handleNavigationClick

Object __handleNavigationClick(Object evt,
                                Object url,
                                Object target)

onclick event handler for Faces navigation components with GET request, here we only handle it if left button is clicked by clalling _handleNavigation, otherwise let the browser to handle it. Handle following components: af:goLink af:goButton af:goImage

Parameters:
evt  -  event of mouse click
url  -  fully qualified URL or a relative URL of the application
target  -  target to load the url, possible values _blank Open the linked document in a new window _self Open the linked document in the same frame as it was clicked (this is default) _parent Open the linked document in the parent frameset _top Open the linked document in the full body of the window framename Open the linked document in a named frame
Return:
Object - true if it is not a left click, false otherwise Called from HTML, needs exporting

__handleReload

void __handleReload()

This is called from two locations to force the page to be reloaded:
  • In response to a IllegalActiveDataStateException.
  • To handle a Ctrl+N in IE. IE will sometimes load the cached page. The __validateWindowId(Object) will force a page reload if the window id doesn't match the last know windowId.

Return:
void - null
See also:
__validateWindowId(Object)

_handleResize

private Object _handleResize()

Called when the window is resized

Return:
Object

_handleRichResponse

private Object _handleRichResponse(Object responseDocument,
                                   Object reqContext)

Parameters:
responseDocument    
reqContext    
Return:
Object

__handleRichResponseAction

Object __handleRichResponseAction(Object action,
                                   Object pprAction)

Parameters:
action    
pprAction    
Return:
Object

_handleRichResponseFragment

private Object _handleRichResponseFragment(Node fragmentNode,
                                           Array<HTMLElement> resizeDomNodes,
                                           Object domReplacedIds,
                                           Boolean needsUnescape,
                                           Array<HTMLElement> savedFocusPath,
                                           Boolean isStreaming)

Handles a single fragment node in a rich response. We will also perform DOM replacement notification and add the node to the list of resize dom nodes.

Parameters:
fragmentNode  -  XML DOM Node from PPR response holding content to replace document content
resizeDomNodes  -  in array of DOM Nodes that will need to be resized
domReplacedIds    
needsUnescape  -  true if "xml" elements need to be unescaped (see bug #6164928), false otherwise
savedFocusPath  -  Associative array of HTML Elements in the focus path
isStreaming  -  true is this is a streaming response, false otherwise
Return:
Object - fragmentValues an object carrying the parameters 'restoreFocusIndex' and 'pprNavParams'. The restore focus index will contain a value if an element should gain focus. The ppr nav params is an object carrying the parameters for the future invocation of AdfNavigationHistoryAgent.setCurrentViewId. The attributes on the object are 'viewId' and 'queryParams'. If no PPR navigation occurred, the ppr nav params will be null.

_handleRichResponseLibrary

private Object _handleRichResponseLibrary(Object scriptNode)

Parameters:
scriptNode    
Return:
Object

_handleRichResponseScript

private Object _handleRichResponseScript(Object scriptNode)

Parameters:
scriptNode    
Return:
Object

handleStreamingResponse

public Object handleStreamingResponse(Object doc,
                                      Object id,
                                      Object needsUnescape)

Called when a single streaming data fragment has arrived This function will be called form a script block embedded in the XHTML content sent over the streaming IFRAME

Parameters:
doc  -  The document where the streaming block may be found (the IFRAME's document)
id  -  The id of the data fragment
needsUnescape  -  true if "xml" elements need to be unescaped (see bug #6164928), false otherwise
Return:
Object

hasMessages

public Boolean hasMessages(String componentId)

Returns true if this particular component has messages or false if it does not.

Parameters:
componentId  -  a componentId or null for global messages
Return:
Boolean - true if messages are present and false if not
Overrides:
AdfPage.hasMessages(String)

hideFloatingDiv

public Object hideFloatingDiv(Object floatingDiv)

Hide's a floating Div and cleans out its content

Parameters:
floatingDiv    
Return:
Object

hideGlassPane

public Object hideGlassPane(Object listenerMap)

Hide the GlassPane, removing all of the listeners in the listener map

Parameters:
listenerMap    
Return:
Object

incrementPendingAnimation

public Object incrementPendingAnimation()

Add one to the number of pending animations.

Return:
Object
See also:
decrementPendingAnimation()

Init

protected Object Init(Object lookAndFeel,
                      Object domWindow)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:
lookAndFeel    
domWindow    
Return:
Object
Overrides:
AdfObject.Init()

InitClass

protected static Object InitClass()

Initializes the AdfDhtmlPage class

Return:
Object

__initializeSessionTimeoutTimer

Object __initializeSessionTimeoutTimer(Object timeout,
                                        Object warningBeforeTimeout,
                                        Object newSessionURL)

Initializes the session timer on the client side, and shedules showing the session timeout warning and final timeout dialog.

Parameters:
timeout    
warningBeforeTimeout    
newSessionURL    
Return:
Object

__initUncommittedDataWarningForDocument

Object __initUncommittedDataWarningForDocument(Object enabled)

Initializes uncommitted data warning facility for the document

Parameters:
enabled  -  boolean indicating whether warnings are enabled
Return:
Object

__initUserInactivityTimeout

Object __initUserInactivityTimeout(Object userInactivityTimeout)

Called by "DocumentRenderer" to initialize the user inactivity timeout for active components, like <af:poll> and ADS. If it is enabled, it stops those active components interacting with server after the user is inactive (no interaction with mouse or keyboard) for a period of the timeout to allow application's session to expire.

Parameters:
userInactivityTimeout  -  the default value or value set in web.xml of time (in ms) the user is inactive after which client stops active components
Return:
Object

_inlineSelectionListener

private Object _inlineSelectionListener(Object event)

Event capture listener used to select and start editing of components when we are in editing mode

Parameters:
event    
Return:
Object
See also:
setEditableSubtree(AdfUIComponent)
setSelectedEditingComponents(Array<AdfUIComponent>)
getEditedComponent()

_inlineSelectionStub

private static Object _inlineSelectionStub(Object event)

Event capture stub used with in-place editing. This stub establishes "this" and calls _inlineSelectionListener.

Parameters:
event    
Return:
Object

_insertReduce

private static Object _insertReduce(Object state,
                                    Object createURL)

Reduce callback for inserting new skin stylesheets

Parameters:
state    
createURL    
Return:
Object

_installBlockingHandler

private Object _installBlockingHandler(HTMLDocument ownerDocument)

Creates a blocking pane, masking frame and installs keyboard blocking.

Parameters:
ownerDocument  -  root dom node
Return:
Object
See also:
_blockUI(Object, Object)
getGlassPane()

_intersectSelectionWithEditableSubtree

private Object _intersectSelectionWithEditableSubtree(AdfUIComponent editableSubtree,
                                                      Object selection)

Given the proposed selected components, returns an array of those that are in the editable subtree.

Parameters:
editableSubtree  -  Root of editable subtree
selection    
Return:
Object - null {AdfUIComponent[]) array of valid selected components or null

_intersectSelectionWithEditableSubtreeDom

private Object _intersectSelectionWithEditableSubtreeDom(Object editableSubtreeDom,
                                                         Object selection)

Given the proposed selected components, returns an array of those that are in the editable subtree.

Parameters:
editableSubtreeDom    
selection    
Return:
Object - null {AdfUIComponent[]) array of valid selected components or null

isActiveDataSupported

public Object isActiveDataSupported()

Return:
Object

_isAdfForm

private Object _isAdfForm(Object form)

Parameters:
form    
Return:
Object

_isAncestorComponent

private Boolean _isAncestorComponent(AdfUIComponent possibleAncestor,
                                     AdfUIComponent possibleChild)

Returns true if the possibleAncestor is an ancestor of component

Parameters:
possibleAncestor  -  Component to check for ancestorship with possibleChild
possibleChild  -  Component to check for descendance from possibleAncestor
Return:
Boolean - null true if the possibleAncestor is an ancestor of component
See also:
_isAncestorComponentOrSelf(AdfUIComponent, AdfUIComponent)

_isAncestorComponentOrSelf

private Boolean _isAncestorComponentOrSelf(AdfUIComponent possibleAncestor,
                                           AdfUIComponent possibleChild)

Returns true if the possibleAncestor is an ancestor of component or the component iself.

Parameters:
possibleAncestor  -  Component to check for ancestorship with possibleChild
possibleChild  -  Component to check for descendance from possibleAncestor
Return:
Boolean - null true if the possibleAncestor is an ancestor of component or the component itself.
See also:
_isAncestorComponent(AdfUIComponent, AdfUIComponent)

isAnimationEnabled

public Object isAnimationEnabled()

Tests if animation is enabled for the page.

Return:
Object
Overrides:
AdfPage.isAnimationEnabled()

isAttachmentMode

public Object isAttachmentMode()

Tests whether the page is running in attachment output mode.

Return:
Object

isAutomationEnabled

public Object isAutomationEnabled()

Tests if automation is enabled for the page.

Return:
Object
Overrides:
AdfPage.isAutomationEnabled()

_isComponentInlineSelectable

private Boolean _isComponentInlineSelectable(HTMLElement componentDomElement)

Determines whether the component is inline selectable based on the presence of style classes on the component's DOM

Parameters:
componentDomElement    
Return:
Boolean - Returns true if the component is inline selectable

isCoreBackgroundScriptLoaded

public boolean isCoreBackgroundScriptLoaded()

Return:
boolean - null true if the script partition containing a good chunk of the popup code has been lazily loaded.

__isDirtyPostbackPayloadsEnabled

Object __isDirtyPostbackPayloadsEnabled()

Return:
Object

isDragging

public Object isDragging()

Determines whether a drag operation is in progress

Return:
Object - true if drag operation is in progress, false otherwise

isPageFullyLoaded

public Boolean isPageFullyLoaded()

Automation tools such as selenium use this function to verify that our rich page has successfully loaded. It should be called after an action event triggers a full-page postback. There are several conditions that need to be checked to determine the page has fully loaded resulting from a full page postback.
  1. Queued action events that invoke full-page postbacks are still queued and processed within a timed event loop. We must check to make sure that the server event queues are empty to ensure that pending events have been packaged up and sent to the server.
  2. Check to make sure that we are not waiting on the document to unload. This would be the state after the full page postback but before the document is unloaded.
  3. Next, we need to verify that the page has been fully loaded and that all client-side components have been initialized. The _initializationComplete flag is set after the on load callbacks have been invoked.
  4. The last check is to make sure that the page has finished table data streaming requests on the initial page load.

Return:
Boolean - null true if the page is fully loaded with all content is available.
See also:
isSynchronizedWithServer()

isPageOnloadCalled

public Boolean isPageOnloadCalled()

Return:
Boolean - null true if page onload and __onload get called.

isPerformingFullSubmit

public Boolean isPerformingFullSubmit()

Return:
Boolean - null true if we currently have an outstanding full page submit.

isPortlet

public Boolean isPortlet()

Returns whether or not this Page is in a Portlet context based on an internal flag.

Return:
Boolean - true if we are within a portlet context
Overrides:
AdfPage.isPortlet()

isPPRNavigationEnabled

public Boolean isPPRNavigationEnabled()

Returns whether or not PPR-Navigation is enabled.

Return:
Boolean - true if it is

_isPrintablePage

private boolean _isPrintablePage()

Return:
boolean - returns true if the page is in "printable" mode.

isProcessingIndicatorDisplayed

public Object isProcessingIndicatorDisplayed()

Returns whether the processing indicator is displayed or not

Return:
Object - boolean indicating if the processing indicator is displayed or not

_isRichResponseDirty

private Object _isRichResponseDirty()

Return:
Object

isScreenReaderMode

public Object isScreenReaderMode()

Tests whether the page is running in screen reader mode.

Return:
Object
Overrides:
AdfPage.isScreenReaderMode()

__isSeleniumRC

Object __isSeleniumRC()

Tests whether we are running under Selenium RC.

Return:
Object

_isSeleniumRCWindow

private Object _isSeleniumRCWindow(Object domWindow)

Parameters:
domWindow    
Return:
Object

isStreamingDisabled

public Object isStreamingDisabled()

Determines whether table data streaming is disabled

Return:
Object - true is streaming has been disabled

isStreamingRequestPending

public Object isStreamingRequestPending(Object id)

Parameters:
id    
Return:
Object

isSynchronizedWithServer

public Boolean isSynchronizedWithServer()

The logic for checking for completion of a full page postback has been combining with the logic to check for a partial page postback. The following conditions indicate the page has completed a request to the server:
  1. Make sure we are not in the critical section of redistributing native events to component events.
  2. Checks the pre-server queue (initial queue) to make sure it is empty. In some cases, client only events queue events that propagates to the server.
  3. Make sure that the data transfer server is in a ready state and that we are not waiting on a data streaming request that would occur on the initial page load of a full submit or during ppr navigation.
  4. Checking to see that the page was fully loaded. This check only applies to a full page postback when it is called from isPageFullyLoaded. For a pure PPR request, this flag will be set during the initial page load. Full page postback also toggle off this flag to indicate we are waiting on a new document. For attachment mode, we bypass the rest of the conditions.
  5. Checking to make sure that our event queues are empty and that all pending requests have been processed including the active data service channel.
  6. Check to see if we are actively processing the event queue. The _inDeliverQueuedServerEvents flag indicates when we are folding together a PPR request or processing the response.
  7. If a full-page postback that expects a response has been issued, make sure that we are not waiting for the document to unload.

Return:
Boolean - null true if the client has no outstanding state to synchronize with the server. This function is used by automated testing tools in order to wait until the client has been appropriately updated.
See also:
isPageFullyLoaded()
Overrides:
AdfPage.isSynchronizedWithServer()

_isTrackingDirtyData

private Object _isTrackingDirtyData()

Return:
Object

_isTrackingDocumentUncommittedData

private Object _isTrackingDocumentUncommittedData()

Return:
Object

_isTrackingRegionClientUncommittedData

private Object _isTrackingRegionClientUncommittedData()

Return:
Object

_isTrackingRegionUncommittedData

private Object _isTrackingRegionUncommittedData()

Return:
Object

_isUIBlocked

private Boolean _isUIBlocked(Object reason)

Returns whether the UI is currently blocked in the rich page.

Parameters:
reason  -  Optional param that allows testing for specific type of block. One of _UI_BLOCK_REASON_PPR or _UI_BLOCK_REASON_SCRIPT_LOADING. If unspecified, tests whether any block is occurring, regardless of the reason.
Return:
Boolean - indicating if the UI is currently blocked in the rich page

_isUncheckedInput

private Object _isUncheckedInput(Object inputElement)

Parameters:
inputElement    
Return:
Object

isUserActivityMonitoringOn

public Object isUserActivityMonitoringOn()

Return:
Object

_jsfAjaxAddOnError

private Object _jsfAjaxAddOnError(Object callback)

Parameters:
callback    
Return:
Object

_jsfAjaxAddOnEvent

private Object _jsfAjaxAddOnEvent(Object callback)

Parameters:
callback    
Return:
Object

_jsfAjaxRequest

private Object _jsfAjaxRequest(Object source,
                               Object event,
                               Object options)

Parameters:
source    
event    
options    
Return:
Object

_keyEventCallback

private static Object _keyEventCallback(Object event)

Static stub callback for ensuring that we have an event and using the correct "this"

Parameters:
event    
Return:
Object

launchHelpWindow

public Object launchHelpWindow(Object url)

Method that will launch the help window given a url.

Parameters:
url    
Return:
Object
Overrides:
AdfPage.launchHelpWindow(String)

_loadBackgroundScript

private Object _loadBackgroundScript(Object source)

Parameters:
source    
Return:
Object

__loadCoreBackgroundScript

Object __loadCoreBackgroundScript(Object url)

Parameters:
url    
Return:
Object

_loadCss

private Object _loadCss(Object source)

Parameters:
source    
Return:
Object

_loadScript

private Object _loadScript(Object source)

Parameters:
source    
Return:
Object

_loadSynchronousScript

private Object _loadSynchronousScript(Object source)

Parameters:
source    
Return:
Object

loadView

public Object loadView(Object viewId,
                       Object params,
                       Object loadId,
                       Object pageId)

This function is called by AdfNavigationHistoryAgent when it needs to load a new view

Parameters:
viewId    
params    
loadId    
pageId    
Return:
Object

localNavigate

public Object localNavigate(String uri)

Issue a GET request for a local page and perform a page transition. This method is supported only for pages within the same web application. If PPR Navigation is enabled, this method loads the page via PPR.

Parameters:
uri  -  for the new page
Return:
Object
Overrides:
AdfPage.localNavigate(String)

logAsGlobalError

public Object logAsGlobalError(Object e)

Parameters:
e    
Return:
Object

_logAsGlobalError

private Object _logAsGlobalError(Object e)

Parameters:
e    
Return:
Object

mapComponent

public Object mapComponent(Object clientId,
                           Object component)

Adds a component to the clientID map. Only the implementation should ever need to call this function.

Parameters:
clientId    
component    
Return:
Object

_mapInputElementToComponent

private Object _mapInputElementToComponent(Object inputElement)

Parameters:
inputElement    
Return:
Object

__markSeleniumRC

Object __markSeleniumRC()

Called our Selenium RC-specific user-extensions.js code to let us know that we are running under RC.

Return:
Object

_marshallMultipleEventParameters

private Object _marshallMultipleEventParameters(Object paramList)

Parameters:
paramList    
Return:
Object

_mergeFormParamValues

private Object _mergeFormParamValues(Object oldValue,
                                     Object newValue)

Parameters:
oldValue    
newValue    
Return:
Object

moveMaskingFrame

public Object moveMaskingFrame(Object element,
                               Object maskFrame)

Moves a masking IFrame underneath a floating element.

Parameters:
element  -  the element associated with the masking frame
maskFrame  -  the maskFrame instance to be moved
Return:
Object

_navResetPage

private Object _navResetPage()

Return:
Object

needsWindowUnload

public Object needsWindowUnload()

Mark that this page needs windowUnloaded events.

Return:
Object

_nodeListToArray

private Object _nodeListToArray(Object nodeList)

Parameters:
nodeList    
Return:
Object

_notifyComponent

private Object _notifyComponent(Object componentId,
                                Object messageArray)

Notifies a component that it's message queue has changed

Parameters:
componentId    
messageArray    
Return:
Object

_notifyComponentEventListeners

private Object _notifyComponentEventListeners(Object componentEvent)

Parameters:
componentEvent    
Return:
Object

__notifyReturnFromDialog

void __notifyReturnFromDialog()

Called when the DialogService closes the dilaog programmatically within a partial request. The context of the call is the dialog window versus the parent window.

Return:
void - null

__notifyWindowCloseImmediately

Object __notifyWindowCloseImmediately(Object windowClosed,
                                       Object returnId)

this method notifies the server about window closed event. It is hooked into the window's onbeforeunload event, inline dialog and browser window dialog onunload event, so it's a immediate XMLHttpRequest.

Parameters:
windowClosed    
returnId  -  dialog popup return id
Return:
Object

_notifyWindowEvent

private Object _notifyWindowEvent(Object isWindowOpen,
                                  Object windowId,
                                  Object pageId,
                                  Object isDialog)

build the notify window open/unregister event and queue the event this function puts the event information into the global variable _windowEventHeaderMap, which afterwards got cleaned up by deliverQueuedServerEvents()

Parameters:
isWindowOpen  -  this the boolean indicates the type of the event - true windowOpened event - false windowUnregistered event
windowId  -  the window Id
pageId  -  the page Id
isDialog  -  true if the window is a dialog, otherwise false
Return:
Object

_notifyWindowOpened

private Object _notifyWindowOpened(Object isDialog)

Parameters:
isDialog    
Return:
Object

notifyWindowUnloaded

public void notifyWindowUnloaded()

Send window-unloaded notification if necessary

Return:
void - null

_notifyWindowUnregistered

private Object _notifyWindowUnregistered(Object windowId,
                                         Object pageId)

Parameters:
windowId    
pageId    
Return:
Object

__onLoad

Object __onLoad()

Called when the window first loads. The actual onload handler lives in a script which is rendered at the end of the HTML document by the DocumentRenderer. AdfDhtmlPage.__onLoad() is called by this script. Since __onLoad is called from outside of AdfDhtmlPage, we make it package-private so that we don't have to worry about the method name being obfuscated once we start obfuscating private method names.

Return:
Object

_onLoadPerfTimings

private Object _onLoadPerfTimings()

Return:
Object

_onResize

private Object _onResize()

Return:
Object

_onSelectStart

private Object _onSelectStart()

Cancel drag selection if we're already dragging

Return:
Object

pageIdNotSavedWithURI

public Object pageIdNotSavedWithURI()

Specifies that page Id should not be saved with the URI

Return:
Object

__perfTimings

Object __perfTimings(Boolean closeRecord,
                      Boolean closeBefore,
                      Boolean timing,
                      String str1,
                      String str2)

For performance timings. Times the event.

Parameters:
closeRecord  -  should the log record be closed or not
closeBefore  -  should the log record be closed before or after logging
timing  -  should it be loged when only timing is on
str1  -  first string to be logged
str2  -  second string to be logged
Return:
Object

_positionBlockingGlassPane

private Object _positionBlockingGlassPane(Boolean assumeVisible)

Position the blocking pane to fill the visible area of the window.

Parameters:
assumeVisible  -  true if assumed visible
Return:
Object

_positionGlassPane

private Object _positionGlassPane(Boolean assumeVisible)

Position the GlassPane to fill the visible area of the window.

Parameters:
assumeVisible  -  true if assumed visible
Return:
Object

_postOrderPopulate

private Object _postOrderPopulate(Object targetNode,
                                  Object depth,
                                  Object depthArrays,
                                  Object ignoreHidden)

Parameters:
targetNode    
depth    
depthArrays    
ignoreHidden    
Return:
Object

_postOrderPopulateComponent

private Object _postOrderPopulateComponent(Object clientId,
                                           Object depth,
                                           Object depthArrays)

Parameters:
clientId    
depth    
depthArrays    
Return:
Object

preloadImages

public Object preloadImages()

Requests that the page attempt to preload/force loading for all images present in the DOM on document ready. This call is advisory, and will generally have no effect once the page is already loaded.

Return:
Object

_prepareForIncompleteImages

private Object _prepareForIncompleteImages()

Return:
Object

prepareMaskingFrame

public void prepareMaskingFrame(HTMLElement element)

Makes sure that a masking frame is available in the maskFramePool, in anticipation of an upcoming call to createMaskingFrame method. This method was implemented for fixing bug 7137710, where some users would see a popup display blip during popup animation in the case where a new iframe was being created by the createMaskingFrame method.

Parameters:
element  -  the element underneath which to create the masking frame
Return:
void - null

_processValidators

private Object _processValidators(Object sourceComponent,
                                  Object eventRoots,
                                  Object onlyImmediate)

Parameters:
sourceComponent  -  used to determine which subform(s) to validate.
eventRoots  -  [optional] the root of the subtree to validate. If rootComponent is null the sourceComponent's parent form is used.
onlyImmediate  -  [optional] whether only immediate fields are validated
Return:
Object - boolean indicating whether or not all the field's are valid.

_pushEditableComponent

private Object _pushEditableComponent(Array<AdfUIEditableComponent> editableComponents,
                                      String clientId)

Determines whether the specified client id corresponds to an AdfUIEdtiable component and if so pushes it into an array.

Parameters:
editableComponents  -  array containing AdfUIEditableValue components
clientId  -  the client id to test
Return:
Object

__queueDescendantResizeNotifySource

Object __queueDescendantResizeNotifySource(AdfUIComponent component)

=-= Unsupported, internal method per Andy and Blake discussion. Queues a component that has caused a potential change to any of its ancestor's dependency on descendant resize notification. For example, this component had a property change that changed its dimensions and thus would require an ancestor panelStretchLayout's automatic height to be recomputed.

Parameters:
component    
Return:
Object

queueEvent

public Object queueEvent(Object event)

Queues the specified event for delivery during the next event delivery phase.

Parameters:
event    
Return:
Object

__queueEventTimerIfNeeded

Object __queueEventTimerIfNeeded(Object timeout)

Queue a timer to run the event thread.

Parameters:
timeout    
Return:
Object

queueEventToServer

public Object queueEventToServer(Object event)

Queues an event for later delivery to the server

Parameters:
event    
Return:
Object
Overrides:
AdfPage.queueEventToServer(Object)

_reattachInlineEditing

private void _reattachInlineEditing(Array pendingEditableSubtrees)

Filters pending editable subtree notes after the complete response has been applied to the document. This only applies with in inline editing mode.

Parameters:
pendingEditableSubtrees  -  new source nodes that need to be reattached to inline edit mode
Return:
void - null

_redistribute

private void _redistribute(HTMLDomEvent event)

Converts the native dom event into a AdfComponentEvent that is queueed and then sent to the target component.

Parameters:
event  -  native event
Return:
void - null

__registerDescendantResizeNotifyComponent

Object __registerDescendantResizeNotifyComponent(AdfUIComponent component)

=-= Unsupported, internal method per Andy and Blake discussion. Register a component to recieve resize notification when a descendant has a size change. The component's resizeNotify() method will be called when the resize occurs. The component being registered must also be registered for normal, top-down resize notifications. Application developers should not need to call this method explicitly. Components which are interested in resize events will manually register themselves.

Parameters:
component    
Return:
Object

registerDirtyDataComponent

public Object registerDirtyDataComponent(AdfUIComponent component,
                                         Object level)

Registers a component with special dirty data handling. If level is "always" then the uncommitedDataWarning will always be displayed even when not configured for those components. Components which are registered will need to expose the method isDataDirty() on the peer and if the return value is true the warning is displayed.

Parameters:
component  -  AdfUIComponent instance to register.
level  -  a string indicating the level, such as "always"
Return:
Object

_registerGetRequestNavigationTracking

private Object _registerGetRequestNavigationTracking()

Return:
Object

registerKeyStroke

public Object registerKeyStroke(AdfKeyStroke keystroke,
                                Function callback,
                                Object callbackContext)

Registers a global keyboard shortcut/accelerator.

Parameters:
keystroke  -  the key combination for the accelerator
callback  -  the function called in response to the keystroke. The function takes a single argument--the KeyStroke pressed and returns false if the callback did not handle the event.
callbackContext  -  Object to pass as "this" when calling context
Default value = undefined
Return:
Object

registerLoadingComponent

public Object registerLoadingComponent(AdfUIComponent component)

Registers a component that isn't fully loaded on creation with the framework. This allows automated testing tools to wait until the component is ready before interacting with it. AdfUIComponent instances may only be registered once.

Parameters:
component  -  AdfUIComponent instance to register.
Return:
Object
See also:
unregisterLoadingComponent(AdfUIComponent)
Overrides:
AdfPage.registerLoadingComponent(AdfUIComponent)

__registerRegionClientUncommittedDataTracking

Object __registerRegionClientUncommittedDataTracking(Object clientId)

Parameters:
clientId    
Return:
Object

registerResizeNotifyComponent

public Object registerResizeNotifyComponent(AdfUIComponent component)

Register a component to recieve resize notification when the browser window is resized. The component's resizeNotify() method will be called when the resize occurs. Application developers should not need to call this method explicitly. Components which are interested in resize events will automatically register themselves.

Parameters:
component    
Return:
Object
Overrides:
AdfPage.registerResizeNotifyComponent(Object)

_removeAllFormElements

private static Object _removeAllFormElements(Object formObject)

remove all form elements, such as inputs requires a valid form object to be passed in

Parameters:
formObject    
Return:
Object

_removeBlockingHandler

private Object _removeBlockingHandler(HTMLDocument ownerDocument)

Removes the blocking pane and masking frame. Returns focus and uninstalls the keboard blocker.

Parameters:
ownerDocument  -  root dom node
Return:
Object
See also:
_blockUI(Object, Object)

removeBusyStateListener

public Object removeBusyStateListener(Object instance,
                                      Function listener)

Removes a listener so that it will no longer be invoked whenever there is a busy state event. Application developers should not need to call this method explicitly. Components which are interested in busy state events will automatically unregister themselves, typically in their ComponentRemoved peer implementation.

Parameters:
instance  -  the object registered to be used as 'this' when invoking the handler
listener  -  the previously-registered listener to no longer invoke when there is a busy state event
Return:
Object
See also:
addBusyStateListener(Object, Function)
_broadcastBusyStateEvent(Boolean)
Overrides:
AdfPage.removeBusyStateListener(Object, Function)

removeComponentsInSubtree

public Object removeComponentsInSubtree(Object targetDomElement)

Removes all of the componetns in the subtree specified by the clientId

Parameters:
targetDomElement    
Return:
Object

removeEventListener

public Object removeEventListener(Object eventType,
                                  Object listener,
                                  Object instance)

Parameters:
eventType    
listener    
instance    
Return:
Object

removeMaskingFrame

public Object removeMaskingFrame(Object maskFrame)

Removes the masking IFrame underneath a floating element.

Parameters:
maskFrame  -  the maskFrame instance to be moved
Return:
Object

removePageResources

public Object removePageResources()

Removes CSS resources added to the page via af:resource during a PPR navigation to ensure styles from one page are not carried over to the next.

Return:
Object

__removePopupInfo

Object __removePopupInfo(Object component,
                          Object popupId)

Called by AdfRichUIPeer to inform the page that a component is no longer popped up

Parameters:
component    
popupId    
Return:
Object

removePropertyChangeListener

public Object removePropertyChangeListener(Object instance,
                                           Function listener)

Removes a PropertyChangeListener with the specified instance and listener function

Parameters:
instance  -  Object used as "this" when calling the listener
listener  -  Function to call when an AdfDhtmlPage property changes
Return:
Object
Overrides:
AdfPage.removePropertyChangeListener(Object, Function)

_removeResourcesByTagName

private static Object _removeResourcesByTagName(Object tagName,
                                                Object head)

Removes all of the resources with the specified name form the head section

Parameters:
tagName    
head    
Return:
Object

removeResourceURL

public Object removeResourceURL(Object resourcePath)

Returns the URL minus the resourceURL for the given path Note: Resource paths starting with "/" are relative to the base resource url, resource paths starting with "//" are absolute and all other resource paths are not changed.

Parameters:
resourcePath    
Return:
Object
See also:
getResourceURL(Object)

_removeStyleFromComponent

private Boolean _removeStyleFromComponent(String clientId,
                                          String styleClass)

Removes the style class from the component with the specified client id and returns whether it actually removed the style class

Parameters:
clientId    
styleClass    
Return:
Boolean - null

__replaceDomElement

Object __replaceDomElement(HTMLElement newElement,
                            HTMLElement oldElement)

Replaces the a dom element contained in a peer.

Parameters:
newElement  -  the new dom element
oldElement  -  the old dom element
Return:
Object

_replaceJsfAjaxFunctions

private Object _replaceJsfAjaxFunctions()

Replaces the jsf.ajax public API functions so that we can have JSF2 requests and responses channel through the rich client framework and honer queuing, client events and other rich framework architecture

Return:
Object

requestStatusChanged

public Object requestStatusChanged(Object requestEvent)

Parameters:
requestEvent    
Return:
Object

rescheduleTimer

public Object rescheduleTimer(Object timerId,
                              Number delay)

Reschedules the timer to fire delay</coee> milliseconds in the future

Parameters:
timerId  -  Identifier for the timer to reschedule
delay  -  Milliseconds in the future that the timer will refire
Return:
Object
See also:
scheduleTimer(Object, Function, Object, Object, Object)
cancelTimer(Object)

_resetPendingStreamingIDs

private Object _resetPendingStreamingIDs()

Return:
Object

_resetPerformingFullSubmit

private void _resetPerformingFullSubmit()

Called from a scheduled timeout from a full page postback that doesn't expect a response to reset the flag.

Return:
void - null
See also:
_handleBeforeUnload(Object)
_doFullPostback(Object, Object, Object, Object)

_resetUncommittedIds

private Object _resetUncommittedIds()

Return:
Object

_resolveMessageComponentId

private Object _resolveMessageComponentId(String componentId,
                                          Boolean useDefaultAsFallback)

Calculate the id of the component to show message associated with component whose id is componentId. When componentId is null the default message key that handles global messages is returned.

Parameters:
componentId  -  the clientid of the component to which the message will be added.
useDefaultAsFallback  -  - when componentId is not null and this parameter is set to true, the method attempts to locate a client component. If it cannot be found or if the component is not editable or does not have a companion af:message, the default message key is returned. When set to false, and if componentId is not null it will simply be returned.
Return:
Object

_restoreFocusPath

private Object _restoreFocusPath(Array<HTMLElement> focusPath,
                                 Object maxIndex)

Restores the focus to the best focusable element based on the focusPath

Parameters:
focusPath  -  A focusPath returned by _getFocusPath()
maxIndex    
Return:
Object
See also:
_getFocusPath()

_restorePreviousUserActivityData

private Object _restorePreviousUserActivityData()

Called during onload or when a PPR navigation of the entire view root / document occurs.

Return:
Object

_richResponseComplete

private Object _richResponseComplete(Object reqContext)

Parameters:
reqContext    
Return:
Object

_richResponseCompleteCallback

private Object _richResponseCompleteCallback(Object reqContext)

Parameters:
reqContext    
Return:
Object

_richUpdateComplete

private Object _richUpdateComplete(Object resizeDomNodes,
                                   Object domReplacedIds,
                                   Object pprNavParams,
                                   Object reqContext,
                                   Object savedFocusPath,
                                   Object pendingEditableSubtrees,
                                   Object oldActiveComponents)

Parameters:
resizeDomNodes    
domReplacedIds    
pprNavParams    
reqContext    
savedFocusPath    
pendingEditableSubtrees    
oldActiveComponents    
Return:
Object

_richUpdateCompleteCallback

private Object _richUpdateCompleteCallback(Object state)

Parameters:
state    
Return:
Object

scheduleTimer

public Object scheduleTimer(Object context,
                            Function callback,
                            Object state,
                            Object delay,
                            Object options)

Schedules a callback to be fired in the future.

The callback is of the form int callback(state)

If the callback returns a non-negative number, the callback will be rescheduled to run that many milliseconds in the future.


Parameters:
context  -  Object to pass as "this" to the callback
callback  -  function called when timer expires
state  -  State parameter passed to
delay    
options    
Return:
Object - the timer reference used for rescheduling or canceling the timer
See also:
rescheduleTimer(Object, Number)
cancelTimer(Object)

_scriptLoadingStatusChange

private Object _scriptLoadingStatusChange(Object status)

Parameters:
status    
Return:
Object

__scrollComponentIntoView

static Object __scrollComponentIntoView(Object clientId,
                                         Object focus)

Private function used from the server to scroll a component into view. Creates a timer to make sure all geometry events are complete.

Parameters:
clientId    
focus    
Return:
Object

_scrollComponentIntoView

private static Object _scrollComponentIntoView(Object argObj)

Private function to be called from a timer

Parameters:
argObj    
Return:
Object

_scrubPartialTargets

private Object _scrubPartialTargets(Object oldPartialTargets)

Returns a scrubbed partial targets array with any clientIds that are no longer in the DOM removed. This avoids cases where partial targets are added why we have an outstanding request that then removes that content when it returns

Parameters:
oldPartialTargets    
Return:
Object

_sendJsfAjaxEvent

private Object _sendJsfAjaxEvent(Object type,
                                 Object params)

Parameters:
type    
params    
Return:
Object

_sendRichPayload

private Object _sendRichPayload(Object params,
                                Object context)

Parameters:
params    
context    
Return:
Object

sendStreamingRequest

public Object sendStreamingRequest(Object pageStateId,
                                   Object iDs)

sends streaming requtest over an IFRAME

Parameters:
pageStateId    
iDs    
Return:
Object

setAccessibilityMode

public Object setAccessibilityMode(Object mode)

Sets the accessibility mode.

Parameters:
mode  -  The accessibility mode. Valid values are AdfDhtmlPage.SCREEN_READER_ACCESSIBILITY_MODE, AdfDhtmlPage.DEFAULT_ACCESSIBILITY_MODE, or AdfDhtmlPage.INACCESSIBLE_MODE. Note: this is method is not exposed on AdfPage and will not be. It is exclusively called by DocumentRenderer to initially the accessibility mode during the inital page render. There are no other callers of this method.
Return:
Object

_setActiveComponentId

private Object _setActiveComponentId(Object clientId)

Sets the page's active component to the component with the specified id.

Parameters:
clientId    
Return:
Object

__setActiveDomNodeInfo

Object __setActiveDomNodeInfo(HTMLElement domNode,
                               string clientId)

Sets the currently focused DOM Node and the clientID of the focused component Package private method, needed for cases where there's another document and the _redistribute method is not called. For example in the rich text editor where there's an iframe with its own document.

Parameters:
domNode  -  focus event target
clientId  -  the component nearest to the event target
Return:
Object - false if we can not activate this node; otherwise, true.

_setActiveTimeout

private Object _setActiveTimeout(Object argObj)

Parameters:
argObj    
Return:
Object

setAnimationEnabled

public Object setAnimationEnabled(Boolean enabled)

Sets the accessibility mode.

Parameters:
enabled  -  boolean value to set animation on/off
Return:
Object

__setAsynchronousUpdatesState

Object __setAsynchronousUpdatesState(String state)

Sets the asynchronous update's state

Parameters:
state  -  to be set
Return:
Object

__setAutomationEnabled

Object __setAutomationEnabled(Boolean enabled)

Sets the automation mode.

Parameters:
enabled  -  boolean value to set automation on/off
Return:
Object

_setCookie

private static Object _setCookie(Object domDocument,
                                 Object name,
                                 Object value,
                                 Object expiresAfter,
                                 Object path)

Sets the value of a cookie on the page.

Parameters:
domDocument  -  document object
name  -  cookie name string
value  -  value string for the cookie
expiresAfter  -  number of ms the cookie is alive, after its set
path    
Return:
Object

__setCssSelectorsUncompressed

Object __setCssSelectorsUncompressed(Object disabled)

Sets the compression mode for css selectors.

Parameters:
disabled    
Return:
Object

setDataDirty

public Object setDataDirty(Object isDirty)

Parameters:
isDirty    
Return:
Object

setDefaultMessageHandlerComponentId

public Object setDefaultMessageHandlerComponentId(String id,
                                                  String slaveId)

Sets the component id for global messages. Whenever page-level messages are added to the queue the component corresponding to this component id will be notified.

Parameters:
id  -  the ID of the component that handles the global messages
slaveId  -  the ID of the component that serves attributes to the handler
Return:
Object
Overrides:
AdfPage.setDefaultMessageHandlerComponentId(String, String)

__setDirtyRegions

Object __setDirtyRegions()

This method is called by the DirtyRegionTracker on each request. The arguments are client Ids of the regions that have dirty data on the server

Return:
Object

setDocumentClientId

public Object setDocumentClientId(Object documentClientId)

Parameters:
documentClientId    
Return:
Object

setEditableSubtree

public Object setEditableSubtree(AdfUIComponent newEditableSubtree)

Sets the root of the component subtree that inline-editing is allowed on. When the inline editing root is changed, all selected elements no longer included in the subtree will be removed from the selection.

Parameters:
newEditableSubtree    
Return:
Object
See also:
getSelectedEditingComponents()
setSelectedEditingComponents(Array<AdfUIComponent>)
setEditableSubtreeFilter(Function, Object)
Overrides:
AdfPage.setEditableSubtree(AdfUIComponent)

setEditableSubtreeFilter

public Object setEditableSubtreeFilter(Function callback,
                                       Object context)

Sets the filter applied to all components in the editable subtree. The subtree component and each of its component children will be passed to the callback function, if any, to determine whether the component is
  • AdfRichInlineEditor.FILTER_UNSELECTABLE
  • AdfRichInlineEditor.FILTER_SELECTABLE
  • AdfRichInlineEditor.FILTER_EDITABLE
If no callback is provided, all components are considered editable.

Parameters:
callback  -  Callback function of the form int(component), returning the AdfRichInlineEditor.FILTER_ constant determining the editability of the component.
context    
Return:
Object
See also:
setEditableSubtree(AdfUIComponent)
Overrides:
AdfPage.setEditableSubtreeFilter(Function, Object)

setEditedComponent

public Object setEditedComponent(AdfUIComponent newEditedComponent,
                                 Event event)

Attempts to start editing on the specified component with an option DOM event as the editing trigger. Calling this method has the following effects:
  1. If component is not part of the editable subtree, nothing will happen
  2. If the component is not part of the current selection, it will be added to the selection
  3. If the component allows inline editing, the inline editor for the property of the component indicated by the DOM event will be initiated.
Only components considered editable by the editable subtree filter can be set as the edited component.

Parameters:
newEditedComponent  -  Component to start editing
event  -  DOM Event used to start editing on this component
Return:
Object
See also:
getEditableSubtree()
setEditableSubtree(AdfUIComponent)
setEditableSubtreeFilter(Function, Object)
Overrides:
AdfPage.setEditedComponent(AdfUIComponent, Event)

setExpectedWindowId

public Object setExpectedWindowId(Object windowId)

Parameters:
windowId    
Return:
Object

setFacesPath

public Object setFacesPath(Object path)

This method is called by the DocumentRenderer during page initialization

Parameters:
path    
Return:
Object

__setGlobalMessagesResetStrategy

Object __setGlobalMessagesResetStrategy(Object strategy)

Sets the strategy that determines when global messages are to be cleared

Parameters:
strategy  -  used for clearing global messages
Return:
Object

setHelpWindowName

public Object setHelpWindowName(String windowName)

Method that will set the help window name. This is used when the help icon is pressed to determine the window name so that if there is already a help window that window is used (and a new one isn't created).

Parameters:
windowName  -  The name of the help window
Return:
Object
Overrides:
AdfPage.setHelpWindowName(String)

setLastFocusedElement

public Object setLastFocusedElement(Object element)

Sets the last focused element.

Parameters:
element    
Return:
Object

__setNonHtmlResponse

static Object __setNonHtmlResponse(Object event)

Forces an event to be submitted as a full-page event and mark it as one whose response will never be received by this framework (Excel export, file download)

Parameters:
event    
Return:
Object

__setNonHtmlResponsePartialSubmit

static Object __setNonHtmlResponsePartialSubmit(Object event)

In some instances an event will need to be forced to partial (ExportCollectionActionListener is one such case).

Parameters:
event    
Return:
Object

setOnLoadCallback

public Object setOnLoadCallback(Object onLoadCallback)

Sets the onLoad callback to fire when the AdfPage has finished loading. Note: This is an interim measure until we have a fully functional Lifecycle at the client.

Parameters:
onLoadCallback    
Return:
Object

__setOutputMode

Object __setOutputMode(Object outputMode)

Called by server to set the outputMode

Parameters:
outputMode    
Return:
Object

setPageId

public Object setPageId(String pageId)

set the page instance id

Parameters:
pageId  -  the page instance Id
Return:
Object

setPageProperty

public Object setPageProperty(Object propertyName,
                              Object propertyValue)

Sets the value of a page property. These properties are scoped to the page for the application's use. For almost all uses, this api should be use in preference to using native host objects as the relationship between and lifetimes of AdfPages and native host objects such as a browser's DOM window object aren't guaranteed.

Parameters:
propertyName    
propertyValue    
Return:
Object
See also:
getPageProperty(Object)
Overrides:
AdfPage.setPageProperty(Object, Object)

setPageStateId

public Object setPageStateId(Object id)

Updates the client with the new Page object id

Parameters:
id  -  - new state id
Return:
Object

_setParameter

private Object _setParameter(Object form,
                             Object name,
                             Object value)

Parameters:
form    
name    
value    
Return:
Object

setPortlet

public Object setPortlet(Boolean flag,
                         Object rootClientId)

Setter for internal variable

Parameters:
flag  -  set to true if we are in a portlet context
rootClientId    
Return:
Object

setPPRNavigationOptions

public Object setPPRNavigationOptions(Object options)

Sets PPR Navigation options

Parameters:
options    
Return:
Object

setProcessedRoots

public Object setProcessedRoots(Object ids,
                                Object immediateOnly)

Parameters:
ids    
immediateOnly    
Return:
Object

__setResponseIdentifier

Object __setResponseIdentifier(Object responseId)

Called by response handling code to save the ECID

Parameters:
responseId    
Return:
Object

_setRichResponseDirty

private Object _setRichResponseDirty(Object isDirty)

Parameters:
isDirty    
Return:
Object

setScriptLoadingPolicy

public Object setScriptLoadingPolicy(Object policy)

Sets the library loading policy used by AdfScriptLoadingService. Valid values are AdfScriptLoadingService.POLICY_SAME_ORIGIN, POLICY_CROSS_ORIGIN and POLICY_AUTO. Note: this is method is not exposed on AdfPage and will not be. It is exclusively called by DocumentRenderer to initialize the library loading policy during the inital page render. There are no other callers of this method.

Parameters:
policy    
Return:
Object

setSelectedEditingComponents

public Object setSelectedEditingComponents(Array<AdfUIComponent> newSelection)

Sets the array of AdfUIComponents for inline selection. Only components within the editable subtree will actually be selected. When the selection is changed, editing will be stopped on the current edited component if it is no longer part of the selection.

Only components considered selectable by the editable subtree filter can be set as the edited component.


Parameters:
newSelection    
Return:
Object
See also:
getEditableSubtree()
setEditableSubtree(AdfUIComponent)
getEditedComponent()
setEditedComponent(AdfUIComponent, Event)
setEditableSubtreeFilter(Function, Object)
Overrides:
AdfPage.setSelectedEditingComponents(Array<AdfUIComponent>)

_setSelectedEditingComponents

private Object _setSelectedEditingComponents(Array<AdfUIComponent> newSelection)

Sets the array of AdfUIComponents for inline selection. When the selection is changed, editing will be stopped on the current edited component if it is no longer part of the selection.

This function assumes that the intersection with the editable subtree has already occurred.


Parameters:
newSelection    
Return:
Object
See also:
setSelectedEditingComponents(Array<AdfUIComponent>)

__setSessionIdentifier

Object __setSessionIdentifier(Object sessionId)

Called by server to set the session indentifier

Parameters:
sessionId    
Return:
Object

__setShouldInterpretEmptyStringSubmittedValuesAsNull

Object __setShouldInterpretEmptyStringSubmittedValuesAsNull(Object interpretEmptyString)

Called by server to specify if the client validation should interpret an submitted empty strung as NULL

Parameters:
interpretEmptyString    
Return:
Object

__setShouldTracePPRRequestId

Object __setShouldTracePPRRequestId(Object tracePPRRequestId)

Set the flag to control whether we should trace request id on PPR request.

Parameters:
tracePPRRequestId    
Return:
Object

__setShouldValidateEmptyFields

Object __setShouldValidateEmptyFields(Object validateEmptyFields)

Called by server to specify if the client validation should validate empty fields

Parameters:
validateEmptyFields    
Return:
Object

setStreamingDisabled

public Object setStreamingDisabled(Object disabled)

Specifies whether table data streaming should be disabled

Parameters:
disabled  -  a boolean indicating wthether streaming should be disabled
Return:
Object

__setViewId

Object __setViewId(Object viewId)

Called from the server DocumentRenderer when a full page render or a PPR Navigation occurs. This is the viewId for the page.

Parameters:
viewId    
Return:
Object

__setWindowDetectionStrategy

void __setWindowDetectionStrategy(Object option)

This page flag is used to determine the strategy used by window detection. The default is "aggressive". This indicates that the window unloaded notification requests should be in a synchronized XML http request. A value of "passive" indicates that an asynchronous request should be used which is better performing but less reliable.

Parameters:
option    
Return:
void - null

setWindowId

public Object setWindowId(String windowId)

set the window id

Parameters:
windowId  -  the window id to set
Return:
Object

shouldInterpretEmptyStringSubmittedValuesAsNull

public Object shouldInterpretEmptyStringSubmittedValuesAsNull()

Checks if the client validation should interpret an empty submitted value should be handle as .NULL.

Return:
Object - a boolean to identify the interpretation of empty Strings as null

_shouldPostbackValue

private Object _shouldPostbackValue(Object inputElement,
                                    Object editableEventTargetComponents)

Parameters:
inputElement    
editableEventTargetComponents    
Return:
Object

shouldTracePPRRequestId

public Object shouldTracePPRRequestId()

Checks whether we should trace request id on PPR request.

Return:
Object - a flag indicating to trace request id on PPR request or not.
Overrides:
AdfPage.shouldTracePPRRequestId()

shouldValidateEmptyFields

public Object shouldValidateEmptyFields()

Checks if the client validation should handle empty field validation.

Return:
Object - a boolean to identify empty field validation

showFloatingDiv

public Object showFloatingDiv(Object floatingDiv,
                              Object floatingContent)

Shows the content from the floating content in the specified floating Div at the specified location

Parameters:
floatingDiv    
floatingContent    
Return:
Object

showGlassPane

public Object showGlassPane(Object listenerMap,
                            Object cursor)

Show the GlassPane, adding all of the listeners in the listener map and setting the cursor to the specified CSS-3 cursor

Parameters:
listenerMap    
cursor    
Return:
Object

showMessages

public Object showMessages(String componentId)

Displays the messages to the user.

Parameters:
componentId  -  a specific component client ID whose message should be shown or null if all messages should be shown
Return:
Object
Overrides:
AdfPage.showMessages(String)

showPageProcessingIndicator

public Object showPageProcessingIndicator(Object show)

Displays a processing indicator for the entire page that is useful when and application developer wants to relayout the entire page

Parameters:
show  -  boolean indicating whether to show/hide the processing indicator
Return:
Object
Overrides:
AdfPage.showPageProcessingIndicator(Object)

startActiveData

public Object startActiveData()

Return:
Object

startDrag

public Object startDrag(Object evt,
                        Object moveCallback,
                        Object dropCallback,
                        Object abortCallback,
                        Object showGlassPane)

Initiates drag operation

Parameters:
evt  -  mouse event that invoked drag operation
moveCallback  -  a function called after a mouse is moved. The function will be passed evrnt, deltaX and deltaY (differences in position from the previous move event) as parameters
dropCallback  -  a function called after mouse button is released.
abortCallback  -  a function called after the user cancel's the drag operation.
showGlassPane  -  a boolean indicating whether a glass pane should be used to block all activity while the drag is occuring. By default the glass pane is not used, since it can interfere with drag-related code which relies on the DOM event source element being accurate (ie. not the glass pane itself). If no callback is provided, it is assumes that the caller does not support escape and drag operation is terminated. The function will be passed event, deltaX and deltaY (differences in position from the beginning of drag operation) as parameters
Return:
Object
See also:
stopDrag()

_startGlobalActiveData

private Object _startGlobalActiveData()

Part of interlock called by components to prevent active data from being delivered until the component is in its initial state ready to receive data

Return:
Object

stopActiveData

public Object stopActiveData()

Return:
Object

_stopAutoPPR

private Object _stopAutoPPR(Object clientId)

notifies the active data manager to stop delivering events for the specified autoPPR component

Parameters:
clientId    
Return:
Object

stopDrag

public void stopDrag()

Terminates the drag operation.

Return:
void - null
See also:
startDrag(Object, Object, Object, Object, Object)

_stopGlobalActiveData

private Object _stopGlobalActiveData()

Part of interlock called by components to prevent active data from being delivered until the component is in its initial state ready to receive data.

Return:
Object

streamingResponseComplete

public Object streamingResponseComplete()

Called after all streaming fragments have arrived This function will be called from the IFRAME's onload handler

Return:
Object

streamingResponseStarted

public Object streamingResponseStarted()

A call to this script is rendered at the beginning of the streaming document. When this method is called, we know that the streaming request is being handled by the Framework and not some filter writing arbitrary content or redirecting to a differenr resource

Return:
Object

streamingResponseWritten

public Object streamingResponseWritten()

A call to this script is rendered just before the end of the streaming document. When this method is called, we know that the entire streaming response was written without any exceptions

Return:
Object

_stripSubId

private Object _stripSubId(Object id)

Parameters:
id    
Return:
Object

_styleSheetMapper

private static Object _styleSheetMapper(Object map,
                                        Object value)

Reduce callback for building a map of href->element for skin links

Parameters:
map    
value    
Return:
Object

_throwSavedErrors

private Object _throwSavedErrors()

Return:
Object

_timerDeliverEvents

private static Object _timerDeliverEvents()

Static function called from timer to dispatch events to the components and server if no UI event has occurred recently

Return:
Object

_toUrlEncodedForm

private Object _toUrlEncodedForm(Object formParams)

Parameters:
formParams    
Return:
Object

_unfilterEditableSubtree

private Object _unfilterEditableSubtree(Object subtree)

Recursively remove all of selectable and editable the styles from a subtree

Parameters:
subtree    
Return:
Object

unmapComponent

public Object unmapComponent(Object clientId)

Removes a component from the clientID map

Parameters:
clientId    
Return:
Object

__unregisterDescendantResizeNotifyComponent

Object __unregisterDescendantResizeNotifyComponent(AdfUIComponent component)

=-= Unsupported, internal method per Andy and Blake discussion. Unregister a component so that it will no longer receive notifications of a descendant size change. Application developers should not need to call this method explicitly. Components which are interested in resize events will automatically unregister themselves as necessary.

Parameters:
component    
Return:
Object

_unregisterGetRequestNavigationTracking

private Object _unregisterGetRequestNavigationTracking()

Return:
Object

unregisterKeyStroke

public Object unregisterKeyStroke(Object keystroke,
                                  Object clientId)

Unregisters a global keyboard shortcut/accelerator.

Parameters:
keystroke    
clientId    
Return:
Object

unregisterLoadingComponent

public Object unregisterLoadingComponent(AdfUIComponent component)

Unregisters a component registered with registerLoadingComponent. Components should be unregistered when fully loaded and must be unregistered when removed. For coding convenience, it is not an error to unregister a component that was never registered.

Parameters:
component  -  AdfUIComponent instance to unregister.
Return:
Object
See also:
registerLoadingComponent(AdfUIComponent)
Overrides:
AdfPage.unregisterLoadingComponent(AdfUIComponent)

__unregisterRegionClientUncommittedDataTracking

Object __unregisterRegionClientUncommittedDataTracking(Object clientId)

Parameters:
clientId    
Return:
Object

unregisterResizeNotifyComponent

public Object unregisterResizeNotifyComponent(AdfUIComponent component)

Unregister a component so that it will no longer receive resize notifications. Application developers should not need to call this method explicitly. Components which are interested in resize events will automatically unregister themselves as necessary.

Parameters:
component    
Return:
Object
Overrides:
AdfPage.unregisterResizeNotifyComponent(Object)

updateAutoPPRComponents

public Object updateAutoPPRComponents(Object pageId,
                                      Object clientIds)

Called by server to register one or more clientIds as representing server components on which auto-PPR will be performed. This is necessary in order to support stopping the listeners on these components when they are no longer visible, Note that the clientIds do NOT need clientComponents

Parameters:
pageId    
clientIds    
Return:
Object

_updateDeliveryTimer

private Object _updateDeliveryTimer(Object timeout)

Called to reset the timer that will deliver the events

Parameters:
timeout    
Return:
Object

updateStartActiveDataStateChange

public Object updateStartActiveDataStateChange(Boolean modelChanged,
                                               String clientId)

Updates the sets of components to start active data on, ensuring that the sets of components to start active data on and stop active data on are disjoint.

Parameters:
modelChanged  -  indicates that model has changed and to force an ADS start.
clientId  -  client ID of component to start or stop active data on
Return:
Object

updateStopActiveDataStateChange

public Object updateStopActiveDataStateChange(String clientId)

Updates the sets of components to stop active data on, ensuring that the sets of components to start active data on and stop active data on are disjoint and queueing a stop event if necessary

Parameters:
clientId  -  client ID of component to stop active data on
Return:
Object

updateStreamingViewState

public Object updateStreamingViewState(Object doc,
                                       Object id)

Called after the block with the current view state has been delivered over the streaming IFRAME This function will be called from a script block embedded in the XHTML content sent over the streaming IFRAME

Parameters:
doc  -  The document where the block may be found (the IFRAME's document)
id  -  The id of the fragment containing view state string
Return:
Object

_updateViewState

private Object _updateViewState(Object fragmentNode)

Parameters:
fragmentNode    
Return:
Object

__validateWindowId

boolean __validateWindowId(Object id)

This function is called from the onload script of the document for the IE browser to capture a Ctrl+N that has loaded a cached page. It validates that the windowId is the same as the last known window id. If the windowIds don't match, the page is reloaded.

Parameters:
id    
Return:
boolean - null true if the current windowId is valid; false if the page needs to be reloaded.
See also:
__handleReload()

_valueMapper

private static Object _valueMapper(Object map,
                                   Object value)

Reduce callback for adding the value to a map

Parameters:
map    
value    
Return:
Object

_waitingForAnimation

private Object _waitingForAnimation()

Return:
Object

_waitingForDescendantResize

private Object _waitingForDescendantResize()

Return:
Object

_waitingForIncompleteImages

private Object _waitingForIncompleteImages()

Return:
Object

whyIsNotSynchronizedWithServer

public Object whyIsNotSynchronizedWithServer()

Return:
Object

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

 

Generated on 2014.03.27 12:59 UTC
Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.