Versions Compared

Old Version 29

changes.mady.by.user Justin Justin

Saved on

compared with

New Version Current

changes.mady.by.user Anastasia Cheetham

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Section
This documentation refers to the latest trunk version of the Inline Edit code. For documentation specific to the v0.5 released version, please see

Inline Edit

API - v0.5.Inline Edit

Overview

The Inline Edit allows users to edit content within the context of their work rather than going to an "edit mode". It can be applied to any text, assuming a very simple contract is maintained:

  1. The elements that are part of the Inline Edit component have some kind of container element.
  2. The text you wish to make editable is within the component container.

You can optionally provide your own markup that will be used for the edit mode, but if not, default markup is provided.

Creation

Creating a single Inline Edit

Column
width60%
Info
Code Block
javascript
javascript
fluid.inlineEdit(componentContainer, options);

Return: The Inline Edit component object.

Creating Multiple Inline Edits

Code Block
javascript
javascript

fluid.inlineEdits(componentContainer, options);

Return: An array of the Inline Edit component objects.

This function will find any elements within the given container that are identified as 'editables' and apply the Inline Edit component to them.

Column
Panel
borderColor#321137
bgColor#fff
titleBGColor#aab597
borderStylesolid
titleStatus

This component is in Production status

solid
Panel
borderStyle
borderColor#566b30
bgColor#fff
titleBGColor#D3E3C4
borderStylesolid
titleOn This Page
Table of Contents
toc
maxLevel
5
minLevel2maxLevel5
Panel
borderColor#321137
bgColor#fff
titleBGColor#c1b7c3
borderStylesolid
titleSee Also
borderStylesolid
Panel
borderColor#321137
bgColor#fff
titleBGColor#cccccc
borderStylesolid
titleStill need help?
borderStylesolid

Join the fluidinfusion-talk users mailing list and ask your questions there.

Parameters

componentContainer

The componentContainer parameter is a selector, a single-element jQuery, or a DOM element representing the component's containerspecifying the root DOM node of the Inline Edit markup.

Anchor
option_description
option_description

options

The options parameter is an optional collection of name-value pairs that configure data structure that configures 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 above), with the addition of a selector for identifying the editable elements. The default selector is defined as follows:

...

(s), as described below in the fluid:Options section.

...

Anchor
events
events

Supported Events

The Inline Edit component fires the following events (for more information about events in the Fluid Framework, see Events for Component Users):

Include Page
Inline Edit Events
Inline Edit Events
Include Page
Inline Edit Functions
Inline Edit Functions
Include Page
Inline Edit Configuration Options
Inline Edit Configuration Options
nopaneltrue

...

Skinning

This component can be skinned "out of the box" when you include the component's CSS files. Just be sure to put the following in your document:

Code Block
html
html

<link rel="stylesheet" type="text/css" href="components/inlineEdit/css/InlineEdit.css" />

...

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
html
html
<script type="text/javascript" src="Fluid-allInfusionAll.js"></script>

Alternatively, the individual file requirements are:

...

Include Page
Inline Edit Dependencies
Inline Edit Dependencies
nopaneltrue