Package org.openpdf.pdf

Class ITextOutputDevice

java.lang.Object

org.openpdf.render.AbstractOutputDevice

org.openpdf.pdf.ITextOutputDevice

All Implemented Interfaces:

OutputDevice

public class ITextOutputDevice
extends AbstractOutputDevice
implements OutputDevice

This class is largely based on PdfGraphics2D. See http://sourceforge.net/ projects/itext/ for license information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ITextOutputDevice.Bookmark
private static class	ITextOutputDevice.Metadata

Field Summary

Fields

Modifier and Type	Field	Description
private List<ITextOutputDevice.Bookmark>	_bookmarks
private @Nullable Area	_clip
private Color	_color
private @Nullable PdfContentByte	_currentPage
private @Nullable PdfDestination	_defaultDestination
private final float	_dotsPerPoint
private @Nullable Color	_fillColor
private @Nullable ITextFSFont	_font
private final Set<String>	_linkTargetAreas
private final List<@Nullable ITextOutputDevice.Metadata>	_metadata
private int	_nextFormFieldIndex
private @Nullable Stroke	_oldStroke
private float	_opacity
private @Nullable Stroke	_originalStroke
private float	_pageHeight
private final Map<URI,PdfReader>	_readerCache
private @Nullable Box	_root
private @Nullable SharedContext	_sharedContext
private int	_startPageNo
private @Nullable Stroke	_stroke
private @Nullable Color	_strokeColor
private AffineTransform	_transform
private @Nullable PdfWriter	_writer
private static final int	CLIP
private static final int	FILL
private static final AffineTransform	IDENTITY
private static final boolean	ROUND_RECT_DIMENSIONS_DOWN
private static final int	STROKE
private static final BasicStroke	STROKE_ONE

Constructor Summary

Constructors

Constructor	Description
ITextOutputDevice(float dotsPerPoint)

Method Summary

Modifier and Type	Method	Description
private Rectangle	add(Rectangle r1, Rectangle r2)
private void	addLinkAnnotation(PdfAction action, Rectangle targetArea)
void	addMetadata(String name, String value)	Appends a name/content metadata pair to this output device.
private @Nullable PagePosition	calcPDFPagePosition(CssContext c, String id, Box box)
private Rectangle	calcTotalLinkArea(RenderingContext c, Box box)
private Optional<Rectangle>	checkLinkArea(RenderingContext c, Box box)
void	clip(Shape s)
private @Nullable PdfDestination	createDestination(RenderingContext c, Box box)
Rectangle	createLocalTargetArea(RenderingContext c, Box box)
private Rectangle	createLocalTargetArea(RenderingContext c, Box box, boolean useAggregateBounds)
private String	createRectKey(Rectangle rect)
Rectangle	createTargetArea(RenderingContext c, Box box)
void	draw(Shape s)
void	drawBorderLine(Shape bounds, int side, int lineWidth, boolean solid)
void	drawImage(FSImage fsImage, int x, int y)
protected void	drawLine(int x1, int y1, int x2, int y2)
void	drawLinearGradient(FSLinearGradient gradient, int x, int y, int width, int height)
void	drawOval(int x, int y, int width, int height)
private void	drawPDFAsImage(PDFAsImage image, int x, int y)
void	drawRect(int x, int y, int width, int height)
void	drawSelection(RenderingContext c, InlineText inlineText)
void	drawString(String s, float x, float y, @Nullable JustificationInfo info)
private void	ensureFillColor()
private void	ensureStrokeColor()
void	fill(Shape s)
void	fillOval(int x, int y, int width, int height)
void	fillRect(int x, int y, int width, int height)
List<PagePosition>	findPagePositionsByID(CssContext c, Pattern pattern)
void	finish(RenderingContext c, Box root)
void	finishPage()
private void	followPath(Shape s, int drawType)
@Nullable Shape	getClip()
PdfContentByte	getCurrentPage()
float	getDeviceLength(float length)
float	getDotsPerPoint()
@Nullable String	getMetadataByName(String name)	Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name.
List<String>	getMetadataListByName(String name)	Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList.
int	getNextFormFieldIndex()
private int	getPageRefY(Box box)
PdfReader	getReader(URI uri)
@Nullable Object	getRenderingHint(RenderingHints.Key key)
SharedContext	getSharedContext()
int	getStartPageNo()
Stroke	getStroke()
AffineTransform	getTransform()
@Nullable PdfWriter	getWriter()
private static PdfAction	gotoDestination(PdfDestination dest)
void	initializePage(PdfContentByte currentPage, float height)
private boolean	isMakeDash(boolean oldOk, BasicStroke nStroke, BasicStroke oStroke)
boolean	isSupportsCMYKColors()
boolean	isSupportsSelection()
private void	loadBookmark(ITextOutputDevice.Bookmark parent, Element bookmark)
private void	loadBookmarks(Document doc)
private void	loadMetadata(Document doc)	Locates and stores all metadata values in the document head that contain name/content pairs.
private PdfTextArray	makeJustificationArray(String s, JustificationInfo info)
private AffineTransform	normalizeMatrix(AffineTransform current)
private float	normalizeY(float y)
private void	normalizeY(float[] coords)
void	paintBackground(RenderingContext c, Box box)
void	paintReplacedElement(RenderingContext c, BlockBox box)
private void	processLink(RenderingContext c, Box box)
private String	replaceMissingCharacters(String string)
void	setClip(Shape s)
void	setColor(FSColor color)
void	setFont(FSFont font)
void	setMetadata(String name, String value)	Replaces all copies of the named metadata with a single value.
void	setOpacity(float opacity)
void	setRenderingHint(RenderingHints.Key key, Object value)
void	setRoot(Box root)
void	setSharedContext(SharedContext sharedContext)
void	setStartPageNo(int startPageNo)
void	setStroke(Stroke s)
private void	setStrokeDiff(Stroke newStroke, @Nullable Stroke oldStroke)
void	setWriter(PdfWriter writer)
void	start(Document doc)
private Stroke	transformStroke(Stroke stroke)
void	translate(double tx, double ty)
private void	writeBookmark(RenderingContext c, Box root, PdfOutline parent, ITextOutputDevice.Bookmark bookmark)
private void	writeBookmarks(RenderingContext c, Box root, PdfOutline parent, List<ITextOutputDevice.Bookmark> bookmarks)
private void	writeNamedDestinations(RenderingContext c)
private void	writeOutline(RenderingContext c, Box root)

Methods inherited from class org.openpdf.render.AbstractOutputDevice

drawDebugOutline, drawText, drawTextDecoration, drawTextDecoration, getFontSpecification, paintBackground, paintBorder, paintBorder, paintCollapsedBorder, setFontSpecification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openpdf.extend.OutputDevice

drawDebugOutline, drawText, drawTextDecoration, drawTextDecoration, paintBackground, paintBorder, paintBorder, paintCollapsedBorder

Field Details

FILL

private static final int FILL

See Also:

• Constant Field Values

STROKE

private static final int STROKE

See Also:

• Constant Field Values

CLIP

private static final int CLIP

See Also:

• Constant Field Values

IDENTITY

private static final AffineTransform IDENTITY

STROKE_ONE

private static final BasicStroke STROKE_ONE

ROUND_RECT_DIMENSIONS_DOWN

private static final boolean ROUND_RECT_DIMENSIONS_DOWN

_currentPage

private @Nullable PdfContentByte _currentPage

_pageHeight

private float _pageHeight

_font

private @Nullable ITextFSFont _font

_transform

private AffineTransform _transform

_color

private Color _color

_fillColor

private @Nullable Color _fillColor

_strokeColor

private @Nullable Color _strokeColor

_stroke

private @Nullable Stroke _stroke

_originalStroke

private @Nullable Stroke _originalStroke

_oldStroke

private @Nullable Stroke _oldStroke

_opacity

private float _opacity

_clip

private @Nullable Area _clip

_sharedContext

private @Nullable SharedContext _sharedContext

_dotsPerPoint

private final float _dotsPerPoint

_writer

private @Nullable PdfWriter _writer

_readerCache

private final Map<URI,PdfReader> _readerCache

_defaultDestination

private @Nullable PdfDestination _defaultDestination

_bookmarks

private List<ITextOutputDevice.Bookmark> _bookmarks

_metadata

private final List<@Nullable ITextOutputDevice.Metadata> _metadata

_root

private @Nullable Box _root

_startPageNo

private int _startPageNo

_nextFormFieldIndex

private int _nextFormFieldIndex

_linkTargetAreas

private final Set<String> _linkTargetAreas

Constructor Details

ITextOutputDevice

public ITextOutputDevice(float dotsPerPoint)

Method Details

setWriter

public void setWriter(PdfWriter writer)

getWriter

public @Nullable PdfWriter getWriter()

getNextFormFieldIndex

public int getNextFormFieldIndex()

initializePage

public void initializePage(PdfContentByte currentPage,
 float height)

finishPage

public void finishPage()

paintReplacedElement

public void paintReplacedElement(RenderingContext c,
 BlockBox box)

Specified by:

paintReplacedElement in interface OutputDevice

paintBackground

public void paintBackground(RenderingContext c,
 Box box)

Specified by:

paintBackground in interface OutputDevice

Overrides:

paintBackground in class AbstractOutputDevice

calcTotalLinkArea

private Rectangle calcTotalLinkArea(RenderingContext c,
 Box box)

add

private Rectangle add(Rectangle r1,
 Rectangle r2)

createRectKey

private String createRectKey(Rectangle rect)

checkLinkArea

private Optional<Rectangle> checkLinkArea(RenderingContext c,
 Box box)

processLink

private void processLink(RenderingContext c,
 Box box)

gotoDestination

private static PdfAction gotoDestination(PdfDestination dest)

addLinkAnnotation

private void addLinkAnnotation(PdfAction action,
 Rectangle targetArea)

createLocalTargetArea

public Rectangle createLocalTargetArea(RenderingContext c,
 Box box)

createLocalTargetArea

private Rectangle createLocalTargetArea(RenderingContext c,
 Box box,
 boolean useAggregateBounds)

createTargetArea

public Rectangle createTargetArea(RenderingContext c,
 Box box)

getDeviceLength

public float getDeviceLength(float length)

createDestination

private @Nullable PdfDestination createDestination(RenderingContext c,
 Box box)

drawBorderLine

public void drawBorderLine(Shape bounds,
 int side,
 int lineWidth,
 boolean solid)

Specified by:

drawBorderLine in interface OutputDevice

setOpacity

public void setOpacity(float opacity)

Specified by:

setOpacity in interface OutputDevice

setColor

public void setColor(FSColor color)

Specified by:

setColor in interface OutputDevice

draw

public void draw(Shape s)

Specified by:

draw in interface OutputDevice

drawLine

protected void drawLine(int x1,
 int y1,
 int x2,
 int y2)

Specified by:

drawLine in class AbstractOutputDevice

drawRect

public void drawRect(int x,
 int y,
 int width,
 int height)

Specified by:

drawRect in interface OutputDevice

drawOval

public void drawOval(int x,
 int y,
 int width,
 int height)

Specified by:

drawOval in interface OutputDevice

fill

public void fill(Shape s)

Specified by:

fill in interface OutputDevice

fillRect

public void fillRect(int x,
 int y,
 int width,
 int height)

Specified by:

fillRect in interface OutputDevice

fillOval

public void fillOval(int x,
 int y,
 int width,
 int height)

Specified by:

fillOval in interface OutputDevice

translate

public void translate(double tx,
 double ty)

Specified by:

translate in interface OutputDevice

getRenderingHint

public @Nullable Object getRenderingHint(RenderingHints.Key key)

Specified by:

getRenderingHint in interface OutputDevice

setRenderingHint

public void setRenderingHint(RenderingHints.Key key,
 Object value)

Specified by:

setRenderingHint in interface OutputDevice

setFont

public void setFont(FSFont font)

Specified by:

setFont in interface OutputDevice

normalizeMatrix

private AffineTransform normalizeMatrix(AffineTransform current)

drawString

public void drawString(String s,
 float x,
 float y,
 @Nullable JustificationInfo info)

replaceMissingCharacters

private String replaceMissingCharacters(String string)

makeJustificationArray

private PdfTextArray makeJustificationArray(String s,
 JustificationInfo info)

getTransform

public AffineTransform getTransform()

ensureFillColor

private void ensureFillColor()

ensureStrokeColor

private void ensureStrokeColor()

getCurrentPage

public PdfContentByte getCurrentPage()

followPath

private void followPath(Shape s,
 int drawType)

normalizeY

private float normalizeY(float y)

normalizeY

private void normalizeY(float[] coords)

setStrokeDiff

private void setStrokeDiff(Stroke newStroke,
 @Nullable Stroke oldStroke)

isMakeDash

private boolean isMakeDash(boolean oldOk,
 BasicStroke nStroke,
 BasicStroke oStroke)

setStroke

public void setStroke(Stroke s)

Specified by:

setStroke in interface OutputDevice

transformStroke

private Stroke transformStroke(Stroke stroke)

clip

public void clip(Shape s)

Specified by:

clip in interface OutputDevice

getClip

public @Nullable Shape getClip()

Specified by:

getClip in interface OutputDevice

setClip

public void setClip(Shape s)

Specified by:

setClip in interface OutputDevice

getStroke

public Stroke getStroke()

Specified by:

getStroke in interface OutputDevice

drawImage

public void drawImage(FSImage fsImage,
 int x,
 int y)

Specified by:

drawImage in interface OutputDevice

drawLinearGradient

public void drawLinearGradient(FSLinearGradient gradient,
 int x,
 int y,
 int width,
 int height)

Specified by:

drawLinearGradient in interface OutputDevice

drawPDFAsImage

private void drawPDFAsImage(PDFAsImage image,
 int x,
 int y)

getReader

public PdfReader getReader(URI uri)
                    throws IOException

Throws:

IOException

getDotsPerPoint

public float getDotsPerPoint()

start

public void start(Document doc)

finish

public void finish(RenderingContext c,
 Box root)

writeOutline

private void writeOutline(RenderingContext c,
 Box root)

writeBookmarks

private void writeBookmarks(RenderingContext c,
 Box root,
 PdfOutline parent,
 List<ITextOutputDevice.Bookmark> bookmarks)

writeNamedDestinations

private void writeNamedDestinations(RenderingContext c)

getPageRefY

private int getPageRefY(Box box)

writeBookmark

private void writeBookmark(RenderingContext c,
 Box root,
 PdfOutline parent,
 ITextOutputDevice.Bookmark bookmark)

loadBookmarks

private void loadBookmarks(Document doc)

loadBookmark

private void loadBookmark(ITextOutputDevice.Bookmark parent,
 Element bookmark)

addMetadata

public void addMetadata(String name,
 String value)

Appends a name/content metadata pair to this output device. A name or content value of null will be ignored.

Parameters:

name - the name of the metadata element to add.

getMetadataByName

public @Nullable String getMetadataByName(String name)

Searches the metadata name/content pairs of the current document and returns the content value from the first pair with a matching name. The search is case-insensitive.

Parameters:

name - the metadata element name to locate.

Returns:

the content value of the first found metadata element; otherwise null.

getMetadataListByName

public List<String> getMetadataListByName(String name)

Searches the metadata name/content pairs of the current document and returns any content values with a matching name in an ArrayList. The search is case-insensitive.

Parameters:

name - the metadata element name to locate.

Returns:

an ArrayList with matching content values; otherwise an empty list.

loadMetadata

private void loadMetadata(Document doc)

Locates and stores all metadata values in the document head that contain name/content pairs. If there is no pair with a name of "title", any content in the title element is saved as a "title" metadata item.

Parameters:

doc - the Document level node of the parsed xhtml file.

setMetadata

public void setMetadata(String name,
 String value)

Replaces all copies of the named metadata with a single value. A new value of null will result in the removal of all copies of the named metadata. Use addMetadata to append additional values with the same name.

Parameters:

name - the metadata element name to locate.

getSharedContext

public SharedContext getSharedContext()

setSharedContext

public void setSharedContext(SharedContext sharedContext)

setRoot

public void setRoot(Box root)

getStartPageNo

public int getStartPageNo()

setStartPageNo

public void setStartPageNo(int startPageNo)

drawSelection

public void drawSelection(RenderingContext c,
 InlineText inlineText)

Specified by:

drawSelection in interface OutputDevice

isSupportsSelection

public boolean isSupportsSelection()

Specified by:

isSupportsSelection in interface OutputDevice

isSupportsCMYKColors

public boolean isSupportsCMYKColors()

Specified by:

isSupportsCMYKColors in interface OutputDevice

findPagePositionsByID

public List<PagePosition> findPagePositionsByID(CssContext c,
 Pattern pattern)

calcPDFPagePosition

private @Nullable PagePosition calcPDFPagePosition(CssContext c,
 String id,
 Box box)