TestMode | wed

This mode is purely designed to help test wed, and nothing else. Don't derive anything from it and don't use it for editing.

Hierarchy

GenericMode<TestModeOptions>
- TestMode

Implements

Mode<TestModeOptions>

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new TestMode(editor: EditorAPI, options: TestModeOptions): TestMode

Overrides GenericMode.constructor
- Defined in wed/modes/test/test-mode.ts:343
Parameters
- editor: EditorAPI
- options: TestModeOptions
Returns TestMode

Properties

Private draggableAction

draggableAction: DraggableModalAction

Private draggableResizableAction

draggableResizableAction: DraggableResizableModalAction

Protected editor

editor: EditorAPI

The editor for which this mode is created.

Protected metadata

metadata: Metadata

Protected options

options: TestModeOptions

The options for the mode. Each mode defines what fields this object contains.

Private resizableAction

resizableAction: ResizableModalAction

Protected resolver

resolver: DefaultNameResolver

Protected tagTr

tagTr: Record<string, Transformation<NamedTransformationData>>

Private typeaheadAction

typeaheadAction: TypeaheadAction

Methods

checkOptions

checkOptions(options: GenericModeOptions): void

Inherited from GenericMode.checkOptions
- Defined in wed/modes/generic/generic.ts:113
Check that the options are okay. This method will throw if there are any unexpected options or mandatory options are missing.

Parameters
- options: GenericModeOptions
  
  The options to check.
Returns void

documentationLinkFor

documentationLinkFor(name: string): string | null | undefined

Implementation of Mode.documentationLinkFor

Inherited from GenericMode.documentationLinkFor

Overrides BaseMode.documentationLinkFor
- Defined in wed/modes/generic/generic.ts:181
Returns a URL to the documentation for an element. The element should be named according to the mappings reported by the resolve returned by "wed/mode".Mode.getAbsoluteResolver. The generic mode delegates the call to the metadata.

Parameters
- name: string
  
  The name of the element.
Returns string | null | undefined

The URL. If the value returned is undefined, then URL is not available. If the value returned is null, the URL has not been loaded yet.

getAbsoluteNamespaceMappings

getAbsoluteNamespaceMappings(): Record<string, string>

Implementation of Mode.getAbsoluteNamespaceMappings

Inherited from GenericMode.getAbsoluteNamespaceMappings

Overrides BaseMode.getAbsoluteNamespaceMappings
- Defined in wed/modes/generic/generic.ts:131
Returns Record<string, string>

getAbsoluteResolver

getAbsoluteResolver(): DefaultNameResolver

Implementation of Mode.getAbsoluteResolver

Inherited from GenericMode.getAbsoluteResolver

Overrides BaseMode.getAbsoluteResolver
- Defined in wed/modes/generic/generic.ts:141
Returns DefaultNameResolver

getAttributeCompletions

getAttributeCompletions(attr: Attr): string[]

Implementation of Mode.getAttributeCompletions

Overrides BaseMode.getAttributeCompletions
- Defined in wed/modes/test/test-mode.ts:437
Parameters
- attr: Attr
Returns string[]

getContextualActions

getContextualActions(transformationType: string | string[], tag: string, container: Node, offset: number): Action<__type>[]

Overrides GenericMode.getContextualActions
- Defined in wed/modes/test/test-mode.ts:400
Parameters
- transformationType: string | string[]
- tag: string
- container: Node
- offset: number
Returns Action<__type>[]

getModeOptions

getModeOptions(): TestModeOptions

Implementation of Mode.getModeOptions

Inherited from BaseMode.getModeOptions
- Defined in wed/mode.ts:234
Gets the mode options. The returned object should be considered frozen. You may inspect it, not modify it.

Returns TestModeOptions

getStylesheets

getStylesheets(): string[]

Implementation of Mode.getStylesheets

Overrides BaseMode.getStylesheets
- Defined in wed/modes/test/test-mode.ts:391
Returns string[]

getToolbarButtons

getToolbarButtons(): Button[]

Implementation of Mode.getToolbarButtons

Overrides BaseMode.getToolbarButtons
- Defined in wed/modes/test/test-mode.ts:396
Returns Button[]

getValidator

getValidator(): ModeValidator

Implementation of Mode.getValidator

Overrides BaseMode.getValidator
- Defined in wed/modes/test/test-mode.ts:445
Returns ModeValidator

getWedOptions

getWedOptions(): WedOptions

Implementation of Mode.getWedOptions

Inherited from BaseMode.getWedOptions
- Defined in wed/mode.ts:243
Gets the options that the mode wants wed to use with this mode.

Returns WedOptions

The options. Callers are not allowed to modify the value returned.

init

init(): Promise<void>

Implementation of Mode.init

Inherited from GenericMode.init

Overrides BaseMode.init
- Defined in wed/modes/generic/generic.ts:84
Returns Promise<void>

makeDecorator

makeDecorator(): GenericDecorator

Implementation of Mode.makeDecorator

Overrides GenericMode.makeDecorator
- Defined in wed/modes/test/test-mode.ts:433
Returns GenericDecorator

makeMetadata

makeMetadata(): Promise<Metadata>

Inherited from GenericMode.makeMetadata
- Defined in wed/modes/generic/generic.ts:123
Make a Metadata object for use with this mode. The default implementation requires that there be a metadata option set and uses that to load a metadata file. Derived classes can override this as needed.

Returns Promise<Metadata>

makePlaceholderFor

makePlaceholderFor(_element: Element): Element

Implementation of Mode.makePlaceholderFor

Inherited from BaseMode.makePlaceholderFor
- Defined in wed/mode.ts:291
Parameters
- _element: Element
Returns Element

nodesAroundEditableContents

nodesAroundEditableContents(element: Element): [Node | null, Node | null]

Implementation of Mode.nodesAroundEditableContents

Inherited from BaseMode.nodesAroundEditableContents
- Defined in wed/mode.ts:254
Parameters
- element: Element
Returns [Node | null, Node | null]

shortDescriptionFor

shortDescriptionFor(name: string): string | null | undefined

Implementation of Mode.shortDescriptionFor

Inherited from GenericMode.shortDescriptionFor

Overrides BaseMode.shortDescriptionFor
- Defined in wed/modes/generic/generic.ts:161
Returns a short description for an element. The element should be named according to the mappings reported by the resolve returned by "wed/mode".Mode.getAbsoluteResolver. The generic mode delegates the call to the metadata.

Parameters
- name: string
  
  The name of the element.
Returns string | null | undefined

The description. If the value returned is undefined, then the description is not available. If the value returned is null, the description has not been loaded yet.

unresolveName

unresolveName(name: EName): string | undefined

Implementation of Mode.unresolveName

Inherited from GenericMode.unresolveName

Overrides BaseMode.unresolveName
- Defined in wed/modes/generic/generic.ts:137
Parameters
- name: EName
Returns string | undefined

Object literals

optionTemplate

optionTemplate: object

ambiguous_fileDesc_insert

ambiguous_fileDesc_insert: false = false

autoinsert

autoinsert: false = false

fileDesc_insert_needs_input

fileDesc_insert_needs_input: false = false

hide_attributes

hide_attributes: false = false

metadata

metadata: true = true

nameSuffix

nameSuffix: false = false

stylesheets

stylesheets: false = false

Protected wedOptions

wedOptions: object

label_levels

label_levels: object

initial

initial: number = 1

max

max: number = 1

metadata

metadata: object

authors

authors: string[] = ["Louis-Dominique Dubeau"]

copyright

description

description: string = "The base mode. You should not be using it directly."

license

license: string = "MPL 2.0"

name

name: string = "Base Mode (you should not be using this)"

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

editor: EditorAPI

options: TestModeOptions

Returns TestMode

Properties

Private draggableAction

Private draggableResizableAction

Protected editor

Protected metadata

Protected options

Private resizableAction

Protected resolver

Protected tagTr

Private typeaheadAction

Methods

checkOptions

Parameters

options: GenericModeOptions

Returns void

documentationLinkFor

Parameters

name: string

Returns string | null | undefined

getAbsoluteNamespaceMappings

Returns Record<string, string>

getAbsoluteResolver

Returns DefaultNameResolver

getAttributeCompletions

Parameters

attr: Attr

Returns string[]

getContextualActions

Parameters

transformationType: string | string[]

tag: string

container: Node

offset: number

Returns Action<__type>[]

getModeOptions

Returns TestModeOptions

getStylesheets

Returns string[]

getToolbarButtons

Returns Button[]

getValidator

Returns ModeValidator

getWedOptions

Returns WedOptions

init

Returns Promise<void>

makeDecorator

Returns GenericDecorator

makeMetadata

Returns Promise<Metadata>

makePlaceholderFor

Parameters

_element: Element

Returns Element

nodesAroundEditableContents

Parameters

element: Element

Returns [Node | null, Node | null]

shortDescriptionFor

Parameters

name: string

Returns string | null | undefined

unresolveName

Parameters

name: EName

Returns string | undefined

Object literals