/
Inline Edit API - v0.5

Documentation for a historical release of Infusion: 1.3
Please view the Infusion Documentation site for the latest documentation.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Inline Edit API - v0.5

Dec 17, 2008

Parameters

componentContainer

The componentContainer parameter is a selector, a single-element jQuery, or a DOM element representing the component's container.

options

The options parameter is an optional collection of name-value pairs that configure the Inline Edit component:

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.

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.

Creating Multiple Inline Edits

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.

options

The options parameter is an optional collection of name-value pairs that configure the Inline Edit components. The available options are the same as those for the creation of a single Inline edit (described fluid:above), with the addition of a selector for identifying the editable elements. The default selector is defined as follows:

selectors: { editables: ".inlineEditable" }

Dependencies

The Inline Edit dependencies can be met by including the minified Fluid-all.js file in the header of the HTML file:

<script type="text/javascript" src="Fluid-all.js"></script>

Alternatively, the individual file requirements are:

<script type="text/javascript" src="jquery/jquery-1.2.6.js"></script> <script type="text/javascript" src="jquery/jARIA.js"></script> <script type="text/javascript" src="jquery/jquery.keyboard-a11y.js"></script> <script type="text/javascript" src="jquery/jquery.tooltip.js"></script> <script type="text/javascript" src="fluid/Fluid.js"></script> <script type="text/javascript" src="fluid/InlineEdit.js"></script>