mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Action.js
Trevor Parscal 2e76271b4e The Great ve.ui.Surface refactor of 2013
Prologue:

Farewell ve.Editor my good chap… Oh, hey there HTML frames - I didn't
see you there! In a world where iframes are outlaws, and symbols like
document and window are global, there were more than a few assumptions
about which document or window was being used. But fear not - for this
commit (probably) tracks them all down, leaving a trail of
iframe-compatible awesomeness in its wake. With the great ve.ui.Surface
now able to be used inside of iframes, let the reference editing
commence. But there, lurking in the darkness is a DM issue so fierce it
may take Roan and/or Ed up to 3 whole hours to sort it out.

Note to Roan and/or Ed:

Editing references seems to work fine, but when saving the page there
are "no changes" which is a reasonable indication to the contrary.

Objectives:

* Make it possible to have multiple surfaces be instantiated, get along
  nicely, and be embedded inside of iframes if needed.
* Make reference content editable within a dialog

Approach:

* Move what's left of ve.Editor to ve.ui.Surface and essentially
  obliterate all use of it
* Make even more stuff inherit from ve.Element (long live this.$$)
* Use the correct document or window anywhere it was being assumed to be
  the top level one
* Resolve stacking order issues by removing the excessive use of z-index
  and introducing global and local overlay elements for each editor
* Add a surface to the reference dialog, load up the reference contents
  and save them back on apply
* Actually destroy what we create in ce and ui surfaces
* Add recursive frame offset calculation method to ve.Element
* Moved ve.ce.Surface's getSelectionRect method to the prototype

Bonus:

* Move ve.ce.DocumentNode.css contents to ve.ce.Node.css (not sure why it
  was separate in the first place, but I'm likely the one to blame)
* Fix blatant lies in documentation
* Whitespace cleanup here and there
* Get rid of ve.ui.Window overlays - not used or needed

Change-Id: Iede83e7d24f7cb249b6ba3dc45d770445b862e08
2013-05-24 14:01:02 +02:00

49 lines
1.3 KiB
JavaScript

/*!
* VisualEditor UserInterface Action class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Generic action.
*
* An action is built around a surface for one-time use. It is a generic way of extending the
* functionality of a surface. Actions are accessible via {ve.ui.Surface.prototype.execute}.
*
* @class
*
* @constructor
* @param {ve.ui.Surface} surface Surface to act on
*/
ve.ui.Action = function VeUiAction( surface ) {
// Properties
this.surface = surface;
};
/* Static Properties */
/**
* @static
* @property
* @inheritable
*/
ve.ui.Action.static = {};
/**
* List of allowed methods for the action.
*
* To avoid use of methods not intended to be executed via surface.execute(), the methods must be
* whitelisted here. This information is checked by ve.ui.Surface before executing an action.
*
* If a method returns a value, it will be cast to boolean and be used to determine if the action
* was canceled. Not returning anything, or returning undefined will be treated the same as
* returning true. A canceled action will yield to other default behavior. For example, when
* triggering an action from a keystroke, a canceled action will allow normal insertion behavior to
* be carried out.
*
* @static
* @property
*/
ve.ui.Action.static.methods = [];