Added by Anastasia Cheetham, last edited by Anastasia Cheetham on Oct 07, 2009  (view change)

Labels:

manual manual Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Grid Reorderer Overview

The Grid Reorderer is a convenience function for applying the Reorder to a grid of items with minimal effort. This page provides technical details of the API. For a simple working example, see Integrating the Reorderer.

Creation

var myReorderableGrid = fluid.reorderGrid(container[, options]);

Parameters

container

The container is a CSS-based selector, single-element jQuery object, or DOM element that identifies the DOM element that contains the elements to be reorderable. This may be a <div> that encapsulates the reorderable elements, for example.

options

The options object is an optional collection of key/value pairs that can be used to further configure the Grid Reorderer, as described below in the Options section.
Status

This component is in Production status

On This Page
See Also
Still need help?

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

Supported Events

The Grid Reorderer fires the following events (for more information about events, see Events for Component Users):

Event Type Description Parameters Parameter Description
onShowKeyboardDropWarning default This event fires before a drop warning is displayed. item, kbDropWarning item: The item being moved.
kbDropWarning: The DOM element that contains the drop warning, and that will be displayd.
onSelect default This event fires when an item is selected by the user. item item: The item being moved.
onBeginMove "preventable" This event fires just before a request to move is processed. Because the event is preventable, listeners may prevent the move from happening. item item: The item being moved.
onMove default This event fires just before an item is actually moved. item, requestedPosition item: The item being moved.
requestedPosition: An object describing the position that the user is trying to move the item into: 
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
}
afterMove default This event fires after an item has successfully been moved. For more information, see Talking to the Server Using The afterMove Event

Deprecated as of 1.1.2: If an afterMoveCallbackUrl is provided, a default listener for this event will post a string version of the model to the URL.		 item, requestedPosition, movables item: The item being moved.
requestedPosition: An object describing the position that the user is trying to move the item into: 
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
}

movables: A list of all of the movable elements.
onHover 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 (styles.hover) to/from the item. item, state item: The item being moved.
state: A boolean indicating whether the cursor is moving to (true) or away from (false) the item.
onRefresh default This event fires any time the order of the items changes, or when the refresh() function is called. none  

Options

Selectors

The selectors option is an object containing CSS-based selectors for various parts of the Grid Reorderer. Supported selectors are:

Name Description Default Examples
movables Identifies the DOM elements contained within the Reorderer container that can be moved using the Reorderer. ".flc-reorderer-movable" 
selectors: {
    movables: "div.movable"
}
selectables 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 movables 
selectors: {
    selectables: "div.selectable"
}
dropTargets 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 movables 
selectors: {
    dropTargets: "div.dropTarget"
}
grabHandle 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.) ""
(empty string) 
selectors: {
    grabHandle: ".title-bar"
}
dropWarning 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. ".flc-reorderer-dropWarning" 
selectors: {
    dropWarning: "#drop-warning"
}

General Options

Name Description Values Default
mergePolicy an object describing how user options should be merged in with defaults
For information on options merging, see Options Merging for Fluid Components 		  
mergePolicy: {
    keysets: "replace",
    "selectors.selectables": 
               "selectors.movables",
    "selectors.dropTargets": 
               "selectors.movables"
}
listeners 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. See Supported Events
styles 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"
}
keysets 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:
  modifier : a function that returns true or false, indicating whether or not the required modifier(s) are activated
  up
  down
  right
  left 
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
}];
avatarCreator a function that returns a valid DOM node to be used as the dragging avatar   The item being dragged will be cloned

Grid-specific Options

Name Description Values Default
containerRole indicates the role, or general use, for this instance of the Reorderer fluid.roles.LIST
fluid.roles.GRID
fluid.roles.REGIONS 		fluid.roles.GRID

Dependencies

The Grid 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/ui.core.js"></script>
<script type="text/javascript" src="lib/jquery/ui/js/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>