Enumeration HOOKS

Called when a Viewer is configured.

The hook is called with an object with the following properties: {Base.JSON} command

Called before geting CssCascade.polyfilledInheritedProps.

The hook return a array of polyfilled inherited property name.

Called after laid out a block contents.

The hook is called with an object with the following properties: {Vtree.NodeContext} nodeContext {Array.<Vtree.NodeContext>} checkPoints {Layout.Column} column

Called before creating a element for modifying a element style.

The hook is called with an object with the following properties: {Vtree.NodeContext} nodeContext {!Object} style

Called when a single document (i.e. a single spine item) has been fetched, before parsing.

The hook is called with the Document object.

Called before creating a text node for modifying a text content.

The hook is called with an object with the following properties: {Vtree.NodeContext} nodeContext {string} sourceTextContent

Functions called by this hook are expected to return a Task.Result.. The text content is then replaced by the returned value.

Called when resolving a formatting context.

The hook is called with the following parameters: nodeContext: a NodeContext object firstTime: a boolean flag representing whether this node is encountered for the first time or not display: an Css.Ident value representing 'display' value of the node position: an Css.Ident value representing 'position' value of the node float: an Css.Ident value representing 'float' value of the node isRoot: a boolean flag representing whether this node is a root (of a flow) or not Functions called by this hook are expected to return a formatting context for the NodeContext.

Called when resolving a layout processor (LayoutProcessor) for a formatting context.

The hook is called with a formatting context (Vtree.FormattingContext). Functions called by this hook are expected to return a layout processor corresponding to the formatting context.

Called when resolving a text node breaker which detects an acceptable breakpoint and break text node at this point.

The hook is called with an object with the following properties: {Vtree.NodeContext} nodeContext

Functions called by this hook are expected to return an instnce of {Layout.TextNodeBreaker} or null.

Called when a single property declaration is parsed.

The hook is called with an object with the following properties: {string} name: Property name {!Css.Val} value: Property value {boolean} important: Whether '!important' flag is present or not Functions called by this hook are expected to return a value with the same type as the above. The declaration is then replaced by the returned value.

Note that a shorthand declaration is not directly passed to this hook. After the shorthand declaration is interpreted and broken into non-shorthand declarations, the hook is called for each of the non-shorthand declarations.