For the moment, this is just an empty placeholder. Eventually, the active data implementation will be pulled out of AdfDhtmlPage and hosted here. This will allow us to use library partitioning to pull in the active data code base on an as needed basis, rather than pulling this code down all the time with AdfDhtmlPage.
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)-
This method registers a listener which is a callback function that is invoked on any change in the ADS connection state.
|
public Object |
adsScreenReaderModeOnLoad(Object clientId)-
handles onload related functions in screen reader mode
|
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
|
public 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.
|
private Object |
_broadcastADSConnectionStateChange(Object adsConnectionState)-
This method is called to notify the page of a new ADS connection state.
|
private Object |
_cancelADSTimers()-
clean up active data timers, like connection check timer and polling timer
|
private Object |
_checkAdsConnection()-
This method is called by a setInterval based timer to check if the channel is connected.
|
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 |
_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 |
failover(Object windows)-
this function is called from the server, when the AdsProcessor notices it is in a failover
|
private Object |
_findYoungestWindow(Object windowMap)-
helper function to find the latest added (youngest) AdfPage object from our window map.
|
public Object |
getActiveComponents()
|
private Object |
_getActiveFrame()-
get the IFrame that we will use for active data channel
|
public AdfDhtmlPage.PushChannelStates |
getADSConnectionState()-
Accessor for the current ADS connection state
|
private Object |
_getADSMasterWindow(String masterWindowId)-
Get the master window.
|
private Object |
_getClientStateMap()-
get the client state map, i.e.
|
private Object |
_getMasterPageId()-
get the master page Id
|
private Object |
_getMasterWindowId()-
get the master window ID
|
private Object |
_getMilliSecondsBehind(Object timestamp)
|
private Object |
_getRegistryMap()-
gets the window name to window map
|
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
|
private Object |
_handleADSChannelMigration()-
handles the migration
|
private Object |
_handleAllFailovers(Object windows)-
this function is only called on the master 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
|
protected Object |
Init()-
Initializes the instance.
|
public Object |
initActivePage()-
when we need to initialize the active page, we do it here
|
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
|
public Object |
initializeActiveForm(Boolean wls, String ctxName)-
Initializing the ADS Active Form URL, based on the underlying runtime.
|
private Object |
_initializeADSIFrame()
|
public Object |
initLongPolling()-
This script is rendered by the server to trigger a new long-polling request from the client to the server.
|
public Object |
isHAMigrated()-
Queries the migrated state of this AdfPage object.
|
private Object |
_makeADSChannelRequest(Boolean createChannel, Boolean reconnect)-
Makes the request to server to create channel, this also sends the change counts.
|
private Object |
_notifyADSConnectionStateChange(Object adsConnectionState)-
Notifies the page of the latest ADS connection state.
|
public Object |
onBeforeUnload()-
This method is normally called from AdfPage.PAGE._handleBeforeUnload() However, when we ask the user whether navigation is desired, this method will be called from page's onUnload
|
private Object |
_pollForEvents()-
This is the method that prepares and sends the poll request
|
public Object |
populateStartActiveDataArray(Object startActiveDataArray, Object startActiveDataEventIdArray, Object currClientId)-
populate the start active data array
|
private Object |
_prepareAdsConnectionTimer()-
Helper function that handles to schedule the _checkAdsConnection timer.
|
public 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 |
_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.
|
public Object |
recordActiveDataActivity()-
Heartbeat called from active data iframe
|
private Object |
_refreshAllPushComponents()-
this method makes a request to refresh all the push components within the page use case:
|
public 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:
|
private Object |
_registerWindowWithADSMaster(Object registeringWindow)-
Registers a page with the AdfDhtmlPage acting as the master
|
public 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
|
public Object |
removeADSConnectionStateListener(Object listener, Object instance)-
This method unregisters a listener callback function from being invoked on any change in the ADS connection state
|
private static Object |
_requestCallback(Object xmlRequest)-
Callback for the XHR onreadystatechange handler.
|
public Object |
requestStatusChanged(Object requestEvent)
|
public Object |
reset()
|
private Object |
_sendADSChannelRequest(Object channelParameterMap, Object clientStateMap)-
This method does the following:
|
public Object |
setActiveComponents(Object activeComponents)
|
private Object |
_setBodyCursorForActivePage()-
In FF2 active page shows progress cursor so we need to set custom cursor that looks like default cursor arrow.
|
public 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)
|
public Object |
setConnected()-
This script is rendered by the server over the push channel to notify the Page that the channel is connected
|
public Object |
setHAMigrated(Object migration)-
Takes a boolean to tell the AdfPage object if this in an HA migration
|
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
|
private Object |
_setReplaceMasterPageId(Object replaceMasterPageId)-
set the replace master page ID
|
private Object |
_setReplaceMasterWindowId(Object replaceMasterWindowId)-
set the replace master window ID
|
public Object |
setServerTimestamp(Object timestamp)-
This script is rendered by the server to send the server time to the client.
|
private Object |
_startPolling()-
_startPolling is called by the onload handler for the iframe and is responsible for scheduling the next polling timeout.
|
public Object |
stop()-
This functon gets called when user has been inactive for a period of inactivity timesout interval.
|
private Object |
_stopActiveData(Object clientId)-
notifies the active data manager to stop delivering events for the specified component
|
private Object |
_testAdfPageExistence(Object windowObject)-
test the window object to see if the rich page exists
|
public Object |
unmapComponent(Object clientId)-
unmap the component.
|
public Object |
updateActiveDataComponents(String masterWindowId, String masterPageId, String pageId, Boolean modelChanged, String... clientIds, Number... changeCounts)-
List of components to update the active data counts for.
|
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 "."
|
JavaScript API Reference for Oracle ADF Faces