org.xhtmlrenderer.render.AbstractOutputDevice Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of flying-saucer-core Show documentation
Show all versions of flying-saucer-core Show documentation
Flying Saucer is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code as well as Java2D output.
/*
* {{{ header & license
* Copyright (c) 2006 Wisconsin Court System
*
* 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 org.xhtmlrenderer.render;
import org.w3c.dom.css.CSSPrimitiveValue;
import org.xhtmlrenderer.css.constants.CSSName;
import org.xhtmlrenderer.css.constants.IdentValue;
import org.xhtmlrenderer.css.parser.FSColor;
import org.xhtmlrenderer.css.parser.FSRGBColor;
import org.xhtmlrenderer.css.parser.PropertyValue;
import org.xhtmlrenderer.css.style.BackgroundPosition;
import org.xhtmlrenderer.css.style.BackgroundSize;
import org.xhtmlrenderer.css.style.CalculatedStyle;
import org.xhtmlrenderer.css.style.CssContext;
import org.xhtmlrenderer.css.style.derived.BorderPropertySet;
import org.xhtmlrenderer.css.style.derived.LengthValue;
import org.xhtmlrenderer.css.value.FontSpecification;
import org.xhtmlrenderer.extend.FSImage;
import org.xhtmlrenderer.extend.OutputDevice;
import org.xhtmlrenderer.util.Configuration;
import org.xhtmlrenderer.util.Uu;
import java.awt.*;
import java.awt.geom.Area;
import java.util.List;
/**
* An abstract implementation of an {@link OutputDevice}. It provides complete
* implementations for many {@code OutputDevice} methods.
*/
public abstract class AbstractOutputDevice implements OutputDevice {
private FontSpecification _fontSpec;
protected abstract void drawLine(int x1, int y1, int x2, int y2);
@Override
public void drawText(RenderingContext c, InlineText inlineText) {
InlineLayoutBox iB = inlineText.getParent();
String text = inlineText.getSubstring();
if (text != null && !text.isEmpty()) {
setColor(iB.getStyle().getColor());
setFont(iB.getStyle().getFSFont(c));
setFontSpecification(iB.getStyle().getFontSpecification());
if (inlineText.getParent().getStyle().isTextJustify()) {
JustificationInfo info = inlineText.getParent().getLineBox().getJustificationInfo();
if (info != null) {
c.getTextRenderer().drawString(
c.getOutputDevice(),
text,
iB.getAbsX() + inlineText.getX(), iB.getAbsY() + iB.getBaseline(),
info);
} else {
c.getTextRenderer().drawString(
c.getOutputDevice(),
text,
iB.getAbsX() + inlineText.getX(), iB.getAbsY() + iB.getBaseline());
}
} else {
c.getTextRenderer().drawString(
c.getOutputDevice(),
text,
iB.getAbsX() + inlineText.getX(), iB.getAbsY() + iB.getBaseline());
}
}
if (c.debugDrawFontMetrics()) {
drawFontMetrics(c, inlineText);
}
}
private void drawFontMetrics(RenderingContext c, InlineText inlineText) {
InlineLayoutBox iB = inlineText.getParent();
String text = inlineText.getSubstring();
setColor(new FSRGBColor(0xFF, 0x33, 0xFF));
FSFontMetrics fm = iB.getStyle().getFSFontMetrics(null);
int width = c.getTextRenderer().getWidth(
c.getFontContext(),
iB.getStyle().getFSFont(c), text);
int x = iB.getAbsX() + inlineText.getX();
int y = iB.getAbsY() + iB.getBaseline();
drawLine(x, y, x + width, y);
y += (int) Math.ceil(fm.getDescent());
drawLine(x, y, x + width, y);
y -= (int) Math.ceil(fm.getDescent());
y -= (int) Math.ceil(fm.getAscent());
drawLine(x, y, x + width, y);
}
@Override
public void drawTextDecoration(
RenderingContext c, InlineLayoutBox iB, TextDecoration decoration) {
setColor(iB.getStyle().getColor());
Rectangle edge = iB.getContentAreaEdge(iB.getAbsX(), iB.getAbsY(), c);
fillRect(edge.x, iB.getAbsY() + decoration.getOffset(),
edge.width, decoration.getThickness());
}
@Override
public void drawTextDecoration(RenderingContext c, LineBox lineBox) {
setColor(lineBox.getStyle().getColor());
Box parent = lineBox.getParent();
List decorations = lineBox.getTextDecorations();
for (TextDecoration textDecoration : decorations) {
if (parent.getStyle().isIdent(
CSSName.FS_TEXT_DECORATION_EXTENT, IdentValue.BLOCK)) {
fillRect(
lineBox.getAbsX(),
lineBox.getAbsY() + textDecoration.getOffset(),
parent.getAbsX() + parent.getTx() + parent.getContentWidth() - lineBox.getAbsX(),
textDecoration.getThickness());
} else {
fillRect(
lineBox.getAbsX(), lineBox.getAbsY() + textDecoration.getOffset(),
lineBox.getContentWidth(),
textDecoration.getThickness());
}
}
}
@Override
public void drawDebugOutline(RenderingContext c, Box box, FSColor color) {
setColor(color);
Rectangle rect = box.getMarginEdge(box.getAbsX(), box.getAbsY(), c, 0, 0);
rect.height -= 1;
rect.width -= 1;
drawRect(rect.x, rect.y, rect.width, rect.height);
}
@Override
public void paintCollapsedBorder(
RenderingContext c, BorderPropertySet border, Rectangle bounds, int side) {
BorderPainter.paint(bounds, side, border, c, 0, false);
}
@Override
public void paintBorder(RenderingContext c, Box box) {
if (! box.getStyle().isVisible()) {
return;
}
Rectangle borderBounds = box.getPaintingBorderEdge(c);
BorderPainter.paint(borderBounds, box.getBorderSides(), box.getBorder(c), c, 0, true);
}
@Override
public void paintBorder(RenderingContext c, CalculatedStyle style, Rectangle edge, int sides) {
BorderPainter.paint(edge, sides, style.getBorder(c), c, 0, true);
}
private FSImage getBackgroundImage(RenderingContext c, CalculatedStyle style) {
if (! style.isIdent(CSSName.BACKGROUND_IMAGE, IdentValue.NONE)) {
String uri = style.getStringProperty(CSSName.BACKGROUND_IMAGE);
try {
return c.getUac().getImageResource(uri).getImage();
} catch (Exception ex) {
Uu.p(ex);
}
}
return null;
}
@Override
public void paintBackground(
RenderingContext c, CalculatedStyle style,
Rectangle bounds, Rectangle bgImageContainer, BorderPropertySet border) {
paintBackground0(c, style, bounds, bgImageContainer, border);
}
@Override
public void paintBackground(RenderingContext c, Box box) {
if (! box.getStyle().isVisible()) {
return;
}
Rectangle backgroundBounds = box.getPaintingBorderEdge(c);
BorderPropertySet border = box.getStyle().getBorder(c);
paintBackground0(c, box.getStyle(), backgroundBounds, backgroundBounds, border);
}
private void paintBackground0(
RenderingContext c, CalculatedStyle style,
Rectangle backgroundBounds, Rectangle bgImageContainer,
BorderPropertySet border) {
if (!Configuration.isTrue("xr.renderer.draw.backgrounds", true)) {
return;
}
FSColor backgroundColor = style.getBackgroundColor();
FSImage backgroundImage = getBackgroundImage(c, style);
// If the image width or height is zero, then there's nothing to draw.
// Also prevents infinite loop when trying to tile an image with zero size.
if (backgroundImage == null || backgroundImage.getHeight() == 0 || backgroundImage.getWidth() == 0) {
backgroundImage = null;
}
if ( (backgroundColor == null || backgroundColor == FSRGBColor.TRANSPARENT) &&
backgroundImage == null) {
return;
}
Area borderBounds = new Area(BorderPainter.generateBorderBounds(backgroundBounds, border, false));
Shape oldclip = getClip();
if(oldclip != null) {
// we need to respect the clip sent to us, get the intersection between the old and the new
borderBounds.intersect(new Area(oldclip));
}
if (backgroundColor != null && backgroundColor != FSRGBColor.TRANSPARENT) {
setColor(backgroundColor);
fill(borderBounds);
}
if (backgroundImage != null) {
setClip(borderBounds);
Rectangle localBGImageContainer = bgImageContainer;
if (style.isFixedBackground()) {
localBGImageContainer = c.getViewportRectangle();
}
int xoff = localBGImageContainer.x;
int yoff = localBGImageContainer.y;
if (border != null) {
xoff += (int)border.left();
yoff += (int)border.top();
}
scaleBackgroundImage(c, style, localBGImageContainer, backgroundImage);
float imageWidth = backgroundImage.getWidth();
float imageHeight = backgroundImage.getHeight();
BackgroundPosition position = style.getBackgroundPosition();
xoff += calcOffset(
c, style, position.getHorizontal(), localBGImageContainer.width, imageWidth);
yoff += calcOffset(
c, style, position.getVertical(), localBGImageContainer.height, imageHeight);
boolean hrepeat = style.isHorizontalBackgroundRepeat();
boolean vrepeat = style.isVerticalBackgroundRepeat();
if (! hrepeat && ! vrepeat) {
Rectangle imageBounds = new Rectangle(xoff, yoff, (int)imageWidth, (int)imageHeight);
if (imageBounds.intersects(backgroundBounds)) {
drawImage(backgroundImage, xoff, yoff);
}
} else if (hrepeat && vrepeat) {
paintTiles(
backgroundImage,
adjustTo(backgroundBounds.x, xoff, (int)imageWidth),
adjustTo(backgroundBounds.y, yoff, (int)imageHeight),
backgroundBounds.x + backgroundBounds.width,
backgroundBounds.y + backgroundBounds.height);
} else if (hrepeat) {
xoff = adjustTo(backgroundBounds.x, xoff, (int)imageWidth);
Rectangle imageBounds = new Rectangle(xoff, yoff, (int)imageWidth, (int)imageHeight);
if (imageBounds.intersects(backgroundBounds)) {
paintHorizontalBand(
backgroundImage,
xoff,
yoff,
backgroundBounds.x + backgroundBounds.width);
}
} else if (vrepeat) {
yoff = adjustTo(backgroundBounds.y, yoff, (int)imageHeight);
Rectangle imageBounds = new Rectangle(xoff, yoff, (int)imageWidth, (int)imageHeight);
if (imageBounds.intersects(backgroundBounds)) {
paintVerticalBand(
backgroundImage,
xoff,
yoff,
backgroundBounds.y + backgroundBounds.height);
}
}
setClip(oldclip);
}
}
private int adjustTo(int target, int current, int imageDim) {
int result = current;
if (result > target) {
while (result > target) {
result -= imageDim;
}
} else if (result < target) {
while (result < target) {
result += imageDim;
}
if (result != target) {
result -= imageDim;
}
}
return result;
}
private void paintTiles(FSImage image, int left, int top, int right, int bottom) {
int width = image.getWidth();
int height = image.getHeight();
for (int x = left; x < right; x+= width) {
for (int y = top; y < bottom; y+= height) {
drawImage(image, x, y);
}
}
}
private void paintVerticalBand(FSImage image, int left, int top, int bottom) {
int height = image.getHeight();
for (int y = top; y < bottom; y+= height) {
drawImage(image, left, y);
}
}
private void paintHorizontalBand(FSImage image, int left, int top, int right) {
int width = image.getWidth();
for (int x = left; x < right; x+= width) {
drawImage(image, x, top);
}
}
private int calcOffset(CssContext c, CalculatedStyle style, PropertyValue value, float boundsDim, float imageDim) {
if (value.getPrimitiveType() == CSSPrimitiveValue.CSS_PERCENTAGE) {
float percent = value.getFloatValue() / 100.0f;
return Math.round(boundsDim*percent - imageDim*percent);
} else { /* it's a */
return (int)LengthValue.calcFloatProportionalValue(
style,
CSSName.BACKGROUND_POSITION,
value.getCssText(),
value.getFloatValue(),
value.getPrimitiveType(),
0,
c);
}
}
private void scaleBackgroundImage(CssContext c, CalculatedStyle style, Rectangle backgroundContainer, FSImage image) {
BackgroundSize backgroundSize = style.getBackgroundSize();
if (! backgroundSize.isBothAuto()) {
if (backgroundSize.isCover() || backgroundSize.isContain()) {
int testHeight = (int)((double)image.getHeight() * backgroundContainer.width / image.getWidth());
if (backgroundSize.isContain()) {
if (testHeight > backgroundContainer.height) {
image.scale(-1, backgroundContainer.height);
} else {
image.scale(backgroundContainer.width, -1);
}
} else if (backgroundSize.isCover()) {
if (testHeight > backgroundContainer.height) {
image.scale(backgroundContainer.width, -1);
} else {
image.scale(-1, backgroundContainer.height);
}
}
} else {
int scaledWidth = calcBackgroundSizeLength(c, style, backgroundSize.getWidth(), backgroundContainer.width);
int scaledHeight = calcBackgroundSizeLength(c, style, backgroundSize.getHeight(), backgroundContainer.height);
image.scale(scaledWidth, scaledHeight);
}
}
}
private int calcBackgroundSizeLength(CssContext c, CalculatedStyle style, PropertyValue value, float boundsDim) {
if (value.getPrimitiveType() == CSSPrimitiveValue.CSS_IDENT) { // 'auto'
return -1;
} else if (value.getPrimitiveType() == CSSPrimitiveValue.CSS_PERCENTAGE) {
float percent = value.getFloatValue() / 100.0f;
return Math.round(boundsDim*percent);
} else {
return (int)LengthValue.calcFloatProportionalValue(
style,
CSSName.BACKGROUND_SIZE,
value.getCssText(),
value.getFloatValue(),
value.getPrimitiveType(),
0,
c);
}
}
/**
* Gets the FontSpecification for this AbstractOutputDevice.
*
* @return current FontSpecification.
*/
public FontSpecification getFontSpecification() {
return _fontSpec;
}
/**
* Sets the FontSpecification for this AbstractOutputDevice.
*
* @param fs current FontSpecification.
*/
public void setFontSpecification(FontSpecification fs) {
_fontSpec = fs;
}
}