JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.agent
Class AdfNavigationHistoryAgent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.agent.AdfNavigationHistoryAgent

Direct Known Subclasses:

AdfGeckoNavigationHistoryAgent, AdfHtml5NavigationHistoryAgent, AdfIE8NavigationHistoryAgent, AdfIENavigationHistoryAgent, AdfOperaNavigationHistoryAgent, AdfSafariNavigationHistoryAgent

public class AdfNavigationHistoryAgent
extends AdfObject

_loadCounter

private Object _loadCounter

STATE_MARKER

public static Object STATE_MARKER

_STATE_MARKER_LENGTH

private static Object _STATE_MARKER_LENGTH

_STATE_SEPARATOR

private static Object _STATE_SEPARATOR

AdfNavigationHistoryAgent

public AdfNavigationHistoryAgent()

This class implements browser-specific support for keeping history of page (view) transitions over AJAX.

AddHistoryEntry

protected Object AddHistoryEntry(Object id,
                                 Object queryParams)

Parameters:

id
queryParams

Return:

Object - true if the history entry was added, false if the current browser URI already reflects the new view id

_delayedStartTrackingURI

private static Object _delayedStartTrackingURI()

Return:

Object

dispose

public Object dispose()

Disposes of this agent

Return:

Object

GetCurrentQueryParams

protected Object GetCurrentQueryParams()

Return:

Object

GetCurrentViewId

protected Object GetCurrentViewId()

Return:

Object

_getDefaultQueryParams

private Object _getDefaultQueryParams()

Return:

Object

GetDomDocument

protected Object GetDomDocument()

Return:

Object

GetDomWindow

protected Object GetDomWindow()

Return:

Object

GetFacesPath

protected Object GetFacesPath()

Retrieves Faces path

Return:

Object - faces path

getInstance

public static Object getInstance()

Gets the current instance of the agent.

Return:

Object - the instance.

GetViewInfoFromBrowserURI

protected Object GetViewInfoFromBrowserURI()

Return:

Object

_handleAnchorNavigation

private Object _handleAnchorNavigation()

Return:

Object

Init

protected Object Init()

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

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Return:

Object

initializeNavigation

public Object initializeNavigation(Object defaultViewId,
                                   Object queryParams)

This method should be called by the framework while the page is still loading (before document's onLoad() fires)

Parameters:

defaultViewId
queryParams	-	URI query parameters to be stored in the hash portion of the URL This parameter may be null

Return:

Object

isNavigationInitialized

public Object isNavigationInitialized()

Determines whether this agent instance has been initialized for dealing with page navigation

Return:

Object - true if initialized, false otherwise

isWaitingForServer

public Object isWaitingForServer()

Return:

Object

_loadView

private Object _loadView(Object id,
                         Object params,
                         Object pageId)

Parameters:

id
params
pageId

Return:

Object

_navigateToSavedAnchor

private Object _navigateToSavedAnchor(Object info)

Parameters:

info

Return:

Object

NavigateToSavedAnchorImpl

protected Object NavigateToSavedAnchorImpl(Object info,
                                           Object anchor)

Parameters:

info
anchor

Return:

Object

_recordCurrentTrackedValues

private Object _recordCurrentTrackedValues()

Return:

Object

_replaceLocation

private Object _replaceLocation(Object hash)

Parameters:

hash

Return:

Object

RestoreValuesAfterAnchorNavigation

protected Object RestoreValuesAfterAnchorNavigation(Object pageId,
                                                    Object viewid,
                                                    Object queryParams,
                                                    Object anchor)

Parameters:

pageId
viewid
queryParams
anchor

Return:

Object

setCurrentPage

public Object setCurrentPage(Object viewId,
                             Object queryParams,
                             Object loadId)

Informs this agent that the framework loaded a new view. If the URI does not already reflect the transition, it will be updated and a browser history entry will be added

Parameters:

viewId	-	new view Id
queryParams	-	query parameters associated with the view Id (may be null)
loadId	-	load View request id. A non-null request Id will be passed if the new page was requested to satisfy the current browser URL (back button, etc.)

Return:

Object

setFacesPath

public Object setFacesPath(Object path)

Supplies Faces Path to this agent.

Parameters:

path

-

Faces Path (the portion of the URL from the context path until the View Id)

Return:

Object

setPageId

public Object setPageId(Object id)

Sets page Id on the URI

Parameters:

id

-

new page Id

Return:

Object

setQueryString

public Object setQueryString(Object queryParams,
                             Object noHistory)

Updates query parameters stored in the hash portion of the URI without changing the view Id.

Parameters:

queryParams	-	query string
noHistory	-	true if the browser history entry should not be added, false otherwise

Return:

Object

SetQueryStringImpl

protected Object SetQueryStringImpl(Object pageId,
                                    Object id,
                                    Object queryParams,
                                    Object anchor,
                                    Object noHistory)

Parameters:

pageId
id
queryParams
anchor
noHistory

Return:

Object

SetViewIdOnURI

protected Object SetViewIdOnURI(Object id,
                                Object queryParams)

Parameters:

id
queryParams

Return:

Object - true if the view id has been set, false if the view id has not been set since it already has the correct value

startTrackingURI

public Object startTrackingURI(Object callbackObj)

Tells this agent to start checking that the browser URI reflects the current view When there is no match, the agent will invoke loadView(viewId) on the callback object

Parameters:

callbackObj

-

callback object

Return:

Object

StartTrackingUriImpl

protected Object StartTrackingUriImpl(Object info)

Parameters:

info

Return:

Object

UpdateHash

protected Object UpdateHash(Object pageId,
                            Object id,
                            Object queryParams,
                            Object anchor,
                            Object noHistory)

Parameters:

pageId
id
queryParams
anchor
noHistory

Return:

Object

UpdateInitialValues

protected Object UpdateInitialValues(Object pageId,
                                     Object viewid,
                                     Object queryParams,
                                     Object anchor)

Parameters:

pageId
viewid
queryParams
anchor

Return:

Object

UsesHashForTrackingNavigation

protected Object UsesHashForTrackingNavigation()

Return:

Object

ValidateCurrentView

protected Object ValidateCurrentView(Object browserId,
                                     Object queryParams)

Parameters:

browserId
queryParams

Return:

Object