Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7415915
ve.ui.CommandHelpDialog.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.CommandHelpDialog.js
View Options
/*!
* VisualEditor UserInterface CommandHelpDialog class.
*
* @copyright See AUTHORS.txt
*/
/**
* Dialog for listing all command keyboard shortcuts.
*
* @class
* @extends OO.ui.ProcessDialog
*
* @constructor
* @param {Object} [config] Configuration options
*/
ve
.
ui
.
CommandHelpDialog
=
function
VeUiCommandHelpDialog
(
config
)
{
// Parent constructor
ve
.
ui
.
CommandHelpDialog
.
super
.
call
(
this
,
config
);
};
/* Inheritance */
OO
.
inheritClass
(
ve
.
ui
.
CommandHelpDialog
,
OO
.
ui
.
ProcessDialog
);
/* Static Properties */
ve
.
ui
.
CommandHelpDialog
.
static
.
name
=
'commandHelp'
;
ve
.
ui
.
CommandHelpDialog
.
static
.
size
=
'larger'
;
ve
.
ui
.
CommandHelpDialog
.
static
.
title
=
OO
.
ui
.
deferMsg
(
'visualeditor-dialog-command-help-title'
);
ve
.
ui
.
CommandHelpDialog
.
static
.
actions
=
[
{
label
:
OO
.
ui
.
deferMsg
(
'visualeditor-dialog-action-done'
),
flags
:
[
'safe'
,
'close'
]
}
];
ve
.
ui
.
CommandHelpDialog
.
static
.
commandGroups
=
{
textStyle
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-text-style'
),
promote
:
[
'bold'
,
'italic'
,
'link'
],
demote
:
[
'clear'
]
},
clipboard
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-clipboard'
)
},
formatting
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-formatting'
),
promote
:
[
'paragraph'
,
'pre'
,
'blockquote'
]
},
history
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-history'
),
promote
:
[
'undo'
,
'redo'
]
},
dialog
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-dialog'
)
},
other
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-other'
),
promote
:
[
'findAndReplace'
,
'findNext'
,
'findPrevious'
],
demote
:
[
'commandHelp'
]
},
insert
:
{
title
:
OO
.
ui
.
deferMsg
(
'visualeditor-shortcuts-insert'
)
}
};
ve
.
ui
.
CommandHelpDialog
.
static
.
commandGroupsOrder
=
[
'textStyle'
,
'clipboard'
,
'formatting'
,
'history'
,
'dialog'
,
'other'
,
'insert'
];
/* Methods */
/**
* @inheritdoc
*/
ve
.
ui
.
CommandHelpDialog
.
prototype
.
getBodyHeight
=
function
()
{
return
Math
.
round
(
this
.
contentLayout
.
$element
[
0
].
scrollHeight
);
};
/**
* @inheritdoc
*/
ve
.
ui
.
CommandHelpDialog
.
prototype
.
initialize
=
function
()
{
// Parent method
ve
.
ui
.
CommandHelpDialog
.
super
.
prototype
.
initialize
.
call
(
this
);
this
.
contentLayout
=
new
OO
.
ui
.
PanelLayout
(
{
scrollable
:
true
,
padded
:
true
,
expanded
:
false
}
);
this
.
$container
=
$
(
'<div>'
).
addClass
(
've-ui-commandHelpDialog-container'
);
this
.
contentLayout
.
$element
.
append
(
this
.
$container
);
this
.
$body
.
append
(
this
.
contentLayout
.
$element
);
};
/**
* @inheritdoc
*/
ve
.
ui
.
CommandHelpDialog
.
prototype
.
getSetupProcess
=
function
(
data
)
{
return
ve
.
ui
.
CommandHelpDialog
.
super
.
prototype
.
getSetupProcess
.
call
(
this
,
data
)
.
next
(
()
=>
{
const
surface
=
data
.
surface
,
target
=
surface
.
getTarget
(),
sequenceRegistry
=
surface
.
sequenceRegistry
,
commandRegistry
=
surface
.
commandRegistry
,
availableCommands
=
surface
.
getCommands
()
.
concat
(
target
.
constructor
.
static
.
documentCommands
)
.
concat
(
target
.
constructor
.
static
.
targetCommands
),
commandGroups
=
this
.
constructor
.
static
.
commandGroups
,
commandGroupsOrder
=
this
.
constructor
.
static
.
commandGroupsOrder
;
this
.
$container
.
empty
();
commandGroupsOrder
.
forEach
(
(
groupName
)
=>
{
let
hasCommand
=
false
;
const
commandGroup
=
commandGroups
[
groupName
];
const
commands
=
this
.
constructor
.
static
.
sortedCommandsFromGroup
(
groupName
,
commandGroup
.
promote
,
commandGroup
.
demote
);
const
$list
=
$
(
'<dl>'
).
addClass
(
've-ui-commandHelpDialog-list'
);
commands
.
forEach
(
(
command
)
=>
{
let
triggerList
;
if
(
command
.
trigger
)
{
if
(
!
command
.
ignoreCommand
&&
(
!
availableCommands
.
includes
(
command
.
trigger
)
||
!
commandRegistry
.
lookup
(
command
.
trigger
)
)
)
{
// Trigger is specified by unavailable command
return
;
}
triggerList
=
ve
.
ui
.
triggerRegistry
.
lookup
(
command
.
trigger
);
}
else
{
triggerList
=
[];
if
(
command
.
shortcuts
)
{
if
(
command
.
checkCommand
&&
(
!
availableCommands
.
includes
(
command
.
checkCommand
)
||
!
commandRegistry
.
lookup
(
command
.
checkCommand
)
)
)
{
// 'checkCommand' is not available
return
;
}
triggerList
=
command
.
shortcuts
.
map
(
(
shortcut
)
=>
new
ve
.
ui
.
Trigger
(
shortcut
,
true
)
);
}
}
let
hasShortcut
=
false
;
const
$shortcut
=
$
(
'<dt>'
);
triggerList
.
forEach
(
(
trigger
)
=>
{
if
(
surface
.
doesAllowTabFocusChange
()
)
{
const
triggerString
=
trigger
.
toString
();
if
(
triggerString
===
'tab'
||
triggerString
===
'shift+tab'
)
{
return
;
}
}
// Append an array of jQuery collections from buildKeyNode
// eslint-disable-next-line no-jquery/no-append-html
$shortcut
.
append
(
$
(
'<kbd>'
).
addClass
(
've-ui-commandHelpDialog-shortcut'
).
append
(
trigger
.
getMessage
(
true
).
map
(
this
.
constructor
.
static
.
buildKeyNode
)
).
find
(
'kbd + kbd'
).
before
(
'+'
).
end
()
);
hasShortcut
=
true
;
}
);
if
(
command
.
sequences
)
{
command
.
sequences
.
forEach
(
(
sequenceName
)
=>
{
const
sequence
=
sequenceRegistry
.
lookup
(
sequenceName
);
if
(
sequence
)
{
// Append an array of jQuery collections from buildKeyNode
// eslint-disable-next-line no-jquery/no-append-html
$shortcut
.
append
(
$
(
'<kbd>'
).
addClass
(
've-ui-commandHelpDialog-sequence'
)
.
attr
(
'data-label'
,
ve
.
msg
(
'visualeditor-shortcuts-sequence-notice'
)
)
.
append
(
sequence
.
getMessage
(
true
).
map
(
this
.
constructor
.
static
.
buildKeyNode
)
)
);
hasShortcut
=
true
;
}
}
);
}
if
(
hasShortcut
)
{
$list
.
append
(
$shortcut
,
$
(
'<dd>'
).
text
(
OO
.
ui
.
resolveMsg
(
command
.
label
)
)
);
hasCommand
=
true
;
}
}
);
if
(
hasCommand
)
{
this
.
$container
.
append
(
$
(
'<div>'
)
.
addClass
(
've-ui-commandHelpDialog-section'
)
.
append
(
$
(
'<h3>'
).
text
(
OO
.
ui
.
resolveMsg
(
commandGroup
.
title
)
),
$list
)
);
}
}
);
}
);
};
/* Static methods */
/**
* Wrap a key (as provided by a Trigger) in a node, for display
*
* @static
* @param {string} key Key to display
* @return {jQuery} A kbd wrapping the key text
*/
ve
.
ui
.
CommandHelpDialog
.
static
.
buildKeyNode
=
function
(
key
)
{
const
$key
=
$
(
'<kbd>'
);
if
(
key
===
' '
)
{
// Might need to expand this if other keys show up, but currently things like
// the tab-character only come from Triggers and are pre-localized there into
// "tab" anyway.
key
=
(
new
ve
.
ui
.
Trigger
(
'space'
)
).
getMessage
();
$key
.
addClass
(
've-ui-commandHelpDialog-specialKey'
);
}
return
$key
.
text
(
key
);
};
/**
* Extract a properly sorted list of commands from a command-group
*
* @static
* @param {string} groupName The dialog-category in which to display this
* @param {string[]} [promote] Commands which should be displayed first
* @param {string[]} [demote] Commands which should be displayed last
* @return {Object[]} List of commands in order
*/
ve
.
ui
.
CommandHelpDialog
.
static
.
sortedCommandsFromGroup
=
function
(
groupName
,
promote
,
demote
)
{
const
commands
=
ve
.
ui
.
commandHelpRegistry
.
lookupByGroup
(
groupName
),
keys
=
Object
.
keys
(
commands
),
used
=
{},
auto
=
[],
promoted
=
[],
demoted
=
[];
keys
.
sort
();
if
(
promote
)
{
promote
.
forEach
(
(
name
)
=>
{
if
(
!
commands
[
name
]
)
{
return
;
}
promoted
.
push
(
commands
[
name
]
);
used
[
name
]
=
true
;
}
);
}
if
(
demote
)
{
demote
.
forEach
(
(
name
)
=>
{
if
(
used
[
name
]
||
!
commands
[
name
]
)
{
return
;
}
demoted
.
push
(
commands
[
name
]
);
used
[
name
]
=
true
;
}
);
}
keys
.
forEach
(
(
name
)
=>
{
if
(
used
[
name
]
)
{
return
;
}
auto
.
push
(
commands
[
name
]
);
}
);
promoted
.
push
(
...
auto
,
...
demoted
);
return
promoted
;
};
/* Registration */
ve
.
ui
.
windowFactory
.
register
(
ve
.
ui
.
CommandHelpDialog
);
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Nov 22, 02:26 (1 d, 11 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5e/66/dd3b66e97cf5ff80a37ee68ee3df
Default Alt Text
ve.ui.CommandHelpDialog.js (7 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment