er.ajax

Class AjaxInPlace

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxInPlace

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

Direct Known Subclasses:

MTAjaxInPlace

public class AjaxInPlace
extends WOComponent

AjaxInPlace is a generalization of the AjaxInPlaceEditor. To use this component, you must wrap an ERXWOTemplate named "view" and an ERXWOTemplate named "edit".
For instance:

HTML:

   <webobject name = "ExampleInPlace">
      <webobject name = "View">View: <webobject name = "Value"/></webobject>
      <webobject name = "Edit">Edit: <webobject name = "ValueField"/></webobject>
   </webobject>
 

WOD:

   ExampleInPlace : AjaxInPlace {
   }
   
   View : ERXWOTemplate {
      templateName = "view";
   }
   
   Value : WOString {
      value = value;
   }
   
   Edit : ERXWOTemplate {
      templateName = "edit";
   }
   
   ValueField : WOTextField {
      value = value;
   }
 

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
class	the class used on the top container
id	the id used on various parts of this component
saveLabel	the label to show on the save button
saveAction	the action to invoke on save
saveUpdateContainerID	by default save updates the container specified in "id", but you can override that with this binding
saveClass	the class of the save button
canSave	if true, the results are saved; if false, the user is not allowed to leave edit mode
onSaveClick	the action to fire when save is clicked
onSaveSuccess	the javascript function to execute after a successful save
onSaveFailure	the javascript function to execute after a failed save
onSaving	the javascript action to fire when saving
button	if true, the save action is a button; if false, it's a link
submitOnSave	if true, the save button is an AjaxSubmitButton; if false, it's an AjaxUpdateLink (which will not actually submit a form -- you would have to do some work here) // PROTOTYPE FUNCTIONS
saveInsertion	the insertion function to use on save
saveInsertionDuration	the duration of the before and after insertion animation (if using insertion)
saveBeforeInsertionDuration	the duration of the before insertion animation (if using insertion)
saveAfterInsertionDuration	the duration of the after insertion animation (if using insertion)
cancelLabel	the label to show on the cancel button
cancelAction	the action to invoke on cancel
cancelUpdateContainerID	by default cancel updates the container specified in "id", but you can override that with this binding
cancelClass	the class of the cancel button
onCancelClick	the action to fire when cancel is clicked
onCancelSuccess	the javascript function to execute after a successful cancel
onCancelFailure	the javascript function to execute after a failed cancel
onCancelling	the javascript action to fire when cancelling // PROTOTYPE FUNCTIONS
cancelInsertion	the insertion function to use on cancel
cancelInsertionDuration	the duration of the before and after insertion animation (if using insertion)
cancelBeforeInsertionDuration	the duration of the before insertion animation (if using insertion)
cancelAfterInsertionDuration	the duration of the after insertion animation (if using insertion)
editClass	the class of the div that you click on to trigger edit mode (yes this name sucks)
formClass	the class of the form around the edit view
canEdit	if true, edit mode is entered; if false, view mode remains active
editOnly	if true, edit mode is locked on (and save controls don't show if it's in a parent form); if false, you can switch between edit and view mode
onEditClick	the action to fire when edit mode is triggered
onEditSuccess	the javascript function to execute after a successful edit
onEditFailure	the javascript function to execute after a failed edit
onEditing	the javascript action to fire when editing mode is loading // PROTOTYPE FUNCTIONS
editInsertion	the insertion function to use on edit
editInsertionDuration	the duration of the before and after insertion animation (if using insertion)
editBeforeInsertionDuration	the duration of the before insertion animation (if using insertion)
editAfterInsertionDuration	the duration of the after insertion animation (if using insertion)
onRefreshComplete	the javascript function to execute after refreshing the container
disabled	whether or not edit mode should be disabled
manualControl	if true, it is up to you to provide click-to-edit, save, and cancel controls
manualViewControl	if true, it is up to you to provide click-to-edit controls
manualEditControl	if true, it is up to you to provide save and cancel controls
style	the style of the top level container
elementName	the name of the container element (defaults to "div")
formSerializer	the name of the javascript function to call to serialize the form
onsubmit	pass through onsubmit to form

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
AjaxInPlace(WOContext context)

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(WOResponse aResponse, WOContext aContext)
boolean	button()
WOActionResults	cancel()
String	cancelFunctionCall()
String	cancelFunctionName()
String	cancelUpdateContainerID()
boolean	canEdit()
boolean	canSave()
boolean	changingToEdit()
boolean	changingToView()
String	cleanupFunction()
boolean	disabled()
boolean	disableForm()
String	editFunctionCall()
String	editFunctionName()
boolean	editing()
boolean	editOnly()
String	elementName()
String	formName()
String	id()
WOActionResults	invokeAction(WORequest aRequest, WOContext aContext)
boolean	linkOnSave()
boolean	manualControl()
boolean	manualEditControl()
boolean	manualViewControl()
WOActionResults	save()
String	saveFunctionCall()
String	saveFunctionName()
String	saveLabel()
String	saveUpdateContainerID()
void	setEditing(boolean editing)
WOActionResults	startEditing()
boolean	submitOnSave()
boolean	synchronizesVariablesWithBindings()
void	takeValuesFromRequest(WORequest aRequest, WOContext aContext)
String	updateFunctionName()

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxInPlace

public AjaxInPlace(WOContext context)

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class WOComponent

elementName

public String elementName()

id

public String id()

invokeAction

public WOActionResults invokeAction(WORequest aRequest,
                                    WOContext aContext)

Overrides:

invokeAction in class WOComponent

takeValuesFromRequest

public void takeValuesFromRequest(WORequest aRequest,
                                  WOContext aContext)

Overrides:

takeValuesFromRequest in class WOComponent

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Overrides:

appendToResponse in class WOComponent

saveUpdateContainerID

public String saveUpdateContainerID()

cancelUpdateContainerID

public String cancelUpdateContainerID()

saveLabel

public String saveLabel()

formName

public String formName()

button

public boolean button()

submitOnSave

public boolean submitOnSave()

linkOnSave

public boolean linkOnSave()

disableForm

public boolean disableForm()

updateFunctionName

public String updateFunctionName()

editFunctionName

public String editFunctionName()

editFunctionCall

public String editFunctionCall()

saveFunctionName

public String saveFunctionName()

saveFunctionCall

public String saveFunctionCall()

cancelFunctionName

public String cancelFunctionName()

cancelFunctionCall

public String cancelFunctionCall()

manualControl

public boolean manualControl()

manualEditControl

public boolean manualEditControl()

manualViewControl

public boolean manualViewControl()

disabled

public boolean disabled()

editOnly

public boolean editOnly()

editing

public boolean editing()

canEdit

public boolean canEdit()

canSave

public boolean canSave()

changingToEdit

public boolean changingToEdit()

changingToView

public boolean changingToView()

setEditing

public void setEditing(boolean editing)

cleanupFunction

public String cleanupFunction()

startEditing

public WOActionResults startEditing()

save

public WOActionResults save()

cancel

public WOActionResults cancel()