ITSSTOOLS/js/form_handler.js

//iTop Form handler
;
$(function()
{
    // the widget definition, where 'itop' is the namespace,
    // 'form_handler' the widget name
    $.widget( 'itop.form_handler',
    {
        // default options
        options:
        {
            formmanager_class: null,
            formmanager_data: null,
            submit_btn_selector: null,
            cancel_btn_selector: null,
            endpoint: null,
            is_modal: false,
            field_set: null
        },

        // the constructor
        _create: function()
        {
            var me = this;
            
            this.element
            .addClass('form_handler');

            this.element.bind('update_fields', function(event, data){
                this._onUpdateFields(event, data);
            });

            // Binding buttons
            if(this.options.submit_btn_selector !== null)
            {
                this.options.submit_btn_selector.off('click').on('click', function(event){ me._onSubmitClick(event); });
            }
            if(this.options.cancel_btn_selector !== null)
            {
                this.options.cancel_btn_selector.off('click').on('click', function(event){ me._onCancelClick(event); });
            }
        },
   
        // called when created, and later when changing options
        _refresh: function()
        {
            
        },
        // events bound via _bind are removed automatically
        // revert other modifications here
        _destroy: function()
        {
            this.element
            .removeClass('form_handler');
        },
        // _setOptions is called with a hash of all options that are changing
        // always refresh when changing options
        _setOptions: function()
        {
            this._superApply(arguments);
        },
        // _setOption is called for each individual option that is changing
        _setOption: function( key, value )
        {
            this._super( key, value );
        },
        getCurrentValues: function()
        {
            return this.options.field_set.triggerHandler('get_current_values');
        },
        _onUpdateFields: function(event, data)
        {
            var me = this;
            var sFormPath = data.form_path;

            // Data checks
            if(this.options.endpoint === null)
            {
                console.log('Form handler : An endpoint must be defined.');
                return false;
            }
            if(this.options.formmanager_class === null)
            {
                console.log('Form handler : Form manager class must be defined.');
                return false;
            }
            if(this.options.formmanager_data === null)
            {
                console.log('Form handler : Form manager data must be defined.');
                return false;
            }
            
            this._disableFormBeforeLoading();
            $.post(
                this.options.endpoint,
                {
                    operation: 'update',
                    formmanager_class: this.options.formmanager_class,
                    formmanager_data: JSON.stringify(this.options.formmanager_data),
                    current_values: this.getCurrentValues(),
                    requested_fields: data.requested_fields,
                    form_path: sFormPath
                },
                function(data){
                    me._onUpdateSuccess(data, sFormPath);
                }
            )
            .fail(function(data){ me._onUpdateFailure(data, sFormPath); })
            .always(function(data){ me._onUpdateAlways(data, sFormPath); });
        },
        // Intended for overloading in derived classes
        _onSubmitClick: function(event)
        {
        },
        // Intended for overloading in derived classes
        _onCancelClick: function(event)
        {
        },
        // Intended for overloading in derived classes
        _onUpdateSuccess: function(data, sFormPath)
        {
            if(data.form.updated_fields !== undefined)
            {
                this.element.find('[data-form-path="'+sFormPath+'"]').trigger('update_form', {updated_fields: data.form.updated_fields});
            }
        },
        // Intended for overloading in derived classes
        _onUpdateFailure: function(data, sFormPath)
        {
        },
        // Intended for overloading in derived classes
        _onUpdateAlways: function(data, sFormPath)
        {
            // Check all touched AFTER ajax is complete, otherwise the renderer will redraw the field in the mean time.
            this.element.find('[data-form-path="'+sFormPath+'"]').trigger('validate');
            this._enableFormAfterLoading();
        },
        // Intended for overloading in derived classes
        _disableFormBeforeLoading: function()
        {
        },
        // Intended for overloading in derived classes
        _enableFormAfterLoading: function()
        {
        },
        showOptions: function() // Debug helper
        {
            console.log(this.options);
        }
    });
});