All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.resources.org.richfaces.togglePanel.js Maven / Gradle / Ivy

There is a newer version: 4.3.7.Final
Show newest version
/*
 * JBoss, Home of Professional Open Source
 * Copyright ${year}, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

(function ($, rf) {

    rf.ui = rf.ui || {};

    /* SIMPLE INNER CLASS for handle switch operation*/
    function SwitchItems(comp) {
        this.comp = comp;
    }

    SwitchItems.prototype = {

        /**
         * @param {TogglePanelItem} oldPanel
         * @param {TogglePanelItem} newPanel
         *
         * @return {void}
         * */
        exec : function (oldPanel, newPanel) {
            if (newPanel.switchMode == "server") {
                return this.execServer(oldPanel, newPanel);
            } else if (newPanel.switchMode == "ajax") {
                return this.execAjax(oldPanel, newPanel);
            } else if (newPanel.switchMode == "client") {
                return this.execClient(oldPanel, newPanel);
            } else {
                rf.log.error("SwitchItems.exec : unknown switchMode (" + this.comp.switchMode + ")");
            }
        },

        /**
         * @protected
         * @param {TogglePanelItem} oldPanel
         * @param {TogglePanelItem} newPanel
         *
         * @return {Boolean} false
         * */
        execServer : function (oldPanel, newPanel) {
            if (oldPanel) {
                var continueProcess = oldPanel.__leave();
                if (!continueProcess) {
                    return false;
                }
            }

            this.__setActiveItem(newPanel.getName());

            rf.submitForm(this.__getParentForm());

            return false;
        },

        /**
         * @protected
         * @param {TogglePanelItem} oldPanel
         * @param {TogglePanelItem} newPanel
         *
         * @return {Boolean} false
         * */
        execAjax : function (oldPanel, newPanel) {
            var options = $.extend({}, this.comp.options["ajax"], {}/*this.getParameters(newPanel)*/);

            this.__setActiveItem(newPanel.getName());
            rf.ajax(this.comp.id, null, options);

            if (oldPanel) {
                this.__setActiveItem(oldPanel.getName());
            }

            return false;
        },

        /**
         * @protected
         * @param {TogglePanelItem} oldPanel
         * @param {TogglePanelItem} newPanel
         *
         * @return {undefined}
         *             - false - if process has been terminated
         *             - true  - in other cases
         * */
        execClient : function (oldPanel, newPanel) {
            if (oldPanel) {
                var continueProcess = oldPanel.__leave();
                if (!continueProcess) {
                    return false;
                }
            }

            this.__setActiveItem(newPanel.getName());

            newPanel.__enter();
            this.comp.__fireItemChange(oldPanel, newPanel);

            return true;
        },

        /**
         * @private
         * */
        __getParentForm : function () {
            return $(rf.getDomElement(this.comp.id)).parents('form:first');
        },

        /**
         * @private
         * */
        __setActiveItem : function (name) {
            rf.getDomElement(this.__getValueInputId()).value = name;
            this.comp.activeItem = name;
        },

        /**
         * @private
         * */
        __getValueInputId: function () {
            return this.comp.id + "-value"
        }
    };

    /**
     * @class TogglePanel
     * @name TogglePanel
     *
     * @constructor
     * @param {String} componentId - component id
     * @param {Hash} options - params
     * */
    rf.ui.TogglePanel = rf.BaseComponent.extendClass({

        // class name
        name:"TogglePanel",

        init : function (componentId, options) {
            $super.constructor.call(this, componentId);
            this.attachToDom();

            this.items = [];

            this.options = $.extend(this.options, options || {});
            this.activeItem = this.options.activeItem;

            this.__addUserEventHandler("itemchange");
            this.__addUserEventHandler("beforeitemchange");
        },

        /***************************** Public Methods  ****************************************************************/

        /**
         * @methodOf
         *
         * @name TogglePanel#getSelectItem
         *
         * @return {String} name of current selected panel item
         */
        getSelectItem: function () {
            return this.activeItem;
        },

        /**
         * @methodOf
         * @name TogglePanel#switchToItem
         *
         * @param {String} name - panel item name to switch
         *           we can use meta names @first, @prev, @next and @last
         * @return {Boolean} - false if something wrong and true if all is ok
         */
        switchToItem: function (name) {
            var newPanel = this.getNextItem(name);
            if (newPanel == null) {
                rf.log.warn("TogglePanel.switchToItems(" + name + "): item with name '" + name + "' not found");
                return false;
            }

            var oldPanel = this.__getItemByName(this.getSelectItem());

            var continueProcess = this.__fireBeforeItemChange(oldPanel, newPanel);
            if (!continueProcess) {
                rf.log.warn("TogglePanel.switchToItems(" + name + "): switch has been canceled by beforeItemChange event");
                return false
            }

            return this.__itemsSwitcher().exec(oldPanel, newPanel);
        },

        /**
         * @methodOf
         * @name TogglePanel#getNextItem
         *
         * @param {String} name of TogglePanelItem or meta name (@first | @prev | @next | @last)
         * @return {TogglePanelItem} null if item not found
         */
        getNextItem : function (name) {
            if (name) {
                var newItemIndex = this.__ITEMS_META_NAMES[name];
                if (newItemIndex) {
                    return this.__getItem(newItemIndex(this));
                } else {
                    return this.__getItemByName(name);
                }
            } else {
                return this.__getItemByName(this.nextItem());
            }
        },

        /**
         * please, remove this method when client side ajax events will be added
         *
         * */
        onCompleteHandler : function (newItemName) {
            var oldItem = this.__getItemByName(this.activeItem);
            var newItem = this.__getItemByName(newItemName);

            // Don't do like this and remove it ASAP
            this.__itemsSwitcher().execClient(oldItem, newItem);
        },

        /**
         * @methodOf
         * @name TogglePanel#getItems
         *
         * @return {TogglePanelItem[]} all defined panel items
         */
        getItems : function () {
            return this.items;
        },

        /**
         * @methodOf
         * @name TogglePanel#getItemsNames
         *
         * @return {String[]} names of all defined items
         */
        getItemsNames: function () {
            var res = [];
            for (var i=0; i 0) {
                    res += step;
                }
                return res;
            }


            return {
                "@first" : function (comp) {
                    return goFrom(comp, 0, 1);
                },

                "@prev"  : function (comp) {
                    return goFrom(comp, parseInt(comp.__getItemIndex(comp.activeItem)) - 1 , -1);
                },

                "@next"  : function (comp) {
                    return goFrom(comp, parseInt(comp.__getItemIndex(comp.activeItem)) + 1 , 1);
                },

                "@last"  : function (comp) {
                    return goFrom(comp, comp.items.length - 1, -1);
                }
            }
        })(),

        /**
         * @private
         * */
        __getItemIndex : function (itemName) {
        	var item;
            for (var i=0; i= 0 && index < this.items.length) {
                return this.items[index]
            } else {
                return null;
            }
        },

        __getItemByName : function (name) {
            return this.__getItem(this.__getItemIndex(name));
        },

        __getItemName : function (index) {
            var item = this.__getItem(index);
            if (item == null) {
                return null;
            }

            return item.getName();
        },

        /**
         * Fire Concealable Event
         * */

        __fireItemChange : function (oldItem, newItem) {
            return new rf.Event.fireById(this.id, "itemchange", {
                id: this.id,
                oldItem : oldItem,
                newItem : newItem
            });
        },

        __fireBeforeItemChange : function (oldItem, newItem) {
            return rf.Event.fireById(this.id, "beforeitemchange", {
                id: this.id,
                oldItem : oldItem,
                newItem : newItem
            });
        }
    });

    // define super class link
    var $super = rf.ui.TogglePanel.$super;
})(jQuery, RichFaces);




© 2015 - 2025 Weber Informatics LLC | Privacy Policy