The in-place “text edit” testing allows for “on-the-fly” textfields. See the documentation on Ajax.InPlaceEditor and Ajax.InPlaceCollectionEditor
Syntax
new Ajax.InPlaceEditor( element, url, {options});
Options
Name | since | default | Description |
---|---|---|---|
okControl |
V?? | “button” | What type of ok button to use in edit mode, or none at all (button, link, false) |
cancelControl |
V?? | “link” | What type of cancel button to use in edit mode, or none at all (button, link, false) |
okText |
V1.5 | “ok” | The text of the submit button that submits the changed value to the server |
cancelText |
V1.5 | “cancel” | The text of the link that cancels editing |
savingText |
V1.5 | “Saving…” | The text shown while the text is sent to the server |
clickToEditText |
V1.6 | “Click to edit” | The text shown during mouseover the editable text |
formId |
V1.5 | id of the element to edit plus ‘InPlaceForm’ | The id given to the element |
externalControl |
V1.5 | null | ID of an element that acts as an external control used to enter edit mode. The external control will be hidden when entering edit mode and shown again when leaving edit mode. |
externalControlOnly |
V1.5 | false | Whether or not to disable onclick editing so that only an external control can activate editable mode |
rows |
V1.5 | 1 | The row height of the input field (anything greater than 1 uses a multiline textarea for input) |
onComplete |
V1.6 | “function(transport, element) {new Effect.Highlight(element, {startcolor: this.options.highlightcolor});}” | Code run if update successful with server |
onFailure |
V1.6 | “function(transport) {alert(“Error communicating with the server: ” + transport.responseText.stripTags());}” | Code run if update failed with server |
cols |
V1.5 | none | The number of columns the text area should span (works for both single line or multi line) |
size |
V1.5 | none | Synonym for ‘cols’ when using single-line (rows=1) input |
highlightcolor |
? | Ajax.InPlaceEditor.defaultHighlightColor | The highlight color |
highlightendcolor |
? | ”#FFFFFF” | The color which the highlight fades to |
savingClassName |
V1.5 | “inplaceeditor-saving” | CSS class added to the element while displaying “Saving…” (removed when server responds) |
formClassName |
V1.5 | “inplaceeditor-form” | CSS class used for the in place edit form |
hoverClassName |
? | ? | ? |
loadTextURL |
V1.5 | null | Will cause the text to be loaded from the server (useful if your text is actually textile and formatted on the server) |
loadingText |
V1.5 | “Loading…” | If the loadText URL option is specified then this text is displayed while the text is being loaded from the server |
callback |
V1.5 | function(form) {Form.serialize(form)} | A function that will get executed just before the request is sent to the server, should return the parameters to be sent in the URL. Will get two parameters, the entire form and the value of the text control. |
submitOnBlur |
V1.6 | “false” | This option if true will submit the in_place_edit form when the input tag loses focus. |
ajaxOptions |
V1.5 | {} | Options specified to all AJAX calls (loading and saving text), these options are passed through to the prototype AJAX classes. |
The server side component gets the new value as the parameter ‘value’ (POST method), and should send the new value as the body of the response.
for more information please check this url: http://wiki.github.com/madrobby/scriptaculous/ajax-inplaceeditor