mediawiki-extensions-Visual.../modules/ve/ui/widgets/ve.ui.SurfaceWidget.js
Ed Sanders e01e2e045b Always use #getDocumentNode.
Because if you only sometimes use a getter you're just wasting your time!

Change-Id: Idd38976f77b58e322d527cecca9f9c36e3ad9318
2013-12-04 22:55:26 +00:00

109 lines
2.3 KiB
JavaScript

/*!
* VisualEditor UserInterface SurfaceWidget class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.SurfaceWidget object.
*
* @class
* @abstract
* @extends OO.ui.Widget
*
* @constructor
* @param {ve.dm.ElementLinearData} data Content data
* @param {Object} [config] Configuration options
* @cfg {Object[]} [tools] Toolbar configuration
* @cfg {string[]} [commands] List of supported commands
*/
ve.ui.SurfaceWidget = function VeUiSurfaceWidget( data, config ) {
// Config intialization
config = config || {};
// Parent constructor
OO.ui.Widget.call( this, config );
// Properties
this.surface = new ve.ui.Surface( data, { '$': this.$ } );
this.toolbar = new ve.ui.Toolbar( this.surface, { '$': this.$ } );
// Initialization
this.surface.$element.addClass( 've-ui-surfaceWidget-surface' );
this.toolbar.$element.addClass( 've-ui-surfaceWidget-toolbar' );
this.$element
.addClass( 've-ui-surfaceWidget' )
.append( this.toolbar.$element, this.surface.$element );
if ( config.tools ) {
this.toolbar.setup( config.tools );
}
if ( config.commands ) {
this.surface.addCommands( config.commands );
}
};
/* Inheritance */
OO.inheritClass( ve.ui.SurfaceWidget, OO.ui.Widget );
/* Methods */
/**
* Get surface.
*
* @method
* @returns {ve.ui.Surface} Surface
*/
ve.ui.SurfaceWidget.prototype.getSurface = function () {
return this.surface;
};
/**
* Get toolbar.
*
* @method
* @returns {OO.ui.Toolbar} Toolbar
*/
ve.ui.SurfaceWidget.prototype.getToolbar = function () {
return this.toolbar;
};
/**
* Get content data.
*
* @method
* @returns {ve.dm.ElementLinearData} Content data
*/
ve.ui.SurfaceWidget.prototype.getContent = function () {
return this.surface.getModel().getDocument().getData();
};
/**
* Initialize surface and toolbar.
*
* Widget must be attached to DOM before initializing.
*
* @method
*/
ve.ui.SurfaceWidget.prototype.initialize = function () {
this.toolbar.initialize();
this.surface.initialize();
this.surface.view.documentView.getDocumentNode().$element.focus();
};
/**
* Destroy surface and toolbar.
*
* @method
*/
ve.ui.SurfaceWidget.prototype.destroy = function () {
if ( this.surface ) {
this.surface.destroy();
}
if ( this.toolbar ) {
this.toolbar.destroy();
}
this.$element.remove();
};