// --
// Core.UI.js - provides all UI functions
// Copyright (C) 2001-2011 OTRS AG, http://otrs.org/
// --
// $Id: Core.UI.DnD.js,v 1.3 2011-02-17 21:30:59 en Exp $
// --
// This software comes with ABSOLUTELY NO WARRANTY. For details, see
// the enclosed file COPYING for license information (AGPL). If you
// did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
// --

"use strict";

var Core = Core || {};
Core.UI = Core.UI || {};

/**
 * @namespace
 * @exports TargetNS as Core.UI.DnD
 * @description
 *      Drag and Drop
 * @requires
 *      jquery-ui-sortable
 */
Core.UI.DnD = (function (TargetNS) {

    if (!Core.Debug.CheckDependency('Core.UI.DnD', '$([]).sortable', 'jQuery UI sortable')) {
        return;
    }

    /**
     * @function
     * @description
     *      This function initializes the sortable nature on the specified Elements.
     *      Child elements with the class "CanDrag" can then be sorted with Drag and Drop.
     * @param {jQueryObject} $Elements
     *      The elements which should be made sortable
     * @param {Object} Options
     *      Hash which can contain the following entries:
     * @param {Selector String} [Options.Handle]
     *      To restrict the dragging start to a sub-element (e.g. a h2)
     * @param {String} [Options.Containment]
     *      Constrains dragging to within the bounds of the specified element -
     *      can be a DOM element, 'parent', 'document', 'window', or a jQuery selector.
     * @param {String} [Options.Axis]
     *      If defined, the items can be dragged only horizontally or vertically.
     *      Possible values:'x', 'y'.
     * @param {Selector String} [Options.Items]
     *      To restrict the draggable child elements with a selector
     * @param {Selector String} [Options.Placeholder]
     *      Class to give to the placeholder div which indicates the drop area
     * @param {String} [Options.Tolerance]
     *      This is the way the reordering behaves during drag.
     *      Possible values: 'intersect', 'pointer'. In some setups, 'pointer' is more natural.
     *      intersect: draggable overlaps the droppable at least 50% (this is the default value).
     *      pointer: mouse pointer overlaps the droppable.
     * @param {Number} [Options.Opacity]
     *      Defines the opacity of the helper while sorting. From 0.01 to 1.
     * @param {Number} [Options.Opacity]
     *      Only start visible dragging after a certain minimum pixel distance.
     *
     * @return nothing
     *
     * @example
        Core.UI.DnD.Sortable(
        $(".SidebarColumn"),
        {
            Handle: '.Header h2',
            Containment: '.SidebarColumn',
            Axis: 'y',
            Items: '.CanDrag',
            Placeholder: 'DropPlaceholder',
            Tolerance: 'pointer',
            Distance: 15,
            Opacity: 0.9
        }
    );
     */
    TargetNS.Sortable = function ($Elements, Options) {
        $Elements.sortable({
            handle: Options.Handle,
            items: Options.Items,
            axis: Options.Axis,
            placeholder: Options.Placeholder,
            containment: Options.Containment,
            forcePlaceholderSize: true,
            distance: Options.Distance,
            opacity: Options.Opacity,
            tolerance: Options.Tolerance,
            update: Options.Update
        });
    };

    return TargetNS;
}(Core.UI.DnD || {}));
