oracle.maf.impl.amx

Class Dispatch

Object

oracle.maf.impl.amx.Dispatch

public class Dispatch
extends Object

Handles communication between the JavaScript code and the AMX embedded code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dispatch.ViewCleanupListener

Method Summary

Modifier and Type	Method and Description
static String	getCurrentViewId(String featureId) Get the view ID of the current page or null if one has yet to be loaded
static JSONObject	loadPage(String viewId, String lang, String dir, boolean newViewScope, Integer clientStateIdentifier, int[] clientStatesToRemove) Loads an AMX page.
static String	processAmxEvent(String nodeId, String attributeName, Object newAttributeValue, String eventName, AMXEvent event) Called when an AMX event has been generated by the browser
static boolean	validate(String nodeId) Causes the node with the given ID to be validated.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadPage

public static JSONObject loadPage(String viewId,
                                  String lang,
                                  String dir,
                                  boolean newViewScope,
                                  Integer clientStateIdentifier,
                                  int[] clientStatesToRemove)
                           throws AdfException

Loads an AMX page.

Parameters:

viewId - the view ID pointing to a valid AMX file (should not be a fragment)

lang - the language set on the document

direction - the value of the 'dir' HTML attribute

newViewScope - if true a new view scope will be created for this view

clientStateIdentifier - the ID to use to store viewScope data for any nodes

clientStatesToRemove - if any client states should be removed as part of loading this view. For example, if this is a result of a back navigation, the current view scope needs to be popped/removed.

Returns:

the JSON object representing the tag and node hierarchies

Throws:

AdfException - if an exception occurred during the loading of the view

getCurrentViewId

public static String getCurrentViewId(String featureId)

Get the view ID of the current page or null if one has yet to be loaded

Parameters:

featureId - the ID of the feature for which to get the view

Returns:

the view ID

processAmxEvent

public static String processAmxEvent(String nodeId,
                                     String attributeName,
                                     Object newAttributeValue,
                                     String eventName,
                                     AMXEvent event)

Called when an AMX event has been generated by the browser

Parameters:

nodeId - the ID of the node that the event is for

attributeName - the attribute name if this AMX event should set a new value on the node via the value expression. This will be null if an attribute should not be changed

newAttributeValue - the new value to set

eventName - the name of the AMX event

event - the event

Returns:

the action to use for navigation if the node supports an action attribute, otherwise null

validate

public static boolean validate(String nodeId)

Causes the node with the given ID to be validated. This is the node that contains amx:validationBehavior child tags. If no behavior tags are found, nothing is done and true is returned.

Parameters:

nodeId - the ID of the node that should be validated

Returns:

true if valid, false otherwise