mediawiki-extensions-Visual.../modules/ve/ui/dialogs/ve.ui.MediaDialog.js

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

/**
 * Document dialog.
 *
 * @class
 * @abstract
 * @extends ve.ui.Dialog
 *
 * @constructor
 * @param {ve.ui.Surface} surface
 * @param {Object} [config] Config options
 */
ve.ui.MediaDialog = function VeUiMediaDialog( surface, config ) {
	// Parent constructor
	ve.ui.Dialog.call( this, surface, config );
};

/* Inheritance */

ve.inheritClass( ve.ui.MediaDialog, ve.ui.Dialog );

/* Static Properties */

ve.ui.MediaDialog.static.titleMessage = 'visualeditor-dialog-media-title';

ve.ui.MediaDialog.static.icon = 'picture';

ve.ui.MediaDialog.static.modelClasses = [ ve.dm.ImageNode ];

/* Methods */

/* Registration */

ve.ui.dialogFactory.register( 'media', ve.ui.MediaDialog );

ve.ui.viewRegistry.register( 'media', ve.ui.MediaDialog );
Media dialog support /index.php Added links to new files VisualEditor.php * Added links to new files * Removed keys of non-existent messages ve.ui.ContentDialog.js, ve.ui.MetaDialog.js * Removed redundant comments ve.ui.MediaDialog.js * New dialog, just for media icons.ai, picture.png, picture.svg, ve.ui.Icons-.css Added picture icon ve.ui.MediaButtonTool.js * New button, just for media (shows up in the context toolbar) ve.ui.DialogButtonTool.js * New base class for dialog buttons ve.ui.Context.js * Added basic support for showing dialog buttons, in addition to annotation buttons, in the context toolbar - to test, select only an image node ve.ui.Dialog.js * Prevent clicks on the click-block from changing focus * Moved initialize to below the event handlers and updated its documentation ve.ui.DialogFactory.js * Added a way to get the names of dialogs that can be used to edit a node ve.ui.Inspector.js * Removed close handler which set focus, this is done already in window ve.ui.InspectorFactory.js * Fixed comment so it's not telling lies anymore ve.ui.Window.js * Removed auto-focus on frame, it's changing the focus in the parent document which blows-away the focus in CE, and it really isn't needed as it turns out VisualEditor.18n.php * Added media dialog title message * Added media tool tooltip message Bug: 37870 Change-Id: I9150c46b3e292910fed899fa60d6da433049ca45 2013-03-28 19:15:17 +00:00			`/*!`
			`* VisualEditor user interface MediaDialog class.`
			`*`
			`* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt`
			`* @license The MIT License (MIT); see LICENSE.txt`
			`*/`

			`/**`
			`* Document dialog.`
			`*`
			`* @class`
			`* @abstract`
			`* @extends ve.ui.Dialog`
			`*`
			`* @constructor`
ve.Editor Objectives: * Split ve.Surface into ve.Editor and ve.ui.Surface * Move actions, triggers and commands to ve.ui * Move toolbar wrapping, floating, shadow and actions functionality to configurable options of ve.ui.Toolbar * Make ve.ce.Surface and ve.ui.Surface inherit ve.Element and use this.$$ for iframe friendliness * Make the toolbar separately initialized so it's possible to have a surface without one, as well as control where the toolbar is Some change notes: VisualEditor.php * Added standalone module for mediawiki integrated unit testing ve.ce.Surface.js * Remove requirement to pass in an attached container to construct object * Inherit ve.Element and use this.$$ instead of $ * Make getSelectionRect iframe friendly * Move most of the initialize stuff to a new initialize method to be called after the surface is attached to the DOM ve.init.mw.ViewPageTarget.js * Merge toolbar functions into setup/teardown methods * Add toolbar manually (since it's not added by the surface anymore) ve.init.sa.Target.js * Update new init procedure for editor, surface and toolbar separately * Move toolbar floating stuff to ve.Toolbar Change-Id: If91a9d6e76a8be8d1b5a2566394765a37d29a8a7 2013-05-14 23:45:42 +00:00			`* @param {ve.ui.Surface} surface`
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-20 22:45:50 +00:00			`* @param {Object} [config] Config options`
Media dialog support /index.php Added links to new files VisualEditor.php * Added links to new files * Removed keys of non-existent messages ve.ui.ContentDialog.js, ve.ui.MetaDialog.js * Removed redundant comments ve.ui.MediaDialog.js * New dialog, just for media icons.ai, picture.png, picture.svg, ve.ui.Icons-.css Added picture icon ve.ui.MediaButtonTool.js * New button, just for media (shows up in the context toolbar) ve.ui.DialogButtonTool.js * New base class for dialog buttons ve.ui.Context.js * Added basic support for showing dialog buttons, in addition to annotation buttons, in the context toolbar - to test, select only an image node ve.ui.Dialog.js * Prevent clicks on the click-block from changing focus * Moved initialize to below the event handlers and updated its documentation ve.ui.DialogFactory.js * Added a way to get the names of dialogs that can be used to edit a node ve.ui.Inspector.js * Removed close handler which set focus, this is done already in window ve.ui.InspectorFactory.js * Fixed comment so it's not telling lies anymore ve.ui.Window.js * Removed auto-focus on frame, it's changing the focus in the parent document which blows-away the focus in CE, and it really isn't needed as it turns out VisualEditor.18n.php * Added media dialog title message * Added media tool tooltip message Bug: 37870 Change-Id: I9150c46b3e292910fed899fa60d6da433049ca45 2013-03-28 19:15:17 +00:00			`*/`
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-20 22:45:50 +00:00			`ve.ui.MediaDialog = function VeUiMediaDialog( surface, config ) {`
Media dialog support /index.php Added links to new files VisualEditor.php * Added links to new files * Removed keys of non-existent messages ve.ui.ContentDialog.js, ve.ui.MetaDialog.js * Removed redundant comments ve.ui.MediaDialog.js * New dialog, just for media icons.ai, picture.png, picture.svg, ve.ui.Icons-.css Added picture icon ve.ui.MediaButtonTool.js * New button, just for media (shows up in the context toolbar) ve.ui.DialogButtonTool.js * New base class for dialog buttons ve.ui.Context.js * Added basic support for showing dialog buttons, in addition to annotation buttons, in the context toolbar - to test, select only an image node ve.ui.Dialog.js * Prevent clicks on the click-block from changing focus * Moved initialize to below the event handlers and updated its documentation ve.ui.DialogFactory.js * Added a way to get the names of dialogs that can be used to edit a node ve.ui.Inspector.js * Removed close handler which set focus, this is done already in window ve.ui.InspectorFactory.js * Fixed comment so it's not telling lies anymore ve.ui.Window.js * Removed auto-focus on frame, it's changing the focus in the parent document which blows-away the focus in CE, and it really isn't needed as it turns out VisualEditor.18n.php * Added media dialog title message * Added media tool tooltip message Bug: 37870 Change-Id: I9150c46b3e292910fed899fa60d6da433049ca45 2013-03-28 19:15:17 +00:00			`// Parent constructor`
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-20 22:45:50 +00:00			`ve.ui.Dialog.call( this, surface, config );`
Media dialog support /index.php Added links to new files VisualEditor.php * Added links to new files * Removed keys of non-existent messages ve.ui.ContentDialog.js, ve.ui.MetaDialog.js * Removed redundant comments ve.ui.MediaDialog.js * New dialog, just for media icons.ai, picture.png, picture.svg, ve.ui.Icons-.css Added picture icon ve.ui.MediaButtonTool.js * New button, just for media (shows up in the context toolbar) ve.ui.DialogButtonTool.js * New base class for dialog buttons ve.ui.Context.js * Added basic support for showing dialog buttons, in addition to annotation buttons, in the context toolbar - to test, select only an image node ve.ui.Dialog.js * Prevent clicks on the click-block from changing focus * Moved initialize to below the event handlers and updated its documentation ve.ui.DialogFactory.js * Added a way to get the names of dialogs that can be used to edit a node ve.ui.Inspector.js * Removed close handler which set focus, this is done already in window ve.ui.InspectorFactory.js * Fixed comment so it's not telling lies anymore ve.ui.Window.js * Removed auto-focus on frame, it's changing the focus in the parent document which blows-away the focus in CE, and it really isn't needed as it turns out VisualEditor.18n.php * Added media dialog title message * Added media tool tooltip message Bug: 37870 Change-Id: I9150c46b3e292910fed899fa60d6da433049ca45 2013-03-28 19:15:17 +00:00			`};`

			`/* Inheritance */`

			`ve.inheritClass( ve.ui.MediaDialog, ve.ui.Dialog );`

			`/* Static Properties */`

			`ve.ui.MediaDialog.static.titleMessage = 'visualeditor-dialog-media-title';`

			`ve.ui.MediaDialog.static.icon = 'picture';`

ve.ui.Context: Add embedding feature Objectives: * Make the context menu display in the top right corner of the currently focused inspectable node (if there is one) * Prevent clicking on anything to do with the toolbar or popup from doing anything at all, ever Bonus: * While we are using the clever feature in jQuery's on method which allows passing boolean false to cancel the event - may as well do that in ve.ui.Dialog as well Changes: ve.ui.FocusableNode * Add ability to specify the focusable element so that dimensions can be derived from it ve.ce.Surface * Add quotes to object keys ve.ui.MediaDialog * Change association from being MW specific to handling images in general ve.ui.Context * Add embedded styles for context * Add embedded mode, which is triggered when the context is a single focusable node, and the node is large enough to fit the context reasonably ve.ui.Dialog * Inline mousedown handler ve.ui.Toolbar, ve.ui.PopupWidget * Cancel stray mousedown events Change-Id: I4b25d33f64b4bcb8a3ecfd7e9728f54a2d4886f3 2013-05-15 23:31:02 +00:00			`ve.ui.MediaDialog.static.modelClasses = [ ve.dm.ImageNode ];`

			`/* Methods */`
Media dialog support /index.php Added links to new files VisualEditor.php * Added links to new files * Removed keys of non-existent messages ve.ui.ContentDialog.js, ve.ui.MetaDialog.js * Removed redundant comments ve.ui.MediaDialog.js * New dialog, just for media icons.ai, picture.png, picture.svg, ve.ui.Icons-.css Added picture icon ve.ui.MediaButtonTool.js * New button, just for media (shows up in the context toolbar) ve.ui.DialogButtonTool.js * New base class for dialog buttons ve.ui.Context.js * Added basic support for showing dialog buttons, in addition to annotation buttons, in the context toolbar - to test, select only an image node ve.ui.Dialog.js * Prevent clicks on the click-block from changing focus * Moved initialize to below the event handlers and updated its documentation ve.ui.DialogFactory.js * Added a way to get the names of dialogs that can be used to edit a node ve.ui.Inspector.js * Removed close handler which set focus, this is done already in window ve.ui.InspectorFactory.js * Fixed comment so it's not telling lies anymore ve.ui.Window.js * Removed auto-focus on frame, it's changing the focus in the parent document which blows-away the focus in CE, and it really isn't needed as it turns out VisualEditor.18n.php * Added media dialog title message * Added media tool tooltip message Bug: 37870 Change-Id: I9150c46b3e292910fed899fa60d6da433049ca45 2013-03-28 19:15:17 +00:00
			`/* Registration */`

			`ve.ui.dialogFactory.register( 'media', ve.ui.MediaDialog );`
UI "Views" refactor Objective: Make it possible for inspectors to inspect nodes or annotations, rather than only annotations. Meanwhile, also make it possible for dialogs to edit an annotation. Strategy: Switch from using type patterns to associate inspectors with annotations to using arrays of classes, similar to how dialogs already work. Introduce a view registry which provides lookups for relationships between models and views. This is more centralized and less repetitive than implement matching functions for both annotations and nodes in both the dialog and inspector factories. Changes: .php Added links to new file ve.AnnotationAction.js * Removed unused parameter to filter annotations using a string or regexp ve.dm.AnnotationSet.js * Switched from property/value arguments to callbacks ve.ui.(Dialog\|Inspector).js Replaced type patterns with class lists * Added class to view registry ve.ui.Tool.js, ve.ui.Context.js Updated model/view relationship lookup ve.ui.Factory.js Removed overly-specific lookup functions ve.ui.Inspector.js * Removed typePattern property * Updated model/view relationship lookup ve.ui.ViewRegistry.js * New class! * Migrated node and annotation lookup functions from factories Change-Id: Ic2bbcf072fdd87e5ce8a03fe1ae3e6d8d50e2593 2013-04-15 21:35:32 +00:00
			`ve.ui.viewRegistry.register( 'media', ve.ui.MediaDialog );`