mediawiki-extensions-VisualEditor/modules/ve/ui/widgets/ve.ui.OutlineItemWidget.js

/*!
 * VisualEditor UserInterface OutlineItemWidget class.
 *
 * @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.OutlineItemWidget object.
 *
 * @class
 * @extends ve.ui.OptionWidget
 *
 * @constructor
 * @param {Mixed} data Item data
 * @param {Object} [config] Config options
 * @cfg {string} [icon] Symbolic name of icon
 * @cfg {number} [level] Indentation level
 * @cfg {boolean} [moveable] Allow modification from outline controls
 */
ve.ui.OutlineItemWidget = function VeUiOutlineItemWidget( data, config ) {
	// Config intialization
	config = config || {};

	// Parent constructor
	ve.ui.OptionWidget.call( this, data, config );

	// Properties
	this.level = 0;
	this.moveable = !!config.moveable;

	// Initialization
	this.$.addClass( 've-ui-outlineItemWidget' );
	if ( config.icon ) {
		this.$.addClass( 've-ui-icon-' + config.icon );
	}
	this.setLevel( config.level );
};

/* Inheritance */

ve.inheritClass( ve.ui.OutlineItemWidget, ve.ui.OptionWidget );

/* Static Properties */

ve.ui.OutlineItemWidget.static.highlightable = false;

ve.ui.OutlineItemWidget.static.levelClass = 've-ui-outlineItemWidget-level-';

ve.ui.OutlineItemWidget.static.levels = 3;

/* Methods */

/**
 * Check if item is moveable.
 *
 * Moveablilty is used by outline controls.
 *
 * @returns {boolean} Item is moveable
 */
ve.ui.OutlineItemWidget.prototype.isMoveable = function () {
	return this.moveable;
};

/**
 * Get indentation level.
 *
 * @returns {number} Indentation level
 */
ve.ui.OutlineItemWidget.prototype.getLevel = function () {
	return this.level;
};

/**
 * Set indentation level.
 *
 * @method
 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
 * @chainable
 */
ve.ui.OutlineItemWidget.prototype.setLevel = function ( level ) {
	var levels = this.constructor.static.levels,
		levelClass = this.constructor.static.levelClass,
		i = levels;

	this.level = level ? Math.max( 0, Math.min( levels - 1, level ) ) : 0;
	while ( i-- ) {
		if ( this.level === i ) {
			this.$.addClass( levelClass + i );
		} else {
			this.$.removeClass( levelClass + i );
		}
	}

	return this;
};