oxjs/source/Ox.UI/js/Form/Ox.Select.js

// vim: et:ts=4:sw=4:sts=4:ft=javascript

'use strict';

/*@
Ox.Select <f:Ox.Element> Select Object
    () ->              <f> Select Object
    (options) ->       <f> Select Object
    (options, self) -> <f> Select Object
    options <o> Options object
        disabled <b|false> If true, select is disabled
        id <s> Element id
        items <a|[]> Items (array of {id, title} or strings)
        label <s|''> Label
        labelWidth <n|64> Label width
        max <n|1> Maximum number of selected items
        maxWidth <n|0> Maximum menu width
        min <n|1> Minimum number of selected items
        overlap <s|'none'> Can be 'none', 'left' or 'right'
        selectable <b|true> is selectable
        size <s|'medium'> Size, can be small, medium, large
        style <s|'rounded'> Style ('rounded' or 'square')
        title <s|''> Select title
        tooltip <s|f|''> Tooltip title, or function that returns one
            (e) -> <string> Tooltip title
            e <object> Mouse event
        type <s|'text'> Type ('text' or 'image')
        value <a|s> Selected id, or array of selected ids
        width <s|n|'auto'> Width in px, or 'auto'
    self <o> Shared private variable
    click <!> Click event
    change <!> Change event
@*/

Ox.Select = function(options, self) {

    self = self || {};
    var that = Ox.Element({
                tooltip: options.tooltip || ''
            }, self)
            .defaults({
                id: '',
                items: [],
                label: '',
                labelWidth: 64,
                max: 1,
                maxWidth: 0,
                min: 1,
                overlap: 'none',
                size: 'medium',
                style: 'rounded',
                title: '',
                type: 'text',
                value: options.max != 1 ? [] : '',
                width: 'auto'
            })
            // fixme: make default selection restorable
            .options(options)
            .addClass(
                'OxSelect Ox' + Ox.toTitleCase(self.options.size)
                + ' Ox' + Ox.toTitleCase(self.options.style) + (
                    self.options.overlap == 'none'
                    ? '' : ' OxOverlap' + Ox.toTitleCase(self.options.overlap)
                ) + (self.options.label ? ' OxLabelSelect' : '')
            )
            .css(self.options.width == 'auto' ? {} : {
                width: self.options.width - 2 + 'px'
            })
            .bindEvent({
                anyclick: showMenu,
                key_escape: loseFocus,
                key_down: showMenu
            });

    Ox.Log('Form', 'Ox.Select', self.options);

    self.options.items = self.options.items.map(function(item) {
        return {
            id: item.id || item,
            title: item.title || item,
            checked: Ox.toArray(self.options.value).indexOf(item.id || item) > -1
        };
    });

    self.optionGroup = new Ox.OptionGroup(
        self.options.items,
        self.options.min,
        self.options.max,
        'checked'
    );
    self.options.items = self.optionGroup.init();
    self.options.value = self.optionGroup.value();

    if (self.options.label) {
        self.$label = Ox.Label({
            overlap: 'right',
            textAlign: 'right',
            title: self.options.label,
            width: self.options.labelWidth
        })
        .appendTo(that);
    }

    if (self.options.type == 'text') {
        Ox.Log('Form', 'S.O.V.', self.options.value)
        self.$title = $('<div>')
            .addClass('OxTitle')
            .css({
                width: getTitleWidth() + 'px'
            })
            .html(
                self.options.title
                || getItem(self.options.value).title
            )
            .appendTo(that);
    }

    self.$button = Ox.Button({
            id: self.options.id + 'Button',
            style: 'symbol',
            title: self.options.type == 'text' || !self.options.title
                ? 'select' : self.options.title,
            type: 'image'
        })
        .appendTo(that);

    self.$menu = Ox.Menu({
            element: self.$title || self.$button,
            id: self.options.id + 'Menu',
            items: [{
                group: self.options.id + 'Group',
                items: self.options.items,
                max: self.options.max,
                min: self.options.min
            }],
            maxWidth: self.options.maxWidth,
            side: 'bottom', // FIXME: should be edge
            size: self.options.size
        })
        .bindEvent({
            change: changeMenu,
            click: clickMenu,
            hide: hideMenu
        });

    self.options.type == 'image' && self.$menu.addClass('OxRight');

    function clickMenu(data) {
        that.triggerEvent('click', data);
    }

    function changeMenu(data) {
        self.options.value = self.optionGroup.value();
        Ox.Log('Form', 'changeMenu: ', data, 'value:', self.options.value, 'checked:', self.optionGroup.checked())
        self.$title && self.$title.html(
            self.options.title ? self.options.title : getItem(self.options.value).title
        );
        that.triggerEvent('change', {
            value: self.options.value
        });
    }

    function getItem(id) {
        return Ox.getObjectById(self.options.items, id);
    }

    function getTitleWidth() {
        // fixme: used to be 22. obscure
        return self.options.width - 24 - (
            self.options.label ? self.options.labelWidth : 0
        );
    }

    function hideMenu() {
        that.loseFocus();
        that.removeClass('OxSelected');
    }

    function loseFocus() {
        that.loseFocus();
    }

    function selectItem() {
        
    }

    function showMenu() {
        that.gainFocus();
        that.addClass('OxSelected');
        self.options.tooltip && that.$tooltip.hide();
        self.$menu.showMenu();
    }

    self.setOption = function(key, value) {
        if (key == 'labelWidth') {
            self.$label.options({width: value});
            self.$title.css({width: getTitleWidth() + 'px'});
        } else if (key == 'title') {
            if (self.options.type == 'text') {
                self.$title.html(value);
            } else {
                self.$button.options({title: value});
            }
        } else if (key == 'width') {
            Ox.Log('Form', 'SETTING WIDTH OPTION', value);
            that.css({width: value - 2 + 'px'});
            self.$title.css({width: getTitleWidth() + 'px'});
        } else if (key == 'value') {
            Ox.Log('Form', 'SETTING VALUE OPTION', value);
            if (self.options.type == 'text' && !self.options.title) {
                self.$title.html(getItem(value).title);
            }
            Ox.toArray(value).forEach(function(value) {
                self.$menu.checkItem(value);
            });
            self.options.value = self.optionGroup.value();
        }
    };

    that.disableItem = function(id) {
        self.$menu.getItem(id).options({disabled: true});
    };

    that.enableItem = function(id) {
        self.$menu.getItem(id).options({disabled: false});
    };

    self.superRemove = that.remove;
    that.remove = function() {
        self.$menu.remove();
        self.superRemove();
    };

    /*@
    selected <f> gets selected item
        () -> <o> returns array of selected items with id and title
    @*/
    that.selected = function() {
        return Ox.toArray(self.optionGroup.value()).map(function(id) {
            return {
                id: id,
                title: getItem(id).title
            };
        });
    };

    /*
    that.width = function(val) {
        // fixme: silly hack, and won't work for css() ... remove!
        that.$element.width(val + 16);
        that.$button.width(val);
        //that.$symbol.width(val);
        return that;
    };
    */

    return that;

};