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
_activeComponents
private Object
_activeDomNode
private Object
_animationEnabled
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 static Object
_CUSTOM_PPR_URL_EXPANDO
public static Object
DEFAULT_ACCESSIBILITY_MODE
private static Object
_DEFAULT_ACTIVEDATA_CONFIG
private Object
_defaultMessageKey
private static Object
_DELAYED_RESIZE_TIMEOUT
private Object
_delayedMessages
private Object
_descendantResizeNotifyList
private Object
_discreteEventQueue
private Object
_document
private static Object
_DOCUMENT_STYLE_HOLDER
private Object
_documentClientId
private Object
_dragDropCallbacks
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
_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
_isWindowClosing
private Object
_jsfAjaxInit
private Object
_keepAliveInterval
private static Object
_KEYSTROKE_OVERRIDES
private Object
_keyStrokeToCallbackContextMap
private Object
_keyStrokeToCallbackMap
private Object
_lastActiveDataActivityTime
private Object
_lastDomEvent
private Object
_lastPollTime
private Object
_latencyThreshold
private static Object
_LAZY_FETCH_ID_PARAM
private static Object
_LOAD_CHECKPOINT
private Object
_loadingComponents
private Object
_maxReconnectionRetries
private Object
_messages
private static Object
_NAVIGATION_QUERY_PARAMS
private static Object
_NAVIGATION_VIEW_ROOT
private static Object
_NAVIGATION_WRAPPER_ID
private Object
_noResponseEventQueue
private Object
_pageProperties
private static Object
_PARSER_DIV_ID
private Object
_pendingStreamingIDs
private Object
_perfProfileEnabled
private Object
_perfProfileTimingEnabled
private Object
_pollingInterval
protected static Object
PollingTimeoutStates
'enum' to capture the different 'polling timeout timer' states
private Object
_pollingTimer
private Object
_portlet
private Object
_positionBlockingGlassPaneCallback
private static Object
_POSTBACK_CHECKPOINT
public static Object
PPR_NAVIGATION_FORCE_PPR
public static Object
PPR_NAVIGATION_ON
protected static Object
PushChannelStates
private Object
_reconnectRetries
private Object
_reconnectWaitTime
private static Object
_REMOVED_STREAMING_IDS_PARAM
private Object
_replaceJsfAjaxFunctions
private Object
_resizeNotifyMap
private Object
_resizeNotifyTree
private Object
_responseId
private Object
_restartInterval
private static Object
_RICH_UPDATE_FLAG
private Object
_rootClientId
public static Object
SCREEN_READER_ACCESSIBILITY_MODE
private static Object
_SELECTABLE_STYLE
private Object
_selectedEditingComponents
private Object
_serverEventQueue
private Object
_serverTimeDifference
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 Object
_timeoutWarningWindowState
protected static Object
TimeoutWarningWindowStates
'enum' for different warning window states
private Object
_transport
private Object
_validateEmptyFields
private Object
_window


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

ACTIVE_COMPONENT_PROPERTY, CREATE_VIEW_PHASE, DELIVER_EVENTS_PHASE, EDITABLE_SUBTREE_PROPERTY, EDITED_COMPONENT_PROPERTY, PAGE, 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

private Object
_activeDataHotKeyhandler()
this is the callback function when we press the hot key in screenreader mode this function will walk through the active components list and if there is any dirty components, ask user to confirm if we should do a page refresh.
public Object
addADSConnectionStateListener(Object listener, Object instance)
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
addMessage(String componentId, AdfFacesMessage facesMessage, Object toBeRemoved)
Adds a Message to AdfDhtmlPage's message queue.
private Object
_addPageId(Object headerParams)
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 ids, Object params)
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)
private boolean
_alert(String title, String message, Function callback)
Launches a modal inline popup alert dialog.
private Object
_alertTimeout()
Alert when we think session really times out
private Object
_alertTimeoutWarning()
Alert when we think session is going to time out soon
private Object
_announceActiveComponents()
this method pops up a dialog telling users about the active data information in the screenreader mode in this function we launch another thread to popup the alert window, since the alert is a blocking call, and our function is going to be called from the PPR handling code, blocking it will sometimes screw up the PPR timing
private Object
_announceActiveComponentsByAlert()
this method will create the message and popup the alert window
private Object
_announceActiveComponentsChanged(Object oldActiveComponents)
check to see if there is any change made to the active data components on the page if yes, announce that.
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)
private Object
_applyRichResponse(Object documentElement, Object needsUnescape, Object isStreaming, Object reqContext)
private Object
_areComponentsLoaded()
Loop over the loading components, returning true if all of them are loaded.
private Object
_attemptToRelayoutForNewlyCompleteImages()
private Object
_blockUI(Object block)
Prevents the user from interacting with the client UI.
private Object
_broadcastADSConnectionStateChange(Object adsConnectionState)
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 Object
cancelTimer(Object timerId)
Cancels the firing of the specified timer.
private Object
_checkAdsConnection()
This method is called by a setInterval based timer to check if the channel is connected.
Object
__checkRichResponseDirty()
public Object
checkUncommittedData()
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
_claimMaster(String masterWindowId, String masterPageId)
a rich page calls this method to claim itself as the master this happens when rich page exists(not the init page case), but somehow we think we should create a channel on our page
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
_collectLoadedLibraries()
private 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.
private Object
_createADSChannel(Object reconnect)
this method create the channel and send the client state in one shot.
private Object
_createADSChannelParameterMap(Object reconnect)
creates the channel parameter map that we will use to submit the form to create channel
private Object
_createADSClientStateMap(Boolean createChannel)
Creates the client state map for all the windows, this is used in handling migration ADS reconnect.
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)
public Object
createMaskingFrame(Object element)
Creates a masking IFrame underneath a floating element.
private Object
_createStyle(Object content)
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 Object
_deliverQueuedServerEvents()
Deliver all of the events in the server event queue
private static Object
_descendantResizeNotifyListComparator(Object itemA, Object itemB)
private Object
_displayUncommittedDataWarning()
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 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)
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)
Perform a rich postback
private Object
_dragKeyDown(Object evt)
private Object
_dragMouseMove(Object evt)
private Object
_dragMouseUp(Object evt)
private Object
_dtsStateChanged()
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)
Object
__failover(Object windows)
this function is called from the server, when the AdsProcessor notices it is in a failover
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 absloute locator.
private Object
_findYoungestWindow(Object windowMap)
helper function to find the latest added (youngest) AdfPage object from our window map.
private Object
_fixupLinkOnClick(Object element)
public Object
flushToAssistiveTechnology()
private static Object
_forceGC(Object count)
Code for forcing a GC
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 Node
getActiveDomElement()
Returns the DOM Element with the current DOM focus
private Object
_getActiveFrame()
get the IFrame that we will use for active data channel
public Object
getADSConnectionState()
private Object
_getADSMasterWindow(String masterWindowId)
Get the master window.
public Object
getAllMessages()
Return an object containing all messages keyed by componentID and containing an array of FacesMessages.
private Object
_getAndClearDeltas(Object doClear)
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.
private Object
_getClientStateMap()
get the client state map, i.e.
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.
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)
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()
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 Object
getDomDocument()
public Object
getDomWindow()
public AdfUIComponent
getEditableSubtree()
Returns the root of the component subtree that inline-editing is allowed on
public AdfUIComponent
getEditedComponent()
Returns the current component being edited.
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
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
_getMasterPageId()
get the master page Id
private Object
_getMasterWindowId()
get the master window ID
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.
private Object
_getMilliSecondsBehind(Object timestamp)
public AdfDhtmlModalityManager
getModalityManager()
Returns the modality manager for this page.
private Object
_getPageId()
get the page instance Id
public Object
getPageProperty(Object propertyName)
Gets the value of a page property.
private Object
_getParameterElement(Object form, Object name)
Object
__getPollHelper()
Hook to get a reference to our poll helper.
public AdfDhtmlPositionManager
getPositionManager()
Returns the position manager for this page.
private static Object
_getPostbackContent(HTMLElement actionForm, Object params)
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
_getRegistryMap()
gets the window name to window map
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
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.
private Object
_getSubtreeRootNode(Object rootId)
private AdfDhtmlPage
_getTargetPage(String windowId)
Returns the AdfDhtmlPage object for the specified windowId This will only be called when we deliver the events.
private static Object
_getTimeDifference(Object timestamp)
This method returns the difference in milliseconds between the current time and the passed in time
public Object
getTimeoutWarningWindowState()
private 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
_handleADSChannelMigration()
handles the migration
private Object
_handleAllFailovers(Object windows)
this function is only called on the master window.
private Object
_handleBeforeUnload(Object evt)
the onbeforeunload event handler we attach to window
private Object
_handleDisconnect()
This method is invoked from the event handler(s) that detect disconnection from the push channel.
private Object
_handleFailover()
this function handles failover for each individual window
private Object
_handleGlobalError(Object msg, Object url, Object line)
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.
private 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.
Object
__handleReload()
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, 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)
private Object
_handleSessionTimeoutAlert(Object adfDialogEvent)
private Object
_handleSessionTimeoutConfirm(Object adfDialogEvent)
public Object
handleStreamingResponse(Object doc, Object id, Object needsUnescape)
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
protected Object
Init(Object lookAndFeel, Object domWindow)
Initializes the instance.
private Object
_initActivePage()
Setup the page states Plus, if we are master, create the channel.
private Object
_initAdm()
this method initializes the page states this should only be called once
protected static Object
InitClass()
Initializes the AdfDhtmlPage class
public Object
initializeActiveForm(Boolean wls, String ctxName)
Initializing the ADS Active Form URL, based on the underlying runtime.
private Object
_initializeADSIFrame()
Object
__initLongPolling()
This script is rendered by the server to trigger a new long-polling request from the client to the server.
Object
__initPollingTimeout(Object interval)
Called by "DocumentRenderer" to setup a callback which ensures all <af:poll> components stop polling after a configured amount of time, while the user is inactive (no interaction with mouse or keyboard)
Object
__initUncommittedDataWarningForDocument(Object enabled)
Initializes uncommitted data warning facility for the document
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 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 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.
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 Object
isDragging()
Determines whether a drag operation is in progress
public Object
isHAMigrated()
Queries the migrated state of this AdfPage object.
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.
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.
public Object
isStreamingDisabled()
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 Boolean
_isUIBlocked()
Returns whether the UI is currently blocked in the rich page.
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
_loadCss(Object source)
private Object
_loadScript(Object source)
public Object
loadView(Object viewId, Object params, Object loadId)
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.
private Object
_logAsGlobalError(Object e)
private Object
_makeADSChannelRequest(Boolean createChannel, Boolean reconnect)
Makes the request to server to create channel, this also sends the change counts.
public Object
mapComponent(Object clientId, Object component)
Adds a component to the clientID map.
private Object
_marshallMultipleEventParameters(Object paramList)
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
_notifyADSConnectionStateChange(Object adsConnectionState)
Notifies the page of the latest ADS connection state.
private Object
_notifyComponent(Object componentId, Object messageArray)
Notifies a component that it's message queue has changed
Object
__notifyReturnFromDialog()
Called when the DialogService closes the dilaog programmatically
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)
private Object
_notifyWindowUnloaded()
Send window-unloaded notification if necessary
private Object
_notifyWindowUnregistered(Object windowId, Object pageId)
private Object
_onBeforeUnload()
This method is normally called from _handleBeforeUnload() However, when we ask the user whether navigation is desired, this method will be called from onUnload
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
Object
__perfTimings(Boolean closeRecord, Boolean closeBefore, Boolean timing, String str1, String str2)
For performance timings.
private Object
_pollForEvents()
This is the method that prepares and sends the poll request
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)
private Object
_prepareAdsConnectionTimer()
Helper function that handles to schedule the _checkAdsConnection timer.
private Object
_prepareForIncompleteImages()
public Object
prepareMaskingFrame()
Makes sure that a masking frame is available in the maskFramePool, in anticipation of an upcoming call to createMaskingFrame method.
Object
__processActiveDataEvent(String windowId, String pageId, String clientId, Object payload, Number changeCount, Number timeStamp, Number eventNumber, Number perfLogging)
Process an active data event from the push service.
private Boolean
_processPushData(String clientId, Object payload, Number changeCount, Boolean isLate, Number eventNumber, Boolean perfLogging)
This method is called by the current active data manager to delivery active data to a component, returning whether the component the component can accept more active data events.
private Object
_processValidators(Object sourceComponent, Object rootComponent, Object onlyImmediate)
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.
public Object
queueEventTimerIfNeeded()
Queue a timer to run the event thread.
public Object
queueEventToServer(Object event)
Queues an event for later delivery to the server
private Object
_reattachInlineEditing(Object editableSubtreeDom)
Detaches and reattaches the inline editing subtree and Reapplies the selected, selectable, and editable styles to the selected editing components to handle the case where they have been ppr'ed
private Object
_reconnect()
This method sends a reconnect request and sets a timer for the next reconnect attempt If the configured maximum number of reconnect attempts is reached, then a warning is logged to the console and no further reconnect attempts are made.
Object
__recordActiveDataActivity()
Heartbeat called from active data iframe
Object
__recordSessionTimeout(Object timeout, Object warningBeforeTimeout, Object newSessionURL)
Record the session related info from server.
private void
_redistribute(HTMLDomEvent event)
Converts the native dom event into a AdfComponentEvent that is queueed and then sent to the target component.
private Object
_refreshAllPushComponents()
this method makes a request to refresh all the push components within the page use case:
Object
__refreshPushComponent(String windowId, String pageId, String clientId)
this method is invoked through a script rendered over the push channel it finds the window identified by windowId and makes a request to the rich page on the window for refreshing the push component with the specified clientId use cases:
private Boolean
_refreshPushComponent(String clientId)
this method makes a request to the rich page for refreshing a push component use case:
Object
__registerDescendantResizeNotifyComponent(AdfUIComponent component)
=-= Unsupported, internal method per Andy and Blake discussion.
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.
public Object
registerResizeNotifyComponent(AdfUIComponent component)
Register a component to recieve resize notification when the browser window is resized.
private Object
_registerWindowWithADSMaster(Object registeringWindow)
Registers a page with the AdfDhtmlPage acting as the master
Object
__registerWithNewMaster(Object masterWindowId, Object masterPageId)
this method is called in this scenario:
private Object
_registerWithNewMaster(Object state)
this method registers this window with this new master window
private Object
_reloadPage()
Reload current page, appending a timestamp to avoid caching
public Object
removeADSConnectionStateListener(Object listener, Object instance)
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
removeMaskingFrame(Object maskFrame)
Removes the masking IFrame underneath a floating element.
public Object
removePageResources(Object name, Object head)
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.
public Object
removePropertyChangeListener(Object instance, Function listener)
Removes a PropertyChangeListener with the specified instance and listener function
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
private Object
_removeUncommittedIds(Object Ids)
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 Object
_resetUncommittedIds()
private Object
_resolveMessageComponentId(Object componentId)
Calculate the id of the component to show message associated with component whose id is componentId If componentId is null, or component is not an editable component, default Message Key will be used so that the message will be page level message.
private Object
_restoreFocusPath(Array<HTMLElement> focusPath, Object maxIndex)
Restores the focus to the best focusable element based on the focusPath
public Object
scheduleTimer(Object context, Function callback, Object state, Object delay)
Schedules a callback to be fired in the future.
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 static Array
_scrubEvents(Array eventQueue, Object eventSourceFixup)
As a pre-condition of sending queued events to the server, scrub the event queue for events that have a reference to a dead component - it may have been replaced via PPR.
private Object
_sendADSChannelRequest(Object channelParameterMap, Object clientStateMap)
This method does the following:
private Object
_sendJsfAjaxEvent(Object type, Object params)
private Object
_sendRichPayload(Object params, Object context)
public Object
sendStreamingRequest(Object iDs)
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.
private Object
_setBodyCursorForActivePage()
In FF2 active page shows progress cursor so we need to set custom cursor that looks like default cursor arrow.
Object
__setConfiguration(Object config)
This script is rendered by the server to send active data configuration parameters as stored in a configuration file on the server (adf-config.xml)
Object
__setConnected()
This script is rendered by the server over the push channel to notify the Page that the channel is connected
private static Object
_setCookie(Object domDocument, Object name, Object value, Object expiresAfter, Object path)
Sets the value of a cookie on the page.
public Object
setDataDirty(Object isDirty)
public Object
setDefaultMessageHandlerComponentId(String id, String slaveId)
Sets the component id for global messages.
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
__setHAMigrated(Object migration)
Takes a boolean to tell the AdfPage object if this in an HA migration
public Object
setHelpWindowName(String windowName)
Method that will set the help window name.
public Object
setLastFocusedElement(Object element)
Sets the last focused element.
private Object
_setMasterPageId(String masterPageId)
set the master page id
private Object
_setMasterWindowId(String masterWindowId)
set the master window ID
private Object
_setMasterWindowRef(Object masterWinRef)
set the reference to the window object
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.
private Object
_setPageId(String pageId)
set the page instance id
public Object
setPageProperty(Object propertyName, Object propertyValue)
Sets the value of a page property.
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()
private Object
_setReplaceMasterPageId(Object replaceMasterPageId)
set the replace master page ID
private Object
_setReplaceMasterWindowId(Object replaceMasterWindowId)
set the replace master window ID
Object
__setResponseIdentifier(Object responseId)
Called by response handling code to save the ECID
private Object
_setRichResponseDirty(Object isDirty)
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
__setServerTimestamp(Object timestamp)
This script is rendered by the server to send the server time to the client.
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)
private 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.
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
private Object
_startPolling()
_startPolling is called by the onload handler for the iframe and is responsible for scheduling the next polling timeout.
public Object
stopActiveData()
private Object
_stopActiveData(Object clientId)
notifies the active data manager to stop delivering events for the specified component
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
_testAdfPageExistence(Object windowObject)
test the window object to see if the rich page exists
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
_touchServerSession()
Send a request to server to touch the server session
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.
public Object
unregisterKeyStroke(Object keystroke, Object clientId)
Unregisters a global keyboard shortcut/accelerator.
public Object
unregisterLoadingComponent(AdfUIComponent component)
Unregisters a component registered with registerLoadingComponent.
public Object
unregisterResizeNotifyComponent(AdfUIComponent component)
Unregister a component so that it will no longer receive resize notifications.
public Object
updateActiveDataComponents(String masterWindowId, Object masterPageId, Object pageId, String... clientIds, Number... changeCounts)
List of components to update the active data counts for.
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()
Called to reset the timer that will deliver the events
private Object
_updateStartActiveDataStateChange(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.
private 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)
private Object
_updateViewState(Object fragmentNode)
private Object
_wrapMasterWindowId(Object windowId)
this is for safety, in case somebody messes up the window id basically in IE, window.open() doesn't like anything like "/", "-", or "."


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

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


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

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, 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

_activeComponents

private Object _activeComponents

_activeDomNode

private Object _activeDomNode

_animationEnabled

private Object _animationEnabled

_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

_CUSTOM_PPR_URL_EXPANDO

private static Object _CUSTOM_PPR_URL_EXPANDO

DEFAULT_ACCESSIBILITY_MODE

public static Object DEFAULT_ACCESSIBILITY_MODE

_DEFAULT_ACTIVEDATA_CONFIG

private static Object _DEFAULT_ACTIVEDATA_CONFIG

_defaultMessageKey

private Object _defaultMessageKey

_DELAYED_RESIZE_TIMEOUT

private static Object _DELAYED_RESIZE_TIMEOUT

_delayedMessages

private Object _delayedMessages

_descendantResizeNotifyList

private Object _descendantResizeNotifyList

_discreteEventQueue

private Object _discreteEventQueue

_document

private Object _document

_DOCUMENT_STYLE_HOLDER

private static Object _DOCUMENT_STYLE_HOLDER

_documentClientId

private Object _documentClientId

_dragDropCallbacks

private Object _dragDropCallbacks

_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

_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

_isWindowClosing

private Object _isWindowClosing

_jsfAjaxInit

private Object _jsfAjaxInit

_keepAliveInterval

private Object _keepAliveInterval

_KEYSTROKE_OVERRIDES

private static Object _KEYSTROKE_OVERRIDES

_keyStrokeToCallbackContextMap

private Object _keyStrokeToCallbackContextMap

_keyStrokeToCallbackMap

private Object _keyStrokeToCallbackMap

_lastActiveDataActivityTime

private Object _lastActiveDataActivityTime

_lastDomEvent

private Object _lastDomEvent

_lastPollTime

private Object _lastPollTime

_latencyThreshold

private Object _latencyThreshold

_LAZY_FETCH_ID_PARAM

private static Object _LAZY_FETCH_ID_PARAM

_LOAD_CHECKPOINT

private static Object _LOAD_CHECKPOINT

_loadingComponents

private Object _loadingComponents

_maxReconnectionRetries

private Object _maxReconnectionRetries

_messages

private Object _messages

_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

_noResponseEventQueue

private Object _noResponseEventQueue

_pageProperties

private Object _pageProperties

_PARSER_DIV_ID

private static Object _PARSER_DIV_ID

_pendingStreamingIDs

private Object _pendingStreamingIDs

_perfProfileEnabled

private Object _perfProfileEnabled

_perfProfileTimingEnabled

private Object _perfProfileTimingEnabled

_pollingInterval

private Object _pollingInterval

PollingTimeoutStates

protected static Object PollingTimeoutStates

'enum' to capture the different 'polling timeout timer' states

_pollingTimer

private Object _pollingTimer

_portlet

private Object _portlet

_positionBlockingGlassPaneCallback

private Object _positionBlockingGlassPaneCallback

_POSTBACK_CHECKPOINT

private static Object _POSTBACK_CHECKPOINT

PPR_NAVIGATION_FORCE_PPR

public static Object PPR_NAVIGATION_FORCE_PPR

PPR_NAVIGATION_ON

public static Object PPR_NAVIGATION_ON

PushChannelStates

protected static Object PushChannelStates

_reconnectRetries

private Object _reconnectRetries

_reconnectWaitTime

private Object _reconnectWaitTime

_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

_restartInterval

private Object _restartInterval

_RICH_UPDATE_FLAG

private static Object _RICH_UPDATE_FLAG

_rootClientId

private Object _rootClientId

SCREEN_READER_ACCESSIBILITY_MODE

public static Object SCREEN_READER_ACCESSIBILITY_MODE

_SELECTABLE_STYLE

private static Object _SELECTABLE_STYLE

_selectedEditingComponents

private Object _selectedEditingComponents

_serverEventQueue

private Object _serverEventQueue

_serverTimeDifference

private Object _serverTimeDifference

_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

_timeoutWarningWindowState

private Object _timeoutWarningWindowState

TimeoutWarningWindowStates

protected static Object TimeoutWarningWindowStates

'enum' for different warning window states

_transport

private Object _transport

_validateEmptyFields

private Object _validateEmptyFields

_window

private Object _window

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


_activeDataHotKeyhandler

private Object _activeDataHotKeyhandler()

this is the callback function when we press the hot key in screenreader mode this function will walk through the active components list and if there is any dirty components, ask user to confirm if we should do a page refresh.

Return:
Object

addADSConnectionStateListener

public Object addADSConnectionStateListener(Object listener,
                                            Object instance)

Parameters:
listener    
instance    
Return:
Object

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

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

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 ids,
                                       Object params)

Parameters:
ids    
params    
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

private 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.

_alertTimeout

private Object _alertTimeout()

Alert when we think session really times out

Return:
Object

_alertTimeoutWarning

private Object _alertTimeoutWarning()

Alert when we think session is going to time out soon

Return:
Object

_announceActiveComponents

private Object _announceActiveComponents()

this method pops up a dialog telling users about the active data information in the screenreader mode in this function we launch another thread to popup the alert window, since the alert is a blocking call, and our function is going to be called from the PPR handling code, blocking it will sometimes screw up the PPR timing

Return:
Object

_announceActiveComponentsByAlert

private Object _announceActiveComponentsByAlert()

this method will create the message and popup the alert window

Return:
Object

_announceActiveComponentsChanged

private Object _announceActiveComponentsChanged(Object oldActiveComponents)

check to see if there is any change made to the active data components on the page if yes, announce that. Note, this function will only be called in screen reader mode. Also, it modifies the passed in parameter - oldActiveComponents

Parameters:
oldActiveComponents    
Return:
Object

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

_applyRichResponse

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

Parameters:
documentElement    
needsUnescape    
isStreaming    
reqContext    
Return:
Object

_areComponentsLoaded

private Object _areComponentsLoaded()

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

Return:
Object

_attemptToRelayoutForNewlyCompleteImages

private Object _attemptToRelayoutForNewlyCompleteImages()

Return:
Object

_blockUI

private Object _blockUI(Object block)

Prevents the user from interacting with the client UI.

Parameters:
block  -  boolean indicating whether to block/unblock the ui
Return:
Object
See also:
_isUIBlocked()
_removeBlockingHandler(HTMLDocument)
_installBlockingHandler(HTMLDocument)

_broadcastADSConnectionStateChange

private Object _broadcastADSConnectionStateChange(Object adsConnectionState)

Parameters:
adsConnectionState    
Return:
Object

_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

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)
rescheduleTimer(Object, Number)

_checkAdsConnection

private Object _checkAdsConnection()

This method is called by a setInterval based timer to check if the channel is connected. It checks the time elapsed since the last ADS activity was recorded and if that exceeds the interval in which we expect keep alive messages (plus the max allowable latency), then the client is assumed to be disconnected and the disconnect handler is invoked.

Return:
Object

__checkRichResponseDirty

Object __checkRichResponseDirty()

Return:
Object

checkUncommittedData

public Object checkUncommittedData()

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

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

_claimMaster

private Object _claimMaster(String masterWindowId,
                            String masterPageId)

a rich page calls this method to claim itself as the master this happens when rich page exists(not the init page case), but somehow we think we should create a channel on our page

Parameters:
masterWindowId  -  the master window id
masterPageId  -  the master page id
Return:
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

_collectLoadedLibraries

private Object _collectLoadedLibraries()

Return:
Object

_confirm

private 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

_createADSChannel

private Object _createADSChannel(Object reconnect)

this method create the channel and send the client state in one shot.

Parameters:
reconnect    
Return:
Object

_createADSChannelParameterMap

private Object _createADSChannelParameterMap(Object reconnect)

creates the channel parameter map that we will use to submit the form to create channel

Parameters:
reconnect    
Return:
Object

_createADSClientStateMap

private Object _createADSClientStateMap(Boolean createChannel)

Creates the client state map for all the windows, this is used in handling migration ADS reconnect.

Parameters:
createChannel  -  are we the master page or not
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

createMaskingFrame

public Object createMaskingFrame(Object 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

_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 Object _deliverQueuedServerEvents()

Deliver all of the events in the server event queue

Return:
Object

_descendantResizeNotifyListComparator

private static Object _descendantResizeNotifyListComparator(Object itemA,
                                                            Object itemB)

Parameters:
itemA    
itemB    
Return:
Object

_displayUncommittedDataWarning

private Object _displayUncommittedDataWarning()

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

_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)

Parameters:
node    
forceResize    
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)

Perform a rich postback

Parameters:
formElement  -  Form element to use a destination
params  -  Name/value pairs to post
headerParams    
blockUI    
context  -  XMLHTTP request context
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

_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

__failover

Object __failover(Object windows)

this function is called from the server, when the AdsProcessor notices it is in a failover

Parameters:
windows    
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 absloute 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 undefined if no component matching that absolute locator exists.
See also:
AdfUIComponent.getAbsoluteLocator()
Overrides:
AdfPage.findComponentByAbsoluteLocator(String)

_findYoungestWindow

private Object _findYoungestWindow(Object windowMap)

helper function to find the latest added (youngest) AdfPage object from our window map.

Parameters:
windowMap    
Return:
Object

_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

__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()

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

_getActiveFrame

private Object _getActiveFrame()

get the IFrame that we will use for active data channel

Return:
Object - Return {DOM.iframe} the iframe used for active data channel

getADSConnectionState

public Object getADSConnectionState()

Return:
Object

_getADSMasterWindow

private Object _getADSMasterWindow(String masterWindowId)

Get the master window. It will return the window reference if it is the current master window. otherwise it will return null.

Parameters:
masterWindowId  -  The master window id
Return:
Object - Return {Window} window object only if it contains the rich page

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

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)

_getClientStateMap

private Object _getClientStateMap()

get the client state map, i.e. _activeComponents

Return:
Object - Returns {Object} client state map, i.e. the _activeChangeCount

_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

_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)

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. 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

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

getDomDocument

public Object getDomDocument()

Return:
Object

getDomWindow

public Object getDomWindow()

Return:
Object

getEditableSubtree

public AdfUIComponent getEditableSubtree()

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

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

getEditedComponent

public AdfUIComponent getEditedComponent()

Returns the current component being edited.

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

_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 ti 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

__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

_getMasterPageId

private Object _getMasterPageId()

get the master page Id

Return:
Object - Returns {String} master page Id

_getMasterWindowId

private Object _getMasterWindowId()

get the master window ID

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

_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)

_getMilliSecondsBehind

private Object _getMilliSecondsBehind(Object timestamp)

Parameters:
timestamp    
Return:
Object

getModalityManager

public AdfDhtmlModalityManager getModalityManager()

Returns the modality manager for this page.

Return:
AdfDhtmlModalityManager - null

_getPageId

private 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)

_getParameterElement

private Object _getParameterElement(Object form,
                                    Object name)

Parameters:
form    
name    
Return:
Object

__getPollHelper

Object __getPollHelper()

Hook to get a reference to our poll helper. If there is any <af:poll> on the page available, the function will return the "per page" poll helper object, otherwise the return value will be undefined

Return:
Object

getPositionManager

public AdfDhtmlPositionManager getPositionManager()

Returns the position manager for this page.

Return:
AdfDhtmlPositionManager - null

_getPostbackContent

private static Object _getPostbackContent(HTMLElement actionForm,
                                          Object params)

Returns the payload to include in the rich postback

Parameters:
actionForm  -  Form to build up input elements for post in
params  -  Name/value pairs to ensure that the form contains
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

_getRegistryMap

private Object _getRegistryMap()

gets the window name to window map

Return:
Object - Returns {Object} the window registry, i.e. the windowNameToWindow map

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()

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()

_getSubtreeRootNode

private Object _getSubtreeRootNode(Object rootId)

Parameters:
rootId    
Return:
Object

_getTargetPage

private AdfDhtmlPage _getTargetPage(String windowId)

Returns the AdfDhtmlPage object for the specified windowId This will only be called when we deliver the events. The initial window registration will go through different methods. Because in that case, we will use window.open, we don't need to look into the windowNameToWindow map; while in the event delivery case, we don't want to call window.open, becasue there might be some events aiming for non-existing window. And window.name will open a blank window in that case.

Parameters:
windowId  -  Name of window object to return
Return:
AdfDhtmlPage - AdfDhtmlPage object for the target page

_getTimeDifference

private static Object _getTimeDifference(Object timestamp)

This method returns the difference in milliseconds between the current time and the passed in time

Parameters:
timestamp    
Return:
Object

getTimeoutWarningWindowState

public Object getTimeoutWarningWindowState()

Return:
Object

_getWindowId

private 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

_handleADSChannelMigration

private Object _handleADSChannelMigration()

handles the migration

Return:
Object

_handleAllFailovers

private Object _handleAllFailovers(Object windows)

this function is only called on the master window. and it handles failover for all windows managed by itself

Parameters:
windows    
Return:
Object

_handleBeforeUnload

private Object _handleBeforeUnload(Object evt)

the onbeforeunload event handler we attach to window

Parameters:
evt    
Return:
Object

_handleDisconnect

private Object _handleDisconnect()

This method is invoked from the event handler(s) that detect disconnection from the push channel. This is not used in the polling case.

Return:
Object

_handleFailover

private Object _handleFailover()

this function handles failover for each individual window

Return:
Object

_handleGlobalError

private Object _handleGlobalError(Object msg,
                                  Object url,
                                  Object line)

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

private 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

__handleReload

Object __handleReload()

Return:
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,
                                           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
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

_handleSessionTimeoutAlert

private Object _handleSessionTimeoutAlert(Object adfDialogEvent)

Parameters:
adfDialogEvent    
Return:
Object

_handleSessionTimeoutConfirm

private Object _handleSessionTimeoutConfirm(Object adfDialogEvent)

Parameters:
adfDialogEvent    
Return:
Object

handleStreamingResponse

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

Parameters:
doc    
id    
needsUnescape    
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

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()

_initActivePage

private Object _initActivePage()

Setup the page states Plus, if we are master, create the channel.

Return:
Object

_initAdm

private Object _initAdm()

this method initializes the page states this should only be called once

Return:
Object

InitClass

protected static Object InitClass()

Initializes the AdfDhtmlPage class

Return:
Object

initializeActiveForm

public Object initializeActiveForm(Boolean wls,
                                   String ctxName)

Initializing the ADS Active Form URL, based on the underlying runtime.

Parameters:
wls  -  boolean if this app runs on wls.
ctxName  -  the application context name
Return:
Object

_initializeADSIFrame

private Object _initializeADSIFrame()

Return:
Object

__initLongPolling

Object __initLongPolling()

This script is rendered by the server to trigger a new long-polling request from the client to the server.

Return:
Object

__initPollingTimeout

Object __initPollingTimeout(Object interval)

Called by "DocumentRenderer" to setup a callback which ensures all <af:poll> components stop polling after a configured amount of time, while the user is inactive (no interaction with mouse or keyboard)

Parameters:
interval  -  the amount of time (in ms) after which the polling components should timeout, as specified in web.xml file.
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

_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

_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)
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

_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()

_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

isDragging

public Object isDragging()

Determines whether a drag operation is in progress

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

isHAMigrated

public Object isHAMigrated()

Queries the migrated state of this AdfPage object. this needs to be called from other pages, so we make it public

Return:
Object

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

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()

isStreamingDisabled

public Object isStreamingDisabled()

Return:
Object

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.
  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()

_isUIBlocked

private Boolean _isUIBlocked()

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

Return:
Boolean - indicating if the UI is currently blocked in the rich page

_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)

_loadCss

private Object _loadCss(Object source)

Parameters:
source    
Return:
Object

_loadScript

private Object _loadScript(Object source)

Parameters:
source    
Return:
Object

loadView

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

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

Parameters:
viewId    
params    
loadId    
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

private Object _logAsGlobalError(Object e)

Parameters:
e    
Return:
Object

_makeADSChannelRequest

private Object _makeADSChannelRequest(Boolean createChannel,
                                      Boolean reconnect)

Makes the request to server to create channel, this also sends the change counts.

Parameters:
createChannel  -  are we the master page or not
reconnect  -  a flag
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

_marshallMultipleEventParameters

private Object _marshallMultipleEventParameters(Object paramList)

Parameters:
paramList    
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

_notifyADSConnectionStateChange

private Object _notifyADSConnectionStateChange(Object adsConnectionState)

Notifies the page of the latest ADS connection state. This should be called only on the master window. It will go over all the active windows and broadcast the state change to them (including itself). Each window in turn will broadcast the state change to each peer registered as a listener for the purpose of displaying the correct status indicator.

Parameters:
adsConnectionState    
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

__notifyReturnFromDialog

Object __notifyReturnFromDialog()

Called when the DialogService closes the dilaog programmatically

Return:
Object

__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

private Object _notifyWindowUnloaded()

Send window-unloaded notification if necessary

Return:
Object

_notifyWindowUnregistered

private Object _notifyWindowUnregistered(Object windowId,
                                         Object pageId)

Parameters:
windowId    
pageId    
Return:
Object

_onBeforeUnload

private Object _onBeforeUnload()

This method is normally called from _handleBeforeUnload() However, when we ask the user whether navigation is desired, this method will be called from onUnload

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

__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

_pollForEvents

private Object _pollForEvents()

This is the method that prepares and sends the poll request

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

_prepareAdsConnectionTimer

private Object _prepareAdsConnectionTimer()

Helper function that handles to schedule the _checkAdsConnection timer. If the timer has already been scheduled it will be canceled an rescheduled again.

Return:
Object

_prepareForIncompleteImages

private Object _prepareForIncompleteImages()

Return:
Object

prepareMaskingFrame

public Object prepareMaskingFrame()

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.

Return:
Object

__processActiveDataEvent

Object __processActiveDataEvent(String windowId,
                                 String pageId,
                                 String clientId,
                                 Object payload,
                                 Number changeCount,
                                 Number timeStamp,
                                 Number eventNumber,
                                 Number perfLogging)

Process an active data event from the push service. This method is called from the push channel

Parameters:
windowId  -  Identifier of window that is the target for this event
pageId  -  Identifier of page that is the target for this event
clientId  -  Identifier of component that is the target of this event
payload  -  Payload to be delivered to the component
changeCount  -  for this event, so that component can determine whether to discard this event if the component has been synchronously updated more recently
timeStamp  -  GMT timestamp in millis from the data source
eventNumber  -  cross component event nubmer (this is passed in only when the profiler is turned on and logging level is info)
perfLogging  -  flag indicating if the event needs to be logged of timing
Return:
Object

_processPushData

private Boolean _processPushData(String clientId,
                                 Object payload,
                                 Number changeCount,
                                 Boolean isLate,
                                 Number eventNumber,
                                 Boolean perfLogging)

This method is called by the current active data manager to delivery active data to a component, returning whether the component the component can accept more active data events. A component may no longer be able to recieve active data events if the component is no longer visible.

Only the Active Data Manager should call this method.


Parameters:
clientId  -  client id of the component to deliver the event to
payload  -  Peer-specific payload for the component
changeCount  -  the current event index
isLate  -  flag indicating whether the event was received beyond the configured threshold
eventNumber  -  cross component event nubmer (this is passed in only when the profiler is turned on and logging level is info)
perfLogging  -  flag indicating if the event needs to be logged of timing
Return:
Boolean - Returns true if the component should continue to receive active data events.

_processValidators

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

Parameters:
sourceComponent  -  used to determine which subform(s) to validate.
rootComponent  -  [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.

__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

public Object queueEventTimerIfNeeded()

Queue a timer to run the event thread.

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 Object _reattachInlineEditing(Object editableSubtreeDom)

Detaches and reattaches the inline editing subtree and Reapplies the selected, selectable, and editable styles to the selected editing components to handle the case where they have been ppr'ed

Parameters:
editableSubtreeDom    
Return:
Object

_reconnect

private Object _reconnect()

This method sends a reconnect request and sets a timer for the next reconnect attempt If the configured maximum number of reconnect attempts is reached, then a warning is logged to the console and no further reconnect attempts are made.

Return:
Object

__recordActiveDataActivity

Object __recordActiveDataActivity()

Heartbeat called from active data iframe

Return:
Object

__recordSessionTimeout

Object __recordSessionTimeout(Object timeout,
                               Object warningBeforeTimeout,
                               Object newSessionURL)

Record the session related info from server. We will setup timers and do some alerts accordingly

Parameters:
timeout    
warningBeforeTimeout    
newSessionURL    
Return:
Object

_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

_refreshAllPushComponents

private Object _refreshAllPushComponents()

this method makes a request to refresh all the push components within the page use case: encoder instructed, latency, etc.

Return:
Object

__refreshPushComponent

Object __refreshPushComponent(String windowId,
                               String pageId,
                               String clientId)

this method is invoked through a script rendered over the push channel it finds the window identified by windowId and makes a request to the rich page on the window for refreshing the push component with the specified clientId use cases: encoder instructed and latency

Parameters:
windowId  -  String, the windowId of the page containing the component that we want to refresh
pageId  -  String, the pageId of the page containing the component that we want to refresh
clientId  -  String, the clientId of the component that we want to refresh
Return:
Object

_refreshPushComponent

private Boolean _refreshPushComponent(String clientId)

this method makes a request to the rich page for refreshing a push component use case: encoder instructed, latency, etc.

Parameters:
clientId  -  String, the clietnId of the component that we want to refresh
Return:
Boolean - Returns true if the component should continue to receive active data events.

__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

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)

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)

_registerWindowWithADSMaster

private Object _registerWindowWithADSMaster(Object registeringWindow)

Registers a page with the AdfDhtmlPage acting as the master

Parameters:
registeringWindow    
Return:
Object

__registerWithNewMaster

Object __registerWithNewMaster(Object masterWindowId,
                                Object masterPageId)

this method is called in this scenario: we submit the request to create the channel, server decides that there is already another channel which is good for use, so it will return a new master window id, and we need to register with this new master page we backoff for 3 seconds before we register

Parameters:
masterWindowId    
masterPageId    
Return:
Object

_registerWithNewMaster

private Object _registerWithNewMaster(Object state)

this method registers this window with this new master window

Parameters:
state  -  the map which has the parameters - wId: the mastet window Id - pId: the master page Id
Return:
Object

_reloadPage

private Object _reloadPage()

Reload current page, appending a timestamp to avoid caching

Return:
Object

removeADSConnectionStateListener

public Object removeADSConnectionStateListener(Object listener,
                                               Object instance)

Parameters:
listener    
instance    
Return:
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)

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

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(Object name,
                                  Object head)

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.

Parameters:
name    
head    
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)

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

_removeUncommittedIds

private Object _removeUncommittedIds(Object Ids)

Parameters:
Ids    
Return:
Object

__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)
cancelTimer(Object)

_resetPendingStreamingIDs

private Object _resetPendingStreamingIDs()

Return:
Object

_resetUncommittedIds

private Object _resetUncommittedIds()

Return:
Object

_resolveMessageComponentId

private Object _resolveMessageComponentId(Object componentId)

Calculate the id of the component to show message associated with component whose id is componentId If componentId is null, or component is not an editable component, default Message Key will be used so that the message will be page level message.

Parameters:
componentId    
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()

scheduleTimer

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

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    
Return:
Object - the timer reference used for rescheduling or canceling the timer
See also:
rescheduleTimer(Object, Number)
cancelTimer(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

_scrubEvents

private static Array _scrubEvents(Array eventQueue,
                                  Object eventSourceFixup)

As a pre-condition of sending queued events to the server, scrub the event queue for events that have a reference to a dead component - it may have been replaced via PPR. Try to re-find dead components. If that fails, it has been dropped and we need to remove the event from the server queue before committing to send a request to the server. The eventSourceFixup map will track the live component to the associated event. This will be used in later processing instead of the source of the event object.

Parameters:
eventQueue  -  event queue to clean
eventSourceFixup  -  map that associates an event with a valid client component.
Return:
Array - clean event queue

_sendADSChannelRequest

private Object _sendADSChannelRequest(Object channelParameterMap,
                                      Object clientStateMap)

This method does the following: - create the active data form, if needed - set up form inputs from the passed in parameters - post the form the active data target It is used in both the poll and push cases

Parameters:
channelParameterMap    
clientStateMap    
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 iDs)

Parameters:
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

_setBodyCursorForActivePage

private Object _setBodyCursorForActivePage()

In FF2 active page shows progress cursor so we need to set custom cursor that looks like default cursor arrow.

Return:
Object

__setConfiguration

Object __setConfiguration(Object config)

This script is rendered by the server to send active data configuration parameters as stored in a configuration file on the server (adf-config.xml)

Parameters:
config    
Return:
Object

__setConnected

Object __setConnected()

This script is rendered by the server over the push channel to notify the Page that the channel is connected

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

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)

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

__setHAMigrated

Object __setHAMigrated(Object migration)

Takes a boolean to tell the AdfPage object if this in an HA migration

Parameters:
migration    
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

_setMasterPageId

private Object _setMasterPageId(String masterPageId)

set the master page id

Parameters:
masterPageId  -  the master page Id
Return:
Object

_setMasterWindowId

private Object _setMasterWindowId(String masterWindowId)

set the master window ID

Parameters:
masterWindowId  -  the master window id to set
Return:
Object

_setMasterWindowRef

private Object _setMasterWindowRef(Object masterWinRef)

set the reference to the window object

Parameters:
masterWinRef    
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

_setPageId

private 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)

_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()

Return:
Object

_setReplaceMasterPageId

private Object _setReplaceMasterPageId(Object replaceMasterPageId)

set the replace master page ID

Parameters:
replaceMasterPageId    
Return:
Object

_setReplaceMasterWindowId

private Object _setReplaceMasterWindowId(Object replaceMasterWindowId)

set the replace master window ID

Parameters:
replaceMasterWindowId    
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

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>)

__setServerTimestamp

Object __setServerTimestamp(Object timestamp)

This script is rendered by the server to send the server time to the client. The server time is stored on the page and is used for latency calculation

Parameters:
timestamp    
Return:
Object

__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)

Parameters:
disabled    
Return:
Object

_setWindowId

private 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

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

_startPolling

private Object _startPolling()

_startPolling is called by the onload handler for the iframe and is responsible for scheduling the next polling timeout. It was added to avoid making a poll request when the previous poll response had not come back. Instead of making poll requests at fixed intervals, we make poll requests only after a poll response comes back taking into account the time elapsed and configured polling interval. For example: if polling interval is "i" and the poll response returns in delta "t" from the time the poll request was sent, then: if (t >= i) poll immediately else poll in (i - t)

Return:
Object

stopActiveData

public Object stopActiveData()

Return:
Object

_stopActiveData

private Object _stopActiveData(Object clientId)

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

Parameters:
clientId    
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

_testAdfPageExistence

private Object _testAdfPageExistence(Object windowObject)

test the window object to see if the rich page exists

Parameters:
windowObject    
Return:
Object - Returns true if the window object contains a rich page

_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

_touchServerSession

private Object _touchServerSession()

Send a request to server to touch the server session

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

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)

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)

updateActiveDataComponents

public Object updateActiveDataComponents(String masterWindowId,
                                         Object masterPageId,
                                         Object pageId,
                                         String... clientIds,
                                         Number... changeCounts)

List of components to update the active data counts for. If the component isn't already in the list of active components, it will be added.

Removal is handled automatically when the component is removed from the client side tree.


Parameters:
masterWindowId  -  Id of the master window.
masterPageId    
pageId    
clientIds  -  Alternating varargs of trgs of the component's client ID
changeCounts  -  Alternating varargs of the component's change count
Return:
Object
See also:
unmapComponent(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()

Called to reset the timer that will deliver the events

Return:
Object

_updateStartActiveDataStateChange

private Object _updateStartActiveDataStateChange(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:
clientId  -  client ID of component to start or stop active data on
Return:
Object

_updateStopActiveDataStateChange

private 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)

Parameters:
doc    
id    
Return:
Object

_updateViewState

private Object _updateViewState(Object fragmentNode)

Parameters:
fragmentNode    
Return:
Object

_wrapMasterWindowId

private Object _wrapMasterWindowId(Object windowId)

this is for safety, in case somebody messes up the window id basically in IE, window.open() doesn't like anything like "/", "-", or "."

Parameters:
windowId    
Return:
Object - Returns {String} wrapped window id which doesn't contains those chars

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

 

Generated on 2011.04.27 02:28 UTC
Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.