ariba.ui.aribaweb.core
Class AWContainerElement

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AWAction, AWApi, AWApiDeclaration, AWAppendEnvironment, AWBlock, AWComment, AWComponentReference, AWContent, AWExampleApi, AWFor, AWGenericContainer, AWIf.AWIfBlock, AWIncludeComponent, AWIncludeExample, AWLocal, AWMappingRepetition, AWMessageArgument, AWOutputRangeCheck, AWResourceOverlay, AWScope, AWStaticContent, AWSubcomponentScope, AWTaggedContainer, AWTDataTable.Column, AWWhile, Markdown, MetaContext, MetaRules, ToggleBox.ToggleBoxElement

public abstract class AWContainerElement
extends AWBindableElement
implements AWElementContaining

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

Constructor Summary

AWContainerElement()

Method Summary

void	add(AWElement element)
void	appendTo(java.lang.StringBuffer buffer) This default implementation is not intended to be executed -- just here for backward compatibility to avoid forcing old code to update to new api's (which was required when no default implementation was provided).
void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
AWElement	contentElement()
void	continueVisit(AWVisitor visitor)
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.
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
void	setContentElement(AWElement contentElement)
void	validate(AWValidationContext validationContext, AWComponent component) Checks for things like valid binding names and definitions.

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

allBindings, determineInstance, init, 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.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

AWContainerElement

public AWContainerElement()

Method Detail

add

public void add(AWElement element)

Specified by:

add in interface AWElementContaining

setContentElement

public void setContentElement(AWElement contentElement)

contentElement

public AWElement contentElement()

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 AWBaseElement

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 AWBaseElement

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 AWBaseElement

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 AWBindableElement

appendTo

public void appendTo(java.lang.StringBuffer buffer)

Description copied from class: AWBaseElement

This default implementation is not intended to be executed -- just here for backward compatibility to avoid forcing old code to update to new api's (which was required when no default implementation was provided).

Specified by:

appendTo in interface AWElement

Overrides:

appendTo in class AWBindableElement

continueVisit

public void continueVisit(AWVisitor visitor)

Specified by:

continueVisit in interface AWVisitable

Overrides:

continueVisit in class AWBaseElement