JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.agent
Class AdfNavigationHistoryAgent

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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

Direct Known Subclasses:

AdfGeckoNavigationHistoryAgent, AdfIE8NavigationHistoryAgent, AdfIENavigationHistoryAgent, AdfSafariNavigationHistoryAgent

public class AdfNavigationHistoryAgent
extends AdfObject

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

Field Summary

private Object	_loadCounter
private static Object	_STATE_SEPARATOR

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

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

Method Summary

protected Object	AddHistoryEntry(Object id, Object queryParams)
public Object	dispose() Disposes of this agent
private Object	_getDefaultQueryParams()
protected Object	GetDomDocument()
protected Object	GetDomWindow()
public static Object	getInstance() Gets the current instance of the agent.
protected Object	GetViewInfoFromBrowserURI()
protected Object	Init() Initializes the instance.
protected static Object	InitClass()
public Object	initialize(Object defaultViewId, Object queryParams) This method should be called by the framework while the page is still loading (before document's onLoad() fires)
public Object	isInitialized() Determines whether this agent instance has been initialized
private Object	_loadView(Object id, Object params)
public Object	setCurrentPage(Object viewId, Object queryParams, Object loadId) Informs this agent that the framework loaded a new view.
public Object	setQueryString(Object queryParams, Object noHistory) Updates query parameters stored in the hash portion of the URI without changing the view Id.
protected Object	SetQueryStringImpl(Object id, Object queryParams, Object noHistory)
protected Object	SetViewIdOnURI(Object id, Object queryParams)
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
private Object	_updateHash(Object id, Object queryParams, Object noHistory)
protected Object	ValidateCurrentView(Object browserId, Object queryParams)

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

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

Field Detail

_loadCounter

private Object _loadCounter

_STATE_SEPARATOR

private static Object _STATE_SEPARATOR

Constructor Detail

AdfNavigationHistoryAgent

public AdfNavigationHistoryAgent()

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

Method Detail

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

dispose

public Object dispose()

Disposes of this agent

Return:

Object

_getDefaultQueryParams

private Object _getDefaultQueryParams()

Return:

Object

GetDomDocument

protected Object GetDomDocument()

Return:

Object

GetDomWindow

protected Object GetDomWindow()

Return:

Object

getInstance

public static Object getInstance()

Gets the current instance of the agent.

Return:

Object - the instance.

GetViewInfoFromBrowserURI

protected Object GetViewInfoFromBrowserURI()

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

initialize

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

isInitialized

public Object isInitialized()

Determines whether this agent instance has been initialized

Return:

Object - true if initialized, false otherwise

_loadView

private Object _loadView(Object id,
Object params)

Parameters:

id
params

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

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 id,
Object queryParams,
Object noHistory)

Parameters:

id
queryParams
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

_updateHash

private Object _updateHash(Object id,
Object queryParams,
Object noHistory)

Parameters:

id
queryParams
noHistory

Return:

Object

ValidateCurrentView

protected Object ValidateCurrentView(Object browserId,
Object queryParams)

Parameters:

browserId
queryParams

Return:

Object

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