oxjs/source/Ox.UI/js/List/Ox.IconList.js

// vim: et:ts=4:sw=4:sts=4:ft=js
/*@
Ox.IconList <f:Ox.Element> IconList Object
    () ->              <f> IconList Object
    (options) ->       <f> IconList Object
    (options, self) -> <f> IconList Object
    options <o> Options object
        borderRadius <n|0> border radius for icon images
        centerSelection <b|false> scroll list so selection is always centered
        defaultRatio <n|1> aspect ratio of icon placeholders
        draggable <b|false> If true, items can be dragged
        fixedRatio <b|n|false> if set to a number, icons have a fixed ratio
        id <s|''> element id
        item <f|null> called with data, sort, size,
                      extends data with information needed for constructor
        itemConstructor <f|Ox.IconItem> contructor used to create item
        items <f|null> items array or callback function
        keys <a|[]> available item keys
        max <n|-1> maximum selected selected items
        min <n|0> minimum of selcted items
        orientation <s|both> list orientation
        selected <a|[]> array of selected items
        size <n|128> list size
        sort <a|[]> sort keys
    self    <o> shared private variable
@*/

Ox.IconList = function(options, self) {

    self = self || {};
    var that = Ox.Element({}, self)
            .defaults({
                borderRadius: 0,
                centerSelection: false,
                defaultRatio: 1,
                draggable: false,
                fixedRatio: false,
                id: '',
                item: null,
                itemConstructor: Ox.IconItem,
                items: null,
                keys: [],
                max: -1,
                min: 0,
                orientation: 'both',
                selected: [],
                size: 128,
                sort: [],
                unique: ''
            })
            .options(options || {});

    if (self.options.fixedRatio) {
        self.options.defaultRatio = self.options.fixedRatio;
    }

    self.iconHeight = Math.round(self.options.size / (self.options.fixedRatio || 1));
    self.iconWidth = self.options.size;
    self.itemHeight = self.iconHeight + self.options.size * 0.5;
    self.itemWidth = self.options.size;

    that.$element = Ox.List({
            centered: self.options.centered,
            // fixme: change all occurences of construct to render
            construct: constructItem,
            draggable: self.options.draggable,
            id: self.options.id,
            itemHeight: self.itemHeight,
            items: self.options.items,
            itemWidth: self.itemWidth,
            keys: self.options.keys,
            max: self.options.max,
            min: self.options.min,
            orientation: self.options.orientation,
            selected: self.options.selected,
            sort: self.options.sort,
            type: 'icon',
            unique: self.options.unique
        }, $.extend({}, self)) // pass event handler
        .addClass('OxIconList Ox' + Ox.toTitleCase(self.options.orientation))
        .bindEvent({
            select: function() {
                self.options.selected = that.$element.options('selected');
            }
        });

    updateKeys();

    function constructItem(data) {
        var isEmpty = Ox.isEmpty(data);
        data = !isEmpty
            ? self.options.item(data, self.options.sort, self.options.size)
            : {
                width: Math.round(self.options.size * (
                    self.options.defaultRatio >= 1 ? 1 : self.options.defaultRatio
                )),
                height: Math.round(self.options.size / (
                    self.options.defaultRatio <= 1 ? 1 : self.options.defaultRatio
                ))
            };
        return self.options.itemConstructor(Ox.extend(data, {
            borderRadius: self.options.borderRadius,
            iconHeight: self.iconHeight,
            iconWidth: self.iconWidth,
            imageHeight: data.height,
            imageWidth: data.width,
            itemHeight: self.itemHeight,
            itemWidth: self.itemWidth,
            //height: Math.round(self.options.size / (ratio <= 1 ? 1 : ratio)),
            //size: self.options.size,
            //width: Math.round(self.options.size * (ratio >= 1 ? 1 : ratio))
        }));
    }

    function updateKeys() {
        self.options.keys = Ox.unique($.merge(self.options.keys, [self.options.sort[0].key]));
        that.$element.options({
            keys: self.options.keys
        });
    }

    /*@
    setOption <f> set key/value
        (key, value) -> <u> set key in options to value
    @*/
    self.setOption = function(key, value) {
        if (key == 'items') {
            that.$element.options(key, value);
        } else if (key == 'selected') {
            that.$element.options(key, value);
        } else if (key == 'sort') {
            that.$element.options(key, value);
        }
    };

    /*@
    closePreview <f> close preview
        () -> <o> the list
    @*/
    that.closePreview = function() {
        that.$element.closePreview();
        return that;
    };

    /*@
    paste <f> paste into list
        () -> <o> the list
    @*/
    that.paste = function(data) {
        that.$element.paste(data);
        return that;
    };

    /*@
    reloadList <f> reload list
        () -> <o> the list
    @*/
    that.reloadList = function() {
        that.$element.reloadList();
        return that;
    };

    /*@
    scrollToSelection <f> scroll list to selection
        () -> <o> the list
    @*/
    that.scrollToSelection = function() {
        that.$element.scrollToSelection();
        return that;
    };

    /*@
    size <f> get size of list
        () -> <n> size
    @*/
    that.size = function() {
        that.$element.size();
    };

    /*@
    sortList <f> sort list
        (key, operator) -> <o> the list
        key <s> sort key
        operator <s> sort operator ("+" or "-")
    @*/
    that.sortList = function(key, operator) {
        self.options.sort = [{
            key: key,
            operator: operator
        }];
        updateKeys();
        that.$element.sortList(key, operator);
        return that;
    };

    /*@
    value <f> get/set value of item in list
        (id) -> <o> get all data for item
        (id, key) -> <s> get value of key of item with id
        (id, key, value) -> <f> set value, returns IconList
    @*/
    that.value = function(id, key, value) {
        // fixme: make this accept id, {k: v, ...}
        if (arguments.length == 1) {
            return that.$element.value(id);
        } else if (arguments.length == 2) {
            return that.$element.value(id, key);
        } else {
            that.$element.value(id, key, value);
            return that;
        }
    };

    return that;

};