com.openhtmltopdf.render.RenderingContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openhtmltopdf-core Show documentation
Show all versions of openhtmltopdf-core Show documentation
Open HTML to PDF is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code.
/*
* RenderingContext.java
* Copyright (c) 2004, 2005 Josh Marinacci
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
package com.openhtmltopdf.render;
import java.awt.Rectangle;
import com.openhtmltopdf.bidi.BidiReorderer;
import com.openhtmltopdf.bidi.SimpleBidiReorderer;
import com.openhtmltopdf.context.StyleReference;
import com.openhtmltopdf.css.style.CalculatedStyle;
import com.openhtmltopdf.css.style.CssContext;
import com.openhtmltopdf.css.value.FontSpecification;
import com.openhtmltopdf.extend.*;
import com.openhtmltopdf.layout.Layer;
import com.openhtmltopdf.layout.SharedContext;
/**
* Supplies information about the context in which rendering will take place
*
* @author jmarinacci
* November 16, 2004
*/
public class RenderingContext implements CssContext, Cloneable {
protected final SharedContext sharedContext;
private OutputDevice outputDevice;
private FontContext fontContext;
private int pageCount;
private int pageNo;
private PageBox page;
private int shadowPageNumber = -1;
private Layer rootLayer;
private int initialPageNo;
private boolean isFastRenderer = false;
private boolean inPageMargins = false;
private boolean _isInFloatBottom;
/**
* needs a new instance every run
*/
public RenderingContext(SharedContext sharedContext) {
this.sharedContext = sharedContext;
}
public boolean isFastRenderer() {
return isFastRenderer;
}
public void setFastRenderer(boolean isFast) {
this.isFastRenderer = isFast;
}
public void setBaseURL(String url) {
sharedContext.setBaseURL(url);
}
public UserAgentCallback getUac() {
return sharedContext.getUserAgentCallback();
}
public String getBaseURL() {
return sharedContext.getBaseURL();
}
public float getDPI() {
return sharedContext.getDPI();
}
public float getMmPerDot() {
return sharedContext.getMmPerDotParent();
}
public int getDotsPerPixel() {
return sharedContext.getDotsPerPixel();
}
public float getFontSize2D(FontSpecification font) {
return sharedContext.getFont(font).getSize2D();
}
public float getXHeight(FontSpecification parentFont) {
return sharedContext.getXHeight(getFontContext(), parentFont);
}
@Override
public TextRenderer getTextRenderer() {
return sharedContext.getTextRenderer();
}
private BidiReorderer _bidi = new SimpleBidiReorderer();
public void setBidiReorderer(BidiReorderer bidi) {
this._bidi = bidi;
}
public BidiReorderer getBidiReorderer() {
return this._bidi;
}
/**
* Returns true if the currently set media type is paged. Currently returns
* true only for print , projection , and embossed ,
* handheld , and tv . See the media section of the CSS
* 2.1 spec for more information on media types.
*
* @return The paged value
*/
public boolean isPaged() {
return sharedContext.isPaged();
}
public FontResolver getFontResolver() {
return sharedContext.getFontResolver();
}
public FSFont getFont(FontSpecification font) {
return sharedContext.getFont(font);
}
public FSCanvas getCanvas() {
return sharedContext.getCanvas();
}
/**
* Get the document (for non-paged docs) or page rect where
* fixed position boxes should be layed out. Generally we want to set
* excludeFloatBottomArea true so fixed content doesn't sit
* above footnotes.
*/
public Rectangle getFixedRectangle(boolean excludeFloatBottomArea) {
if (!outputDevice.isPDF() && !isPaged()) {
return new Rectangle(
-this.page.getMarginBorderPadding(this, CalculatedStyle.LEFT),
-this.page.getTop() - this.page.getMarginBorderPadding(this, CalculatedStyle.TOP),
this.page.getContentWidth(this),
this.page.getContentHeight(this));
} else if (!outputDevice.isPDF() && isPaged()) {
return new Rectangle(
0, -this.page.getTop(),
this.page.getContentWidth(this),
this.page.getContentHeight(this));
}
Rectangle result;
if (! isPrint()) {
result = sharedContext.getFixedRectangle();
} else {
if (excludeFloatBottomArea &&
this.page.getFootnoteAreaHeight() > 0 &&
!this.page.isFootnoteReserved(this)) {
// Generally, with bottom: 0 for fixed content, we do not
// want it sitting above the footnotes. The exception is
// multi-page footnotes where the entire page is reserved
// for footnotes and so we don't have any choice.
result = new Rectangle(
0,
-this.page.getTop(),
this.page.getContentWidth(this),
this.page.getBottom(this) - this.page.getTop());
} else {
result = new Rectangle(0, -this.page.getTop(),
this.page.getContentWidth(this),
this.page.getContentHeight(this)-1);
}
}
result.translate(-1, -1);
return result;
}
/**
* Get the viewport rect, for painting the body or html tag background.
*/
public Rectangle getViewportRectangle() {
Rectangle result = new Rectangle(getFixedRectangle(false));
result.y *= -1;
return result;
}
public boolean debugDrawBoxes() {
return sharedContext.debugDrawBoxes();
}
public boolean debugDrawLineBoxes() {
return sharedContext.debugDrawLineBoxes();
}
public boolean debugDrawInlineBoxes() {
return sharedContext.debugDrawInlineBoxes();
}
public boolean debugDrawFontMetrics() {
return sharedContext.debugDrawFontMetrics();
}
public boolean isInteractive() {
return sharedContext.isInteractive();
}
public boolean isPrint() {
return sharedContext.isPrint();
}
public OutputDevice getOutputDevice() {
return outputDevice;
}
public void setOutputDevice(OutputDevice outputDevice) {
this.outputDevice = outputDevice;
}
@Override
public FontContext getFontContext() {
return fontContext;
}
public void setFontContext(FontContext fontContext) {
this.fontContext = fontContext;
}
public void setPage(int pageNo, PageBox page) {
this.pageNo = pageNo;
this.page = page;
}
public int getPageCount() {
return pageCount;
}
public void setPageCount(int pageCount) {
this.pageCount = pageCount;
}
public PageBox getPage() {
return page;
}
public int getPageNo() {
return pageNo;
}
public StyleReference getCss() {
return sharedContext.getCss();
}
public FSFontMetrics getFSFontMetrics(FSFont font) {
return getTextRenderer().getFSFontMetrics(getFontContext(), font, "");
}
public Layer getRootLayer() {
return rootLayer;
}
public void setRootLayer(Layer rootLayer) {
this.rootLayer = rootLayer;
}
public int getInitialPageNo() {
return initialPageNo;
}
public void setInitialPageNo(int initialPageNo) {
this.initialPageNo = initialPageNo;
}
public Box getBoxById(String id) {
return sharedContext.getBoxById(id);
}
public void setShadowPageNumber(int shadow) {
this.shadowPageNumber = shadow;
}
/**
* @return overflow page number or -1 if this is not an overflow page.
*/
public int getShadowPageNumber() {
return this.shadowPageNumber;
}
public void setInPageMargins(boolean inMargin) {
this.inPageMargins = inMargin;
}
public boolean isInPageMargins() {
return this.inPageMargins;
}
@Override
public Object clone() {
try {
return super.clone();
} catch (CloneNotSupportedException e) {
return null;
}
}
/**
* See {@link #isInFloatBottom()}
*/
public void setIsInFloatBottom(boolean inFloatBottom) {
_isInFloatBottom = inFloatBottom;
}
/**
* {@inheritDoc}
*/
public boolean isInFloatBottom() {
return _isInFloatBottom;
}
}