@vivliostyle/core 2.24.2 → 2.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/vivliostyle/adaptive-viewer.d.ts +167 -167
- package/lib/vivliostyle/asserts.d.ts +21 -21
- package/lib/vivliostyle/assets.d.ts +35 -35
- package/lib/vivliostyle/base.d.ts +189 -189
- package/lib/vivliostyle/break-position.d.ts +39 -39
- package/lib/vivliostyle/break.d.ts +112 -112
- package/lib/vivliostyle/cfi.d.ts +77 -77
- package/lib/vivliostyle/columns.d.ts +52 -52
- package/lib/vivliostyle/constants.d.ts +53 -53
- package/lib/vivliostyle/core-viewer.d.ts +240 -240
- package/lib/vivliostyle/counters.d.ts +127 -127
- package/lib/vivliostyle/css-cascade.d.ts +974 -954
- package/lib/vivliostyle/css-logical-util.d.ts +3 -3
- package/lib/vivliostyle/css-page.d.ts +451 -450
- package/lib/vivliostyle/css-parser.d.ts +320 -320
- package/lib/vivliostyle/css-prop.d.ts +74 -74
- package/lib/vivliostyle/css-styler.d.ts +210 -210
- package/lib/vivliostyle/css-tokenizer.d.ts +243 -243
- package/lib/vivliostyle/css-validator.d.ts +319 -319
- package/lib/vivliostyle/css.d.ts +205 -205
- package/lib/vivliostyle/diff.d.ts +26 -26
- package/lib/vivliostyle/display.d.ts +62 -57
- package/lib/vivliostyle/epub.d.ts +329 -329
- package/lib/vivliostyle/exprs.d.ts +395 -395
- package/lib/vivliostyle/font.d.ts +87 -87
- package/lib/vivliostyle/footnotes.d.ts +41 -41
- package/lib/vivliostyle/geometry-util.d.ts +110 -110
- package/lib/vivliostyle/layout-helper.d.ts +16 -15
- package/lib/vivliostyle/layout-processor.d.ts +73 -73
- package/lib/vivliostyle/layout-retryers.d.ts +21 -21
- package/lib/vivliostyle/layout-util.d.ts +55 -55
- package/lib/vivliostyle/layout.d.ts +456 -456
- package/lib/vivliostyle/logging.d.ts +56 -56
- package/lib/vivliostyle/matchers.d.ts +36 -36
- package/lib/vivliostyle/math-util.d.ts +22 -22
- package/lib/vivliostyle/net.d.ts +72 -72
- package/lib/vivliostyle/ops.d.ts +263 -263
- package/lib/vivliostyle/page-floats.d.ts +178 -178
- package/lib/vivliostyle/page-master.d.ts +247 -247
- package/lib/vivliostyle/plugin.d.ts +172 -172
- package/lib/vivliostyle/print.d.ts +7 -7
- package/lib/vivliostyle/profile.d.ts +59 -59
- package/lib/vivliostyle/pseudo-element.d.ts +32 -32
- package/lib/vivliostyle/repetitive-element.d.ts +162 -162
- package/lib/vivliostyle/scripts.d.ts +15 -15
- package/lib/vivliostyle/sha1.d.ts +33 -33
- package/lib/vivliostyle/shared.d.ts +24 -24
- package/lib/vivliostyle/sizing.d.ts +29 -29
- package/lib/vivliostyle/table.d.ts +263 -263
- package/lib/vivliostyle/task-util.d.ts +37 -37
- package/lib/vivliostyle/task.d.ts +357 -357
- package/lib/vivliostyle/text-polyfill.d.ts +3 -3
- package/lib/vivliostyle/toc.d.ts +64 -64
- package/lib/vivliostyle/types.d.ts +977 -977
- package/lib/vivliostyle/urls.d.ts +25 -25
- package/lib/vivliostyle/vgen.d.ts +213 -213
- package/lib/vivliostyle/viewer-app.d.ts +19 -19
- package/lib/vivliostyle/vtree.d.ts +392 -392
- package/lib/vivliostyle/xml-doc.d.ts +88 -88
- package/lib/vivliostyle.d.ts +6 -6
- package/lib/vivliostyle.js +1 -1
- package/lib/vivliostyle.js.map +1 -1
- package/package.json +5 -5
|
@@ -1,247 +1,247 @@
|
|
|
1
|
-
import * as Css from "./css";
|
|
2
|
-
import * as CssCascade from "./css-cascade";
|
|
3
|
-
import * as CssParser from "./css-parser";
|
|
4
|
-
import * as CssValidator from "./css-validator";
|
|
5
|
-
import * as Exprs from "./exprs";
|
|
6
|
-
import * as Font from "./font";
|
|
7
|
-
import * as Vtree from "./vtree";
|
|
8
|
-
export declare let keyCount: number;
|
|
9
|
-
/**
|
|
10
|
-
* Represent an at-rule which creates a page-level CSS box (page-master,
|
|
11
|
-
* partition, and partition-group).
|
|
12
|
-
*/
|
|
13
|
-
export declare abstract class PageBox<I extends PageBoxInstance = PageBoxInstance<any>> {
|
|
14
|
-
readonly name: string | null;
|
|
15
|
-
readonly pseudoName: string | null;
|
|
16
|
-
readonly classes: string[];
|
|
17
|
-
readonly parent: PageBox;
|
|
18
|
-
specified: CssCascade.ElementStyle;
|
|
19
|
-
children: PageBox[];
|
|
20
|
-
pageMaster: PageMaster;
|
|
21
|
-
index: number;
|
|
22
|
-
key: string;
|
|
23
|
-
protected _scope: Exprs.LexicalScope;
|
|
24
|
-
get scope(): Exprs.LexicalScope;
|
|
25
|
-
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
26
|
-
createInstance(parentInstance: PageBoxInstance): PageBoxInstance;
|
|
27
|
-
/**
|
|
28
|
-
* Clone the PageBox.
|
|
29
|
-
* @param param parent: The parent of the cloned PageBox.
|
|
30
|
-
* pseudoName: Assign this value as the pseudoName of the cloned PageBox.
|
|
31
|
-
*/
|
|
32
|
-
clone(param: {
|
|
33
|
-
parent?: PageBox;
|
|
34
|
-
pseudoName?: string;
|
|
35
|
-
}): PageBox<I>;
|
|
36
|
-
/**
|
|
37
|
-
* Copy 'specified' properties to another instance.
|
|
38
|
-
* @param dest The PageBox into which 'specified' properties are copied
|
|
39
|
-
*/
|
|
40
|
-
protected copySpecified(dest: PageBox): void;
|
|
41
|
-
/**
|
|
42
|
-
* Clone children with the specified PageBox as their parent.
|
|
43
|
-
*/
|
|
44
|
-
protected cloneChildren(parent: PageBox): void;
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* Parent of all page masters
|
|
48
|
-
*/
|
|
49
|
-
export declare class RootPageBox extends PageBox<RootPageBoxInstance> {
|
|
50
|
-
constructor(scope: Exprs.LexicalScope);
|
|
51
|
-
}
|
|
52
|
-
export declare class PageMasterScope extends Exprs.LexicalScope {
|
|
53
|
-
pageMaster: PageMaster;
|
|
54
|
-
constructor(scope: Exprs.LexicalScope, pageMaster: PageMaster);
|
|
55
|
-
}
|
|
56
|
-
/**
|
|
57
|
-
* Represent a page-master rule
|
|
58
|
-
*/
|
|
59
|
-
export declare class PageMaster<I extends PageMasterInstance = PageMasterInstance<any>> extends PageBox<I> {
|
|
60
|
-
readonly condition: Exprs.Val;
|
|
61
|
-
readonly specificity: number;
|
|
62
|
-
keyMap: {
|
|
63
|
-
[key: string]: string;
|
|
64
|
-
};
|
|
65
|
-
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: RootPageBox, condition: Exprs.Val, specificity: number);
|
|
66
|
-
createInstance(parentInstance: any): PageBoxInstance;
|
|
67
|
-
clone(param: any): PageMaster;
|
|
68
|
-
/**
|
|
69
|
-
* Point the pageMaster reference in the PageMasterScope to the current page
|
|
70
|
-
* master. This is needed when a page master is cloned and shares a common
|
|
71
|
-
* scope with the original page master. Since every Exprs.Val which the
|
|
72
|
-
* page master holds has a reference to the scope and uses it for variable
|
|
73
|
-
* resolution, this reference must be updated properly before the page master
|
|
74
|
-
* instance is used.
|
|
75
|
-
*/
|
|
76
|
-
resetScope(): void;
|
|
77
|
-
}
|
|
78
|
-
/**
|
|
79
|
-
* Represent a partition-group rule
|
|
80
|
-
*/
|
|
81
|
-
export declare class PartitionGroup extends PageBox<PartitionGroupInstance> {
|
|
82
|
-
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
83
|
-
createInstance(parentInstance: PageBoxInstance): PageBoxInstance;
|
|
84
|
-
clone(param: any): PartitionGroup;
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* Represent a partition rule
|
|
88
|
-
*/
|
|
89
|
-
export declare class Partition<I extends PartitionInstance = PartitionInstance> extends PageBox<I> {
|
|
90
|
-
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
91
|
-
createInstance(parentInstance: any): PageBoxInstance;
|
|
92
|
-
clone(param: any): Partition;
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* @param def default value
|
|
96
|
-
*/
|
|
97
|
-
export declare function toExprIdent(scope: Exprs.LexicalScope, val: Css.Val, def: string): Exprs.Val;
|
|
98
|
-
export declare function toExprAuto(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
99
|
-
export declare function toExprNormal(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
100
|
-
export declare function toExprZero(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
101
|
-
/**
|
|
102
|
-
* If the value is not specified (null), returns zero.
|
|
103
|
-
* If the value is 'auto', returns null.
|
|
104
|
-
* Otherwise, return the value itself.
|
|
105
|
-
*/
|
|
106
|
-
export declare function toExprZeroAuto(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
107
|
-
export declare function toExprZeroBorder(scope: Exprs.LexicalScope, val: Css.Val, styleVal: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
108
|
-
export declare function toExprBool(scope: Exprs.LexicalScope, val: Css.Val, def: Exprs.Val): Exprs.Val;
|
|
109
|
-
export interface InstanceHolder extends Exprs.Context {
|
|
110
|
-
registerInstance(key: string, instance: PageBoxInstance): void;
|
|
111
|
-
/**
|
|
112
|
-
* @return instance
|
|
113
|
-
*/
|
|
114
|
-
lookupInstance(key: string): PageBoxInstance;
|
|
115
|
-
}
|
|
116
|
-
export declare class PageBoxInstance<P extends PageBox = PageBox<any>> {
|
|
117
|
-
readonly parentInstance: PageBoxInstance;
|
|
118
|
-
readonly pageBox: P;
|
|
119
|
-
/**
|
|
120
|
-
* cascaded styles, geometric ones converted to Css.Expr
|
|
121
|
-
*/
|
|
122
|
-
protected cascaded: CssCascade.ElementStyle;
|
|
123
|
-
style: {
|
|
124
|
-
[key: string]: Css.Val;
|
|
125
|
-
};
|
|
126
|
-
private autoWidth;
|
|
127
|
-
private autoHeight;
|
|
128
|
-
children: PageBoxInstance[];
|
|
129
|
-
isAutoWidth: boolean;
|
|
130
|
-
isAutoHeight: boolean;
|
|
131
|
-
isTopDependentOnAutoHeight: boolean;
|
|
132
|
-
isRightDependentOnAutoWidth: boolean;
|
|
133
|
-
private calculatedWidth;
|
|
134
|
-
private calculatedHeight;
|
|
135
|
-
pageMasterInstance: PageMasterInstance;
|
|
136
|
-
namedValues: {
|
|
137
|
-
[key: string]: Exprs.Val;
|
|
138
|
-
};
|
|
139
|
-
namedFuncs: {
|
|
140
|
-
[key: string]: Exprs.Val;
|
|
141
|
-
};
|
|
142
|
-
vertical: boolean;
|
|
143
|
-
rtl: boolean;
|
|
144
|
-
suppressEmptyBoxGeneration: boolean;
|
|
145
|
-
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
146
|
-
/**
|
|
147
|
-
* Reset information related to layout.
|
|
148
|
-
*/
|
|
149
|
-
reset(): void;
|
|
150
|
-
private addNamedValues;
|
|
151
|
-
resolveName(name: string): Exprs.Val;
|
|
152
|
-
resolveFunc(name: any): Exprs.Val;
|
|
153
|
-
private initEnabled;
|
|
154
|
-
protected boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
155
|
-
protected initHorizontal(): void;
|
|
156
|
-
protected initVertical(): void;
|
|
157
|
-
private initColumns;
|
|
158
|
-
private depends;
|
|
159
|
-
private init;
|
|
160
|
-
getProp(context: Exprs.Context, name: string): Css.Val;
|
|
161
|
-
getPropAsNumber(context: Exprs.Context, name: string): number;
|
|
162
|
-
getSpecial(context: Exprs.Context, name: string): Css.Val[];
|
|
163
|
-
getActiveRegions(context: Exprs.Context): string[];
|
|
164
|
-
propagateProperty(context: Exprs.Context, container: Vtree.Container, name: string, docFaces: Font.DocumentFaces): void;
|
|
165
|
-
propagatePropertyToElement(context: Exprs.Context, element: Element, name: string, docFaces: Font.DocumentFaces): void;
|
|
166
|
-
propagateDelayedProperty(context: Exprs.Context, container: Vtree.Container, name: string, delayedItems: Vtree.DelayedItem[]): void;
|
|
167
|
-
assignLeftPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
168
|
-
assignRightPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
169
|
-
assignTopPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
170
|
-
assignBottomPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
171
|
-
assignBeforePosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
172
|
-
assignAfterPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
173
|
-
assignStartEndPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
174
|
-
sizeWithMaxHeight(context: Exprs.Context, container: Vtree.Container): void;
|
|
175
|
-
sizeWithMaxWidth(context: Exprs.Context, container: Vtree.Container): void;
|
|
176
|
-
prepareContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces, clientLayout: Vtree.ClientLayout): void;
|
|
177
|
-
transferContentProps(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces): void;
|
|
178
|
-
|
|
179
|
-
/**
|
|
180
|
-
* @param column (null when content comes from the content property)
|
|
181
|
-
*/
|
|
182
|
-
finishContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, column: Vtree.Container, columnCount: number, clientLayout: Vtree.ClientLayout, docFaces: Font.DocumentFaces): void;
|
|
183
|
-
applyCascadeAndInit(cascade: CssCascade.CascadeInstance, docElementStyle: CssCascade.ElementStyle): void;
|
|
184
|
-
resolveAutoSizing(context: Exprs.Context): void;
|
|
185
|
-
}
|
|
186
|
-
/**
|
|
187
|
-
* Properties that are passed through before the layout.
|
|
188
|
-
*/
|
|
189
|
-
export declare const passPreProperties: string[];
|
|
190
|
-
/**
|
|
191
|
-
* Properties that are passed through after the layout.
|
|
192
|
-
*/
|
|
193
|
-
export declare const passPostProperties: string[];
|
|
194
|
-
/**
|
|
195
|
-
* Only passed when there is content assigned by the content property.
|
|
196
|
-
*/
|
|
197
|
-
export declare const passContentProperties: string[];
|
|
198
|
-
export declare const passSingleUriContentProperties: string[];
|
|
199
|
-
export declare const delayedProperties: string[];
|
|
200
|
-
export declare const userAgentPageMasterPseudo = "background-host";
|
|
201
|
-
export declare class RootPageBoxInstance extends PageBoxInstance<RootPageBox> {
|
|
202
|
-
constructor(pageBox: RootPageBox);
|
|
203
|
-
applyCascadeAndInit(cascade: CssCascade.CascadeInstance, docElementStyle: CssCascade.ElementStyle): void;
|
|
204
|
-
}
|
|
205
|
-
export declare class PageMasterInstance<P extends PageMaster = PageMaster<PageMasterInstance<any>>> extends PageBoxInstance<P> {
|
|
206
|
-
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
207
|
-
boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
208
|
-
/**
|
|
209
|
-
* Called after layout of contents of the page has done to adjust the overall
|
|
210
|
-
* page layout. Override in subclasses.
|
|
211
|
-
*/
|
|
212
|
-
adjustPageLayout(context: Exprs.Context, page: Vtree.Page, clientLayout: Vtree.ClientLayout): void;
|
|
213
|
-
}
|
|
214
|
-
export declare class PartitionGroupInstance extends PageBoxInstance<PartitionGroup> {
|
|
215
|
-
constructor(parentInstance: PageBoxInstance, pageBox: PageBox);
|
|
216
|
-
}
|
|
217
|
-
export declare class PartitionInstance<P extends Partition = Partition<PartitionInstance<any>>> extends PageBoxInstance<P> {
|
|
218
|
-
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
219
|
-
processPartitionList(enabled: Exprs.Val, listVal: Css.Val, conflicting: boolean): Exprs.Val;
|
|
220
|
-
boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
221
|
-
prepareContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces, clientLayout: Vtree.ClientLayout): void;
|
|
222
|
-
}
|
|
223
|
-
export declare class PageBoxParserHandler extends CssParser.SlaveParserHandler implements CssValidator.PropertyReceiver {
|
|
224
|
-
readonly target: PageBox;
|
|
225
|
-
readonly validatorSet: CssValidator.ValidatorSet;
|
|
226
|
-
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PageBox, validatorSet: CssValidator.ValidatorSet);
|
|
227
|
-
property(name: string, value: Css.Val, important: boolean): void;
|
|
228
|
-
/** @override */
|
|
229
|
-
unknownProperty(name: string, value: Css.Val): void;
|
|
230
|
-
/** @override */
|
|
231
|
-
invalidPropertyValue(name: string, value: Css.Val): void;
|
|
232
|
-
/** @override */
|
|
233
|
-
simpleProperty(name: string, value: Css.Val, important: any): void;
|
|
234
|
-
}
|
|
235
|
-
export declare class PartitionParserHandler extends PageBoxParserHandler {
|
|
236
|
-
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: Partition, validatorSet: CssValidator.ValidatorSet);
|
|
237
|
-
}
|
|
238
|
-
export declare class PartitionGroupParserHandler extends PageBoxParserHandler {
|
|
239
|
-
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PartitionGroup, validatorSet: CssValidator.ValidatorSet);
|
|
240
|
-
startPartitionRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
241
|
-
startPartitionGroupRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
242
|
-
}
|
|
243
|
-
export declare class PageMasterParserHandler extends PageBoxParserHandler {
|
|
244
|
-
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PageMaster, validatorSet: CssValidator.ValidatorSet);
|
|
245
|
-
startPartitionRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
246
|
-
startPartitionGroupRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
247
|
-
}
|
|
1
|
+
import * as Css from "./css";
|
|
2
|
+
import * as CssCascade from "./css-cascade";
|
|
3
|
+
import * as CssParser from "./css-parser";
|
|
4
|
+
import * as CssValidator from "./css-validator";
|
|
5
|
+
import * as Exprs from "./exprs";
|
|
6
|
+
import * as Font from "./font";
|
|
7
|
+
import * as Vtree from "./vtree";
|
|
8
|
+
export declare let keyCount: number;
|
|
9
|
+
/**
|
|
10
|
+
* Represent an at-rule which creates a page-level CSS box (page-master,
|
|
11
|
+
* partition, and partition-group).
|
|
12
|
+
*/
|
|
13
|
+
export declare abstract class PageBox<I extends PageBoxInstance = PageBoxInstance<any>> {
|
|
14
|
+
readonly name: string | null;
|
|
15
|
+
readonly pseudoName: string | null;
|
|
16
|
+
readonly classes: string[];
|
|
17
|
+
readonly parent: PageBox;
|
|
18
|
+
specified: CssCascade.ElementStyle;
|
|
19
|
+
children: PageBox[];
|
|
20
|
+
pageMaster: PageMaster;
|
|
21
|
+
index: number;
|
|
22
|
+
key: string;
|
|
23
|
+
protected _scope: Exprs.LexicalScope;
|
|
24
|
+
get scope(): Exprs.LexicalScope;
|
|
25
|
+
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
26
|
+
createInstance(parentInstance: PageBoxInstance): PageBoxInstance;
|
|
27
|
+
/**
|
|
28
|
+
* Clone the PageBox.
|
|
29
|
+
* @param param parent: The parent of the cloned PageBox.
|
|
30
|
+
* pseudoName: Assign this value as the pseudoName of the cloned PageBox.
|
|
31
|
+
*/
|
|
32
|
+
clone(param: {
|
|
33
|
+
parent?: PageBox;
|
|
34
|
+
pseudoName?: string;
|
|
35
|
+
}): PageBox<I>;
|
|
36
|
+
/**
|
|
37
|
+
* Copy 'specified' properties to another instance.
|
|
38
|
+
* @param dest The PageBox into which 'specified' properties are copied
|
|
39
|
+
*/
|
|
40
|
+
protected copySpecified(dest: PageBox): void;
|
|
41
|
+
/**
|
|
42
|
+
* Clone children with the specified PageBox as their parent.
|
|
43
|
+
*/
|
|
44
|
+
protected cloneChildren(parent: PageBox): void;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Parent of all page masters
|
|
48
|
+
*/
|
|
49
|
+
export declare class RootPageBox extends PageBox<RootPageBoxInstance> {
|
|
50
|
+
constructor(scope: Exprs.LexicalScope);
|
|
51
|
+
}
|
|
52
|
+
export declare class PageMasterScope extends Exprs.LexicalScope {
|
|
53
|
+
pageMaster: PageMaster;
|
|
54
|
+
constructor(scope: Exprs.LexicalScope, pageMaster: PageMaster);
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Represent a page-master rule
|
|
58
|
+
*/
|
|
59
|
+
export declare class PageMaster<I extends PageMasterInstance = PageMasterInstance<any>> extends PageBox<I> {
|
|
60
|
+
readonly condition: Exprs.Val;
|
|
61
|
+
readonly specificity: number;
|
|
62
|
+
keyMap: {
|
|
63
|
+
[key: string]: string;
|
|
64
|
+
};
|
|
65
|
+
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: RootPageBox, condition: Exprs.Val, specificity: number);
|
|
66
|
+
createInstance(parentInstance: any): PageBoxInstance;
|
|
67
|
+
clone(param: any): PageMaster;
|
|
68
|
+
/**
|
|
69
|
+
* Point the pageMaster reference in the PageMasterScope to the current page
|
|
70
|
+
* master. This is needed when a page master is cloned and shares a common
|
|
71
|
+
* scope with the original page master. Since every Exprs.Val which the
|
|
72
|
+
* page master holds has a reference to the scope and uses it for variable
|
|
73
|
+
* resolution, this reference must be updated properly before the page master
|
|
74
|
+
* instance is used.
|
|
75
|
+
*/
|
|
76
|
+
resetScope(): void;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Represent a partition-group rule
|
|
80
|
+
*/
|
|
81
|
+
export declare class PartitionGroup extends PageBox<PartitionGroupInstance> {
|
|
82
|
+
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
83
|
+
createInstance(parentInstance: PageBoxInstance): PageBoxInstance;
|
|
84
|
+
clone(param: any): PartitionGroup;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Represent a partition rule
|
|
88
|
+
*/
|
|
89
|
+
export declare class Partition<I extends PartitionInstance = PartitionInstance> extends PageBox<I> {
|
|
90
|
+
constructor(scope: Exprs.LexicalScope, name: string | null, pseudoName: string | null, classes: string[], parent: PageBox);
|
|
91
|
+
createInstance(parentInstance: any): PageBoxInstance;
|
|
92
|
+
clone(param: any): Partition;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* @param def default value
|
|
96
|
+
*/
|
|
97
|
+
export declare function toExprIdent(scope: Exprs.LexicalScope, val: Css.Val, def: string): Exprs.Val;
|
|
98
|
+
export declare function toExprAuto(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
99
|
+
export declare function toExprNormal(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
100
|
+
export declare function toExprZero(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
101
|
+
/**
|
|
102
|
+
* If the value is not specified (null), returns zero.
|
|
103
|
+
* If the value is 'auto', returns null.
|
|
104
|
+
* Otherwise, return the value itself.
|
|
105
|
+
*/
|
|
106
|
+
export declare function toExprZeroAuto(scope: Exprs.LexicalScope, val: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
107
|
+
export declare function toExprZeroBorder(scope: Exprs.LexicalScope, val: Css.Val, styleVal: Css.Val, ref: Exprs.Val): Exprs.Val;
|
|
108
|
+
export declare function toExprBool(scope: Exprs.LexicalScope, val: Css.Val, def: Exprs.Val): Exprs.Val;
|
|
109
|
+
export interface InstanceHolder extends Exprs.Context {
|
|
110
|
+
registerInstance(key: string, instance: PageBoxInstance): void;
|
|
111
|
+
/**
|
|
112
|
+
* @return instance
|
|
113
|
+
*/
|
|
114
|
+
lookupInstance(key: string): PageBoxInstance;
|
|
115
|
+
}
|
|
116
|
+
export declare class PageBoxInstance<P extends PageBox = PageBox<any>> {
|
|
117
|
+
readonly parentInstance: PageBoxInstance;
|
|
118
|
+
readonly pageBox: P;
|
|
119
|
+
/**
|
|
120
|
+
* cascaded styles, geometric ones converted to Css.Expr
|
|
121
|
+
*/
|
|
122
|
+
protected cascaded: CssCascade.ElementStyle;
|
|
123
|
+
style: {
|
|
124
|
+
[key: string]: Css.Val;
|
|
125
|
+
};
|
|
126
|
+
private autoWidth;
|
|
127
|
+
private autoHeight;
|
|
128
|
+
children: PageBoxInstance[];
|
|
129
|
+
isAutoWidth: boolean;
|
|
130
|
+
isAutoHeight: boolean;
|
|
131
|
+
isTopDependentOnAutoHeight: boolean;
|
|
132
|
+
isRightDependentOnAutoWidth: boolean;
|
|
133
|
+
private calculatedWidth;
|
|
134
|
+
private calculatedHeight;
|
|
135
|
+
pageMasterInstance: PageMasterInstance;
|
|
136
|
+
namedValues: {
|
|
137
|
+
[key: string]: Exprs.Val;
|
|
138
|
+
};
|
|
139
|
+
namedFuncs: {
|
|
140
|
+
[key: string]: Exprs.Val;
|
|
141
|
+
};
|
|
142
|
+
vertical: boolean;
|
|
143
|
+
rtl: boolean;
|
|
144
|
+
suppressEmptyBoxGeneration: boolean;
|
|
145
|
+
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
146
|
+
/**
|
|
147
|
+
* Reset information related to layout.
|
|
148
|
+
*/
|
|
149
|
+
reset(): void;
|
|
150
|
+
private addNamedValues;
|
|
151
|
+
resolveName(name: string): Exprs.Val;
|
|
152
|
+
resolveFunc(name: any): Exprs.Val;
|
|
153
|
+
private initEnabled;
|
|
154
|
+
protected boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
155
|
+
protected initHorizontal(): void;
|
|
156
|
+
protected initVertical(): void;
|
|
157
|
+
private initColumns;
|
|
158
|
+
private depends;
|
|
159
|
+
private init;
|
|
160
|
+
getProp(context: Exprs.Context, name: string): Css.Val;
|
|
161
|
+
getPropAsNumber(context: Exprs.Context, name: string): number;
|
|
162
|
+
getSpecial(context: Exprs.Context, name: string): Css.Val[];
|
|
163
|
+
getActiveRegions(context: Exprs.Context): string[];
|
|
164
|
+
propagateProperty(context: Exprs.Context, container: Vtree.Container, name: string, docFaces: Font.DocumentFaces): void;
|
|
165
|
+
propagatePropertyToElement(context: Exprs.Context, element: Element, name: string, docFaces: Font.DocumentFaces): void;
|
|
166
|
+
propagateDelayedProperty(context: Exprs.Context, container: Vtree.Container, name: string, delayedItems: Vtree.DelayedItem[]): void;
|
|
167
|
+
assignLeftPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
168
|
+
assignRightPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
169
|
+
assignTopPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
170
|
+
assignBottomPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
171
|
+
assignBeforePosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
172
|
+
assignAfterPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
173
|
+
assignStartEndPosition(context: Exprs.Context, container: Vtree.Container): void;
|
|
174
|
+
sizeWithMaxHeight(context: Exprs.Context, container: Vtree.Container): void;
|
|
175
|
+
sizeWithMaxWidth(context: Exprs.Context, container: Vtree.Container): void;
|
|
176
|
+
prepareContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces, clientLayout: Vtree.ClientLayout): void;
|
|
177
|
+
transferContentProps(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces): void;
|
|
178
|
+
transferSingleUriContentProps(context: Exprs.Context, element: Element, docFaces: Font.DocumentFaces): void;
|
|
179
|
+
/**
|
|
180
|
+
* @param column (null when content comes from the content property)
|
|
181
|
+
*/
|
|
182
|
+
finishContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, column: Vtree.Container, columnCount: number, clientLayout: Vtree.ClientLayout, docFaces: Font.DocumentFaces): void;
|
|
183
|
+
applyCascadeAndInit(cascade: CssCascade.CascadeInstance, docElementStyle: CssCascade.ElementStyle): void;
|
|
184
|
+
resolveAutoSizing(context: Exprs.Context): void;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Properties that are passed through before the layout.
|
|
188
|
+
*/
|
|
189
|
+
export declare const passPreProperties: string[];
|
|
190
|
+
/**
|
|
191
|
+
* Properties that are passed through after the layout.
|
|
192
|
+
*/
|
|
193
|
+
export declare const passPostProperties: string[];
|
|
194
|
+
/**
|
|
195
|
+
* Only passed when there is content assigned by the content property.
|
|
196
|
+
*/
|
|
197
|
+
export declare const passContentProperties: string[];
|
|
198
|
+
export declare const passSingleUriContentProperties: string[];
|
|
199
|
+
export declare const delayedProperties: string[];
|
|
200
|
+
export declare const userAgentPageMasterPseudo = "background-host";
|
|
201
|
+
export declare class RootPageBoxInstance extends PageBoxInstance<RootPageBox> {
|
|
202
|
+
constructor(pageBox: RootPageBox);
|
|
203
|
+
applyCascadeAndInit(cascade: CssCascade.CascadeInstance, docElementStyle: CssCascade.ElementStyle): void;
|
|
204
|
+
}
|
|
205
|
+
export declare class PageMasterInstance<P extends PageMaster = PageMaster<PageMasterInstance<any>>> extends PageBoxInstance<P> {
|
|
206
|
+
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
207
|
+
boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
208
|
+
/**
|
|
209
|
+
* Called after layout of contents of the page has done to adjust the overall
|
|
210
|
+
* page layout. Override in subclasses.
|
|
211
|
+
*/
|
|
212
|
+
adjustPageLayout(context: Exprs.Context, page: Vtree.Page, clientLayout: Vtree.ClientLayout): void;
|
|
213
|
+
}
|
|
214
|
+
export declare class PartitionGroupInstance extends PageBoxInstance<PartitionGroup> {
|
|
215
|
+
constructor(parentInstance: PageBoxInstance, pageBox: PageBox);
|
|
216
|
+
}
|
|
217
|
+
export declare class PartitionInstance<P extends Partition = Partition<PartitionInstance<any>>> extends PageBoxInstance<P> {
|
|
218
|
+
constructor(parentInstance: PageBoxInstance, pageBox: P);
|
|
219
|
+
processPartitionList(enabled: Exprs.Val, listVal: Css.Val, conflicting: boolean): Exprs.Val;
|
|
220
|
+
boxSpecificEnabled(enabled: Exprs.Val): Exprs.Val;
|
|
221
|
+
prepareContainer(context: Exprs.Context, container: Vtree.Container, page: Vtree.Page, docFaces: Font.DocumentFaces, clientLayout: Vtree.ClientLayout): void;
|
|
222
|
+
}
|
|
223
|
+
export declare class PageBoxParserHandler extends CssParser.SlaveParserHandler implements CssValidator.PropertyReceiver {
|
|
224
|
+
readonly target: PageBox;
|
|
225
|
+
readonly validatorSet: CssValidator.ValidatorSet;
|
|
226
|
+
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PageBox, validatorSet: CssValidator.ValidatorSet);
|
|
227
|
+
property(name: string, value: Css.Val, important: boolean): void;
|
|
228
|
+
/** @override */
|
|
229
|
+
unknownProperty(name: string, value: Css.Val): void;
|
|
230
|
+
/** @override */
|
|
231
|
+
invalidPropertyValue(name: string, value: Css.Val): void;
|
|
232
|
+
/** @override */
|
|
233
|
+
simpleProperty(name: string, value: Css.Val, important: any): void;
|
|
234
|
+
}
|
|
235
|
+
export declare class PartitionParserHandler extends PageBoxParserHandler {
|
|
236
|
+
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: Partition, validatorSet: CssValidator.ValidatorSet);
|
|
237
|
+
}
|
|
238
|
+
export declare class PartitionGroupParserHandler extends PageBoxParserHandler {
|
|
239
|
+
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PartitionGroup, validatorSet: CssValidator.ValidatorSet);
|
|
240
|
+
startPartitionRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
241
|
+
startPartitionGroupRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
242
|
+
}
|
|
243
|
+
export declare class PageMasterParserHandler extends PageBoxParserHandler {
|
|
244
|
+
constructor(scope: Exprs.LexicalScope, owner: CssParser.DispatchParserHandler, target: PageMaster, validatorSet: CssValidator.ValidatorSet);
|
|
245
|
+
startPartitionRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
246
|
+
startPartitionGroupRule(name: string | null, pseudoName: string | null, classes: string[]): void;
|
|
247
|
+
}
|