new EditableMathlist(config: [string]:any, target: Element)private
Note
- Method names that begin with an underbar
_
are private and meant to be used only by the implementation of the class. - Method names that end with an underbar
_
are selectors. They can be invoked by callingMathField.$perform()
. They will be dispatched to an instance ofMathEditableList
as necessary. Note that the selector name does not include the underbar.
For example:
mf.$perform('selectAll');
config
:
[string]:any
target
:
Element
A target object passed as the first argument of callback functions. Typically, a MathField.
Properties
root
:
MathAtom[]
The root element of the math expression.
path
:
Object[]
The path to the element that is the anchor for the selection.
extent
:
number
Number of atoms in the selection. 0
if the
selection is collapsed.
config
:
[string]:any
suppressChangeNotifications
:
boolean
If true, the handlers for notification change won't be called.
Methods
_addCell()private
Internal primitive to add a column/row in a matrix
_deleteAtoms()private
Delete sibling atoms
addColumnAfter_()
addColumnBefore_()
addRowAfter_()
addRowBefore_()
ancestor(ancestor: number): MathAtomprivate
ancestor
:
number
distance from self to ancestor.
ancestor
= 0: selfancestor
= 1: parentancestor
= 2: grand-parent- etc...
anchor()private
The atom where the selection starts. When the selection is extended the anchor remains fixed. The anchor could be either before or after the focus.
applyStyle()
Apply a style (color, background) to the selection.
If the style is already applied to the selection, remove it. If the selection has the style partially applied (i.e. only some sections), remove it from those sections, and apply it to the entire selection.
commandOffsets(): objectprivate
Return a {start:, end:}
for the offsets of the command around the insertion
point, or null.
start
is the first atom which is of typecommand
end
is after the last atom of typecommand
commitCommandStringBeforeInsertionPoint(): stringprivate
→ : stringcontains(atom: MathAtom): booleanprivate
atom
:
MathAtom
True if atom
is within the selection range
decorateCommandStringAroundInsertionPoint(value: boolean)private
value
:
boolean
If true, decorate the command string around the insertion point with an error indicator (red dotted underline). If false, remove it.
delete()
Delete multiple characters
delete_(dir: number)
dir
:
number
If the selection is not collapsed, and dir is negative, delete backwards, starting with the anchor atom. That is, delete(-1) will delete only the anchor atom. If dir = 0, delete only if the selection is not collapsed
deleteAll_()
Delete everything in the field
deleteNextChar_()
deleteNextWord_()
deletePreviousChar_()
deletePreviousWord_()
deleteToGroupEnd_()
deleteToGroupStart_()
deleteToMathFieldEnd_()
endOffset()private
Offset of the first atom not included in the selection
i.e. max value of siblings.length
endOffset - startOffset = extent
extend(dist: number)private
Change the range of the selection
dist
:
number
The change (positive or negative) to the extent of the selection. The anchor point does not move.
extendDown_()
If the selection is in a numerator, the selection will be extended to include the denominator.
extendToGroupEnd_()
extendToGroupStart_()
extendToMathFieldEnd_()
Extend the selection to the end of the math field.
extendToMathFieldStart_()
extendToNextBoundary_()
Extend the selection until the next boundary is reached. A boundary
is defined by an atom of a different type (mbin, mord, etc...)
than the current focus. For example, in "1234+x=y", if the focus is between
"1" and "2", invoking extendToNextBoundary_
would extend the selection
to "234".
extendToNextChar_()
extendToNextWord_()
extendToPreviousBoundary_()
Extend the selection until the previous boundary is reached. A boundary
is defined by an atom of a different type (mbin, mord, etc...)
than the current focus. For example, in "1+23456", if the focus is between
"5" and "6", invoking extendToPreviousBoundary
would extend the selection
to "2345".
extendToPreviousChar_()
extendToPreviousWord_()
extendUp_()
If the selection is in a denominator, the selection will be extended to include the numerator.
extractArgBeforeInsertionPoint(): stringprivate
→ : stringextractCommandStringAroundInsertionPoint(): stringprivate
→ : stringfilter(cb: function, dir: number): MathAtom[]private
Iterate over each atom in the expression, starting with the focus.
Return an array of all the paths for which the callback predicate returned true.
cb
:
function
A predicate being passed a path and the atom at this path. Return true to include the designated atom in the result.
dir
:
number
+1
to iterate forward, -1
to iterate backward.
The atoms for which the predicate is true
getSelectedAtoms(): MathAtom[]private
→ : MathAtom[]The currently selected atoms, or null
if the
selection is collapsed
insert(s: string, options: [string]:any)
s
:
string
options
:
[string]:any
options.insertionMode
:
string
- 'replaceSelection' (default)
- 'replaceAll'
- 'insertBefore'
- 'insertAfter'
options.selectionMode
:
string
Describes where the selection will be after the insertion:
'placeholder'
: the selection will be the first available placeholder in the item that has been inserted) (default)'after'
: the selection will be an insertion point after the item that has been inserted),'before'
: the selection will be an insertion point before the item that has been inserted) or 'item' (the item that was inserted will be selected).
options.placeholder
:
string
The placeholder string, if necessary
options.format
:
string
The format of the string s
:
'auto'
: the string is interpreted as a latex fragment or command or ASCIIMath (default)'latex'
: the string is interpreted strictly as a latex fragment
options.smartFence
:
string
If true, promote plain fences, e.g. (
,
as \left...\right
or \mleft...\mright
options.suppressChangeNotifications
:
boolean
If true, the
handlers for the contentWillChange, contentDidChange, selectionWillChange and
selectionDidChange notifications will not be invoked. Default false
.
insertFirstAtom()private
If necessary, insert a first
atom in the sibling list.
If there's already a first
atom, do nothing.
The first
atom is used as a 'placeholder' to hold the blinking caret when
the caret is positioned at the very beginning of the mathlist.
isCollapsed(): boolean
→ : booleanTrue if the selection is an insertion point.
jump()private
Move to the next/previous expression boundary
leap(): booleanprivate
Move to the next/previous placeholder or empty child list.
False if no placeholder found and did not move
moveAfterParent_()
moveBeforeParent_()
moveDown_()
moveToGroupEnd_()
moveToGroupStart_()
moveToMathFieldEnd_()
moveToMathFieldStart_()
moveToNextChar_()
moveToNextPlaceholder_()
moveToNextWord_()
moveToOpposite_()
If cursor is currently in:
- superscript: move to subscript, creating it if necessary
- subscript: move to superscript, creating it if necessary
- numerator: move to denominator
- denominator: move to numerator
- otherwise: move to superscript
moveToPreviousChar_()
moveToPreviousPlaceholder_()
moveToPreviousWord_()
moveToSubscript_()
Switch the cursor to the subscript and select it. If there is no subscript yet, create one.
moveToSuperscript_()
Switch the cursor to the superscript and select it. If there is no subscript yet, create one.
moveUp_()
next()private
Move the anchor to the next permissible atom
selectAll_()
Select all the atoms in the math field.
selectGroup_()
Select all the atoms in the current group, that is all the siblings. When the selection is in a numerator, the group is the numerator. When the selection is a superscript or subscript, the group is the supsub. When the selection is in a text zone, the "group" is a word.
setExtent(extent: number)private
extent
:
number
setRange(from: string[], to: string[], options: object): booleanprivate
Extend the selection between from
and to
nodes
from
:
string[]
to
:
string[]
options
:
object
- options.extendToWordBoundary
true if the range was actually changed
setSelection(offset: number, extent?: number | string, relation: string): booleanprivate
offset
:
number
- >0: index of the child in the group where the selection will start from
- <0: index counting from the end of the group
extent
:
number
|
string
= 0
Number of items in the selection:
- 0: collapsed selection, single insertion point
- >0: selection extending after the offset
- <0: selection extending before the offset
'end'
: selection extending to the end of the group'start'
: selection extending to the beginning of the group
relation
:
string
e.g. 'body'
, 'superscript'
, etc...
False if the relation is invalid (no such children)
sibling(): MathAtomprivate
Sibling, relative to anchor
sibling(0)
= start of selection
sibling(-1)
= sibling immediately left of start offset
siblings(): MathAtom[]private
→ : MathAtom[]array of children of the parent
skip(dir: number, options: [string]:any)private
Move the selection focus to the next/previous point of interest.
A point of interest is an atom of a different type (mbin, mord, etc...)
than the current focus.
If extend
is true, the selection will be extended. Otherwise, it is
collapsed, then moved.
dir
:
number
+1 to skip forward, -1 to skip back
options
:
[string]:any
startOffset()private
Offset of the first atom included in the selection
i.e. =1
=> selection starts with and includes first atom
With expression _x=_ and atoms :
- 0:
- 1: _x_
2: _=_
if caret is before _x_:
start
= 0,end
= 0- if caret is after _x_:
start
= 1,end
= 1 - if _x_ is selected:
start
= 1,end
= 2 - if _x=_ is selected:
start
= 1,end
= 3
toString(): stringprivate
Return a string representation of the selection.
- To Do:
-
- This is a bad name for this function, since it doesn't return a representation of the content, which one might expect...
transpose_()
Swap the characters to either side of the insertion point and advances the insertion point past both of them. Does nothing to a selected range of text.