oracle.maf.impl.amx

Class View

Object

oracle.maf.impl.amx.View

All Implemented Interfaces:

JSONSerializable

public class View
extends Object
implements JSONSerializable

Houses the data for the currently loaded view in a feature. The view is placed in the view scope so that it is retained without relying on class paths and is thrown out when the view scope is re-created.

Constructor Summary

Constructors

Constructor and Description
View(String viewId, String lang, String dir, String featureId, java.util.Map<String,Object> clientState) Constructor

Method Summary

Modifier and Type	Method and Description
Object	getClientState(Node node) Get the client state for a given node
static View	getInstance(String featureId) Get the current view from the view scope
Object	getKey(String stampKey) Given a string version of the stamp key, get the embedded key object
String	getLanguage() Returns the language set on the web view document element
Node	getNodeById(String nodeId) Find a node by its ID.
static oracle.maf.impl.amx.NodeChangesTracker	getNodeChangesTracker(String featureId) Convenience method to get the current node change tracker
Node	getRootNode()
String	getStampForId(String stampKey) Get a stamp key that is escaped to be valid for inclusion in an HTML ID attribute
String	getStampKey(Object key) Get a stamp key for a stamp object.
TagImpl	getTagForViewId(String viewId) Get a tag for a nested view ID using caching.
String	getViewId()
static boolean	isAmxView(TagImpl tag) Checks if the tag is an AMX view tag.
boolean	isLeftToRight() Checks if the current language is rendered left-to-right
boolean	isRightToLeft() Checks if the current language is rendered right-to-left
void	nodeAdded(Node node) Call when a node is added to the view to be able to update the ID map
void	nodeRemoved(Node node) Call when a node is removed from the view to be able to update the ID map
boolean	registerTag(TagImpl tag) Registers that a tag is being used by the view.
Object	setClientState(Node node, Object state) Set the client state for a node
void	setRootNode(Node rootNode) Sets the root node
void	tearDown() Perform any clean up needed when a view is being disposed
Object	toJSON() Returns an empy JSON object to prevent this class from being serialized to the WebView

Methods inherited from class Object

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

Constructor Detail

View

public View(String viewId,
            String lang,
            String dir,
            String featureId,
            java.util.Map<String,Object> clientState)

Constructor

Parameters:

viewId - the ID of the view, the one requested by the client

clientState - the client state

lang - the language set on the document

direction - the value of the 'dir' HTML attribute

featureId - the ID of the feature

Method Detail

getInstance

public static View getInstance(String featureId)

Get the current view from the view scope

Parameters:

featureId - the ID of the feature for the view

Returns:

the view or null if there is no current view for this feature yet

isAmxView

public static boolean isAmxView(TagImpl tag)

Checks if the tag is an AMX view tag. Used to check if the view is a fragment or an AMX page.

isRightToLeft

public boolean isRightToLeft()

Checks if the current language is rendered right-to-left

isLeftToRight

public boolean isLeftToRight()

Checks if the current language is rendered left-to-right

getLanguage

public String getLanguage()

Returns the language set on the web view document element

getViewId

public String getViewId()

Returns:

the view ID

getRootNode

public Node getRootNode()

Returns:

the root node of the AMX node hierarchy

setRootNode

public void setRootNode(Node rootNode)

Sets the root node

Parameters:

rootNode - the root node

getNodeById

public Node getNodeById(String nodeId)

Find a node by its ID. Used during event processing

Parameters:

nodeId - the node ID

Returns:

the node or null if none exists with the given ID

nodeAdded

public void nodeAdded(Node node)

Call when a node is added to the view to be able to update the ID map

Parameters:

node - the added node

nodeRemoved

public void nodeRemoved(Node node)

Call when a node is removed from the view to be able to update the ID map

Parameters:

node - the added node

getClientState

public Object getClientState(Node node)

Get the client state for a given node

Parameters:

node - the node

Returns:

the client state or null if the node has no client state

setClientState

public Object setClientState(Node node,
                             Object state)

Set the client state for a node

Parameters:

node - the node

state - the state of the node

Returns:

the previous value, if any

tearDown

public void tearDown()

Perform any clean up needed when a view is being disposed

toJSON

public Object toJSON()
              throws Exception

Returns an empy JSON object to prevent this class from being serialized to the WebView

Specified by:

toJSON in interface JSONSerializable

Returns:

Object

Throws:

Exception

getStampKey

public String getStampKey(Object key)

Get a stamp key for a stamp object. Converts the object into a safe string that can be used on the client

Parameters:

key - the stamp

Returns:

a string that can be used on the client

getStampForId

public String getStampForId(String stampKey)

Get a stamp key that is escaped to be valid for inclusion in an HTML ID attribute

Parameters:

stampKey - the string version of a stamp key from getStampKey(Object)

Returns:

the key escaped for usage in an HTML ID attribute

getKey

public Object getKey(String stampKey)

Given a string version of the stamp key, get the embedded key object

Parameters:

stampKey - the client safe string version of the key

Returns:

the original stamp key object or null if the key was not added

registerTag

public boolean registerTag(TagImpl tag)

Registers that a tag is being used by the view. This allows the view to track what tags have been created dynamically during a request. For example, if a fragment src attribute is changed as a result of a change, new tags will have been added that must be serialized to the client.

Parameters:

tag - the tag that may be new

Returns:

true if the tag is new or false if the tag was previously used

getTagForViewId

public TagImpl getTagForViewId(String viewId)

Get a tag for a nested view ID using caching. This is used with fragments to get fragment amxf files so that if a fragment is used more than once in a view, it is only parsed once

Parameters:

viewId - the view ID of the fragment

Returns:

the tag or null if not found

getNodeChangesTracker

public static oracle.maf.impl.amx.NodeChangesTracker getNodeChangesTracker(String featureId)

Convenience method to get the current node change tracker

Returns:

the tracker or null if the view is not available or if changes are not being tracked