inputEx Documentation Back to homepage

### inputEx Documentation > inputEx.InPlaceEdit 0.2.2

## Static Class inputEx.InPlaceEdit - extends inputEx.Field

Meta field providing in place editing (the editor appears when you click on the formatted value).

### Constructor

inputEx.InPlaceEdit `( options )`

Parameters:
  `options <Object>` - Added options:
  - visu
  - editorField
  - animColors

### Properties

#### static groupOptions `- Object`

group Options for each field

#### options `- Object`

Configuration object to set the options for this class and the parent classes. See constructor details for options added by this class.

### Methods

#### close

`close()`
Close the editor when calling the close function on this field

#### getValue

`<Any> getValue()`
Returned the previously stored value
Returns:

`<Any>` The value of the subfield

#### initEvents

`initEvents()`
Adds the events for the editor and color animations

#### onCancelEditor

`onCancelEditor(e)`
Close the editor on cancel (cancel button, blur event or escape key)
Parameters:

`e <Event>` - The original event (click, blur or keydown)

#### onKeyDown

`onKeyDown(e)`
Handle the tabulation key to close the editor
Parameters:

`e <Event>` - The original keydown event

#### onKeyUp

`onKeyUp(e)`
Handle some keys events to close the editor
Parameters:

`e <Event>` - The original keyup event

#### onOkEditor

`onOkEditor()`
Validate the editor (ok button, enter key or tabulation key)

#### onVisuMouseOut

`onVisuMouseOut(e)`
Start the color animation when hovering the field
Parameters:

`e <Event>` - The original mouseout event

#### onVisuMouseOver

`onVisuMouseOver(e)`
Set the color when hovering the field
Parameters:

`e <Event>` - The original mouseover event

#### openEditor

`openEditor()`
Display the editor

#### renderComponent

`renderComponent()`
Override renderComponent to create 2 divs: the visualization one, and the edit in place form

#### renderEditor

`renderEditor()`
Render the editor

#### renderVisuDiv

`renderVisuDiv()`
Create the div that will contain the visualization of the value

#### setOptions

`setOptions(options)`
Set the default values of the options
Parameters:

`options <Object>` - Options object (inputEx inputParams) as passed to the constructor

#### setValue

`setValue(value[,sendUpdatedEvt])`
Set the value and update the display
Parameters:

`value <Any>` - The value to set

`sendUpdatedEvt <boolean>` optional - (optional) Wether this setValue should fire the updatedEvt or not (default is true, pass false to NOT send the event)

#### Methods inherited from class inputEx.Field:

`focus, getEl, validate, fireUpdatedEvt, show, onBlur, onFocus, getStateString, setClassFromState, disable, onChange, render, updatedEvt, getState, hide, displayMessage, destroy, isEmpty, enable, clear,`

Copyright (c) 2007-2009 Eric Abouaf. All rights reserved.
Generated by JsDoc Toolkit 2.0.0 on Wed, 04 Mar 2009 15:41:31 GMT using neyricjslibs-template.