Class RowedAttributionNotice<RowClass>`Abstract`

This is a sub-abstract class of AttributionNotice that represents any attribution notice template that can contain multiple entries (or rows).

Type Parameters

RowClass extends AttributionNoticeRow<RowedAttributionNotice<RowClass>>

Hierarchy (view full)

AttributionNotice
- RowedAttributionNotice

Index

Constructors

constructor

new RowedAttributionNotice<RowClass>(node): RowedAttributionNotice<RowClass>
Super constructor for AttributionNotice subclasses.
Type Parameters
- RowClass extends AttributionNoticeRow<RowedAttributionNotice<RowClass>, RowClass>
Parameters
- node: CTEParsoidTransclusionTemplateNode
  The ParsoidTransclusionTemplateNode of this notice.
Returns RowedAttributionNotice<RowClass>
Inherited from AttributionNotice.constructor
- Defined in src/modules/ante/models/AttributionNotice.ts:57

Properties

`Protected`_rows

_rows: RowClass[]

All the rows of this template.

`Readonly`id

id: string

A unique ID for this template. Derived from the template name and its Parsoid about.

`Readonly`name

name: string

A unique name for this template. Derived from the Parsoid about for its node.

`Readonly`node

node: CTEParsoidTransclusionTemplateNode

The template transclusion node that serves as a reference to an element on the Parsoid DOM.

Accessors

element

get element(): HTMLElement
Returns HTMLElement
The HTMLElement of the node
Inherited from AttributionNotice.element
- Defined in src/modules/ante/models/AttributionNotice.ts:39

i

get i(): number
Returns number
This template's i variable, used to identify this template in the template's parts (data-mw).
Inherited from AttributionNotice.i
- Defined in src/modules/ante/models/AttributionNotice.ts:47

parsoid

get parsoid(): CTEParsoidDocument
Returns CTEParsoidDocument
The ParsoidDocument handling this notice (specifically its node).
Inherited from AttributionNotice.parsoid
- Defined in src/modules/ante/models/AttributionNotice.ts:33

rows

get rows(): RowClass[]
Returns RowClass[]
This template's rows.
- Defined in src/modules/ante/models/RowedAttributionNotice.ts:21

Methods

accessTemplateData

accessTemplateData(callback): void
Provides low-level access to a template's data-mw entry. When possible, use functions from .node instead, as these are much more stable.
Parameters
- callback: TemplateDataModifier
  The callback for data-modifying operations.
Returns void
Inherited from AttributionNotice.accessTemplateData
- Defined in src/modules/ante/models/AttributionNotice.ts:72

addRow

addRow(row): void
Adds a row to this template.
Parameters
- row: RowClass
  The row to add.
Returns void
- Defined in src/modules/ante/models/RowedAttributionNotice.ts:83

deleteRow

deleteRow(row): void
Deletes a row to this template.
Parameters
- row: RowClass
  The row to delete.
Returns void
- Defined in src/modules/ante/models/RowedAttributionNotice.ts:94

`Abstract`destroy

destroy(): void
Destroys the notice by removing it from the Parsoid document. Optionally, a subclass can mark itself as destroyed or wipe its values.

Returns void
Inherited from AttributionNotice.destroy
- Defined in src/modules/ante/models/AttributionNotice.ts:131

`Abstract`generatePage

generatePage(dialog): AttributionNoticePageLayout
Generates an OOUI PageLayout for this notice. Used by the main dialog to generate pages. Do not cache - the dialog is responsible for caching.
Parameters
- dialog: any
Returns AttributionNoticePageLayout
Inherited from AttributionNotice.generatePage
- Defined in src/modules/ante/models/AttributionNotice.ts:137

generatePreview

generatePreview(): Promise<string & {
summary?: string;
}>
Converts this notice to parsed HTML.

Returns Promise<string & {
summary?: string;
}>
Inherited from AttributionNotice.generatePreview
- Defined in src/modules/ante/models/AttributionNotice.ts:168

merge

merge(template, options?): void
Copies in the rows of another SplitArticleTemplate, and optionally deletes that template or clears its contents.
Parameters
- template: RowedAttributionNotice<RowClass>
  The template to copy from.
- options: {
  clear?: boolean;
  delete?: boolean;
  } = {}
  Options for this merge.
  - Optionalclear?: boolean
    Whether the reference template's rows will be cleared after merging.
  - Optionaldelete?: boolean
    Whether the reference template will be deleted after merging.
Returns void
- Defined in src/modules/ante/models/RowedAttributionNotice.ts:118

`Abstract`parse

parse(): void
Extracts the parameters from this notice and stores them in the object. This must NEVER destroy unknown parameters. This function does not always pull all parameters from the template, only those that are known.

This should be implemented by subclasses.

Returns void
Inherited from AttributionNotice.parse
- Defined in src/modules/ante/models/AttributionNotice.ts:120

`Abstract`save

save(): void
Save the existing template parameters into the Parsoid element for this notice.

Returns void
Inherited from AttributionNotice.save
- Defined in src/modules/ante/models/AttributionNotice.ts:125

toWikitext

toWikitext(): string
Gets a wikitext string representation of this template. Used for previews.

Returns string
wikitext.
Inherited from AttributionNotice.toWikitext
- Defined in src/modules/ante/models/AttributionNotice.ts:146

Class RowedAttributionNotice<RowClass>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RowedAttributionNotice<RowClass>

Properties

Protected_rows

Readonlyid

Readonlyname

Readonlynode

Accessors

element

Returns HTMLElement

i

Returns number

parsoid

Returns CTEParsoidDocument

rows

Returns RowClass[]

Methods

accessTemplateData

Parameters

Returns void

addRow

Parameters

Returns void

deleteRow

Parameters

Returns void

Abstractdestroy

Returns void

AbstractgeneratePage

Parameters

Returns AttributionNoticePageLayout

generatePreview

Returns Promise<string & { summary?: string; }>

merge

Parameters

Optionalclear?: boolean

Optionaldelete?: boolean

Returns void

Abstractparse

Returns void

Abstractsave

Returns void

toWikitext

Returns string

Settings

On This Page

Class RowedAttributionNotice<RowClass>`Abstract`

`Protected`_rows

`Readonly`id

`Readonly`name

`Readonly`node

`Abstract`destroy

`Abstract`generatePage

Returns Promise<string & {
summary?: string;
}>

`Optional`clear?: boolean

`Optional`delete?: boolean

`Abstract`parse

`Abstract`save