Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7423011
ve.ui.TargetWidget.js
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
7 KB
Referenced Files
None
Subscribers
None
ve.ui.TargetWidget.js
View Options
/*!
* VisualEditor UserInterface TargetWidget class.
*
* @copyright See AUTHORS.txt
*/
/**
* Creates an ve.ui.TargetWidget object.
*
* User must call #initialize after the widget has been attached
* to the DOM, and also after the document is changed with #setDocument.
*
* @class
* @abstract
* @extends OO.ui.Widget
* @mixes OO.ui.mixin.PendingElement
*
* @constructor
* @param {Object} [config] Configuration options
* @param {ve.dm.Document} [config.doc] Initial document model
* @param {Object} [config.modes] Available editing modes.
* @param {Object} [config.defaultMode] Default mode for new surfaces.
* @param {Object} [config.toolbarGroups] Target's toolbar groups config.
* @param {string[]|null} [config.includeCommands] List of commands to include, null for all registered commands
* @param {string[]} [config.excludeCommands] List of commands to exclude
* @param {Object} [config.importRules] Import rules
* @param {Object} [config.allowTabFocusChange=true] Allow changing focus form the surface with tab/shift+tab.
* Unlike in a normal Target, this defaults to `true` in a TargetWidget.
* @param {boolean} [config.multiline=true] Multi-line surface
* @param {string} [config.placeholder] Placeholder text to display when the surface is empty
* @param {boolean} [config.readOnly] Surface is read-only
* @param {string} [config.inDialog] The name of the dialog this surface widget is in
*/
ve
.
ui
.
TargetWidget
=
function
VeUiTargetWidget
(
config
=
{}
)
{
// Parent constructor
ve
.
ui
.
TargetWidget
.
super
.
call
(
this
,
config
);
// Mixin constructor
OO
.
ui
.
mixin
.
PendingElement
.
call
(
this
,
config
);
// Properties
this
.
toolbarGroups
=
config
.
toolbarGroups
;
// TODO: Override document/targetTriggerListener
this
.
includeCommands
=
config
.
includeCommands
;
this
.
excludeCommands
=
config
.
excludeCommands
;
this
.
multiline
=
config
.
multiline
!==
false
;
this
.
placeholder
=
config
.
placeholder
;
this
.
readOnly
=
config
.
readOnly
;
this
.
importRules
=
config
.
importRules
;
this
.
allowTabFocusChange
=
config
.
allowTabFocusChange
!==
false
;
this
.
inDialog
=
config
.
inDialog
;
this
.
modes
=
config
.
modes
;
this
.
defaultMode
=
config
.
defaultMode
;
this
.
target
=
this
.
createTarget
();
if
(
config
.
doc
)
{
this
.
setDocument
(
config
.
doc
);
}
// Initialization
this
.
$element
.
addClass
(
've-ui-targetWidget'
)
.
append
(
this
.
target
.
$element
);
};
/* Inheritance */
OO
.
inheritClass
(
ve
.
ui
.
TargetWidget
,
OO
.
ui
.
Widget
);
OO
.
mixinClass
(
ve
.
ui
.
TargetWidget
,
OO
.
ui
.
mixin
.
PendingElement
);
/* Methods */
/**
* The target's surface has been changed.
*
* @event ve.ui.TargetWidget#change
*/
/**
* The target's surface has been submitted, e.g. Ctrl+Enter
*
* @event ve.ui.TargetWidget#submit
*/
/**
* The target's surface has been cancelled, e.g. Escape
*
* @event ve.ui.TargetWidget#cancel
*/
/**
* A document has been attached to the target, and a toolbar and surface created.
*
* @event ve.ui.TargetWidget#setup
*/
/**
* Create the target for this widget to use
*
* @return {ve.init.Target}
*/
ve
.
ui
.
TargetWidget
.
prototype
.
createTarget
=
function
()
{
return
new
ve
.
init
.
Target
(
{
register
:
false
,
toolbarGroups
:
this
.
toolbarGroups
,
modes
:
this
.
modes
,
defaultMode
:
this
.
defaultMode
}
);
};
/**
* Set the document to edit
*
* This replaces the entire surface in the target.
*
* @param {ve.dm.Document} doc
* @fires ve.ui.TargetWidget#change
* @fires ve.ui.TargetWidget#setup
* @fires ve.ce.Surface#position
*/
ve
.
ui
.
TargetWidget
.
prototype
.
setDocument
=
function
(
doc
)
{
// Destroy the previous surface
this
.
clear
();
const
surface
=
this
.
target
.
addSurface
(
doc
,
{
inTargetWidget
:
true
,
includeCommands
:
this
.
includeCommands
,
excludeCommands
:
this
.
excludeCommands
,
importRules
:
this
.
importRules
,
allowTabFocusChange
:
this
.
allowTabFocusChange
,
multiline
:
this
.
multiline
,
placeholder
:
this
.
placeholder
,
readOnly
:
this
.
readOnly
,
// Reduce from default 10 so inspector callouts are positioned correctly
overlayPadding
:
5
,
inDialog
:
this
.
inDialog
}
);
this
.
target
.
setSurface
(
surface
);
// Events
surface
.
getView
().
connect
(
this
,
{
activation
:
'onFocusChange'
,
focus
:
'onFocusChange'
,
blur
:
'onFocusChange'
}
);
// Rethrow as target events so users don't have to re-bind when the surface is changed
surface
.
getModel
().
connect
(
this
,
{
history
:
[
'emit'
,
'change'
]
}
);
surface
.
connect
(
this
,
{
submit
:
'onSurfaceSubmit'
,
cancel
:
'onSurfaceCancel'
}
);
// Emit 'position' on first focus, as target widgets are often setup before being made visible. (T303795)
surface
.
getView
().
once
(
'focus'
,
()
=>
{
surface
.
getView
().
emit
(
'position'
);
}
);
this
.
emit
(
'setup'
);
};
/**
* Handle surface submit events
*
* @fires ve.ui.TargetWidget#submit
*/
ve
.
ui
.
TargetWidget
.
prototype
.
onSurfaceSubmit
=
function
()
{
const
handled
=
this
.
emit
(
'submit'
);
if
(
!
handled
&&
this
.
inDialog
)
{
// If we are in a dialog, re-throw a fake keydown event for OO.ui.Dialog#onDialogKeyDown
this
.
$element
.
parent
().
trigger
(
$
.
Event
(
'keydown'
,
{
which
:
OO
.
ui
.
Keys
.
ENTER
,
ctrlKey
:
true
}
)
);
}
};
/**
* Handle surface cancel events
*
* @fires ve.ui.TargetWidget#cancel
*/
ve
.
ui
.
TargetWidget
.
prototype
.
onSurfaceCancel
=
function
()
{
const
handled
=
this
.
emit
(
'cancel'
);
if
(
!
handled
&&
this
.
inDialog
)
{
// If we are in a dialog, re-throw a fake keydown event for OO.ui.Dialog#onDialogKeyDown
this
.
$element
.
parent
().
trigger
(
$
.
Event
(
'keydown'
,
{
which
:
OO
.
ui
.
Keys
.
ESCAPE
}
)
);
}
};
/**
* Check if the surface has been modified.
*
* @return {boolean} The surface has been modified
*/
ve
.
ui
.
TargetWidget
.
prototype
.
hasBeenModified
=
function
()
{
return
!!
this
.
getSurface
()
&&
this
.
getSurface
().
getModel
().
hasBeenModified
();
};
/**
* Set the read-only state of the widget
*
* @param {boolean} readOnly Make widget read-only
*/
ve
.
ui
.
TargetWidget
.
prototype
.
setReadOnly
=
function
(
readOnly
)
{
this
.
readOnly
=
!!
readOnly
;
if
(
this
.
getSurface
()
)
{
this
.
getSurface
().
setReadOnly
(
this
.
readOnly
);
}
this
.
$element
.
toggleClass
(
've-ui-targetWidget-readOnly'
,
this
.
readOnly
);
};
/**
* Check if the widget is read-only
*
* @return {boolean}
*/
ve
.
ui
.
TargetWidget
.
prototype
.
isReadOnly
=
function
()
{
return
this
.
readOnly
;
};
/**
* Get surface.
*
* @return {ve.ui.Surface|null}
*/
ve
.
ui
.
TargetWidget
.
prototype
.
getSurface
=
function
()
{
return
this
.
target
.
getSurface
();
};
/**
* Get toolbar.
*
* @return {OO.ui.Toolbar}
*/
ve
.
ui
.
TargetWidget
.
prototype
.
getToolbar
=
function
()
{
return
this
.
target
.
getToolbar
();
};
/**
* Get content data.
*
* @return {Array} Content data
*/
ve
.
ui
.
TargetWidget
.
prototype
.
getContent
=
function
()
{
return
this
.
getSurface
().
getModel
().
getDocument
().
getData
();
};
/**
* Initialize surface and toolbar.
*
* Widget must be attached to DOM before initializing.
*
* @deprecated
*/
ve
.
ui
.
TargetWidget
.
prototype
.
initialize
=
function
()
{
OO
.
ui
.
warnDeprecation
(
've.ui.TargetWidget#initialize is deprecated and no longer needed.'
);
};
/**
* Destroy surface and toolbar.
*/
ve
.
ui
.
TargetWidget
.
prototype
.
clear
=
function
()
{
this
.
target
.
clearSurfaces
();
// Clear toolbar?
};
/**
* Handle focus and blur events
*/
ve
.
ui
.
TargetWidget
.
prototype
.
onFocusChange
=
function
()
{
// This may be null if the target is in the process of being destroyed
const
surface
=
this
.
getSurface
();
// Replacement for the :focus pseudo selector one would be able to
// use on a regular input widget
this
.
$element
.
toggleClass
(
've-ui-targetWidget-focused'
,
surface
&&
surface
.
getView
().
isFocused
()
&&
!
surface
.
getView
().
isDeactivated
()
);
};
/**
* Focus the surface.
*/
ve
.
ui
.
TargetWidget
.
prototype
.
focus
=
function
()
{
const
surface
=
this
.
getSurface
();
if
(
surface
)
{
if
(
!
surface
.
getView
().
attachedRoot
.
isLive
()
)
{
surface
.
once
(
'ready'
,
()
=>
{
surface
.
getView
().
focus
();
}
);
}
else
{
surface
.
getView
().
focus
();
}
}
};
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Nov 22, 06:19 (9 h, 15 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
84/83/913df80f71540d3a66ffaa79953c
Default Alt Text
ve.ui.TargetWidget.js (7 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment