oracle.cabo.ui.beans.include
Class IncludeContextMap

java.lang.Object
  |
  +--oracle.cabo.ui.beans.include.IncludeContextMap

All Implemented Interfaces:

ContextMap

public class IncludeContextMap

extends java.lang.Object

implements ContextMap

A ContextMap class that assists in implementing Marlin and UIX's "include" functionality.

Clients that want to set up includes from Java must use this class if they wish to add a named child that performs an "include":

   FlowLayoutBean parent = new FlowLayoutBean();
   // Use an IncludeContextMap
   parent.setNamedChildMap(new IncludeContextMap());
   // Then, add the include bean
   IncludeBean include = new IncludeBean();
   parent.setSeparator(include);
 

You must use IncludeUINodeList if you wish to include indexed children.

See Also:

IncludeUINodeList

Constructor Summary

IncludeContextMap()
Creates a new, empty IncludeContextMap.

IncludeContextMap(ContextMap baseMap)
Creates a new IncludeContextMap that wraps another, possibly pre-populated ContextMap.

Method Summary

java.lang.Object	get(RenderingContext context, java.lang.Object key) Returns the Object stored under the key, returning null if no Object with that key exists.
java.util.Enumeration	keys(RenderingContext context) Returns an Enumeration of all of the keys in the ContextMap given the specified context.
void	set(java.lang.Object key, java.lang.Object value) Stores the value in the map, under the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeContextMap

public IncludeContextMap()

Creates a new, empty IncludeContextMap.

IncludeContextMap

public IncludeContextMap(ContextMap baseMap)

Creates a new IncludeContextMap that wraps another, possibly pre-populated ContextMap.

Method Detail

get

public java.lang.Object get(RenderingContext context,
                            java.lang.Object key)

Returns the Object stored under the key, returning null if no Object with that key exists.

Specified by:

get in interface ContextMap

Parameters:

context - RenderingContext to use to fulfill this request

key - key used to retrieve the value

Returns:

The value stored under this key, or null if no value is found.

Throws:

java.lang.IllegalArgumentException - if the key is null

set

public void set(java.lang.Object key,
                java.lang.Object value)

Stores the value in the map, under the key.

As the RenderingContext is not passed to this function, sets do not have the same databinding capabilities that gets do.

Specified by:

set in interface ContextMap

Parameters:

key - key used to set the value

value - The new value to set

Throws:

java.lang.IllegalArgumentException - if either the key or value is null.

keys

public java.util.Enumeration keys(RenderingContext context)

Returns an Enumeration of all of the keys in the ContextMap given the specified context.

The entire contents of the ContextMap can be retrieved by calling ContextMap.get for each of the keys in the enumeration.

Specified by:

keys in interface ContextMap

Parameters:

RenderingContext - context Context used to determine the set of keys.

Returns:

The Enumeration of keys in the RenderingContext