mediawiki-extensions-Visual.../modules/ve/ui/layouts/ve.ui.StackPanelLayout.js
Trevor Parscal ef262dc241 Add padded option to layouts
Objectives:

* Add option to layouts to control whether it's padded or not
* Rename "scroll" option to "scrollable" to better fit with it's boolean value

Changes:

ve.ui.Layout.css
* Add styles for scrollable and padded options

ve.ui.StackPanelLayout.js, ve.ui.PagedDialog.js, ve.ui.ReferenceListDialog.js
* Update use of scroll option

ve.ui.PanelLayout.js
* Add padded option
* Rename scroll option to scrollable
* Switch to using a class for scrollable option, rather than hardcoding CSS properties

Change-Id: I50e996b9d2fde361238cde75e09baa5872e12223
2013-07-17 19:10:44 +00:00

121 lines
2.5 KiB
JavaScript

/*!
* VisualEditor UserInterface StackPanelLayout class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Stack panel layout.
*
* @class
* @extends ve.ui.PanelLayout
* @mixins ve.ui.GroupElement
*
* @constructor
* @param {Object} [config] Config options
* @cfg {string} [icon=''] Symbolic icon name
*/
ve.ui.StackPanelLayout = function VeUiStackPanelLayout( config ) {
// Config initialization
config = ve.extendObject( config, { 'scrollable': true } );
// Parent constructor
ve.ui.PanelLayout.call( this, config );
// Mixin constructors
ve.ui.GroupElement.call( this, this.$, config );
// Properties
this.currentItem = null;
// Initialization
this.$.addClass( 've-ui-stackPanelLayout' );
};
/* Inheritance */
ve.inheritClass( ve.ui.StackPanelLayout, ve.ui.PanelLayout );
ve.mixinClass( ve.ui.StackPanelLayout, ve.ui.GroupElement );
/* Methods */
/**
* Add items.
*
* Adding an existing item (by value) will move it.
*
* @method
* @param {ve.ui.PanelLayout[]} items Items to add
* @param {number} [index] Index to insert items after
* @chainable
*/
ve.ui.StackPanelLayout.prototype.addItems = function ( items, index ) {
var i, len;
for ( i = 0, len = items.length; i < len; i++ ) {
if ( !this.currentItem ) {
this.showItem( items[i] );
} else {
items[i].$.hide();
}
}
ve.ui.GroupElement.prototype.addItems.call( this, items, index );
return this;
};
/**
* Remove items.
*
* Items will be detached, not removed, so they can be used later.
*
* @method
* @param {ve.ui.PanelLayout[]} items Items to remove
* @chainable
*/
ve.ui.StackPanelLayout.prototype.removeItems = function ( items ) {
ve.ui.GroupElement.prototype.removeItems.call( this, items );
if ( items.indexOf( this.currentItem ) !== -1 ) {
this.currentItem = null;
if ( !this.currentItem && this.items.length ) {
this.showItem( this.items[0] );
}
}
return this;
};
/**
* Clear all items.
*
* Items will be detached, not removed, so they can be used later.
*
* @method
* @chainable
*/
ve.ui.StackPanelLayout.prototype.clearItems = function () {
this.currentItem = null;
ve.ui.GroupElement.prototype.clearItems.call( this );
return this;
};
/**
* Show item.
*
* Any currently shown item will be hidden.
*
* @method
* @param {ve.ui.PanelLayout} item Item to show
* @chainable
*/
ve.ui.StackPanelLayout.prototype.showItem = function ( item ) {
this.$items.hide();
item.$.show();
this.currentItem = item;
return this;
};