Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ContentFunctionFactory.FsIfCutOffFunction Content function which returns its argument if on a cut off page, else the empty string.
private static class	ContentFunctionFactory.LeaderFunction Partially implements leaders as specified here: http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#leaders
private static class	ContentFunctionFactory.PageCounterFunction
private abstract static class	ContentFunctionFactory.PageNumberFunction
private static class	ContentFunctionFactory.PagesCounterFunction
private static class	ContentFunctionFactory.TargetCounterFunction Partially implements target counter as specified here: http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#cross-references
private static class	ContentFunctionFactory.TargetTextFunction

Field Summary

Modifier and Type	Field and Description
private final List<ContentFunction>	_functions

Access	Constructor and Description
public	ContentFunctionFactory()

Modifier and Type	Method and Description
public ContentFunction	lookupFunction(LayoutContext c, FSFunction function)
public void	registerFunction(ContentFunction function)

Field Detail

_functions	back to summary
private final List<ContentFunction> _functions

ContentFunctionFactory	back to summary
public ContentFunctionFactory()

lookupFunction	back to summary
public ContentFunction lookupFunction(LayoutContext c, FSFunction function)

registerFunction	back to summary
public void registerFunction(ContentFunction function)

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.FsIfCutOffFunction

Class Inheritance

extends Object
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.FsIfCutOffFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Content function which returns its argument if on a cut off page, else the empty string. Example: content: "Page " counter(page) -fs-if-cut-off(" continued") " of " counter(pages);

Constructor Summary

Access	Constructor and Description
private	FsIfCutOffFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.
public String	getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout.
public boolean	isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Whether or not the function value can change at render time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

FsIfCutOffFunction	back to summary
private FsIfCutOffFunction()

Method Detail

calculate	back to summary
public String calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

public String calculate(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

calculate	back to summary
public String calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

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

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

canHandle	back to summary
public boolean canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle. Annotations @Override

canHandle

back to summary

public boolean canHandle(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Annotations

@Override

getLayoutReplacementText back to summary

getLayoutReplacementText	back to summary
public String getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout. Annotations @Override

public String getLayoutReplacementText()

Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

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

Annotations

@Override

isStatic back to summary

isStatic	back to summary
public boolean isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Doc from com.openhtmltopdf.css.extend.ContentFunction.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. Annotations @Override

public boolean isStatic()

Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Doc from com.openhtmltopdf.css.extend.ContentFunction.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.

Annotations

@Override

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.LeaderFunction

Class Inheritance

extends Object
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.LeaderFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Partially implements leaders as specified here: http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#leaders

Constructor Summary

Access	Constructor and Description
private	LeaderFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public String	calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.
public String	getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout.
public boolean	isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Whether or not the function value can change at render time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

LeaderFunction	back to summary
private LeaderFunction()

Method Detail

calculate	back to summary
public String calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

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

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

calculate	back to summary
public String calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

public String calculate(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

canHandle	back to summary
public boolean canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle. Annotations @Override

canHandle

back to summary

public boolean canHandle(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Annotations

@Override

getLayoutReplacementText back to summary

getLayoutReplacementText	back to summary
public String getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout. Annotations @Override

public String getLayoutReplacementText()

Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

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

Annotations

@Override

isStatic back to summary

isStatic	back to summary
public boolean isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Doc from com.openhtmltopdf.css.extend.ContentFunction.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. Annotations @Override

public boolean isStatic()

Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Doc from com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Annotations

@Override

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.PageCounterFunction

Class Inheritance

extends PageNumberFunction
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.PageNumberFunction
com.openhtmltopdf.context.ContentFunctionFactory.PageCounterFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Constructor Summary

Access	Constructor and Description
private	PageCounterFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Inherited from com.openhtmltopdf.context.ContentFunctionFactory.PageNumberFunction:: calculate getLayoutReplacementText getListStyleType isCounter isStatic

Constructor Detail

PageCounterFunction	back to summary
private PageCounterFunction()

Method Detail

calculate	back to summary
public String calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

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

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

canHandle	back to summary
public boolean canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle. Annotations @Override

canHandle

back to summary

public boolean canHandle(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Annotations

@Override

com.openhtmltopdf.context back to summary

private abstract Class ContentFunctionFactory.PageNumberFunction

Class Inheritance

extends Object
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.PageNumberFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Known Direct Subclasses

com.openhtmltopdf.context.ContentFunctionFactory.PageCounterFunction, com.openhtmltopdf.context.ContentFunctionFactory.PagesCounterFunction

Constructor Summary

Access	Constructor and Description
private	PageNumberFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public String	getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout.
protected IdentValue	getListStyleType(FSFunction function)
protected boolean	isCounter(FSFunction function, String counterName)
public boolean	isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Whether or not the function value can change at render time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

PageNumberFunction	back to summary
private PageNumberFunction()

Method Detail

calculate	back to summary
public String calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

public String calculate(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

getLayoutReplacementText back to summary

getLayoutReplacementText	back to summary
public String getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout. Annotations @Override

public String getLayoutReplacementText()

Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

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

Annotations

@Override

getListStyleType	back to summary
protected IdentValue getListStyleType(FSFunction function)

isCounter	back to summary
protected boolean isCounter(FSFunction function, String counterName)

isStatic back to summary

isStatic	back to summary
public boolean isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Doc from com.openhtmltopdf.css.extend.ContentFunction.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. Annotations @Override

public boolean isStatic()

Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Doc from com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Annotations

@Override

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.PagesCounterFunction

Class Inheritance

extends PageNumberFunction
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.PageNumberFunction
com.openhtmltopdf.context.ContentFunctionFactory.PagesCounterFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Constructor Summary

Access	Constructor and Description
private	PagesCounterFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Inherited from com.openhtmltopdf.context.ContentFunctionFactory.PageNumberFunction:: calculate getLayoutReplacementText getListStyleType isCounter isStatic

Constructor Detail

PagesCounterFunction	back to summary
private PagesCounterFunction()

Method Detail

calculate	back to summary
public String calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

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

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

canHandle	back to summary
public boolean canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle. Annotations @Override

canHandle

back to summary

public boolean canHandle(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Annotations

@Override

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.TargetCounterFunction

Class Inheritance

extends Object
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.TargetCounterFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Partially implements target counter as specified here: http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#cross-references

Constructor Summary

Access	Constructor and Description
private	TargetCounterFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public String	calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.
public String	getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout.
public boolean	isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Whether or not the function value can change at render time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

TargetCounterFunction	back to summary
private TargetCounterFunction()

Method Detail

calculate	back to summary
public String calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

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

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

calculate	back to summary
public String calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate. Annotations @Override

calculate

back to summary

public String calculate(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.

Annotations

@Override

canHandle	back to summary
public boolean canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle. Annotations @Override

canHandle

back to summary

public boolean canHandle(LayoutContext c, FSFunction function)

Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.

Annotations

@Override

getLayoutReplacementText back to summary

getLayoutReplacementText	back to summary
public String getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout. Annotations @Override

public String getLayoutReplacementText()

Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

Doc from com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText.

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

Annotations

@Override

isStatic back to summary

isStatic	back to summary
public boolean isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Doc from com.openhtmltopdf.css.extend.ContentFunction.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. Annotations @Override

public boolean isStatic()

Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Doc from com.openhtmltopdf.css.extend.ContentFunction.isStatic.

Annotations

@Override

com.openhtmltopdf.context back to summary

private Class ContentFunctionFactory.TargetTextFunction

Class Inheritance

extends Object
implements ContentFunction

java.lang.Object
com.openhtmltopdf.context.ContentFunctionFactory.TargetTextFunction

All Implemented Interfaces

com.openhtmltopdf.css.extend.ContentFunction

Constructor Summary

Access	Constructor and Description
private	TargetTextFunction()

Method Summary

Modifier and Type	Method and Description
public String	calculate(RenderingContext c, FSFunction function, InlineText text) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public String	calculate(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.calculate.
public boolean	canHandle(LayoutContext c, FSFunction function) Implements com.openhtmltopdf.css.extend.ContentFunction.canHandle.
public String	getLayoutReplacementText() Implements com.openhtmltopdf.css.extend.ContentFunction.getLayoutReplacementText. If a function value can change at render time (i.e. `isStatic()` returns false) use this text as an approximation at layout.
public boolean	isStatic() Implements com.openhtmltopdf.css.extend.ContentFunction.isStatic. Whether or not the function value can change at render time.