Class default`Abstract`

The base class for all the note types.

Hierarchy (View Summary)

NoteContextAwareWidget
- default

Index

Constructors

constructor

new default(): default
Returns default
Inherited from NoteContextAwareWidget.constructor
- Defined in src/public/app/widgets/basic_widget.ts:13

Properties

_noteId

_noteId: string

_position

_position: number

$widget: JQuery<HTMLElement>

`Protected`attrs

attrs: Record<string, string>

children

children: default[]

componentId

componentId: string

initialized

initialized: null | Promise<void>

`Optional`noteContext

noteContext?: NoteContext

`Optional`parent

parent?: TypedComponent<any>

spacedUpdate

spacedUpdate: default

Accessors

hoistedNoteId

get hoistedNoteId(): undefined | string
Returns undefined | string
Inherited from NoteContextAwareWidget.hoistedNoteId
- Defined in src/public/app/widgets/note_context_aware_widget.ts:40

note

get note(): undefined | null | FNote
Returns undefined | null | FNote
Inherited from NoteContextAwareWidget.note
- Defined in src/public/app/widgets/note_context_aware_widget.ts:28

noteId

get noteId(): undefined | string
Returns undefined | string
Inherited from NoteContextAwareWidget.noteId
- Defined in src/public/app/widgets/note_context_aware_widget.ts:32

notePath

get notePath(): undefined | null | string
Returns undefined | null | string
Inherited from NoteContextAwareWidget.notePath
- Defined in src/public/app/widgets/note_context_aware_widget.ts:36

ntxId

get ntxId(): undefined | null | string
Returns undefined | null | string
Inherited from NoteContextAwareWidget.ntxId
- Defined in src/public/app/widgets/note_context_aware_widget.ts:44

position

get position(): number
Returns number
Inherited from NoteContextAwareWidget.position
- Defined in src/public/app/components/component.ts:34
set position(newPosition: number): void
Parameters
- newPosition: number
Returns void
Inherited from NoteContextAwareWidget.position
- Defined in src/public/app/components/component.ts:38

sanitizedClassName

get sanitizedClassName(): string
Returns string
Inherited from NoteContextAwareWidget.sanitizedClassName
- Defined in src/public/app/components/component.ts:29

Methods

activeContextChanged

activeContextChanged(): Promise<void>
Returns Promise<void>
Inherited from NoteContextAwareWidget.activeContextChanged
- Defined in src/public/app/widgets/note_context_aware_widget.ts:101

activeContextChangedEvent

activeContextChangedEvent(
__namedParameters: { noteContext: NoteContext },
): Promise<void>
Parameters
- __namedParameters: { noteContext: NoteContext }
Returns Promise<void>
Inherited from NoteContextAwareWidget.activeContextChangedEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:95

callMethod

callMethod(
fun: (arg: unknown) => Promise<unknown>,
data: unknown,
): undefined | Promise<unknown>
Parameters
- fun: (arg: unknown) => Promise<unknown>
- data: unknown
Returns undefined | Promise<unknown>
Inherited from NoteContextAwareWidget.callMethod
- Defined in src/public/app/components/component.ts:105

canBeShown

canBeShown(): boolean
Returns boolean
Inherited from NoteContextAwareWidget.canBeShown
- Defined in src/public/app/widgets/basic_widget.ts:226

child

child(...components: default[]): default
Parameters
- ...components: default[]
Returns default
Inherited from NoteContextAwareWidget.child
- Defined in src/public/app/widgets/basic_widget.ts:25

class

class(className: string): default
Parameters
- className: string
Returns default
Inherited from NoteContextAwareWidget.class
- Defined in src/public/app/widgets/basic_widget.ts:64

cleanup

cleanup(): void
Returns void
Inherited from NoteContextAwareWidget.cleanup
- Defined in src/public/app/widgets/basic_widget.ts:252

collapsible

collapsible(): default
Returns default
Inherited from NoteContextAwareWidget.collapsible
- Defined in src/public/app/widgets/basic_widget.ts:103

contentSized

contentSized(): default
Returns default
Inherited from NoteContextAwareWidget.contentSized
- Defined in src/public/app/widgets/basic_widget.ts:97

css

css(name: string, value: string): default
Sets the CSS attribute of the given name to the given value.
Parameters
- name: string
  the name of the CSS attribute to set (e.g. padding-left).
- value: string
  the value of the CSS attribute to set (e.g. 12px).
Returns default
self for chaining.
Inherited from NoteContextAwareWidget.css
- Defined in src/public/app/widgets/basic_widget.ts:76

cssBlock

cssBlock(block: string): default
Accepts a string of CSS to add with the widget.
Parameters
- block: string
Returns default
for chaining
Inherited from NoteContextAwareWidget.cssBlock
- Defined in src/public/app/widgets/basic_widget.ts:118

dataSaved

dataSaved(): void
Returns void
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:62

doRefresh

doRefresh(note: FNote): void | Promise<void>
Parameters
- note: FNote
Returns void | Promise<void>
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:24

doRender

doRender(): void
Method used for rendering the widget.

Your class should override this method. The method is expected to create a this.$widget containing jQuery object

Returns void
Overrides NoteContextAwareWidget.doRender
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:18

filling

filling(): default
Returns default
Inherited from NoteContextAwareWidget.filling
- Defined in src/public/app/widgets/basic_widget.ts:109

focus

focus(): void
Returns void
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:56

frocaReloadedEvent

frocaReloadedEvent(): Promise<void>
Returns Promise<void>
Inherited from NoteContextAwareWidget.frocaReloadedEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:126

getClosestNtxId

getClosestNtxId(): undefined | null | string
Returns undefined | null | string
Inherited from NoteContextAwareWidget.getClosestNtxId
- Defined in src/public/app/widgets/basic_widget.ts:244

getData

getData(): void
Returns void
promise resolving note data. Note data is an object with content.
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:54

getPosition

getPosition(): number
Returns number
Inherited from NoteContextAwareWidget.getPosition
- Defined in src/public/app/widgets/basic_widget.ts:234

handleEvent

handleEvent<T extends EventNames>(
name: T,
data: EventData<T>,
): undefined | null | Promise<unknown>
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns undefined | null | Promise<unknown>
Inherited from NoteContextAwareWidget.handleEvent
- Defined in src/public/app/components/component.ts:57

handleEventInChildren

handleEventInChildren<T extends EventNames>(
name: T,
data: EventData<T>,
): null | Promise<unknown>
By default:
- activeContextChanged is intercepted and converted to a setNoteContext event to avoid refresh().
- entitiesReloaded and refreshData are passed as-is.
- any other event is not passed to the children.
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns null | Promise<unknown>
Overrides NoteContextAwareWidget.handleEventInChildren
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:83

id

id(id: string): default
Parameters
- id: string
Returns default
Inherited from NoteContextAwareWidget.id
- Defined in src/public/app/widgets/basic_widget.ts:59

isActive

isActive(): boolean
Returns boolean
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:49

isActiveNoteContext

isActiveNoteContext(): boolean
Returns boolean
Inherited from NoteContextAwareWidget.isActiveNoteContext
- Defined in src/public/app/widgets/note_context_aware_widget.ts:20

isEnabled

isEnabled(): undefined | null | boolean
Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

If the widget is not enabled, it will not receive `refreshWithNote` updates.
Returns undefined | null | boolean
true when an active note exists
Inherited from NoteContextAwareWidget.isEnabled
- Defined in src/public/app/widgets/note_context_aware_widget.ts:56

isHiddenExt

isHiddenExt(): boolean
Returns boolean
Inherited from NoteContextAwareWidget.isHiddenExt
- Defined in src/public/app/widgets/basic_widget.ts:222

isHiddenInt

isHiddenInt(): boolean
Returns boolean
Inherited from NoteContextAwareWidget.isHiddenInt
- Defined in src/public/app/widgets/basic_widget.ts:213

isNote

isNote(noteId: string): boolean
Parameters
- noteId: string
Returns boolean
Inherited from NoteContextAwareWidget.isNote
- Defined in src/public/app/widgets/note_context_aware_widget.ts:24

isNoteContext

isNoteContext(
ntxId: undefined | null | string | string[],
): undefined | null | boolean | ""
Parameters
- ntxId: undefined | null | string | string[]
Returns undefined | null | boolean | ""
Inherited from NoteContextAwareWidget.isNoteContext
- Defined in src/public/app/widgets/note_context_aware_widget.ts:12

isVisible

isVisible(): boolean
Returns boolean
Inherited from NoteContextAwareWidget.isVisible
- Defined in src/public/app/widgets/basic_widget.ts:230

logRenderingError

logRenderingError(e: Error): void
Parameters
- e: Error
Returns void
Inherited from NoteContextAwareWidget.logRenderingError
- Defined in src/public/app/widgets/basic_widget.ts:163

noteSwitched

noteSwitched(): Promise<void>
Returns Promise<void>
Inherited from NoteContextAwareWidget.noteSwitched
- Defined in src/public/app/widgets/note_context_aware_widget.ts:91

noteSwitchedAndActivatedEvent

noteSwitchedAndActivatedEvent(
__namedParameters: NoteSwitchedContext,
): Promise<void>
Parameters
- __namedParameters: NoteSwitchedContext
Returns Promise<void>
Inherited from NoteContextAwareWidget.noteSwitchedAndActivatedEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:106

noteSwitchedEvent

noteSwitchedEvent(__namedParameters: NoteSwitchedContext): Promise<void>
Parameters
- __namedParameters: NoteSwitchedContext
Returns Promise<void>
Inherited from NoteContextAwareWidget.noteSwitchedEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:84

noteTypeMimeChangedEvent

noteTypeMimeChangedEvent(__namedParameters: { noteId: string }): Promise<void>
Parameters
- __namedParameters: { noteId: string }
Returns Promise<void>
Inherited from NoteContextAwareWidget.noteTypeMimeChangedEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:120

optChild

optChild(condition: boolean, ...components: default[]): default
Conditionally adds the given components as children to this component.
Parameters
- condition: boolean
  whether to add the components.
- ...components: default[]
  the components to be added as children to this component provided the condition is truthy.
Returns default
self for chaining.
Inherited from NoteContextAwareWidget.optChild
- Defined in src/public/app/widgets/basic_widget.ts:51

optCss

optCss(condition: boolean, name: string, value: string): default
Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.
Parameters
- condition: boolean
  true in order to apply the CSS, false to ignore it.
- name: string
  the name of the CSS attribute to set (e.g. padding-left).
- value: string
  the value of the CSS attribute to set (e.g. 12px).
Returns default
self for chaining.
Inherited from NoteContextAwareWidget.optCss
- Defined in src/public/app/widgets/basic_widget.ts:89

readOnlyTemporarilyDisabledEvent

readOnlyTemporarilyDisabledEvent(
__namedParameters: { noteContext: NoteContext },
): Promise<void>
Parameters
- __namedParameters: { noteContext: NoteContext }
Returns Promise<void>
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:66

refresh

refresh(): Promise<void>
Returns Promise<void>
Overrides NoteContextAwareWidget.refresh
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:26

refreshWithNote

refreshWithNote(note: undefined | null | FNote): Promise<void>
Override this method to be able to refresh your widget with each note.
Parameters
- note: undefined | null | FNote
Returns Promise<void>
Inherited from NoteContextAwareWidget.refreshWithNote
- Defined in src/public/app/widgets/note_context_aware_widget.ts:82

remove

remove(): void
Returns void
Inherited from NoteContextAwareWidget.remove
- Defined in src/public/app/widgets/basic_widget.ts:238

render

render(): JQuery<HTMLElement>
Returns JQuery<HTMLElement>
Inherited from NoteContextAwareWidget.render
- Defined in src/public/app/widgets/basic_widget.ts:123

scrollToEnd

scrollToEnd(): void
Returns void
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:58

setNoteContextEvent

setNoteContextEvent(__namedParameters: { noteContext: NoteContext }): void
Parameters
- __namedParameters: { noteContext: NoteContext }
Returns void
Inherited from NoteContextAwareWidget.setNoteContextEvent
- Defined in src/public/app/widgets/note_context_aware_widget.ts:115

setParent

setParent(parent: TypedComponent<any>): default
Parameters
- parent: TypedComponent<any>
Returns default
Inherited from NoteContextAwareWidget.setParent
- Defined in src/public/app/components/component.ts:42

toggleExt

toggleExt(show: undefined | null | boolean | ""): void
Parameters
- show: undefined | null | boolean | ""
Returns void
Inherited from NoteContextAwareWidget.toggleExt
- Defined in src/public/app/widgets/basic_widget.ts:217

toggleInt

toggleInt(show: undefined | null | boolean): void
Parameters
- show: undefined | null | boolean
Returns void
Inherited from NoteContextAwareWidget.toggleInt
- Defined in src/public/app/widgets/basic_widget.ts:208

triggerCommand

triggerCommand<K extends keyof CommandMappings>(
name: K,
data?: CommandMappings[K],
): undefined | null | Promise<unknown>
Type Parameters
- K extends keyof CommandMappings
Parameters
- name: K
- Optionaldata: CommandMappings[K]
Returns undefined | null | Promise<unknown>
Inherited from NoteContextAwareWidget.triggerCommand
- Defined in src/public/app/components/component.ts:91

triggerEvent

triggerEvent<T extends EventNames>(
name: T,
data: EventData<T>,
): undefined | null | Promise<unknown>
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns undefined | null | Promise<unknown>
Inherited from NoteContextAwareWidget.triggerEvent
- Defined in src/public/app/components/component.ts:72

`Static`getType

getType(): void
Returns void
- Defined in src/public/app/widgets/type_widgets/type_widget.ts:16

Class defaultAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns default

Properties

_noteId

_position

$widget

Protectedattrs

children

componentId

initialized

OptionalnoteContext

Optionalparent

spacedUpdate

Accessors

hoistedNoteId

Returns undefined | string

note

Returns undefined | null | FNote

noteId

Returns undefined | string

notePath

Returns undefined | null | string

ntxId

Returns undefined | null | string

position

Returns number

Parameters

Returns void

sanitizedClassName

Returns string

Methods

activeContextChanged

Returns Promise<void>

activeContextChangedEvent

Parameters

Returns Promise<void>

callMethod

Parameters

Returns undefined | Promise<unknown>

canBeShown

Returns boolean

child

Parameters

Returns default

class

Parameters

Returns default

cleanup

Returns void

collapsible

Returns default

contentSized

Returns default

css

Parameters

Returns default

cssBlock

Parameters

Returns default

dataSaved

Returns void

doRefresh

Parameters

Returns void | Promise<void>

doRender

Returns void

filling

Returns default

focus

Returns void

frocaReloadedEvent

Returns Promise<void>

Class default`Abstract`

`Protected`attrs

`Optional`noteContext

`Optional`parent