# all files / src/tools/ ToolGroupTool.js

30.43% Statements 7/23
0% Branches 0/8
0% Functions 0/5
30.43% Lines 7/23

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130

    1×

    1×

    1×

    1×

    1×

    1×

    1×

     /**
     * A ToolGroupTool is a special sort of tool that can contain other {@link OO.ui.Tool tools}
     * and {@link OO.ui.ToolGroup toolgroups}. The ToolGroupTool was specifically designed to be used
     * inside a {@link OO.ui.BarToolGroup bar} toolgroup to provide access to additional tools from
     * the bar item. Included tools will be displayed in a dropdown {@link OO.ui.ListToolGroup list}
     * when the ToolGroupTool is selected.
     *
     *     // Example: ToolGroupTool with two nested tools, 'setting1' and 'setting2', defined elsewhere.
     *
     *     function SettingsTool() {
     *         SettingsTool.parent.apply( this, arguments );
     *     };
     *     OO.inheritClass( SettingsTool, OO.ui.ToolGroupTool );
     *     SettingsTool.static.name = 'settings';
     *     SettingsTool.static.title = 'Change settings';
     *     SettingsTool.static.groupConfig = {
     *         icon: 'settings',
     *         label: 'ToolGroupTool',
     *         include: [  'setting1', 'setting2'  ]
     *     };
     *     toolFactory.register( SettingsTool );
     *
     * For more information, please see the [OOUI documentation on MediaWiki][1].
     *
     * Please note that this implementation is subject to change per [T74159] [2].
     *
     * [1]: https://www.mediawiki.org/wiki/OOUI/Toolbars#ToolGroupTool
     * [2]: https://phabricator.wikimedia.org/T74159
     *
     * @abstract
     * @class
     * @extends OO.ui.Tool
     *
     * @constructor
     * @param {OO.ui.ToolGroup} toolGroup
     * @param {Object} [config] Configuration options
     */
    OO.ui.ToolGroupTool = function OoUiToolGroupTool( toolGroup, config ) {
    	// Allow passing positional parameters inside the config object
    	if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
    		config = toolGroup;
    		toolGroup = config.toolGroup;
    	}

    	// Parent constructor
    	OO.ui.ToolGroupTool.parent.call( this, toolGroup, config );

    	// Properties
    	this.innerToolGroup = this.createGroup( this.constructor.static.groupConfig );

    	// Events
    	this.innerToolGroup.connect( this, {
    		disable: 'onToolGroupDisable',
    		// Re-emit active events from the innerToolGroup on the parent toolGroup
    		active: this.toolGroup.emit.bind( this.toolGroup, 'active' )
    	} );

    	// Initialization
    	this.$link.remove();
    	this.$element
    		.addClass( 'oo-ui-toolGroupTool' )
    		.append( this.innerToolGroup.$element );
    };

    /* Setup */

    OO.inheritClass( OO.ui.ToolGroupTool, OO.ui.Tool );

    /* Static Properties */

    /**
     * Toolgroup configuration.
     *
     * The toolgroup configuration consists of the tools to include, as well as an icon and label
     * to use for the bar item. Tools can be included by symbolic name, group, or with the
     * wildcard selector. Please see {@link OO.ui.ToolGroup toolgroup} for more information.
     *
     * @property {Object.<string,Array>}
     */
    OO.ui.ToolGroupTool.static.groupConfig = {};

    /* Methods */

    /**
     * Handle the tool being selected.
     *
     * @inheritdoc
     */
    OO.ui.ToolGroupTool.prototype.onSelect = function () {
    	this.innerToolGroup.setActive( !this.innerToolGroup.active );
    	return false;
    };

    /**
     * Synchronize disabledness state of the tool with the inner toolgroup.
     *
     * @private
     * @param {boolean} disabled Element is disabled
     */
    OO.ui.ToolGroupTool.prototype.onToolGroupDisable = function ( disabled ) {
    	this.setDisabled( disabled );
    };

    /**
     * Handle the toolbar state being updated.
     *
     * @inheritdoc
     */
    OO.ui.ToolGroupTool.prototype.onUpdateState = function () {
    	this.setActive( false );
    };

    /**
     * Build a {@link OO.ui.ToolGroup toolgroup} from the specified configuration.
     *
     * @param {Object.<string,Array>} group Toolgroup configuration. Please see {@link OO.ui.ToolGroup toolgroup} for
     *  more information.
     * @return {OO.ui.ListToolGroup}
     */
    OO.ui.ToolGroupTool.prototype.createGroup = function ( group ) {
    	if ( group.include === '*' ) {
    		// Apply defaults to catch-all groups
    		if ( group.label === undefined ) {
    			group.label = OO.ui.msg( 'ooui-toolbar-more' );
    		}
    	}

    	return this.toolbar.getToolGroupFactory().create( 'list', this.toolbar, group );
    };