Class CopiedTemplate

Represents a single {{copied}} template in the Parsoid document.

Hierarchy (view full)

RowedAttributionNotice<CopiedTemplateRow>
- CopiedTemplate

Implements

AttributionNoticePageGenerator

Index

Constructors

constructor

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

Properties

`Protected`_rows

_rows: CopiedTemplateRow[]

All the rows of this template.

collapsed

collapsed: string

Whether or not this notice is collapsed (rows hidden if rows are two or more).

`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.

small

small: string

Whether or not this notice is a right-floating box.

Accessors

element

get element(): HTMLElement
Returns HTMLElement
The HTMLElement of the node
Inherited from RowedAttributionNotice.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 RowedAttributionNotice.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 RowedAttributionNotice.parsoid
- Defined in src/modules/ante/models/AttributionNotice.ts:33

rows

get rows(): CopiedTemplateRow[]
Returns CopiedTemplateRow[]
This template's rows.
Overrides RowedAttributionNotice.rows
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:33

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 RowedAttributionNotice.accessTemplateData
- Defined in src/modules/ante/models/AttributionNotice.ts:72

addRow

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

deleteRow

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

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
Overrides RowedAttributionNotice.destroy
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:133

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
Implementation of AttributionNoticePageGenerator.generatePage
Overrides RowedAttributionNotice.generatePage
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:143

generatePreview

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

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

merge

merge(template, options?): void
Copies in the rows of another CopiedTemplate, and optionally deletes that template or clears its contents.
Parameters
- template: CopiedTemplate
  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
Overrides RowedAttributionNotice.merge
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:161

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
Overrides RowedAttributionNotice.parse
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:40

save

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

Returns void
Overrides RowedAttributionNotice.save
- Defined in src/modules/ante/models/templates/CopiedTemplate.ts:90

toWikitext

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

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

Class CopiedTemplate

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CopiedTemplate

Properties

Protected_rows

collapsed

Readonlyid

Readonlyname

Readonlynode

small

Accessors

element

Returns HTMLElement

i

Returns number

parsoid

Returns CTEParsoidDocument

rows

Returns CopiedTemplateRow[]

Methods

accessTemplateData

Parameters

Returns void

addRow

Parameters

Returns void

deleteRow

Parameters

Returns void

destroy

Returns void

generatePage

Parameters

Returns AttributionNoticePageLayout

generatePreview

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

merge

Parameters

Optionalclear?: boolean

Optionaldelete?: boolean

Returns void

parse

Returns void

save

Returns void

toWikitext

Returns string

Settings

On This Page

`Protected`_rows

`Readonly`id

`Readonly`name

`Readonly`node

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

`Optional`clear?: boolean

`Optional`delete?: boolean