These functions are defined on the central
that object returned from the inlineEdit construction function - for example with
Switches the component into edit mode. The events
afterBeginEdit will fire.
Switches the component out of edit mode into display mode, updating the displayed text with the current content of the edit field. The events
afterFinishEdit will fire. If the model value has changed, there will be a call to
modelUpdated in between these calls.
Cancels the in-progress edit and switches back to view mode.
Determines if the component is currently in edit mode: Returns true if edit mode is shown, false if view mode is shown.
Updates the state of the inline editor in the DOM, based on changes that may have happened to the model.
Returns a boolean indicating whether or not the tooltip is enabled.
Updates the component's internal representation of the text to a new value. If the value differs from the existing value, the
modelChanged event will fire and the component will be re-rendered.
updateModelValue, only accepts specification of the overall model object (housing the editable value under the key
Not a function, but a data structure. This directly represents the "model" or state of the editable component. External users should consider this structure as read-only, and only make modifications through the
updateModel call above.
The following options to the creator functions can be used to customize the behaviour of the Inline Edit component: