com.itextpdf.layout.element

Class Text

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement<Text>

com.itextpdf.layout.element.Text

All Implemented Interfaces:

IAccessibleElement, IElement, ILeafElement, IPropertyContainer

Direct Known Subclasses:

Link

public class Text
extends AbstractElement<Text>
implements ILeafElement, IAccessibleElement

A Text is a piece of text of any length. As a leaf element, it is the smallest piece of content that may bear specific layout attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfName	role
protected AccessibilityProperties	tagProperties
protected String	text

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
Text(String text) Constructs a Text with its role initialized.

Method Summary

Modifier and Type	Method and Description
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
Float	getHorizontalScaling() Gets the horizontal scaling property, which determines how wide the text should be stretched.
PdfName	getRole() Gets the element's role.
String	getText() Gets the contents of the Text object that will be rendered.
float	getTextRise() Gets the text rise.
protected IRenderer	makeNewRenderer()
Text	setHorizontalScaling(float horizontalScaling) The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction.
void	setRole(PdfName role) Sets the element's role.
Text	setSkew(float alpha, float beta) Skews the text to simulate italic and other effects.
void	setText(String text) Sets the contents of the Text object.
Text	setTextRise(float textRise) Sets the text rise.

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHeight, setHeightPercent, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

text

protected String text

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

Text

public Text(String text)

Constructs a Text with its role initialized.

Parameters:

text - the contents, as a String

Method Detail

getText

public String getText()

Gets the contents of the Text object that will be rendered.

Returns:

the string with the contents

setText

public void setText(String text)

Sets the contents of the Text object.

Parameters:

text - the new contents

getTextRise

public float getTextRise()

Gets the text rise.

Returns:

the vertical distance from the text's default base line, as a float.

setTextRise

public Text setTextRise(float textRise)

Sets the text rise.

Parameters:

textRise - a vertical distance from the text's default base line.

Returns:

this Text

getHorizontalScaling

public Float getHorizontalScaling()

Gets the horizontal scaling property, which determines how wide the text should be stretched.

Returns:

the horizontal spacing, as a float

setSkew

public Text setSkew(float alpha,
                    float beta)

Skews the text to simulate italic and other effects. Try alpha=0 and beta=12.

Parameters:

alpha - the first angle in degrees

beta - the second angle in degrees

Returns:

this Text

setHorizontalScaling

public Text setHorizontalScaling(float horizontalScaling)

The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction.

Parameters:

horizontalScaling - the scaling parameter. 1 means no scaling will be applied, 0.5 means the text will be scaled by half. 2 means the text will be twice as wide as normal one.

Returns:

this Text

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Specified by:

getRole in interface IAccessibleElement

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Specified by:

setRole in interface IAccessibleElement

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Text>