er.extensions.components._private
Class ERXWOForm

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WODynamicElement
          com.webobjects.appserver._private.WODynamicGroup
              com.webobjects.appserver._private.WOHTMLDynamicElement
                  er.extensions.components._private.ERXWOForm

public class ERXWOForm
extends com.webobjects.appserver._private.WOHTMLDynamicElement

Transparent replacement for WOForm. You don't really need to do anything to use it, because it will get used instead of WOForm elements automagically. In addition, it has a few new features:

• it adds the FORM's name to the ERXWOContext's mutableUserInfo as as "formName" key, which makes writing JavaScript elements a bit easier.
• it warns you when you have one FORM embedded inside another and ommits the tags for the nested FORM.
• it pushes the enctype into the userInfo, so that ERXWOFileUpload can check if it is set correctly. ERXFileUpload will throw an exception if the enctype is not set.
• it has a "fragmentIdentifier" binding, which appends "#" + the value of the binding to the action. The obvious case comes when you have a form at the bottom of the page and want to jump to the error messages if there are any.
• it adds the secure boolean binding that rewrites the URL to use https.
• it adds the disabled boolean binding allows you to omit the form tag.

This subclass is installed when the frameworks loads.
If you actually want to see those new bindings in WOBuilder, edit the file WebObjects Builder.app/Contents/Resources/WebObjectDefinitions.xml, which contains the .api for the dynamic elements.

Author:

ak, Mike Schrag (idea to secure binding)

Properties

er.extensions.ERXWOForm.multipleSubmitDefault	the default value of multipleSubmit for all forms
er.extensions.ERXWOForm.addDefaultSubmitButtonDefault	whether or not a default submit button should be addd to the form

Field Summary

protected WOAssociation	_action
protected WOAssociation	_actionClass
protected WOAssociation	_addDefaultSubmitButton
protected WOAssociation	_directActionName
protected WOAssociation	_href
protected WOAssociation	_multipleSubmit
protected NSDictionary	_otherQueryAssociations
protected WOAssociation	_queryDictionary
static boolean	addDefaultSubmitButtonDefault
static boolean	multipleSubmitDefault
static boolean	useIdInsteadOfNameTag

Fields inherited from class com.webobjects.appserver._private.WOHTMLDynamicElement

_associations, _class, _constantAttributeAssociations, _constantAttributesRepresentation, _dyneltName, _finishedInitialization, _generatedId, _prefix, _rendered, _style, _suffix, _title, DontEscapeHTML, EscapeHTML

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

ERXWOForm(String name, NSDictionary associations, WOElement element)

Method Summary

protected void	_appendHiddenFieldsToResponse(WOResponse response, WOContext context)
protected void	_clearEnctype()
protected void	_clearFormName(WOContext context, boolean wasInForm)
protected boolean	_disabled(WOContext context)
protected String	_enctype(WOContext context)
protected boolean	_enterFormInContext(WOContext context)
protected void	_exitFormInContext(WOContext context, boolean wasInForm, boolean wasFormSubmitted)
protected String	_formName(WOContext context)
protected void	_setEnctype(String enctype)
protected void	_setFormName(WOContext context, boolean wasInForm)
protected boolean	_shouldAppendFormTags(WOContext context, boolean wasInForm)
void	appendAttributesToResponse(WOResponse response, WOContext context)
void	appendChildrenToResponse(WOResponse response, WOContext context)
void	appendToResponse(WOResponse response, WOContext context)
protected String	cgiAction(WOResponse response, WOContext context, boolean secure)
static String	formName(WOContext context, String defaultName) Retrieves the current FORM's name in the supplied context.
WOActionResults	invokeAction(WORequest worequest, WOContext context)
void	takeValuesFromRequest(WORequest request, WOContext context)
String	toString()

Methods inherited from class com.webobjects.appserver._private.WOHTMLDynamicElement

__otherQueryDictionaryInContext, __queryDictionaryInContext, _appendAttributesFromAssociationsToResponse, _appendClassAndIdToResponse, _appendCloseTagToResponse, _appendOpenTagToResponse, _appendTagAttributeAndValueToResponse, _frameworkNameInComponent, appendConstantAttributesToResponse, appendHiddenFieldToResponse, appendNonURLAttributesToResponse, appendURLAttributesToResponse, classInContext, computeActionStringInContext, computeQueryDictionaryInContext, constantAttributeAssociations, constantAttributesRepresentation, elementName, escapeHTML, hasContent, idInContext, isRenderedInContext, nonUrlAttributeAssociations, prefixInContext, secureInContext, stringValueInContext, styleInContext, suffixInContext, titleInContext, urlAttributeAssociations

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest

Methods inherited from class java.lang.Object

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

Field Detail

_action

protected WOAssociation _action

_href

protected WOAssociation _href

_multipleSubmit

protected WOAssociation _multipleSubmit

_actionClass

protected WOAssociation _actionClass

_queryDictionary

protected WOAssociation _queryDictionary

_otherQueryAssociations

protected NSDictionary _otherQueryAssociations

_directActionName

protected WOAssociation _directActionName

_addDefaultSubmitButton

protected WOAssociation _addDefaultSubmitButton

multipleSubmitDefault

public static boolean multipleSubmitDefault

addDefaultSubmitButtonDefault

public static boolean addDefaultSubmitButtonDefault

useIdInsteadOfNameTag

public static boolean useIdInsteadOfNameTag

Constructor Detail

ERXWOForm

public ERXWOForm(String name,
                 NSDictionary associations,
                 WOElement element)

Method Detail

toString

public String toString()

Overrides:

toString in class com.webobjects.appserver._private.WOHTMLDynamicElement

_enterFormInContext

protected boolean _enterFormInContext(WOContext context)

_exitFormInContext

protected void _exitFormInContext(WOContext context,
                                  boolean wasInForm,
                                  boolean wasFormSubmitted)

_enctype

protected String _enctype(WOContext context)

_setEnctype

protected void _setEnctype(String enctype)

_clearEnctype

protected void _clearEnctype()

invokeAction

public WOActionResults invokeAction(WORequest worequest,
                                    WOContext context)

Overrides:

invokeAction in class com.webobjects.appserver._private.WODynamicGroup

_appendHiddenFieldsToResponse

protected void _appendHiddenFieldsToResponse(WOResponse response,
                                             WOContext context)

appendChildrenToResponse

public void appendChildrenToResponse(WOResponse response,
                                     WOContext context)

Overrides:

appendChildrenToResponse in class com.webobjects.appserver._private.WODynamicGroup

cgiAction

protected String cgiAction(WOResponse response,
                           WOContext context,
                           boolean secure)

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Overrides:

takeValuesFromRequest in class com.webobjects.appserver._private.WODynamicGroup

_formName

protected String _formName(WOContext context)

_disabled

protected boolean _disabled(WOContext context)

_shouldAppendFormTags

protected boolean _shouldAppendFormTags(WOContext context,
                                        boolean wasInForm)

_setFormName

protected void _setFormName(WOContext context,
                            boolean wasInForm)

_clearFormName

protected void _clearFormName(WOContext context,
                              boolean wasInForm)

appendAttributesToResponse

public void appendAttributesToResponse(WOResponse response,
                                       WOContext context)

Overrides:

appendAttributesToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Overrides:

appendToResponse in class com.webobjects.appserver._private.WOHTMLDynamicElement

formName

public static String formName(WOContext context,
                              String defaultName)

Retrieves the current FORM's name in the supplied context. If none is set (either the FORM is not a ERXWOForm or the context is not ERXMutableUserInfo) the supplied default value is used.

Parameters:

context - current context

defaultName - default name to use

Returns:

form name in context or default value