Image Reorderer API
Image Reorderer Overview
The Image Reorderer is a convenience function for applying the Reorderer to images within a collection.. This page provides technical details of the API. For a simple working example, see Integrating the Reorderer.
Creation
var myImageReorderer = fluid.reorderImages (container[, options]);
Parameters
container
The container
parameter is a CSS-based selector, single-element jQuery object, or DOM element specifying the root node of the Reorderer.
options
The options
parameter is an optional collection of name-value pairs that configure the Image Reorderer, as described in the fluid:Options section below.
This component is in Production status
Join the infusion-users mailing list and ask your questions there.
Supported Events
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 Image Reorderer. Supported selectors are:
Name |
Description |
Default |
Examples |
---|---|---|---|
|
Identifies the DOM elements contained within the Reorderer container that can be moved using the Reorderer. |
|
selectors: { movables: "div.movable" } |
|
Identifies the DOM elements contained within the Reorderer container that can be selected using keyboard. Note that selectable elements do not have to be movable. |
same as |
selectors: { selectables: "div.selectable" } |
|
Identifies the DOM elements contained within the Reorderer container that can have movable elements dropped relative to them. Note that not all elements within the container need to be drop targets. |
same as |
selectors: { dropTargets: "div.dropTarget" } |
|
If present, identifies a single element within a movable item that the user must click on to drag the movable item. (If not specified, the entire movable item can be clicked on.) |
"" |
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 an item 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" } |
Image Reorderer-specific Selector
The Image Reorderer supports one additional selector:
Name |
Description |
Default |
Examples |
---|---|---|---|
|
Identifies a DOM element that contains a title for the image |
" |
selectors: { imageTitle: ".caption" } |
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 |
|
Image Reorderer Options
Name |
Description |
Values |
Default |
---|---|---|---|
Deprecated as of 1.1.2: |
If an URL is provided with this option, the current state of the component model will be sent to that URL after a move is carried out using a default |
an URL |
none |
Styling the Image Reorderer
The Image Reorderer includes default CSS styles that it applies to the thumbnails. The application of styles is based on known class names. The default class names are described below, and can be used by including the Image Reorderer stylesheet:
<link href="components/reorderer/css/imageReorderer.css" type="text/css" rel="stylesheet" media="all"/>
NOTE that the default class names can be overridden with your own classes using the styles
option: see the fluid:Options section above.
Default classes:
fl-reorderer-movable-default
- This class is applied to thumbnail elements in their default state.
fl-reorderer-movable-selected
- This class is applied to the thumbnail that has been selected. The selected thumbnail item can be moved using keystrokes.
fl-reorderer-movable-hover
- This class is applied to thumbnails when the mouse hovers over them.
fl-reorderer-movable-dragging
- This class is applied to the thumbnail that is currently being moved.
fl-reorderer-avatar
- This class is applied to the avatar, the image of the thumbnail as it is being dragged about by the mouse.
fl-reorderer-dropMarker
- This class is applied to the drop target indicator when the mouse is used to drag a thumbnail.
Dependencies
The Image 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/jquery/jquery.keyboard-a11y.js"></script> <script type="text/javascript" src="framework/core/js//Fluid.js"></script> <script type="text/javascript" src="framework/core/js/FluidDOMUtilities.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="components/reorderer/js/ImageReorderer.js"></script>