Class PageBox<I>`Abstract`

Represent an at-rule which creates a page-level CSS box (page-master, partition, and partition-group).

Type Parameters

I extends PageBoxInstance = PageBoxInstance<any>

Hierarchy (View Summary)

PageBox

Index

Constructors

Properties

_scope children classes index key name pageMaster parent pseudoName specified

Accessors

Methods

clone cloneChildren copySpecified createInstance

Constructors

constructor

new PageBox<I extends PageBoxInstance<PageBox<any>> = PageBoxInstance<any>>(
    scope: LexicalScope,
    name: string,
    pseudoName: string,
    classes: string[],
    parent: PageBox,
): PageBox<I>
Type Parameters
- I extends PageBoxInstance<PageBox<any>> = PageBoxInstance<any>
Parameters
- scope: LexicalScope
- name: string
- pseudoName: string
- classes: string[]
- parent: PageBox
Returns PageBox<I>
- Defined in page-master.ts:55

Properties

`Protected`_scope

_scope: LexicalScope

children

children: PageBox<PageBoxInstance<any>>[] = []

`Readonly`classes

classes: string[]

index

index: number = 0

key

key: string

`Readonly`name

name: string

pageMaster

pageMaster: PageMaster = null

`Readonly`parent

parent: PageBox

`Readonly`pseudoName

pseudoName: string

specified

specified: ElementStyle = {}

Accessors

scope

get scope(): LexicalScope
Returns LexicalScope
- Defined in page-master.ts:51

Methods

clone

clone(param: { parent?: PageBox; pseudoName?: string }): PageBox<I>
Clone the PageBox.
Parameters
- param: { parent?: PageBox; pseudoName?: string }
  parent: The parent of the cloned PageBox. pseudoName: Assign this value as the pseudoName of the cloned PageBox.
Returns PageBox<I>
- Defined in page-master.ts:79

`Protected`cloneChildren

cloneChildren(parent: PageBox): void
Clone children with the specified PageBox as their parent.
Parameters
- parent: PageBox
Returns void
- Defined in page-master.ts:100

`Protected`copySpecified

copySpecified(dest: PageBox): void
Copy 'specified' properties to another instance.
Parameters
- dest: PageBox
  The PageBox into which 'specified' properties are copied
Returns void
- Defined in page-master.ts:87

createInstance

createInstance(parentInstance: PageBoxInstance): PageBoxInstance
Parameters
- parentInstance: PageBoxInstance
Returns PageBoxInstance
- Defined in page-master.ts:70