source: Dev/trunk/src/client/qed-client/widgets/ListWidget.js

define([
    "./_ComplexValueMixin",
    "dijit/_WidgetBase",
    "dijit/registry",
    "dojo/_base/array",
    "dojo/_base/declare",
    "dojo/_base/event",
    "dojo/_base/lang",
    "dojo/dnd/Source",
    "dojo/dnd/common",
    "dojo/dom-construct",
    "dojo/on"
], function(_ComplexValueMixin, _WidgetBase, registry, array, declare, event, lang, Source, dnd, domConstruct, on) {
    return declare([_WidgetBase,_ComplexValueMixin],{
        multiple: true,
        type: "text",
        /* container : dojo/dnd/Container or subclass
         * determine which container to use for the list
         */
        container: Source,
        _restoreParams: null,
        _onChangeActive: false,
        _onChangeHandle: null,
        _fromDrop: true,
        buildRendering: function() {
            this.inherited(arguments);

            var sourceParams = {};
            var paramsToInherit = [
                "singular",
                "creator",
                "skipForm",
                "dropParent",
                "isSource",
                "autoSync",
                "copyOnly",
                "delay",
                "horizontal",
                "selfCopy",
                "selfAccept",
                "withHandles",
                "generateText"
            ];
            array.forEach(paramsToInherit, function(param){
                if ( typeof this[param] !== "undefined" ) {
                    sourceParams[param] = this[param];
                }
            },this);
            lang.mixin(sourceParams, {
                accept: [this.type],
                creator: lang.hitch(this,"creator"),
                dropParent: this.containerNode
            });
            this.source = new this.container(this.domNode,sourceParams);
            this._restoreParams = {
                accept: this.source.accept,
                selfAccept: this.source.selfAccept,
                selfCopy: this.source.selfCopy,
                isSource: this.source.isSource
            };
            this.own(this.source.on('Drop',
                                    lang.hitch(this,'_handleDrop')));
        },
        creator: function(item, hint) {
            var id = dnd.getUniqueId();
            var nodeOrWidget = null;
            if ( hint === "avatar" ) {
                if ( this.createAvatar ) {
                    nodeOrWidget = this.createAvatar(id,item);
                } else {
                    return this.source.defaultCreator(item, hint);
                }
            } else {
                if ( this.createListElement ) {
                    nodeOrWidget =
                        this.createListElement(id,item,this._fromDrop);
                } else {
                    return this.source.defaultCreator(item, hint);
                }
            }
            if ( nodeOrWidget.on ) {
                this.connectChildsChanges(nodeOrWidget);
            }
            var node = nodeOrWidget.domNode ?
                       nodeOrWidget.domNode :
                       nodeOrWidget;
            if ( hint !== "avatar" && node.id !== id ) {
                console.warn("Node id '%s' not equal to generated id '%s'. Is this intended?", node.id, id);
            }
            return {
                data: item,
                type: [this.type],
                node: node
            };
        },
        createAvatar: null, /*function(id,item){},*/
        createListElement: null, /* function(id,item,fromDrop){},*/
        _getValueAttr: function() {
            return array.map(
                this.source.getAllNodes(),
                lang.hitch(this,function(node){
                    var widget = registry.byNode(node);
                    if ( widget && 'value' in widget ) {
                        return widget.get('value');
                    } else {
                        return this.source.getItem(node.id).data;
                    }
                }));
        },
        _setValueAttr: function(value,priorityChange) {
            this.clear();
            this._setValueInternal(value || [], priorityChange);
            this.appendItems(this.value);
        },
        _setReadOnlyAttr: function() {
            this.inherited(arguments);
            this._updateSource();
        },
        _setDisabledAttr: function() {
            this.inherited(arguments);
            this._updateSource();
        },
        _updateSource: function() {
            if ( this.disabled || this.readOnly ) {
                this.source.accept = [];
                this.source.selfAccept = false;
                this.source.selfCopy = false;
                this.source.isSource = false;
            } else {
                lang.mixin(this.source,this._restoreParams);
            }
        },
        getChildren: function() {
            return array.filter(
                array.map(this.source.getAllNodes(), function(node){
                    return registry.byNode(node);
                }),
                function(widget){ return widget !== null; });
        },
        _getDescendantFormWidgets: function() {
            return array.filter(
                this.getChildren(),
                function(child){ return 'value' in child; });
        },

        appendItems: function(items,forceEvent) {
            this._fromDrop = false;
            this.source.insertNodes(false,items);
            this._setValueInternal(
                this.get('value'),
                forceEvent === true ? true : null);
            this._fromDrop = true;
        },
        appendItem: function(item,forceEvent) {
            this._fromDrop = false;
            this.source.insertNodes(false,[item]);
            this._setValueInternal(
                this.get('value'),
                forceEvent === true ? true : null);
            this._fromDrop = true;
        },
        removeItem: function(key,forceEvent) {
            array.forEach(
                array.filter(this.source.getAllNodes(), function(node){
                    return node.id === key;
                }),
                lang.hitch(this, "_destroyNodeOrWidget"));
            this.source.delItem(key);
            this._setValueInternal(
                this.get('value'),
                forceEvent === true ? true : null);
        },
        clear: function(forceEvent) {
            array.forEach(this.source.getAllNodes(),
                          lang.hitch(this, "_destroyNodeOrWidget"));
            this.source.clearItems();
            this._setValueInternal(
                this.get('value'),
                forceEvent === true ? true : null);
        },
        _destroyNodeOrWidget: function(node) {
            var widget = registry.byNode(node);
            if ( widget ) {
                widget.destroyRecursive();
            } else {
                domConstruct.destroy(node);
            }
        },
        destroy: function() {
            this.source.destroy();
            this.inherited(arguments);
        },
        _handleDrop: function() {
            this._setValueInternal(this.get('value'));
        }
    });
});