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

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

'use strict';

/*@
Ox.Button <f:Ox.Element> Button Object
    () ->              <f> Button Object
    (options) ->       <f> Button Object
    (options, self) -> <f> Button Object
    options <o> Options object
        If a button is both selectable and has two values, its value is the
        selected id, and the second value corresponds to the selected state
        disabled    <b|false>       If true, button is disabled
        group       <b|false>       If true, button is part of group
        id          <s|''>          Element id
        overlap     <s|'none'>      'none', 'left' or 'right'
        selectable  <b|false>       If true, button is selectable
        style       <s|'default'>   'default', 'checkbox', 'symbol' or 'tab'
        title       <s|''>          Button title
        tooltip     <s|[s]|''>      Tooltip
        type        <s|text>        'text' or 'image'
        value       <b|s|undefined> True for selected, or current value id
        values      <[o]|[]>        [{id, title}, {id, title}] 
        width       <s|'auto'>      Button width
    self <o>    Shared private variable
    click    <!> non-selectable button was clicked
    change   <!> selectable button was clicked
@*/

Ox.Button = function(options, self) {

    self = self || {};
    var that = Ox.Element('<input>', self)
            .defaults({
                disabled: false,
                group: false,
                id: '',
                overlap: 'none',
                selectable: false,
                size: 'medium',
                // fixme: 'default' or ''?
                style: 'default',
                title: '',
                tooltip: '',
                type: 'text',
                value: void 0,
                values: [],
                width: 'auto'
            })
            .options(options ? Ox.extend(Ox.clone(options), {
                // tooltip may be an array, so we can't pass it yet
                tooltip: ''
            }) : {})
            .attr({
                disabled: self.options.disabled,
                type: self.options.type == 'text' ? 'button' : 'image'
            })
            .addClass(
                'OxButton Ox' + Ox.toTitleCase(self.options.size)
                + (self.options.disabled ? ' OxDisabled': '')
                + (self.options.selectable && self.options.value ? ' OxSelected': '')
                + (self.options.style != 'default' ? ' Ox' + Ox.toTitleCase(self.options.style) : '')
                + (self.options.overlap != 'none' ? ' OxOverlap' + Ox.toTitleCase(self.options.overlap) : '')
            )
            .css(self.options.width == 'auto' ? {} : {
                width: (self.options.width - 14) + 'px'
            })
            .mousedown(mousedown)
            .click(click);

    if (self.options.values.length) {
        self.options.values = self.options.values.map(function(value) {
            return {
                id: value.id || value,
                title: value.title || value
            };
        });
        self.value = Ox.getPositionById(self.options.values, self.options.value);
        if (self.value == -1) {
            self.value = 0;
            self.options.value = self.options.values[0].id;
        }
        self.options.title = self.options.values[self.value].title;
    } else if (self.options.selectable) {
        self.options.value = self.options.value || false;
    }

    setTitle();

    options.tooltip && that.options({
        tooltip: Ox.isArray(options.tooltip)
            ? options.tooltip[self.value]
            : options.tooltip
    });

    function click() {
        if (!self.options.disabled) {
            if (self.options.values.length || self.options.selectable) {
                that.toggle();
                that.triggerEvent('change', {value: self.options.value});
            } else {
                that.triggerEvent('click');
            }
        }
    }

    function mousedown(e) {
        if (self.options.type == 'image' && $.browser.safari) {
            // keep image from being draggable
            e.preventDefault();
        }
    }

    function setTitle() {
        if (self.options.type == 'image') {
            that.attr({
                src: Ox.UI.getImageURL(
                    'symbol' + self.options.title[0].toUpperCase()
                    + self.options.title.substr(1)
                )
            });
        } else {
            that.val(self.options.title);
        }
    }

    self.setOption = function(key, value) {
        if (key == 'disabled') {
            that.attr({disabled: value}).toggleClass('OxDisabled');
        } else if (key == 'tooltip') {
            that.$tooltip.options({title: value});
        } else if (key == 'title') {
            setTitle();
        } else if (key == 'value') {
            if (self.options.values.length) {
                self.options.title = Ox.getObjectById(self.options.values, value).title;
                setTitle();
            }
            self.options.selectable && that.toggleClass('OxSelected');
        } else if (key == 'width') {
            that.$element.css({width: (value - 14) + 'px'});
        }
    };

    that.toggle = function() {
        var index;
        if (self.options.values.length) {
            index = 1 - Ox.getPositionById(self.options.values, self.options.value);
            self.options.title = self.options.values[index].title;
            self.options.value = self.options.values[index].id;
            setTitle();
            // fixme: if the tooltip is visible
            // we also need to call show()
            that.$tooltip && that.$tooltip.options({
                title: self.options.tooltips[index]
            });
        } else {
            self.options.value = !self.options.value;
        }
        self.options.selectable && that.toggleClass('OxSelected');
    }

    return that;

};