<MetaContext>

MetaContext (m:Context) enables manipulation of a MetaUI Context as part of the AribaWeb component processing. The MetaContext tag will find the current Context in the AWEnvironment for the request or will create one, will push() a level on the Context, set() all of its bindings as key/values, render its content, and then pop(). Since its content may contain component that further use MetaContext, additional nested context manipulations may occur.

Simple use:

<m:Context object="$user" layout="Inspect" operation="edit">
    <m:IncludeComponent/>
</m:Context>

More advanced use:

<m:Context object="$user" operation="edit">
    <a:For item="$fieldName"
           list="$metaContext.properties.fieldsByZone.zLeft">
        <m:Context field="$fieldName">
            <a:If ifTrue="$metaContext.properties.visible">
               <a:String value="$metaContext.properties.label"/> :
               <m:IncludeComponent/>
            </a:If>
        </m:Context>
     </a:For>
</m:Context>

Generally, MetaContext treats its bindings as a verbatim list of keys/values to be set() on the context (i.e. the bindings above on "object", "layout", "operation", and "field" are not predefined by MetaContext). See below for a small number of special pre-defined bindings.

Bindings

valueMap	If specified indicates a Map of keys/values to be set on the context (in addition to any others specified as bindings).	Map (get)
scopeKey	The key to force as the "context scope key" (see Context.setScopeKey()).	String (get)
pushNewContext	If true, a new context is pushed on the environment (rather than applying the assignments to any current one).	boolean (get)

ariba.ui.meta.core
Class MetaContext

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWBaseElement
          ariba.ui.aribaweb.core.AWBindableElement
              ariba.ui.aribaweb.core.AWContainerElement
                  ariba.ui.meta.core.MetaContext

All Implemented Interfaces:

AWBindable, AWCycleable, AWCycleableReference, AWElement, AWElementContaining, AWVisitable, AWObject, Cloneable

public class MetaContext
extends AWContainerElement

AW Element for manipulating a MetaUI Context as part of AribaWeb component processing. See AWApi for more info...

Nested Class Summary

static class

MetaContext.ComponentClassExtension

Constructor Summary

MetaContext()

Method Summary

AWBinding[]	allBindings()
void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
static UIMeta.UIContext	currentContext(AWComponent component)
void	init(String tagName, Map bindingsHashtable)
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
static UIMeta.UIContext	peekContext(AWComponent component)
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()

Methods inherited from class ariba.ui.aribaweb.core.AWContainerElement

add, appendTo, contentElement, continueVisit, setContentElement, validate

Methods inherited from class ariba.ui.aribaweb.core.AWBindableElement

determineInstance, tagName

Methods inherited from class ariba.ui.aribaweb.core.AWBaseElement

bareStringContent, clone, determineInstance, lineNumber, setLineNumber, setTemplateName, startVisit, templateName, toString

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, ensureFieldValuesClear, getFieldValue, init, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface ariba.ui.aribaweb.core.AWElement

clone

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, init, isKindOfClass, setFieldValue

Methods inherited from interface ariba.ui.aribaweb.core.AWCycleableReference

determineInstance

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, init, isKindOfClass, setFieldValue

Methods inherited from interface ariba.ui.aribaweb.core.AWVisitable

startVisit

Constructor Detail

MetaContext

public MetaContext()

Method Detail

currentContext

public static UIMeta.UIContext currentContext(AWComponent component)

peekContext

public static UIMeta.UIContext peekContext(AWComponent component)

init

public void init(String tagName,
                 Map bindingsHashtable)

Specified by:

init in interface AWBindable

Overrides:

init in class AWBindableElement

allBindings

public AWBinding[] allBindings()

Specified by:

allBindings in interface AWBindable

Overrides:

allBindings in class AWBindableElement

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

The receiver should render its content to the AWRequestContext.response()

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

applyValues

public void applyValues(AWRequestContext requestContext,
                        AWComponent component)

Description copied from interface: AWCycleable

The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().

Specified by:

applyValues in interface AWCycleable

Overrides:

applyValues in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action