3 * View model for a filter group
5 * @mixins OO.EventEmitter
6 * @mixins OO.EmitterList
9 * @param {string} name Group name
10 * @param {Object} [config] Configuration options
11 * @cfg {string} [type='send_unselected_if_any'] Group type
12 * @cfg {string} [view='default'] Name of the display group this group
14 * @cfg {boolean} [isSticky] This group is using a 'sticky' default; meaning
15 * that every time a value is changed, it becomes the new default
16 * @cfg {boolean} [excludedFromSavedQueries] A specific requirement to exclude
17 * this filter from saved queries. This is always true if the filter is 'sticky'
18 * but can be used for non-sticky filters as an additional requirement. Similarly
19 * to 'sticky' it works for the entire group as a whole.
20 * @cfg {string} [title] Group title
21 * @cfg {boolean} [hidden] This group is hidden from the regular menu views
22 * @cfg {boolean} [allowArbitrary] Allows for an arbitrary value to be added to the
23 * group from the URL, even if it wasn't initially set up.
24 * @cfg {number} [range] An object defining minimum and maximum values for numeric
25 * groups. { min: x, max: y }
26 * @cfg {number} [minValue] Minimum value for numeric groups
27 * @cfg {string} [separator='|'] Value separator for 'string_options' groups
28 * @cfg {boolean} [active] Group is active
29 * @cfg {boolean} [fullCoverage] This filters in this group collectively cover all results
30 * @cfg {Object} [conflicts] Defines the conflicts for this filter group
31 * @cfg {string|Object} [labelPrefixKey] An i18n key defining the prefix label for this
32 * group. If the prefix has 'invert' state, the parameter is expected to be an object
33 * with 'default' and 'inverted' as keys.
34 * @cfg {Object} [whatsThis] Defines the messages that should appear for the 'what's this' popup
35 * @cfg {string} [whatsThis.header] The header of the whatsThis popup message
36 * @cfg {string} [whatsThis.body] The body of the whatsThis popup message
37 * @cfg {string} [whatsThis.url] The url for the link in the whatsThis popup message
38 * @cfg {string} [whatsThis.linkMessage] The text for the link in the whatsThis popup message
40 mw
.rcfilters
.dm
.FilterGroup
= function MwRcfiltersDmFilterGroup( name
, config
) {
41 config
= config
|| {};
44 OO
.EventEmitter
.call( this );
45 OO
.EmitterList
.call( this );
48 this.type
= config
.type
|| 'send_unselected_if_any';
49 this.view
= config
.view
|| 'default';
50 this.sticky
= !!config
.isSticky
;
51 this.excludedFromSavedQueries
= this.sticky
|| !!config
.excludedFromSavedQueries
;
52 this.title
= config
.title
|| name
;
53 this.hidden
= !!config
.hidden
;
54 this.allowArbitrary
= !!config
.allowArbitrary
;
55 this.numericRange
= config
.range
;
56 this.separator
= config
.separator
|| '|';
57 this.labelPrefixKey
= config
.labelPrefixKey
;
59 this.currSelected
= null;
60 this.active
= !!config
.active
;
61 this.fullCoverage
= !!config
.fullCoverage
;
63 this.whatsThis
= config
.whatsThis
|| {};
65 this.conflicts
= config
.conflicts
|| {};
66 this.defaultParams
= {};
67 this.defaultFilters
= {};
69 this.aggregate( { update
: 'filterItemUpdate' } );
70 this.connect( this, { filterItemUpdate
: 'onFilterItemUpdate' } );
74 OO
.initClass( mw
.rcfilters
.dm
.FilterGroup
);
75 OO
.mixinClass( mw
.rcfilters
.dm
.FilterGroup
, OO
.EventEmitter
);
76 OO
.mixinClass( mw
.rcfilters
.dm
.FilterGroup
, OO
.EmitterList
);
83 * Group state has been updated
89 * Initialize the group and create its filter items
91 * @param {Object} filterDefinition Filter definition for this group
92 * @param {string|Object} [groupDefault] Definition of the group default
94 mw
.rcfilters
.dm
.FilterGroup
.prototype.initializeFilters = function ( filterDefinition
, groupDefault
) {
100 filterDefinition
.forEach( function ( filter
) {
101 // Instantiate an item
102 var subsetNames
= [],
103 filterItem
= new mw
.rcfilters
.dm
.FilterItem( filter
.name
, model
, {
104 group
: model
.getName(),
105 label
: filter
.label
|| filter
.name
,
106 description
: filter
.description
|| '',
107 labelPrefixKey
: model
.labelPrefixKey
,
108 cssClass
: filter
.cssClass
,
109 identifiers
: filter
.identifiers
112 if ( filter
.subset
) {
113 filter
.subset
= filter
.subset
.map( function ( el
) {
119 filter
.subset
.forEach( function ( subsetFilterName
) { // eslint-disable-line no-loop-func
120 // Subsets (unlike conflicts) are always inside the same group
121 // We can re-map the names of the filters we are getting from
122 // the subsets with the group prefix
123 var subsetName
= model
.getPrefixedName( subsetFilterName
);
124 // For convenience, we should store each filter's "supersets" -- these are
125 // the filters that have that item in their subset list. This will just
126 // make it easier to go through whether the item has any other items
127 // that affect it (and are selected) at any given time
128 supersetMap
[ subsetName
] = supersetMap
[ subsetName
] || [];
129 mw
.rcfilters
.utils
.addArrayElementsUnique(
130 supersetMap
[ subsetName
],
134 // Translate subset param name to add the group name, so we
135 // get consistent naming. We know that subsets are only within
137 subsetNames
.push( subsetName
);
140 // Set translated subset
141 filterItem
.setSubset( subsetNames
);
144 items
.push( filterItem
);
146 // Store default parameter state; in this case, default is defined per filter
148 model
.getType() === 'send_unselected_if_any' ||
149 model
.getType() === 'boolean'
151 // Store the default parameter state
152 // For this group type, parameter values are direct
153 // We need to convert from a boolean to a string ('1' and '0')
154 model
.defaultParams
[ filter
.name
] = String( Number( filter
.default || 0 ) );
159 this.addItems( items
);
161 // Now that we have all items, we can apply the superset map
162 this.getItems().forEach( function ( filterItem
) {
163 filterItem
.setSuperset( supersetMap
[ filterItem
.getName() ] );
166 // Store default parameter state; in this case, default is defined per the
167 // entire group, given by groupDefault method parameter
168 if ( this.getType() === 'string_options' ) {
169 // Store the default parameter group state
170 // For this group, the parameter is group name and value is the names
172 this.defaultParams
[ this.getName() ] = mw
.rcfilters
.utils
.normalizeParamOptions(
175 groupDefault
.split( this.getSeparator() ) :
178 this.getItems().map( function ( item
) {
179 return item
.getParamName();
181 ).join( this.getSeparator() );
182 } else if ( this.getType() === 'single_option' ) {
183 defaultParam
= groupDefault
!== undefined ?
184 groupDefault
: this.getItems()[ 0 ].getParamName();
186 // For this group, the parameter is the group name,
187 // and a single item can be selected: default or first item
188 this.defaultParams
[ this.getName() ] = defaultParam
;
191 // Store default filter state based on default params
192 this.defaultFilters
= this.getFilterRepresentation( this.getDefaultParams() );
194 // Check for filters that should be initially selected by their default value
195 if ( this.isSticky() ) {
196 $.each( this.defaultFilters
, function ( filterName
, filterValue
) {
197 model
.getItemByName( filterName
).toggleSelected( filterValue
);
201 // Verify that single_option group has at least one item selected
203 this.getType() === 'single_option' &&
204 this.getSelectedItems().length
=== 0
206 defaultParam
= groupDefault
!== undefined ?
207 groupDefault
: this.getItems()[ 0 ].getParamName();
209 // Single option means there must be a single option
210 // selected, so we have to either select the default
211 // or select the first option
212 this.selectItemByParamName( defaultParam
);
217 * Respond to filterItem update event
219 * @param {mw.rcfilters.dm.FilterItem} item Updated filter item
222 mw
.rcfilters
.dm
.FilterGroup
.prototype.onFilterItemUpdate = function ( item
) {
225 active
= this.areAnySelected();
229 this.getType() === 'single_option' &&
231 this.currSelected
!== item
233 this.currSelected
.toggleSelected( false );
236 // For 'single_option' groups, check if we just unselected all
237 // items. This should never be the result. If we did unselect
238 // all (like resetting all filters to false) then this group
239 // must choose its default item or the first item in the group
241 this.getType() === 'single_option' &&
242 !this.getItems().some( function ( filterItem
) {
243 return filterItem
.isSelected();
246 // Single option means there must be a single option
247 // selected, so we have to either select the default
248 // or select the first option
249 this.currSelected
= this.getItemByParamName( this.defaultParams
[ this.getName() ] ) ||
250 this.getItems()[ 0 ];
251 this.currSelected
.toggleSelected( true );
257 this.active
!== active
||
258 this.currSelected
!== item
260 if ( this.isSticky() ) {
261 // If this group is sticky, then change the default according to the
262 // current selection.
263 this.defaultParams
= this.getParamRepresentation( this.getSelectedState() );
266 this.active
= active
;
267 this.currSelected
= item
;
269 this.emit( 'update' );
274 * Get group active state
276 * @return {boolean} Active state
278 mw
.rcfilters
.dm
.FilterGroup
.prototype.isActive = function () {
283 * Get group hidden state
285 * @return {boolean} Hidden state
287 mw
.rcfilters
.dm
.FilterGroup
.prototype.isHidden = function () {
292 * Get group allow arbitrary state
294 * @return {boolean} Group allows an arbitrary value from the URL
296 mw
.rcfilters
.dm
.FilterGroup
.prototype.isAllowArbitrary = function () {
297 return this.allowArbitrary
;
301 * Get group maximum value for numeric groups
303 * @return {number|null} Group max value
305 mw
.rcfilters
.dm
.FilterGroup
.prototype.getMaxValue = function () {
306 return this.numericRange
&& this.numericRange
.max
!== undefined ?
307 this.numericRange
.max
: null;
311 * Get group minimum value for numeric groups
313 * @return {number|null} Group max value
315 mw
.rcfilters
.dm
.FilterGroup
.prototype.getMinValue = function () {
316 return this.numericRange
&& this.numericRange
.min
!== undefined ?
317 this.numericRange
.min
: null;
323 * @return {string} Group name
325 mw
.rcfilters
.dm
.FilterGroup
.prototype.getName = function () {
330 * Get the default param state of this group
332 * @return {Object} Default param state
334 mw
.rcfilters
.dm
.FilterGroup
.prototype.getDefaultParams = function () {
335 return this.defaultParams
;
339 * Get the default filter state of this group
341 * @return {Object} Default filter state
343 mw
.rcfilters
.dm
.FilterGroup
.prototype.getDefaultFilters = function () {
344 return this.defaultFilters
;
348 * This is for a single_option and string_options group types
349 * it returns the value of the default
351 * @return {string} Value of the default
353 mw
.rcfilters
.dm
.FilterGroup
.prototype.getDefaulParamValue = function () {
354 return this.defaultParams
[ this.getName() ];
357 * Get the messags defining the 'whats this' popup for this group
359 * @return {Object} What's this messages
361 mw
.rcfilters
.dm
.FilterGroup
.prototype.getWhatsThis = function () {
362 return this.whatsThis
;
366 * Check whether this group has a 'what's this' message
368 * @return {boolean} This group has a what's this message
370 mw
.rcfilters
.dm
.FilterGroup
.prototype.hasWhatsThis = function () {
371 return !!this.whatsThis
.body
;
375 * Get the conflicts associated with the entire group.
376 * Conflict object is set up by filter name keys and conflict
377 * definition. For example:
381 * filter: filterName,
387 * filter: filterName2,
392 * @return {Object} Conflict definition
394 mw
.rcfilters
.dm
.FilterGroup
.prototype.getConflicts = function () {
395 return this.conflicts
;
399 * Set conflicts for this group. See #getConflicts for the expected
400 * structure of the definition.
402 * @param {Object} conflicts Conflicts for this group
404 mw
.rcfilters
.dm
.FilterGroup
.prototype.setConflicts = function ( conflicts
) {
405 this.conflicts
= conflicts
;
409 * Set conflicts for each filter item in the group based on the
412 * @param {Object} conflicts Object representing the conflict map,
413 * keyed by the item name, where its value is an object for all its conflicts
415 mw
.rcfilters
.dm
.FilterGroup
.prototype.setFilterConflicts = function ( conflicts
) {
416 this.getItems().forEach( function ( filterItem
) {
417 if ( conflicts
[ filterItem
.getName() ] ) {
418 filterItem
.setConflicts( conflicts
[ filterItem
.getName() ] );
424 * Check whether this item has a potential conflict with the given item
426 * This checks whether the given item is in the list of conflicts of
427 * the current item, but makes no judgment about whether the conflict
428 * is currently at play (either one of the items may not be selected)
430 * @param {mw.rcfilters.dm.FilterItem} filterItem Filter item
431 * @return {boolean} This item has a conflict with the given item
433 mw
.rcfilters
.dm
.FilterGroup
.prototype.existsInConflicts = function ( filterItem
) {
434 return Object
.prototype.hasOwnProperty
.call( this.getConflicts(), filterItem
.getName() );
438 * Check whether there are any items selected
440 * @return {boolean} Any items in the group are selected
442 mw
.rcfilters
.dm
.FilterGroup
.prototype.areAnySelected = function () {
443 return this.getItems().some( function ( filterItem
) {
444 return filterItem
.isSelected();
449 * Check whether all items selected
451 * @return {boolean} All items are selected
453 mw
.rcfilters
.dm
.FilterGroup
.prototype.areAllSelected = function () {
457 this.getItems().forEach( function ( filterItem
) {
458 if ( filterItem
.isSelected() ) {
459 selected
.push( filterItem
);
461 unselected
.push( filterItem
);
465 if ( unselected
.length
=== 0 ) {
469 // check if every unselected is a subset of a selected
470 return unselected
.every( function ( unselectedFilterItem
) {
471 return selected
.some( function ( selectedFilterItem
) {
472 return selectedFilterItem
.existsInSubset( unselectedFilterItem
.getName() );
478 * Get all selected items in this group
480 * @param {mw.rcfilters.dm.FilterItem} [excludeItem] Item to exclude from the list
481 * @return {mw.rcfilters.dm.FilterItem[]} Selected items
483 mw
.rcfilters
.dm
.FilterGroup
.prototype.getSelectedItems = function ( excludeItem
) {
484 var excludeName
= ( excludeItem
&& excludeItem
.getName() ) || '';
486 return this.getItems().filter( function ( item
) {
487 return item
.getName() !== excludeName
&& item
.isSelected();
492 * Check whether all selected items are in conflict with the given item
494 * @param {mw.rcfilters.dm.FilterItem} filterItem Filter item to test
495 * @return {boolean} All selected items are in conflict with this item
497 mw
.rcfilters
.dm
.FilterGroup
.prototype.areAllSelectedInConflictWith = function ( filterItem
) {
498 var selectedItems
= this.getSelectedItems( filterItem
);
500 return selectedItems
.length
> 0 &&
502 // The group as a whole is in conflict with this item
503 this.existsInConflicts( filterItem
) ||
504 // All selected items are in conflict individually
505 selectedItems
.every( function ( selectedFilter
) {
506 return selectedFilter
.existsInConflicts( filterItem
);
512 * Check whether any of the selected items are in conflict with the given item
514 * @param {mw.rcfilters.dm.FilterItem} filterItem Filter item to test
515 * @return {boolean} Any of the selected items are in conflict with this item
517 mw
.rcfilters
.dm
.FilterGroup
.prototype.areAnySelectedInConflictWith = function ( filterItem
) {
518 var selectedItems
= this.getSelectedItems( filterItem
);
520 return selectedItems
.length
> 0 && (
521 // The group as a whole is in conflict with this item
522 this.existsInConflicts( filterItem
) ||
523 // Any selected items are in conflict individually
524 selectedItems
.some( function ( selectedFilter
) {
525 return selectedFilter
.existsInConflicts( filterItem
);
531 * Get the parameter representation from this group
533 * @param {Object} [filterRepresentation] An object defining the state
534 * of the filters in this group, keyed by their name and current selected
536 * @return {Object} Parameter representation
538 mw
.rcfilters
.dm
.FilterGroup
.prototype.getParamRepresentation = function ( filterRepresentation
) {
540 areAnySelected
= false,
541 buildFromCurrentState
= !filterRepresentation
,
542 defaultFilters
= this.getDefaultFilters(),
545 filterParamNames
= {},
546 getSelectedParameter = function ( filters
) {
550 // Find if any are selected
551 $.each( filters
, function ( name
, value
) {
553 selected
.push( name
);
557 item
= model
.getItemByName( selected
[ 0 ] );
558 return ( item
&& item
.getParamName() ) || '';
561 filterRepresentation
= filterRepresentation
|| {};
563 // Create or complete the filterRepresentation definition
564 this.getItems().forEach( function ( item
) {
565 // Map filter names to their parameter names
566 filterParamNames
[ item
.getName() ] = item
.getParamName();
568 if ( buildFromCurrentState
) {
569 // This means we have not been given a filter representation
570 // so we are building one based on current state
571 filterRepresentation
[ item
.getName() ] = item
.isSelected();
572 } else if ( filterRepresentation
[ item
.getName() ] === undefined ) {
573 // We are given a filter representation, but we have to make
574 // sure that we fill in the missing filters if there are any
575 // we will assume they are all falsey
576 if ( model
.isSticky() ) {
577 filterRepresentation
[ item
.getName() ] = !!defaultFilters
[ item
.getName() ];
579 filterRepresentation
[ item
.getName() ] = false;
583 if ( filterRepresentation
[ item
.getName() ] ) {
584 areAnySelected
= true;
590 this.getType() === 'send_unselected_if_any' ||
591 this.getType() === 'boolean'
593 // First, check if any of the items are selected at all.
594 // If none is selected, we're treating it as if they are
597 // Go over the items and define the correct values
598 $.each( filterRepresentation
, function ( name
, value
) {
599 // We must store all parameter values as strings '0' or '1'
600 if ( model
.getType() === 'send_unselected_if_any' ) {
601 result
[ filterParamNames
[ name
] ] = areAnySelected
?
602 String( Number( !value
) ) :
604 } else if ( model
.getType() === 'boolean' ) {
605 // Representation is straight-forward and direct from
606 // the parameter value to the filter state
607 result
[ filterParamNames
[ name
] ] = String( Number( !!value
) );
610 } else if ( this.getType() === 'string_options' ) {
613 $.each( filterRepresentation
, function ( name
, value
) {
616 values
.push( filterParamNames
[ name
] );
620 result
[ this.getName() ] = ( values
.length
=== Object
.keys( filterRepresentation
).length
) ?
621 'all' : values
.join( this.getSeparator() );
622 } else if ( this.getType() === 'single_option' ) {
623 result
[ this.getName() ] = getSelectedParameter( filterRepresentation
);
630 * Get the filter representation this group would provide
631 * based on given parameter states.
633 * @param {Object} [paramRepresentation] An object defining a parameter
634 * state to translate the filter state from. If not given, an object
635 * representing all filters as falsey is returned; same as if the parameter
636 * given were an empty object, or had some of the filters missing.
637 * @return {Object} Filter representation
639 mw
.rcfilters
.dm
.FilterGroup
.prototype.getFilterRepresentation = function ( paramRepresentation
) {
640 var areAnySelected
, paramValues
, item
, currentValue
,
641 oneWasSelected
= false,
642 defaultParams
= this.getDefaultParams(),
643 expandedParams
= $.extend( true, {}, paramRepresentation
),
645 paramToFilterMap
= {},
648 if ( this.isSticky() ) {
649 // If the group is sticky, check if all parameters are represented
650 // and for those that aren't represented, add them with their default
652 paramRepresentation
= $.extend( true, {}, this.getDefaultParams(), paramRepresentation
);
655 paramRepresentation
= paramRepresentation
|| {};
657 this.getType() === 'send_unselected_if_any' ||
658 this.getType() === 'boolean'
660 // Go over param representation; map and check for selections
661 this.getItems().forEach( function ( filterItem
) {
662 var paramName
= filterItem
.getParamName();
664 expandedParams
[ paramName
] = paramRepresentation
[ paramName
] || '0';
665 paramToFilterMap
[ paramName
] = filterItem
;
667 if ( Number( paramRepresentation
[ filterItem
.getParamName() ] ) ) {
668 areAnySelected
= true;
672 $.each( expandedParams
, function ( paramName
, paramValue
) {
673 var filterItem
= paramToFilterMap
[ paramName
];
675 if ( model
.getType() === 'send_unselected_if_any' ) {
676 // Flip the definition between the parameter
677 // state and the filter state
678 // This is what the 'toggleSelected' value of the filter is
679 result
[ filterItem
.getName() ] = areAnySelected
?
680 !Number( paramValue
) :
681 // Otherwise, there are no selected items in the
682 // group, which means the state is false
684 } else if ( model
.getType() === 'boolean' ) {
685 // Straight-forward definition of state
686 result
[ filterItem
.getName() ] = !!Number( paramRepresentation
[ filterItem
.getParamName() ] );
689 } else if ( this.getType() === 'string_options' ) {
690 currentValue
= paramRepresentation
[ this.getName() ] || '';
692 // Normalize the given parameter values
693 paramValues
= mw
.rcfilters
.utils
.normalizeParamOptions(
699 this.getItems().map( function ( filterItem
) {
700 return filterItem
.getParamName();
703 // Translate the parameter values into a filter selection state
704 this.getItems().forEach( function ( filterItem
) {
705 // All true (either because all values are written or the term 'all' is written)
706 // is the same as all filters set to true
707 result
[ filterItem
.getName() ] = (
708 // If it is the word 'all'
709 paramValues
.length
=== 1 && paramValues
[ 0 ] === 'all' ||
710 // All values are written
711 paramValues
.length
=== model
.getItemCount()
714 // Otherwise, the filter is selected only if it appears in the parameter values
715 paramValues
.indexOf( filterItem
.getParamName() ) > -1;
717 } else if ( this.getType() === 'single_option' ) {
718 // There is parameter that fits a single filter and if not, get the default
719 this.getItems().forEach( function ( filterItem
) {
720 var selected
= filterItem
.getParamName() === paramRepresentation
[ model
.getName() ];
722 result
[ filterItem
.getName() ] = selected
;
723 oneWasSelected
= oneWasSelected
|| selected
;
727 // Go over result and make sure all filters are represented.
728 // If any filters are missing, they will get a falsey value
729 this.getItems().forEach( function ( filterItem
) {
730 if ( result
[ filterItem
.getName() ] === undefined ) {
731 result
[ filterItem
.getName() ] = false;
735 // Make sure that at least one option is selected in
736 // single_option groups, no matter what path was taken
737 // If none was selected by the given definition, then
738 // we need to select the one in the base state -- either
739 // the default given, or the first item
741 this.getType() === 'single_option' &&
744 item
= this.getItems()[ 0 ];
745 if ( defaultParams
[ this.getName() ] ) {
746 item
= this.getItemByParamName( defaultParams
[ this.getName() ] );
749 result
[ item
.getName() ] = true;
756 * Get current selected state of all filter items in this group
758 * @return {Object} Selected state
760 mw
.rcfilters
.dm
.FilterGroup
.prototype.getSelectedState = function () {
763 this.getItems().forEach( function ( filterItem
) {
764 state
[ filterItem
.getName() ] = filterItem
.isSelected();
771 * Get item by its filter name
773 * @param {string} filterName Filter name
774 * @return {mw.rcfilters.dm.FilterItem} Filter item
776 mw
.rcfilters
.dm
.FilterGroup
.prototype.getItemByName = function ( filterName
) {
777 return this.getItems().filter( function ( item
) {
778 return item
.getName() === filterName
;
783 * Select an item by its parameter name
785 * @param {string} paramName Filter parameter name
787 mw
.rcfilters
.dm
.FilterGroup
.prototype.selectItemByParamName = function ( paramName
) {
788 this.getItems().forEach( function ( item
) {
789 item
.toggleSelected( item
.getParamName() === String( paramName
) );
794 * Get item by its parameter name
796 * @param {string} paramName Parameter name
797 * @return {mw.rcfilters.dm.FilterItem} Filter item
799 mw
.rcfilters
.dm
.FilterGroup
.prototype.getItemByParamName = function ( paramName
) {
800 return this.getItems().filter( function ( item
) {
801 return item
.getParamName() === String( paramName
);
808 * @return {string} Group type
810 mw
.rcfilters
.dm
.FilterGroup
.prototype.getType = function () {
817 * @return {string} Display group
819 mw
.rcfilters
.dm
.FilterGroup
.prototype.getView = function () {
824 * Get the prefix used for the filter names inside this group.
826 * @param {string} [name] Filter name to prefix
827 * @return {string} Group prefix
829 mw
.rcfilters
.dm
.FilterGroup
.prototype.getNamePrefix = function () {
830 return this.getName() + '__';
834 * Get a filter name with the prefix used for the filter names inside this group.
836 * @param {string} name Filter name to prefix
837 * @return {string} Group prefix
839 mw
.rcfilters
.dm
.FilterGroup
.prototype.getPrefixedName = function ( name
) {
840 return this.getNamePrefix() + name
;
846 * @return {string} Title
848 mw
.rcfilters
.dm
.FilterGroup
.prototype.getTitle = function () {
853 * Get group's values separator
855 * @return {string} Values separator
857 mw
.rcfilters
.dm
.FilterGroup
.prototype.getSeparator = function () {
858 return this.separator
;
862 * Check whether the group is defined as full coverage
864 * @return {boolean} Group is full coverage
866 mw
.rcfilters
.dm
.FilterGroup
.prototype.isFullCoverage = function () {
867 return this.fullCoverage
;
871 * Check whether the group is defined as sticky default
873 * @return {boolean} Group is sticky default
875 mw
.rcfilters
.dm
.FilterGroup
.prototype.isSticky = function () {
880 * Check whether the group value is excluded from saved queries
882 * @return {boolean} Group value is excluded from saved queries
884 mw
.rcfilters
.dm
.FilterGroup
.prototype.isExcludedFromSavedQueries = function () {
885 return this.excludedFromSavedQueries
;