Layout Reorderer API
Layout Reorderer Overview
The Layout Reorderer is a convenience function for applying the Reorderer to portlets, content blocks, or other chunks of layout with minimal effort. This page provides technical details of the API. For a simple working example, see Integrating the Reorderer.
Creation
var myReorderableLayout = fluid.reorderLayout(container[, options]);
Parameters
container
The container
is a CSS-based selector, single-element jQuery object, or DOM element that identifies the DOM element containing the layout.
options
The options object is an optional collection of key/value pairs that can be used to further configure the Layout Reorderer, as described below in the fluid:Options section.
This component is in Production status
Join the infusion-users mailing list and ask your questions there.
Supported Events
The Layout Reorderer fires the following events (for more information about events, see Events for Component Users):
Event |
Type |
Description |
Parameters |
Parameter Description |
---|---|---|---|---|
|
default |
This event fires before a drop warning is displayed. |
|
|
|
default |
This event fires when an item is selected by the user. |
|
|
|
"preventable" |
This event fires just before a request to move is processed. Because the event is preventable, listeners may prevent the move from happening. |
|
|
|
default |
This event fires just before an item is actually moved. |
|
requestedPosition = { element, // the drop target position // the position, relative to the drop target, // that a dragged item should be dropped. // One of BEFORE, AFTER, INSIDE, or REPLACE } |
|
default |
This event fires after an item has successfully been moved. For more information, see Talking to the Server Using The afterMove Event |
|
requestedPosition = { element, // the drop target position // the position, relative to the drop target, // that a dragged item should be dropped. // One of BEFORE, AFTER, INSIDE, or REPLACE }
|
|
default |
This event fires when the cursor moves over top of an item, and when the cursor moves away from an item. The default listener either adds or removes the hover class ( |
|
|
|
default |
This event fires any time the order of the items changes, or when the |
none |
 |
Options
Selectors
The selectors
option is an object containing CSS-based selectors for various parts of the Layout Reorderer. Supported selectors are:
Name |
Description |
Default |
Examples |
---|---|---|---|
|
Identifies the DOM elements contained within the Layout Reorderer container that are themselves column containers, that is a container element that corresponds to a single column in the layout. |
|
selectors: { columns: "#column1,#column2,#column3" } |
|
Identifies the DOM elements contained within the Layout Reorderer container that are considered to be modules within the columns. Note that modules are assumed to be movable, unless they are identified by the |
|
selectors: { modules: "div" } |
|
Identifies the modules that should not be movable. |
none |
selectors: { lockedModules: ".locked" } |
|
If present, identifies a single element within a module that the user must click on to drag the module. |
"" |
selectors: { grabHandle: ".title-bar" } |
|
Identifies a single element within the DOM that can be shown to display a warning when the user tries to move module where it can't be moved. It is assumed that this element contains whatever drop warning text and mark-up the implementor desires. |
|
selectors: { dropWarning: "#drop-warning" } |
General options
Name |
Description |
Values |
Default |
---|---|---|---|
|
an object describing how user options should be merged in with defaults |
 |
mergePolicy: { keysets: "replace", "selectors.selectables": "selectors.movables", "selectors.dropTargets": "selectors.movables" } |
|
JavaScript object containing listeners to be attached to the supported events. |
Keys in the object are event names, values are functions or arrays of functions. |
|
|
an object containing CSS class names for styling the Reorderer. |
The object may contain any of the keys defined in the default class names (shown to the right). Any class names not provided will revert to the default. |
styles: { defaultStyle: "fl-reorderer-movable-default", selected: "fl-reorderer-movable-selected", dragging: "fl-reorderer-movable-dragging", mouseDrag: "fl-reorderer-movable-dragging", hover: "fl-reorderer-movable-hover", dropMarker: "fl-reorderer-dropMarker", avatar: "fl-reorderer-avatar" } |
|
an object containing sets of keycodes to use for directional navigation, and for the modifier key used for moving a movable item. |
The object must be a list of objects containing the following keys: |
fluid.reorderer.defaultKeysets = [{ modifier : function (evt) { return evt.ctrlKey; }, up : fluid.reorderer.keys.UP, down : fluid.reorderer.keys.DOWN, right : fluid.reorderer.keys.RIGHT, left : fluid.reorderer.keys.LEFT }, { modifier : function (evt) { return evt.ctrlKey; }, up : fluid.reorderer.keys.i, down : fluid.reorderer.keys.m, right : fluid.reorderer.keys.k, left : fluid.reorderer.keys.j }]; |
|
a function that returns a valid DOM node to be used as the dragging avatar |
 |
The item being dragged will be cloned |
|
Deprecated as of 1.1.2: If an |
The server URL to POST the new item order to |
 |
New in v1.3 |
This option is used to disable wrapping of elements within the container. //example of grid reorderer var reorderer = fluid.reorderGrid('.myGrid', { selectors: { movables: 'p' }, disableWrap: true }); //example of image reorderer var reorderer = fluid.reorderImages(".flc-imageReorderer", { selectors: { movables: ".flc-imageReorderer-item" }, disableWrap: true }); //example of layout reorderer var reorderer = fluid.reorderLayout ("#fluid-LayoutReorderer-sample2", { selectors: { columns: ".myColumn", modules: "> div > div", lockedModules: ".locked", dropWarning: ".flc-reorderer-dropWarning" }, disableWrap: true }); //example of list reorderer var reorderer = fluid.reorderList(".todo-list", { selectors: { movables: ".movable" }, styles: { defaultStyle: "demo-reorderer-movable-default", selected: "demo-reorderer-movable-selected", dragging: "demo-reorderer-movable-dragging", mouseDrag: "demo-reorderer-movable-mousedrag", hover: "demo-reorderer-movable-hover", dropMarker: "demo-reorderer-dropMarker", avatar: "demo-reorderer-avatar" }, disableWrap: true }); |
boolean |
|
Layout-specific options
Name |
Description |
Values |
Default |
---|---|---|---|
|
indicates the role, or general use, for this instance of the Reorderer |
|
|
Dependencies
The Layout Reorderer dependencies can be met by including the minified InfusionAll.js
file in the header of the HTML file:
<script type="text/javascript" src="InfusionAll.js"></script>
Alternatively, the individual file requirements are:
<script type="text/javascript" src="lib/jquery/core/js/jquery.js"></script> <script type="text/javascript" src="lib/jquery/ui/js/jquery.ui.core.js"></script> <script type="text/javascript" src="lib/jquery/ui/js/jquery.ui.widget.js"></script> <script type="text/javascript" src="lib/jquery/ui/js/jquery.ui.mouse.js"></script> <script type="text/javascript" src="lib/jquery/ui/js/jquery.ui.draggable.js"></script> <script type="text/javascript" src="framework/core/js/FluidDocument.js"></script> <!-- New in v1.3 --> <script type="text/javascript" src="framework/core/js/jquery/jquery.keyboard-a11y.js"></script> <script type="text/javascript" src="lib/json/js/json2.js"></script> <script type="text/javascript" src="framework/core/js//Fluid.js"></script> <script type="text/javascript" src="framework/core/js/FluidView.js"></script> <!-- New in v1.3 --> <script type="text/javascript" src="framework/core/js/FluidDOMUtilities.js"></script> <script type="text/javascript" src="framework/core/js/DataBinding.js"></script> <!-- New in v1.3 --> <script type="text/javascript" src="framework/core/js/FluidIoC.js"></script> <!-- New in v1.3 --> <script type="text/javascript" src="framework/core/js/ReordererDOMUtilities.js"></script> <script type="text/javascript" src="components/reorderer/js/GeometricManager.js"></script> <script type="text/javascript" src="components/reorderer/js/Reorderer.js"></script> <script type="text/javascript" src="framework/core/js/LayoutReorderer.js"></script> <script type="text/javascript" src="framework/core/js/ModuleLayout.js"></script>