mediawiki-extensions-Visual.../modules/ve/ui/elements/ve.ui.FlaggableElement.js
Trevor Parscal a2e59f7c86 Stack panel, element mixins, cleanup
*.php
* Updated links to files

ve.ui.MetaDialog
* Added stack panel that now contains category and language editor panels
* Attached outline widget to stack panel

ve.ui.FlaggableWidget -> ve.ui.FlaggableElement
* Moved to elements

ve.ui.GroupWidget -> ve.ui.GroupElement
* Moved to elements
* Removed invalid event documentation

ve.ui.LabledWidget -> ve.ui.LabledElement
* Moved to elements

ve.ui.StackPanelLayout.js
* New class, mutually exclusive panel container

ve.ui.TitledPanelLayout
* Remvoed, using labeled element instead

ve.ui.Element.css
* Added for elements
* Moved label style here, from widget styles

*.css, ve.ui.ButtonWidget.js, ve.ui.InputLabelWidget, ve.ui.OptionWidget, ve.ui.SelectWidget
* Adjusted class names to reflect widget -> element migration

Change-Id: I32f504c844dba7aae1b286eef06ca046627bdc8d
2013-03-28 12:40:01 -07:00

86 lines
1.8 KiB
JavaScript

/*!
* VisualEditor UserInterface FlaggableElement class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Flaggable element.
*
* @class
* @abstract
*
* @constructor
* @param {Object} [config] Config options
* @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
*/
ve.ui.FlaggableElement = function VeUiFlaggableElement( config ) {
// Config initialization
config = config || {};
// Properties
this.flags = {};
// Initialization
this.setFlags( config.flags );
};
/* Methods */
/**
* Check if a flag is set.
*
* @method
* @param {string} flag Flag name to check
* @returns {boolean} Has flag
*/
ve.ui.FlaggableElement.prototype.hasFlag = function ( flag ) {
return flag in this.flags;
};
/**
* Get the names of all flags.
*
* @method
* @returns {string[]} flags Flag names
*/
ve.ui.FlaggableElement.prototype.getFlags = function () {
return ve.getObjectKeys( this.flags );
};
/**
* Add one or more flags.
*
* @method
* @param {string[]|Object.<string, boolean>} flags List of flags to add, or list of set/remove
* values, keyed by flag name
* @chainable
*/
ve.ui.FlaggableElement.prototype.setFlags = function ( flags ) {
var i, len, flag,
classPrefix = 've-ui-flaggableElement-';
if ( ve.isArray( flags ) ) {
for ( i = 0, len = flags.length; i < len; i++ ) {
flag = flags[i];
// Set
this.flags[flag] = true;
this.$.addClass( classPrefix + flag );
}
} else if ( ve.isPlainObject( flags ) ) {
for ( flag in flags ) {
if ( flags[flags] ) {
// Set
this.flags[flag] = true;
this.$.addClass( classPrefix + flag );
} else {
// Remove
delete this.flags[flag];
this.$.removeClass( classPrefix + flag );
}
}
}
return this;
};