Class PageRulePartition

Represent a partition placed in a PageRuleMaster

Param: style

Cascaded style for @page rules

Hierarchy (View Summary)

Partition<PageRulePartitionInstance>
- PageRulePartition

Index

Constructors

Properties

_scope children classes index key name pageAreaPartition pageMaster pageSize parent pseudoName specified

Accessors

Methods

clone cloneChildren copySpecified createInstance

Constructors

constructor

new PageRulePartition(
    scope: LexicalScope,
    parent: PageRuleMaster,
    style: ElementStyle,
    pageSize: PageSize,
): PageRulePartition
Parameters
- scope: LexicalScope
- parent: PageRuleMaster
- style: ElementStyle
- pageSize: PageSize
Returns PageRulePartition
Overrides Partition.constructor
- Defined in src/vivliostyle/css-page.ts:957

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

`Readonly`pageAreaPartition

pageAreaPartition: PageAreaPartition

pageMaster

pageMaster: PageMaster<PageMasterInstance<any>> = null

`Readonly`pageSize

pageSize: PageSize

`Readonly`parent

parent: PageBox<PageBoxInstance<any>>

`Readonly`pseudoName

pseudoName: string

specified

specified: ElementStyle = {}

Accessors

scope

get scope(): LexicalScope
Returns LexicalScope
Inherited from PageMaster.Partition.scope
- Defined in src/vivliostyle/page-master.ts:52

Methods

clone

clone(param: any): Partition
Clone the PageBox.
Parameters
- param: any
  parent: The parent of the cloned PageBox. pseudoName: Assign this value as the pseudoName of the cloned PageBox.
Returns Partition
Inherited from Partition.clone
- Defined in src/vivliostyle/page-master.ts:303

`Protected`cloneChildren

cloneChildren(parent: PageBox): void
Clone children with the specified PageBox as their parent.
Parameters
- parent: PageBox
Returns void
Inherited from Partition.cloneChildren
- Defined in src/vivliostyle/page-master.ts:105

`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
Inherited from Partition.copySpecified
- Defined in src/vivliostyle/page-master.ts:92

createInstance

createInstance(
    parentInstance: PageBoxInstance,
    context: Context,
    docElementStyle: ElementStyle,
): PageRulePartitionInstance
Parameters
- parentInstance: PageBoxInstance
- context: Context
- docElementStyle: ElementStyle
Returns PageRulePartitionInstance
Overrides Partition.createInstance
- Defined in src/vivliostyle/css-page.ts:993