Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Builder State to transfer parameters #199

Merged
merged 7 commits into from
Apr 9, 2018
Merged

Builder State to transfer parameters #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c036b9e
This interface is rather pointless.
rototor Apr 8, 2018
d708010
Use the testcase runner also as an regression test.
rototor Apr 8, 2018
a8f2a9c
Implemented a "sealed" mode for the builder to be able to pass it as
rototor Apr 8, 2018
0d16490
Extract the state of the builder in its own class with all public fields
rototor Apr 8, 2018
491a09f
Make the PdfBoxRenderer use the builder state as it's parameter.
rototor Apr 8, 2018
839dbd6
Also use the state for the Java2D renderer.
rototor Apr 8, 2018
b58b4c3
Make the constructor of the builder states package only.
rototor Apr 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 100 additions & 82 deletions ...mltopdf-core/src/main/java/com/openhtmltopdf/outputdevice/helper/BaseRendererBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,52 @@
* Baseclass for all RendererBuilders (PDF and Java2D), has all common settings
*/
@SuppressWarnings("unchecked")
public abstract class BaseRendererBuilder<TFinalClass extends BaseRendererBuilder> {
public abstract class BaseRendererBuilder<TFinalClass extends BaseRendererBuilder, TBaseRendererBuilderState extends BaseRendererBuilder.BaseRendererBuilderState> {
public static final float PAGE_SIZE_LETTER_WIDTH = 8.5f;
public static final float PAGE_SIZE_LETTER_HEIGHT = 11.0f;
public static final PageSizeUnits PAGE_SIZE_LETTER_UNITS = PageSizeUnits.INCHES;
protected final List<FSDOMMutator> _domMutators = new ArrayList<FSDOMMutator>();
protected HttpStreamFactory _httpStreamFactory;
protected FSCache _cache;
protected FSUriResolver _resolver;
protected String _html;
protected String _baseUri;
protected Document _document;
protected SVGDrawer _svgImpl;
protected SVGDrawer _mathmlImpl;
protected String _replacementText;
protected FSTextBreaker _lineBreaker;
protected FSTextBreaker _charBreaker;
protected FSTextTransformer _unicodeToUpperTransformer;
protected FSTextTransformer _unicodeToLowerTransformer;
protected FSTextTransformer _unicodeToTitleTransformer;
protected BidiSplitterFactory _splitter;
protected BidiReorderer _reorderer;
protected boolean _textDirection = false;
protected Float _pageWidth;
protected Float _pageHeight;
protected boolean _isPageSizeInches;
protected String _uri;
protected File _file;
protected boolean _testMode = false;
protected int _initialPageNumber;
protected short _pagingMode = Layer.PAGED_MODE_PRINT;
protected FSObjectDrawerFactory _objectDrawerFactory;
protected String _preferredTransformerFactoryImplementationClass = "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl";
protected String _preferredDocumentBuilderFactoryImplementationClass = "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl";

/**
* This class is an internal implementation detail
* @internal
*/
public abstract static class BaseRendererBuilderState {
public final List<FSDOMMutator> _domMutators = new ArrayList<FSDOMMutator>();
public HttpStreamFactory _httpStreamFactory;
public FSCache _cache;
public FSUriResolver _resolver;
public String _html;
public String _baseUri;
public Document _document;
public SVGDrawer _svgImpl;
public SVGDrawer _mathmlImpl;
public String _replacementText;
public FSTextBreaker _lineBreaker;
public FSTextBreaker _charBreaker;
public FSTextTransformer _unicodeToUpperTransformer;
public FSTextTransformer _unicodeToLowerTransformer;
public FSTextTransformer _unicodeToTitleTransformer;
public BidiSplitterFactory _splitter;
public BidiReorderer _reorderer;
public boolean _textDirection = false;
public Float _pageWidth;
public Float _pageHeight;
public boolean _isPageSizeInches;
public String _uri;
public File _file;
public boolean _testMode = false;
public int _initialPageNumber;
public short _pagingMode = Layer.PAGED_MODE_PRINT;
public FSObjectDrawerFactory _objectDrawerFactory;
public String _preferredTransformerFactoryImplementationClass = "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl";
public String _preferredDocumentBuilderFactoryImplementationClass = "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl";
}

protected final TBaseRendererBuilderState state;

protected BaseRendererBuilder(TBaseRendererBuilderState state) {
this.state = state;
}

/**
* Add a DOM mutator to this builder. DOM mutators allow to modify the DOM
Expand All @@ -58,7 +71,7 @@ public abstract class BaseRendererBuilder<TFinalClass extends BaseRendererBuilde
* @return this for method chaining
*/
public TFinalClass addDOMMutator(FSDOMMutator domMutator) {
_domMutators.add(domMutator);
state._domMutators.add(domMutator);
return (TFinalClass) this;
}

Expand All @@ -76,7 +89,7 @@ public TFinalClass addDOMMutator(FSDOMMutator domMutator) {
* @return this for method chaining
*/
public final TFinalClass useTransformerFactoryImplementationClass(String transformerFactoryClass) {
this._preferredTransformerFactoryImplementationClass = transformerFactoryClass;
state._preferredTransformerFactoryImplementationClass = transformerFactoryClass;
return (TFinalClass) this;
}

Expand All @@ -85,17 +98,17 @@ public final TFinalClass useTransformerFactoryImplementationClass(String transfo
* setups. Set a preferred implementation class for use as
* javax.xml.parsers.DocumentBuilderFactory. Use null to let a default
* implementation class be used. The default is
* "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl".
* If the default does not work you can use null to let the container use whatever
* "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl". If the
* default does not work you can use null to let the container use whatever
* DocumentBuilderFactory it has available.
*
* @param documentBuilderFactoryClass
* @return this for method chaining
*/
public final TFinalClass useDocumentBuilderFactoryImplementationClass(String documentBuilderFactoryClass) {
this._preferredDocumentBuilderFactoryImplementationClass = documentBuilderFactoryClass;
return (TFinalClass) this;
}
public final TFinalClass useDocumentBuilderFactoryImplementationClass(String documentBuilderFactoryClass) {
state._preferredDocumentBuilderFactoryImplementationClass = documentBuilderFactoryClass;
return (TFinalClass) this;
}

/**
* The default text direction of the document. LTR by default.
Expand All @@ -104,7 +117,7 @@ public final TFinalClass useDocumentBuilderFactoryImplementationClass(String doc
* @return this for method chaining
*/
public final TFinalClass defaultTextDirection(TextDirection textDirection) {
this._textDirection = textDirection == TextDirection.RTL;
state._textDirection = textDirection == TextDirection.RTL;
return (TFinalClass) this;
}

Expand All @@ -116,7 +129,7 @@ public final TFinalClass defaultTextDirection(TextDirection textDirection) {
* @return this for method chaining
*/
public final TFinalClass testMode(boolean mode) {
this._testMode = mode;
state._testMode = mode;
return (TFinalClass) this;
}

Expand All @@ -125,21 +138,21 @@ public final TFinalClass testMode(boolean mode) {
* external HTTP/HTTPS implementation. Uses URL::openStream by default.
*
* @param factory
* @return
* @return this for method chaining
*/
public final TFinalClass useHttpStreamImplementation(HttpStreamFactory factory) {
this._httpStreamFactory = factory;
state._httpStreamFactory = factory;
return (TFinalClass) this;
}

/**
* Provides a uri resolver to resolve relative uris or private uri schemes.
*
* @param resolver
* @return
* @return this for method chaining
*/
public final TFinalClass useUriResolver(FSUriResolver resolver) {
this._resolver = resolver;
state._resolver = resolver;
return (TFinalClass) this;
}

Expand All @@ -148,10 +161,10 @@ public final TFinalClass useUriResolver(FSUriResolver resolver) {
* as fonts or logo images.
*
* @param cache
* @return
* @return this for method chaining
*/
public final TFinalClass useCache(FSCache cache) {
this._cache = cache;
state._cache = cache;
return (TFinalClass) this;
}

Expand All @@ -160,21 +173,21 @@ public final TFinalClass useCache(FSCache cache) {
* default.
*
* @param splitter
* @return
* @return this for method chaining
*/
public final TFinalClass useUnicodeBidiSplitter(BidiSplitterFactory splitter) {
this._splitter = splitter;
state._splitter = splitter;
return (TFinalClass) this;
}

/**
* Provides a reorderer to properly reverse RTL text. No-op by default.
*
* @param reorderer
* @return
* @return this for method chaining
*/
public final TFinalClass useUnicodeBidiReorderer(BidiReorderer reorderer) {
this._reorderer = reorderer;
state._reorderer = reorderer;
return (TFinalClass) this;
}

Expand All @@ -183,11 +196,11 @@ public final TFinalClass useUnicodeBidiReorderer(BidiReorderer reorderer) {
*
* @param html
* @param baseUri
* @return
* @return this for method chaining
*/
public final TFinalClass withHtmlContent(String html, String baseUri) {
this._html = html;
this._baseUri = baseUri;
state._html = html;
state._baseUri = baseUri;
return (TFinalClass) this;
}

Expand All @@ -196,11 +209,11 @@ public final TFinalClass withHtmlContent(String html, String baseUri) {
*
* @param doc
* @param baseUri
* @return
* @return this for method chaining
*/
public final TFinalClass withW3cDocument(org.w3c.dom.Document doc, String baseUri) {
this._document = doc;
this._baseUri = baseUri;
state._document = doc;
state._baseUri = baseUri;
return (TFinalClass) this;
}

Expand All @@ -209,10 +222,10 @@ public final TFinalClass withW3cDocument(org.w3c.dom.Document doc, String baseUr
* document.
*
* @param uri
* @return
* @return this for method chaining
*/
public final TFinalClass withUri(String uri) {
this._uri = uri;
state._uri = uri;
return (TFinalClass) this;
}

Expand All @@ -224,29 +237,31 @@ public final TFinalClass withUri(String uri) {
* @return this for method chaining
*/
public final TFinalClass withFile(File file) {
this._file = file;
state._file = file;
return (TFinalClass) this;
}

/**
* Uses the specified SVG drawer implementation.
*
* @param svgImpl the SVG implementation
* @param svgImpl
* the SVG implementation
* @return this for method chaining
*/
public final TFinalClass useSVGDrawer(SVGDrawer svgImpl) {
this._svgImpl = svgImpl;
state._svgImpl = svgImpl;
return (TFinalClass) this;
}

/**
* Use the specified MathML implementation.
*
* @param mathMlImpl the MathML implementation
* @param mathMlImpl
* the MathML implementation
* @return this for method chaining
*/
public final TFinalClass useMathMLDrawer(SVGDrawer mathMlImpl) {
this._mathmlImpl = mathMlImpl;
state._mathmlImpl = mathMlImpl;
return (TFinalClass) this;
}

Expand All @@ -256,11 +271,12 @@ public final TFinalClass useMathMLDrawer(SVGDrawer mathMlImpl) {
* characters for best results. Also, make sure it can be rendered by at least
* one of your specified fonts! The default is the # character.
*
* @param replacement the default replacement text
* @param replacement
* the default replacement text
* @return this for method chaining
*/
public final TFinalClass useReplacementText(String replacement) {
this._replacementText = replacement;
state._replacementText = replacement;
return (TFinalClass) this;
}

Expand All @@ -278,8 +294,8 @@ public final TFinalClass useReplacementText(String replacement) {
* @return
*/
public final TFinalClass useUnicodeLineBreaker(FSTextBreaker breaker) {
this._lineBreaker = breaker;
return (TFinalClass)this;
state._lineBreaker = breaker;
return (TFinalClass) this;
}

/**
Expand All @@ -291,8 +307,8 @@ public final TFinalClass useUnicodeLineBreaker(FSTextBreaker breaker) {
* @return
*/
public final TFinalClass useUnicodeCharacterBreaker(FSTextBreaker breaker) {
this._charBreaker = breaker;
return (TFinalClass)this;
state._charBreaker = breaker;
return (TFinalClass) this;
}

/**
Expand All @@ -303,8 +319,8 @@ public final TFinalClass useUnicodeCharacterBreaker(FSTextBreaker breaker) {
* @return
*/
public final TFinalClass useUnicodeToUpperTransformer(FSTextTransformer tr) {
this._unicodeToUpperTransformer = tr;
return (TFinalClass)this;
state._unicodeToUpperTransformer = tr;
return (TFinalClass) this;
}

/**
Expand All @@ -315,8 +331,8 @@ public final TFinalClass useUnicodeToUpperTransformer(FSTextTransformer tr) {
* @return
*/
public final TFinalClass useUnicodeToLowerTransformer(FSTextTransformer tr) {
this._unicodeToLowerTransformer = tr;
return (TFinalClass)this;
state._unicodeToLowerTransformer = tr;
return (TFinalClass) this;
}

/**
Expand All @@ -327,8 +343,8 @@ public final TFinalClass useUnicodeToLowerTransformer(FSTextTransformer tr) {
* @return
*/
public final TFinalClass useUnicodeToTitleTransformer(FSTextTransformer tr) {
this._unicodeToTitleTransformer = tr;
return (TFinalClass)this;
state._unicodeToTitleTransformer = tr;
return (TFinalClass) this;
}

/**
Expand All @@ -343,10 +359,10 @@ public final TFinalClass useUnicodeToTitleTransformer(FSTextTransformer tr) {
* @return
*/
public final TFinalClass useDefaultPageSize(float pageWidth, float pageHeight, PageSizeUnits units) {
this._pageWidth = pageWidth;
this._pageHeight = pageHeight;
this._isPageSizeInches = (units == PageSizeUnits.INCHES);
return (TFinalClass)this;
state._pageWidth = pageWidth;
state._pageHeight = pageHeight;
state._isPageSizeInches = (units == PageSizeUnits.INCHES);
return (TFinalClass) this;
}

/**
Expand All @@ -357,16 +373,18 @@ public final TFinalClass useDefaultPageSize(float pageWidth, float pageHeight, P
* @return this for method chaining
*/
public final TFinalClass useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory) {
this._objectDrawerFactory = objectDrawerFactory;
return (TFinalClass)this;
state._objectDrawerFactory = objectDrawerFactory;
return (TFinalClass) this;
}

public enum TextDirection {
RTL, LTR;
RTL, LTR
}

public enum PageSizeUnits {
MM, INCHES
}

public enum FontStyle {
NORMAL, ITALIC, OBLIQUE
}
Expand Down
Loading