| Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Code Block | javascript | javascript |
|---|---|---|
fluid.inlineEdits(componentContainer, options);
|
This function will find any elements within the given container that are identified as 'editables' and apply the Inline Edit component to them.
Parameters
componentContainer
The componentContainer parameter is a selector, a single-element jQuery, or a DOM element specifying the root DOM node of the Inline Edit markup.
| Anchor | ||||
|---|---|---|---|---|
|
options
The options parameter is an optional collection of name-value pairs that configure data structure that configures the Inline Edit component(s), as described below in the fluid:Options section.
...
| Anchor | ||||
|---|---|---|---|---|
|
Supported Events
The Inline Edit component fires the following events :
Event | Type | Description | Parameters | Default Listener |
|---|---|---|---|---|
| default | This event is fired any time the model for the component has changed, that is, any time the value of the text associated with the component has changed. | | none |
| "preventable" | This event fires just before the component switches from 'view' mode into 'edit' mode. Because the event is preventable, listeners may prevent the component from actually entering edit mode. |
| none |
| default | This event fires just after the component has finished entering 'edit' mode. |
| none |
| "preventable" | This event fires just before the component switches out of 'edit' mode, i.e. before the newly edited value is stored in the model. Because the event is preventable, listeners may prevent the new value from being stored in the model, i.e. they may cancel the edit. | | none |
| default | This event fires just after the newly edited value is stored in the model. Note that it only fires if the | | none |
Functions
...
fluid.inlineEdit.edit();
Switches the component into edit mode.
...
fluid.inlineEdit.finish();
Switches the component out of edit mode into display mode, updating the displayed text with the current content of the edit field. Calls the finishedEditing() function provided in the options, if it exists. NOTE that finishedEditing() is deprecated as of version 0.7, and will be removed entirely in version 0.9.
...
fluid.inlineEdit.render(source);
Prompts the component to render itself.
...
fluid.inlineEdit.tooltipEnabled();
Returns a boolean indicating whether or not the tooltip is enabled.
...
fluid.inlineEdit.updateModel(newValue, source);
Updates the component's internal representation of the text to a new value. The component will be re-rendered.
...
Options
The following options to the creator functions can be used to customize the behaviour of the Inline Edit component:
...
(for more information about events in the Fluid Framework, see Events for Component Users):
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||||
|---|---|---|---|---|---|---|
|
The options for the creation of multiple Inline Edits are the same as those for the creation of a single Inline Edit, with the addition of a selector for identifying the editable elements. The default selector is defined as follows:
...
selectors: {
editables: ".inlineEditable"
}
...
Skinning
This component can be skinned "out of the box" when you include our the component's CSS skin files. Just be sure to put the following in you your document:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<link rel="stylesheet" type="text/css" href="css/fluid.layout.css" /> <link rel="stylesheet" type="text/css" href="css/fluid.states.components/inlineEdit/css/InlineEdit.css" /> <link rel="stylesheet" type="text/css" href="css/fluid.theme.mist.css" /> <link rel="stylesheet" type="text/css" href="css/fluid.theme.hc.css" /> |
and to attatch a class attribute that represents the skin you want to the components container, such as:
...
<div id="inlineEditContainer" class="fl-theme-mist">
...
</div>
...
The above code would make use of the theme.mist.css skin file.
Dependencies
The Inline Edit dependencies can be met by including the minified Fluid-allInfusionAll.js file in the header of the HTML file:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script type="text/javascript" src="Fluid-allInfusionAll.js"></script> |
Alternatively, the individual file requirements are:
...
| Include Page | ||||||
|---|---|---|---|---|---|---|
|