<a:Form>

Renders a <form ...>...</form> container in the html and must be used anytime a form is to be submitted from an aribaweb application. AWForm also renders several hidden fields that pass along critical information to the server about the state of the application. Of course, these hiden fields are transparent to the developer, but you should be aware of these to understand why AWForm must be used for the state to be properly maintained.

Bindings

action	In the event that no button is clicked in order to submit the form (ie a carriage return can be used form some browsers), no other element will handle the action phase of the request, so you may bind an action to the form itself. You should return the new page (or null to cycle the page) from your method bound to this action.	AWResponseGenerating (get)
target	The name of the window in which you want the response to be displayed. This also has the effect of creating a new pageCache for this window as each window must maintain its own page cache (in order to model the behavior of the browser). This is only evaluated during renderResponse.	String (get)
fragmentIdentifier	The name of a link on the destination page to which the form should be scrolled when the response is displayed. This may be obsoleted by the scrollToVisible feature of TextButton when available.	String (get)
omitTags	Allows for not rendering the opening/closing tags of the nor any of its hidden fields. This makes it easy to avoid duplicating the body of the form just to turn off the form itself. If true, only the body is rendered. Since, the tags are not rendered, the form elements will not behave as form elements, from the user's persepctive.	boolean (get)
method	Allows for forcing the form post Method to GET. Due to restrictions on the size of urls in some browsers, this is strongly discouraged. This may be desirable as a temporary setting for debugging, but should only be temporarily emplyed. In addition to url length issues, the url which is constructed may leave sensitive information visible int he browsers url text field.	String (get)
onSubmit	Allows for providing your own onSubmit event handler in JavaScript. As with any Javascript overrides in the context of AribaWeb, this is strongly discouraged.	String (get)
submitFormDefault	If you set this to true, you are telling all widgets within the scope of this form that they should behave as though they has submitForm=$true. This way, we can avoid needing to know if the widget is within a form or not.	boolean (get)
id	Not supported?	String (get)
name	Allows override of form name attribute -- use for script based manipulation of AWForm. If not present, then name is set to the value as id.	String (get)
onKeyPress	Not supported?	String (get)
autocomplete	You can specify that the "autocomplete=off" HTML attribute will be included in the form HTML tag.	string (get)

ariba.ui.aribaweb.html
Class AWForm

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.aribaweb.html.AWForm

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWHtmlForm, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class AWForm
extends AWComponent
implements AWHtmlForm

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

AWForm()

Method Summary

void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
AWEncodedString	formActionUrl()
AWEncodedString	formId()
AWEncodedString	formName()
AWEncodedString	frameName()
java.util.List	getHiddenValueHandlers()
java.lang.Boolean	hasFormAction()
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	isFormSender()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
boolean	submitFormDefault()
java.lang.String[]	supportedBindingNames()

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

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStateless, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

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

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

Methods inherited from class java.lang.Object

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

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

getFieldValue, init, isKindOfClass, setFieldValue

Field Detail

_formElementId

public AWEncodedString _formElementId

_hiddenFieldElementId

public AWEncodedString _hiddenFieldElementId

_emitTags

public boolean _emitTags

_submitFormDefault

public boolean _submitFormDefault

curHiddenValueHandler

public AWHiddenFormValueHandler curHiddenValueHandler

Constructor Detail

AWForm

public AWForm()

Method Detail

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

formName

public AWEncodedString formName()

Specified by:

formName in interface AWHtmlForm

formId

public AWEncodedString formId()

frameName

public AWEncodedString frameName()

submitFormDefault

public boolean submitFormDefault()

formActionUrl

public AWEncodedString formActionUrl()

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 AWComponent

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 AWComponent

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 AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

isFormSender

public boolean isFormSender()

hasFormAction

public java.lang.Boolean hasFormAction()

getHiddenValueHandlers

public java.util.List getHiddenValueHandlers()