com.openhtmltopdf.css.extend

Interface ContentFunction

All Known Implementing Classes:

ContentFunctionAbstract, ContentFunctionFactory.LeaderFunction

public interface ContentFunction

Interface for objects which implement a function which creates content (e.g. counter(pages))

Method Summary

Modifier and Type	Method and Description
String	calculate(LayoutContext c, FSFunction function)
String	calculate(RenderingContext c, FSFunction function, InlineText text)
boolean	canHandle(LayoutContext c, FSFunction function)
String	getLayoutReplacementText() If a function value can change at render time (i.e.
default String	getPostBoxingLayoutReplacementText(LayoutContext c, Element element, FSFunction fsFunction) Some content functions can provide a better replacement text after boxing but before layout (ie.
default boolean	isCalculableAtLayout() Is the calculate method going to return valid results if called before or during layout as opposed to at render time.
boolean	isStatic() Whether or not the function value can change at render time.

Method Detail

isStatic

boolean isStatic()

Whether or not the function value can change at render time. If true, calculate(LayoutContext, FSFunction) will be called. If false, calculate(RenderingContext, FSFunction, InlineText) will be called.

calculate

String calculate(LayoutContext c,
                 FSFunction function)

calculate

String calculate(RenderingContext c,
                 FSFunction function,
                 InlineText text)

getLayoutReplacementText

String getLayoutReplacementText()

If a function value can change at render time (i.e. isStatic() returns false) use this text as an approximation at layout.

getPostBoxingLayoutReplacementText

default String getPostBoxingLayoutReplacementText(LayoutContext c,
                                                  Element element,
                                                  FSFunction fsFunction)

Some content functions can provide a better replacement text after boxing but before layout (ie. target-text).

canHandle

boolean canHandle(LayoutContext c,
                  FSFunction function)

isCalculableAtLayout

default boolean isCalculableAtLayout()

Is the calculate method going to return valid results if called before or during layout as opposed to at render time.