JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfAgentHelper
extends AdfObject

AdfAgentHelper

public AdfAgentHelper()

Helper class used to support user-agent (browser) specific features

getInstance

public static Object getInstance()

Return:

Object

getLocalStorageKeys

public Object getLocalStorageKeys()

If the local storage feature is enabled for the user-agent (browser), this function returns all the keys, the key-value pair for which is stored in the local storage provided by DOM:storage methods. If the local storage feature is not enabled, this will be a no-op.

Return:

Object

getLocalStorageProperty

public Object getLocalStorageProperty(String propKey)

If the local storage feature is enabled for the user-agent (browser), this function returns the value for a given key stored in local storage provided by DOM:storage methods. If the local storage feature is not enabled, this will be a no-op.

Parameters:

propKey

-

this key will be used to get the value in storage

Return:

Object

Init

protected Object Init()

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

Return:

Object

Overrides:

AdfObject.Init()

isLocalStorageEnabled

public Boolean isLocalStorageEnabled()

This function returns a boolean indicating whether the local storage feature is enabled for the user-agent (browser).

Return:

Boolean - true if localStorage and is enabled, false otherwise.

removeLocalStorageProperty

public Object removeLocalStorageProperty(String propKey)

If the local storage feature is enabled for the user-agent (browser), this function removes key/value pair stored in session storage provided by DOM:storage methods. If the local storage feature is not enabled, this will be a no-op.

Parameters:

propKey

-

this key will be used to remove the key/value from storage

Return:

Object

setLocalStorageProperty

public Object setLocalStorageProperty(String propKey,
                                      String propValue)

If the local storage feature is enabled for the user-agent (browser), this function stores the key/value pair in local storage provided by DOM:storage methods. If the local storage feature is not enabled, this will be a no-op.

Parameters:

propKey	-	this key will be used to store the key/value in storage
propValue	-	value to be stored.

Return:

Object