er.ajax

Class AjaxTextHinter

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

er.ajax.AjaxTextHinter

All Implemented Interfaces:

IAjaxElement

public class AjaxTextHinter
extends AjaxDynamicElement

Hints input and textarea fields with ghosted text that serves as an explanation for the user what to enter. The style "ajax-hinted-text-with-default" defines the color for this.

The default value for the field comes from setting default = "something"; on the input element. For instance, to set the default value on a text field, you would do <wo:WOTextField value = "$value" default = "Fill this in"/>.

If you place this tag around your forms or input elements, all input elements and forms are automatically re-registered after an Ajax-Refresh when placed within an AjaxUpdateContainer.

Example 1: Given form and all input elements are registered on load (old behaviour of AjaxTextHinter)

 <wo:Form id="myform" ...>
   <wo:WOTextField default="Login name"/>
 </wo:Form>
 <wo:AjaxTextHinter form="myform"/>
 

Example 2: Form is within AjaxUpdateContainer and has to be re-registered after Ajax refresh. So you can nest multiple AjaxTextHinter tags, if necessary

 <wo:AjaxUpdateContainer>
   <wo:AjaxTextHinter>
     <wo:Form id="myform" ...>
       <wo:WOTextField default="Login name"/>
     </wo:Form>
   </wo:AjaxTextHinter/>
 </wo:AjaxUpdateContainer>
 

Example 3: only some input elements are within AjaxUpdateContainer

 <wo:AjaxTextHinter>
   <wo:Form id="myform" ...>
     <wo:AjaxUpdateContainer>
       <wo:AjaxTextHinter>
         <wo:WOTextField default="Login name"/>
      </wo:AjaxTextHinter/>
     </wo:AjaxUpdateContainer>
   </wo:Form>
 </wo:AjaxTextHinter/>
 

Author:

ak

Bindings

Name	Description
form	ID of the form to apply the hints to

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields inherited from class er.extensions.components.ERXDynamicElement

log

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

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
AjaxTextHinter(String name, NSDictionary associations, com.webobjects.appserver.WOElement children)

Method Summary

Modifier and Type	Method and Description
protected String	_containerID(com.webobjects.appserver.WOContext context) Override this method and return an update container ID this element should react on.
protected void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override this method to append the needed scripts for this component.
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Overridden to call AjaxDynamicElement.addRequiredWebResources(WOResponse, WOContext).
com.webobjects.appserver.WOActionResults	handleRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Override this method to return the response for an Ajax request.

Methods inherited from class er.ajax.AjaxDynamicElement

addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, invokeAction, shouldHandleRequest

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, id, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

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

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.ajax.IAjaxElement

valueForBinding, valueForBinding

Constructor Detail

AjaxTextHinter

public AjaxTextHinter(String name,
                      NSDictionary associations,
                      com.webobjects.appserver.WOElement children)

Method Detail

handleRequest

public com.webobjects.appserver.WOActionResults handleRequest(com.webobjects.appserver.WORequest request,
                                                              com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method to return the response for an Ajax request.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

addRequiredWebResources

protected void addRequiredWebResources(com.webobjects.appserver.WOResponse response,
                                       com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method to append the needed scripts for this component.

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Overridden to call AjaxDynamicElement.addRequiredWebResources(WOResponse, WOContext).

Overrides:

appendToResponse in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

_containerID

protected String _containerID(com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method and return an update container ID this element should react on.

Overrides:

_containerID in class AjaxDynamicElement

Parameters:

context - context of the transaction

Returns:

null