History
modules/history.History
The module monitors the status of the editor and creates / deletes the required number of Undo / Redo shots .
Hierarchy
-
↳
History
Implements
constructor
new History(editor
, stack?
, snapshot?
): History
Parameters
Name | Type |
---|---|
editor |
IJodit |
stack |
Stack |
snapshot |
Snapshot |
Returns
Overrides
Defined in
src/modules/history/history.ts#113
STATUSES
Static
STATUSES: Object
= STATUSES
Type declaration
Name | Type |
---|---|
beforeInit |
"beforeInit" |
ready |
"ready" |
beforeDestruct |
"beforeDestruct" |
destructed |
"destructed" |
Inherited from
Defined in
src/core/component/component.ts#40
async
async: IAsync
Inherited from
Defined in
src/core/component/component.ts#44
uid
Readonly
uid: string
Inherited from
Defined in
src/core/component/component.ts#59
ownerWindow
ownerWindow: Window
= window
The window in which jodit was created
Inherited from
Defined in
src/core/component/component.ts#109
jodit
jodit: IJodit
Parent View element
Inherited from
Defined in
src/core/component/view-component.ts#22
snapshot
snapshot: ISnapshot
& IDestructible
Implementation of
Defined in
src/modules/history/history.ts#111
componentName
get
componentName(): string
Returns
string
Inherited from
ViewComponent.componentName
Defined in
src/core/component/component.ts#46
ownerDocument
get
ownerDocument(): Document
The document in which jodit was created
Returns
Inherited from
ViewComponent.ownerDocument
Defined in
src/core/component/component.ts#95
od
get
od(): Document
Shortcut for this.ownerDocument
Returns
Inherited from
ViewComponent.od
Defined in
src/core/component/component.ts#102
ow
get
ow(): Window
Returns
Inherited from
ViewComponent.ow
Defined in
src/core/component/component.ts#110
isReady
get
isReady(): boolean
Component is ready for work
Returns
boolean
Inherited from
ViewComponent.isReady
Defined in
src/core/component/component.ts#145
isDestructed
get
isDestructed(): boolean
Component was destructed
Returns
boolean
Inherited from
ViewComponent.isDestructed
Defined in
src/core/component/component.ts#152
isInDestruct
get
isInDestruct(): boolean
The component is currently undergoing destructuring or has already been destroyed.
Those. you should not the app froze new events on him now or do anything else with him.
Returns
boolean
Inherited from
ViewComponent.isInDestruct
Defined in
src/core/component/component.ts#160
componentStatus
get
componentStatus(): ComponentStatus
Current component status
Returns
Inherited from
ViewComponent.componentStatus
Defined in
src/core/component/component.ts#210
set
componentStatus(componentStatus
): void
Setter for current component status
Parameters
Name | Type |
---|---|
componentStatus |
ComponentStatus |
Returns
void
Inherited from
ViewComponent.componentStatus
Defined in
src/core/component/component.ts#217
j
get
j(): T
Shortcut for this.jodit
Returns
T
Inherited from
ViewComponent.j
Defined in
src/core/component/view-component.ts#27
defaultTimeout
get
defaultTimeout(): number
Returns
number
Inherited from
ViewComponent.defaultTimeout
Defined in
src/core/component/view-component.ts#31
length
get
length(): number
Returns
number
Implementation of
Defined in
src/modules/history/history.ts#96
getFullElName
getFullElName(elementName
): string
Calc BEM element class name
Parameters
Name | Type | Description |
---|---|---|
elementName |
string |
element name in the bem classification |
Returns
string
Inherited from
Defined in
src/core/component/component.ts#65
getFullElName(elementName
, mod
): string
Parameters
Name | Type |
---|---|
elementName |
string |
mod |
string |
Returns
string
Inherited from
Defined in
src/core/component/component.ts#66
getFullElName(elementName
, mod
, modValue
): string
Parameters
Name | Type |
---|---|
elementName |
string |
mod |
string |
modValue |
string | boolean |
Returns
string
Inherited from
Defined in
src/core/component/component.ts#67
get
get<T
>(chain
, obj?
): Nullable
<T
>
Safe get any field
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
chain |
string |
the path to be traversed in the obj object |
obj? |
IDictionary |
the object in which the value is searched |
Returns
Nullable
<T
>
Example
private a = {
b: {
c: {
e: {
g: {
color: 'red'
}
}
}
}
}
this.get('a.b.c.e.g.color'); // Safe access to color
// instead using optionsl chaining
this?.a?.b?.c?.e?.g?.color
Inherited from
Defined in
src/core/component/component.ts#138
bindDestruct
bindDestruct(component
): this
Bind destructor to some View
Parameters
Name | Type |
---|---|
component |
IComponent <IViewBased <IViewOptions >> |
Returns
this
Inherited from
Defined in
src/core/component/component.ts#170
setStatus
setStatus(componentStatus
): void
Set component status
Parameters
Name | Type | Description |
---|---|---|
componentStatus |
ComponentStatus |
component status |
Returns
void
See
ComponentStatus
Inherited from
Defined in
src/core/component/component.ts#226
hookStatus
hookStatus(status
, callback
): void
Adds a handler for changing the component's status
Parameters
Name | Type | Description |
---|---|---|
status |
ComponentStatus |
the status at which the callback is triggered |
callback |
(component : this ) => void |
a function that will be called when the status is status |
Returns
void
Inherited from
Defined in
src/core/component/component.ts#265
isInstanceOf
isInstanceOf<T
>(c
, constructorFunc
): c is T
Type parameters
Name | Type |
---|---|
T |
extends Component |
Parameters
Name | Type |
---|---|
c |
unknown |
constructorFunc |
Function |
Returns
c is T
Inherited from
Defined in
src/core/component/component.ts#283
i18n
i18n(text
, ...params
): string
Parameters
Name | Type |
---|---|
text |
string |
...params |
(string | number )[] |
Returns
string
Inherited from
Defined in
src/core/component/view-component.ts#35
setParentView
setParentView(jodit
): this
Attach component to View
Parameters
Name | Type |
---|---|
jodit |
IJodit |
Returns
this
Inherited from
Defined in
src/core/component/view-component.ts#42
className
className(): string
Returns
string
Overrides
Defined in
src/modules/history/history.ts#58
redo
redo(): void
Return state of the WYSIWYG editor to step back
Returns
void
Implementation of
Defined in
src/modules/history/history.ts#65
canRedo
canRedo(): boolean
Returns
boolean
Implementation of
Defined in
src/modules/history/history.ts#72
undo
undo(): void
Return the state of the WYSIWYG editor to step forward
Returns
void
Implementation of
Defined in
src/modules/history/history.ts#79
canUndo
canUndo(): boolean
Returns
boolean
Implementation of
Defined in
src/modules/history/history.ts#86
clear
clear(): void
Returns
void
Implementation of
Defined in
src/modules/history/history.ts#90
destruct
destruct(): void
Returns
void
Overrides
Defined in
jodit/src/modules/history/history.ts:225