Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7407168
ve.ce.View.js
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
4 KB
Referenced Files
None
Subscribers
None
ve.ce.View.js
View Options
/*!
* VisualEditor ContentEditable View class.
*
* @copyright See AUTHORS.txt
*/
/**
* Generic base class for CE views.
*
* @abstract
* @extends OO.ui.Element
* @mixes OO.EventEmitter
*
* @constructor
* @param {ve.dm.Model} model Model to observe
* @param {Object} [config] Configuration options
*/
ve
.
ce
.
View
=
function
VeCeView
(
model
,
config
=
{}
)
{
// Setting this property before calling the parent constructor allows overridden #getTagName
// methods in view classes to have access to the model when they are called for the first time
// inside of OO.ui.Element
this
.
model
=
model
;
// Parent constructor
ve
.
ce
.
View
.
super
.
call
(
this
,
config
);
// Mixin constructors
OO
.
EventEmitter
.
call
(
this
);
// Properties
this
.
live
=
false
;
// Events
this
.
connect
(
this
,
{
setup
:
'onSetup'
,
teardown
:
'onTeardown'
}
);
// Initialize
this
.
initialize
();
};
/* Inheritance */
OO
.
inheritClass
(
ve
.
ce
.
View
,
OO
.
ui
.
Element
);
OO
.
mixinClass
(
ve
.
ce
.
View
,
OO
.
EventEmitter
);
/* Events */
/**
* @event ve.ce.View#setup
*/
/**
* @event ve.ce.View#teardown
*/
/* Static members */
/**
* Allowed attributes for DOM elements, in the same format as ve.dm.Model#preserveHtmlAttributes
*
* This list includes attributes that are generally safe to include in HTML loaded from a
* foreign source and displaying it inside the browser. It doesn't include any event attributes,
* for instance, which would allow arbitrary JavaScript execution. This alone is not enough to
* make HTML safe to display, but it helps.
*
* TODO: Rather than use a single global list, set these on a per-view basis to something that makes
* sense for that view in particular.
*
* @static
* @property {boolean|Function}
* @param {string} attribute
* @return {boolean} Attibute is allowed
* @inheritable
*/
ve
.
ce
.
View
.
static
.
renderHtmlAttributes
=
function
(
attribute
)
{
const
attributes
=
[
'abbr'
,
'about'
,
'align'
,
'alt'
,
'axis'
,
'bgcolor'
,
'border'
,
'cellpadding'
,
'cellspacing'
,
'char'
,
'charoff'
,
'cite'
,
'class'
,
'clear'
,
'color'
,
'colspan'
,
'datatype'
,
'datetime'
,
'dir'
,
'face'
,
'frame'
,
'headers'
,
'height'
,
'href'
,
'id'
,
'itemid'
,
'itemprop'
,
'itemref'
,
'itemscope'
,
'itemtype'
,
'lang'
,
'noshade'
,
'nowrap'
,
'property'
,
'rbspan'
,
'rel'
,
'resource'
,
'rev'
,
'rowspan'
,
'rules'
,
'scope'
,
'size'
,
'span'
,
'src'
,
'start'
,
'style'
,
'summary'
,
'title'
,
'type'
,
'typeof'
,
'valign'
,
'value'
,
'width'
];
return
attributes
.
includes
(
attribute
);
};
/* Methods */
/**
* Get an HTML document from the model, to use for URL resolution.
*
* The default implementation returns null; subclasses should override this if they can provide
* a resolution document.
*
* @see #getResolvedAttribute
* @return {HTMLDocument|null} HTML document to use for resolution, or null if not available
*/
ve
.
ce
.
View
.
prototype
.
getModelHtmlDocument
=
function
()
{
return
null
;
};
/**
* Initialize this.$element. This is called by the constructor and should be called every time
* this.$element is replaced.
*/
ve
.
ce
.
View
.
prototype
.
initialize
=
function
()
{
if
(
this
.
model
.
element
&&
this
.
model
.
element
.
originalDomElementsHash
!==
undefined
)
{
// Render attributes from original DOM elements
ve
.
dm
.
Converter
.
static
.
renderHtmlAttributeList
(
this
.
model
.
getOriginalDomElements
(),
this
.
$element
,
this
.
constructor
.
static
.
renderHtmlAttributes
,
// Computed
true
,
// Deep
!
(
this
.
model
instanceof
ve
.
dm
.
Node
)
||
!
this
.
model
.
canHaveChildren
()
||
this
.
model
.
handlesOwnChildren
()
);
}
};
/**
* Handle setup event.
*/
ve
.
ce
.
View
.
prototype
.
onSetup
=
function
()
{
this
.
$element
.
data
(
'view'
,
this
);
};
/**
* Handle teardown event.
*/
ve
.
ce
.
View
.
prototype
.
onTeardown
=
function
()
{
this
.
$element
.
removeData
(
'view'
);
};
/**
* Get the model the view observes.
*
* @return {ve.dm.Model} Model the view observes
*/
ve
.
ce
.
View
.
prototype
.
getModel
=
function
()
{
return
this
.
model
;
};
/**
* Check if the view is attached to the live DOM.
*
* @return {boolean} View is attached to the live DOM
*/
ve
.
ce
.
View
.
prototype
.
isLive
=
function
()
{
return
this
.
live
;
};
/**
* Set live state.
*
* @param {boolean} live The view has been attached to the live DOM (use false on detach)
* @fires ve.ce.View#setup
* @fires ve.ce.View#teardown
*/
ve
.
ce
.
View
.
prototype
.
setLive
=
function
(
live
)
{
this
.
live
=
live
;
if
(
this
.
live
)
{
this
.
emit
(
'setup'
);
}
else
{
this
.
emit
(
'teardown'
);
}
};
/**
* Get a resolved URL from a model attribute.
*
* @param {string} key Attribute name whose value is a URL
* @return {string} URL resolved according to the document's base
*/
ve
.
ce
.
View
.
prototype
.
getResolvedAttribute
=
function
(
key
)
{
const
plainValue
=
this
.
model
.
getAttribute
(
key
),
doc
=
this
.
getModelHtmlDocument
();
return
doc
&&
typeof
plainValue
===
'string'
?
ve
.
resolveUrl
(
plainValue
,
doc
)
:
plainValue
;
};
/**
* Release all memory.
*/
ve
.
ce
.
View
.
prototype
.
destroy
=
function
()
{
this
.
disconnect
(
this
);
this
.
model
.
disconnect
(
this
);
this
.
model
=
null
;
};
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sat, Nov 21, 20:48 (1 d, 13 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ea/37/11fcf39be5a893a8586c01651dc4
Default Alt Text
ve.ce.View.js (4 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment