Package com.storedobject.pdf

Class PDFChunk

java.lang.Object

com.storedobject.pdf.PDFChunk

All Implemented Interfaces:

PDFElement

public class PDFChunk
extends Object
implements PDFElement

Representation of "PDF chunk".

Author:

Syam

Field Summary

Fields inherited from interface com.storedobject.pdf.PDFElement

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, TEXT_DIRECTION_DEFAULT, TEXT_DIRECTION_LTR, TEXT_DIRECTION_NO_BIDI, TEXT_DIRECTION_RTL

Constructor Summary

Constructors

Constructor	Description
PDFChunk()	Constructor.
PDFChunk(char c)	Construct from a given character.
PDFChunk(char c, PDFFont font)	Construct from a given character.
PDFChunk(PDFChunk chunk)	Construct from another chunk.
PDFChunk(PDFImage image, float xOffset, float yOffset)	Construct from a given image.
PDFChunk(String text)	Construct from a given text.
PDFChunk(String text, PDFFont font)	Construct from a given text.

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(String text)	Append to the text content.
float	getCharacterSpacing()	Get the character spacing.
List<PDFChunk>	getChunks()	Get the list of chunks within this.
PDFFont	getFont()	Set the font.
float	getHorizontalScaling()	Get horizontal scaling.
PDFImage	getImage()	Get the image in this chunk.
float	getTextRise()	Get the text-rise value.
boolean	isEmpty()	Is this chunk empty?
boolean	isWhitespace()	Does this contain only "white spaces"?
PDFChunk	setBackground(PDFColor color)	Set the background color
void	setBackground(PDFColor color, float extraLeft, float extraBottom, float extraRight, float extraTop)	Set the background color
void	setCharacterSpacing(float spacing)	Set the character spacing.
void	setFont(PDFFont font)	Set the font.
void	setHorizontalScaling(float scaling)	Set the horizontal scaling.
void	setLineHeight(float height)	Set the line height.
void	setNewPage()	Set to the new page.
void	setSkew(float firstAngle, float secondAngle)	Set the skew angles.
void	setTextRise(float rise)	Set the text-rise.
void	setUnderline(float thickness, float yPosition)	Set thickness for the underline.

Methods inherited from class java.lang.Object

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

Constructor Details

PDFChunk

public PDFChunk()

Constructor.

PDFChunk

public PDFChunk(PDFChunk chunk)

Construct from another chunk.

Parameters:

chunk - Create from this chunk.

PDFChunk

public PDFChunk(String text,
 PDFFont font)

Construct from a given text.

Parameters:

text - Text to include.

font - Font to use.

PDFChunk

public PDFChunk(String text)

Construct from a given text.

Parameters:

text - Text to include.

PDFChunk

public PDFChunk(char c,
 PDFFont font)

Construct from a given character.

Parameters:

c - Character to include.

font - Font to use.

PDFChunk

public PDFChunk(char c)

Construct from a given character.

Parameters:

c - Character to include.

PDFChunk

public PDFChunk(PDFImage image,
 float xOffset,
 float yOffset)

Construct from a given image.

Parameters:

image - Image to include.

xOffset - X offset.

yOffset - Y offset.

Method Details

append

public StringBuilder append(String text)

Append to the text content.

Parameters:

text - Text to append.

Returns:

String builder to chain.

isEmpty

public boolean isEmpty()

Is this chunk empty?

Returns:

True/false.

isWhitespace

public boolean isWhitespace()

Does this contain only "white spaces"?

Returns:

True/false.

getImage

public PDFImage getImage()

Get the image in this chunk.

Returns:

Image or null if t=it doesn't exist.

getChunks

public List<PDFChunk> getChunks()

Get the list of chunks within this.

Returns:

List of chunks.

setFont

public void setFont(PDFFont font)

Set the font.

Parameters:

font - Font to set.

setBackground

public PDFChunk setBackground(PDFColor color)

Set the background color

Parameters:

color - Background to set.

Returns:

Self.

setBackground

public void setBackground(PDFColor color,
 float extraLeft,
 float extraBottom,
 float extraRight,
 float extraTop)

Set the background color

Parameters:

color - Background to set.

extraLeft - Extra portion on the left.

extraBottom - Extra portion at the bottom.

extraRight - Extra portion on the right.

extraTop - Extra portion at the top.

getFont

public PDFFont getFont()

Set the font.

Returns:

Font.

getCharacterSpacing

public float getCharacterSpacing()

Get the character spacing.

Returns:

Character spacing.

getHorizontalScaling

public float getHorizontalScaling()

Get horizontal scaling.

Returns:

Horizontal scaling.

setCharacterSpacing

public void setCharacterSpacing(float spacing)

Set the character spacing.

Parameters:

spacing - Character spacing to set.

setHorizontalScaling

public void setHorizontalScaling(float scaling)

Set the horizontal scaling.

Parameters:

scaling - Horizontal scaling to set.

setTextRise

public void setTextRise(float rise)

Set the text-rise.

Parameters:

rise - Rise value for the text.

setNewPage

public void setNewPage()

Set to the new page.

setUnderline

public void setUnderline(float thickness,
 float yPosition)

Set thickness for the underline.

Parameters:

thickness - Thickness.

yPosition - Y position.

getTextRise

public float getTextRise()

Get the text-rise value.

Returns:

Text-rise value.

setSkew

public void setSkew(float firstAngle,
 float secondAngle)

Set the skew angles.

Parameters:

firstAngle - First angle.

secondAngle - Second angle.

setLineHeight

public void setLineHeight(float height)

Set the line height.

Parameters:

height - Line height.