widget-autohide/js/Widget-Autohide.js

	Widget-Autohide.js revision 853244a9af0549d584b80ac65d4fcb92de7c58bc
var WIDGET_AUTOHIDE    = 'widgetAutohide',
    AUTOHIDE            = 'autohide',
    CLICKED_OUTSIDE     = 'clickedOutside',
    FOCUSED_OUTSIDE     = 'focusedOutside',
    PRESSED_ESCAPE      = 'pressedEscape',
    BIND_UI             = 'bindUI',
    SYNC_UI             = "syncUI",
    RENDERED            = "rendered",
    BOUNDING_BOX        = "boundingBox",
    VISIBLE             = "visible",
    HOST                = "host",
    CHANGE              = 'Change',

    getCN               = Y.ClassNameManager.getClassName;


WidgetAutohide = Y.Base.create(WIDGET_AUTOHIDE, Y.Plugin.Base, [], {

    // *** Instance Members *** //

    _uiHandles : null,

    // *** Lifecycle Methods *** //

    initializer : function (config) {

        this.afterHostMethod(BIND_UI, this.bindUI);
        this.afterHostMethod(SYNC_UI, this.syncUI);

        if (this.get(HOST).get(RENDERED)) {
            this.bindUI();
            this.syncUI();
        }
    },

    destructor : function () {

        this._detachUIHandles();
    },

    bindUI : function () {

        this.afterHostEvent(VISIBLE+CHANGE, this._afterHostVisibleChange);
    },

    syncUI : function () {

        this._uiSetHostVisible(this.get(HOST).get(VISIBLE));
    },

    // *** Private Methods *** //

    _uiSetHostVisible : function (visible) {

        if (visible) {
            //this._attachUIHandles();
            Y.later(1, this, '_attachUIHandles');
        } else {
            this._detachUIHandles();
        }
    },

    _attachUIHandles : function () {

        if (this._uiHandles) { return; }

        var host = this.get(HOST),
            bb = host.get(BOUNDING_BOX),
            hide = Y.bind(host.hide, host),
            uiHandles = [];

        if (this.get(CLICKED_OUTSIDE)) {
            uiHandles.push(bb.on('clickoutside', hide));
        }

        if (this.get(FOCUSED_OUTSIDE)) {
            uiHandles.push(bb.on('focusoutside', hide));
        }

        if (this.get(PRESSED_ESCAPE)) {
            uiHandles.push(bb.on('key', hide, 'down:27'));
        }

        this._uiHandles = uiHandles;
    },

    _detachUIHandles : function () {

        Y.each(this._uiHandles, function(h){
            h.detach();
        });
        this._uiHandles = null;
    },

    _afterHostVisibleChange : function (e) {

        this._uiSetHostVisible(e.newVal);
    }

}, {

    // *** Static *** //

    NS : AUTOHIDE,

    ATTRS : {

        clickedOutside  : {
            value       : false,
            validator   : Y.Lang.isBoolean
        },

        focusedOutside  : {
            value       : false,
            validator   : Y.Lang.isBoolean
        },

        pressedEscape   : {
            value       : true,
            validator   : Y.Lang.isBoolean
        }

    }

});

Y.namespace("Plugin").Autohide = WidgetAutohide;