ariba.ui.aribaweb.core
Class AWComponentReference

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.aribaweb.core.AWComponentReference

All Implemented Interfaces:

AWBindable, AWCycleable, AWCycleableReference, AWElement, AWElementContaining, AWVisitable, AWObject, java.lang.Cloneable

public class AWComponentReference
extends AWContainerElement

Nested Class Summary

static interface

AWComponentReference._Creator

Field Summary

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

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Method Summary

void	_checkInSharedComponentInstance(AWComponent subcomponentInstance)
AWComponent	_statelessSubcomponentInstanceInComponent(AWRequestContext requestContext, AWComponent parentComponent)
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().
AWBinding	bindingForName(java.lang.String bindingName)
AWBinding	bindingForName(java.lang.String bindingName, AWComponent component)
AWBindingDictionary	bindings()
AWComponentDefinition	componentDefinition()
static AWComponentReference	create(AWComponentDefinition componentDefinition)
AWComponentReference	createBoundReference(AWComponent instance)
AWElement	determineInstance(java.lang.String elementName, java.util.Map bindingsHashtable, java.lang.String templateName, int lineNumber)
void	init(java.lang.String tagName, java.util.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.
boolean	isKindOfClass(java.lang.Class targetClass)
boolean	isStateless()
void	logPhase(AWRequestContext requestContext, java.lang.String phase, boolean entering)
AWBindingDictionary	otherBindings()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
void	setUserData(java.lang.Object userData)
java.lang.String	toString()
java.lang.Object	userData()
void	validate(AWValidationContext validationContext, AWComponent component) Checks for things like valid binding names and definitions.

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

add, appendTo, contentElement, continueVisit, setContentElement

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

tagName

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

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

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

debugString, ensureFieldValuesClear, getFieldValue, init, 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.core.AWCycleableReference

determineInstance

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

getFieldValue, init, setFieldValue

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

startVisit

Method Detail

create

public static AWComponentReference create(AWComponentDefinition componentDefinition)

init

public void init(java.lang.String tagName,
                 java.util.Map bindingsHashtable)

Specified by:

init in interface AWBindable

Overrides:

init in class AWBindableElement

determineInstance

public AWElement determineInstance(java.lang.String elementName,
                                   java.util.Map bindingsHashtable,
                                   java.lang.String templateName,
                                   int lineNumber)

Specified by:

determineInstance in interface AWCycleableReference

Overrides:

determineInstance in class AWBindableElement

componentDefinition

public AWComponentDefinition componentDefinition()

bindingForName

public AWBinding bindingForName(java.lang.String bindingName,
                                AWComponent component)

bindingForName

public AWBinding bindingForName(java.lang.String bindingName)

bindings

public AWBindingDictionary bindings()

otherBindings

public AWBindingDictionary otherBindings()

allBindings

public AWBinding[] allBindings()

Specified by:

allBindings in interface AWBindable

Overrides:

allBindings in class AWBindableElement

userData

public java.lang.Object userData()

setUserData

public void setUserData(java.lang.Object userData)

isKindOfClass

public boolean isKindOfClass(java.lang.Class targetClass)

Specified by:

isKindOfClass in interface AWObject

Overrides:

isKindOfClass in class AWBaseObject

isStateless

public boolean isStateless()

_statelessSubcomponentInstanceInComponent

public AWComponent _statelessSubcomponentInstanceInComponent(AWRequestContext requestContext,
                                                             AWComponent parentComponent)

_checkInSharedComponentInstance

public void _checkInSharedComponentInstance(AWComponent subcomponentInstance)

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

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

validate

public void validate(AWValidationContext validationContext,
                     AWComponent component)

Description copied from class: AWBaseElement

Checks for things like valid binding names and definitions. Logs all errors and warnings. This is the default, which is to do nothing.

Specified by:

validate in interface AWElement

Overrides:

validate in class AWContainerElement

toString

public java.lang.String toString()

Overrides:

toString in class AWBaseElement

logPhase

public void logPhase(AWRequestContext requestContext,
                     java.lang.String phase,
                     boolean entering)

createBoundReference

public AWComponentReference createBoundReference(AWComponent instance)