TextBuilder
Contents
[
Hide
]Inheritance: java.lang.Object
public final class TextBuilder
Appends text object to Pdf page.
Constructors
Constructor | Description |
---|---|
TextBuilder(Page page) | Initializes a new instance of TextBuilder class for the Pdf page. |
TextBuilder(Page page, BaseOperatorCollection operatorCollection) | Initializes a new instance of TextBuilder class for the Pdf page. |
Methods
Method | Description |
---|---|
getSegmenter() | Gets TextSegmenter object |
appendParagraph(TextParagraph textParagraph) | Appends text paragraph to Pdf page. |
appendText(TextFragment textFragment) | Appends text fragment to Pdf page |
appendText(List | |
appendParagraph(TextParagraph textParagraph, int rotation) | Appends paragraph with rotation |
TextBuilder(Page page)
public TextBuilder(Page page)
Initializes a new instance of TextBuilder class for the Pdf page.
Parameters:
Parameter | Type | Description |
---|---|---|
page | Page | Page object. |
The TextBuilder allows to append text objects to Pdf pages. |
TextBuilder(Page page, BaseOperatorCollection operatorCollection)
public TextBuilder(Page page, BaseOperatorCollection operatorCollection)
Initializes a new instance of TextBuilder class for the Pdf page.
Parameters:
Parameter | Type | Description |
---|---|---|
page | Page | Page object. |
operatorCollection | BaseOperatorCollection | Operator collection. |
getSegmenter()
public TextSegmenter getSegmenter()
Gets TextSegmenter object
Returns: TextSegmenter - TextSegmenter object
appendParagraph(TextParagraph textParagraph)
public void appendParagraph(TextParagraph textParagraph)
Appends text paragraph to Pdf page.
The example demonstrates how to create text paragraph object and append it to the Pdf page.
Document doc = new Document(inFile);
Page page = (Page)doc.getPages().get(1);
// create text paragraph
TextParagraph paragraph = new TextParagraph();
// set the paragraph rectangle
paragraph.setRectangle ( new Rectangle(100, 600, 200, 700));
// set word wrapping options
paragraph.getFormattingOptions().setWrapMode ( TextFormattingOptions.WordWrapMode.ByWords);
// append string lines
paragraph.appendLine("the quick brown fox jumps over the lazy dog");
paragraph.appendLine("line2");
paragraph.appendLine("line3");
// append the paragraph to the Pdf page with the TextBuilder
TextBuilder textBuilder = new TextBuilder(page);
textBuilder.appendParagraph(paragraph);
// save Pdf document
doc.save(outFile);
Parameters:
Parameter | Type | Description |
---|---|---|
textParagraph | TextParagraph | Text paragraph object. |
appendText(TextFragment textFragment)
public void appendText(TextFragment textFragment)
Appends text fragment to Pdf page
The example demonstrates how to create text fragment object, customize it's text segments and append it to the Pdf page.
Document doc = new Document(inFile);
Page page = (Page)doc.getPages().get(1);
// create text fragment
TextFragment tf = new TextFragment("main text");
tf.Position = new Position(100, 600);
// set it's text properties
tf.getTextState().setFontSize ( 5);
tf.getTextState().setFont ( FontRepository.FindFont("TimesNewRoman"));
tf.getTextState().setBackgroundColor ( Color.GREY);
tf.getTextState().setForegroundColor ( Color.Red);
// add one more segment to text fragment's Segments collection
TextSegment segment2 = new TextSegment();
segment2.setText ( "another segment");
tf.getSegments.add(segment2);
// create TextBuilder object
TextBuilder builder = new TextBuilder(page);
// append the text fragment to the Pdf page
builder.appendText(tf);
//save document
doc.save(outFile);
Parameters:
Parameter | Type | Description |
---|---|---|
textFragment | TextFragment | Text fragment object. |
appendText(List textFragments)
public final void appendText(List<TextFragment> textFragments)
Parameters:
Parameter | Type | Description |
---|---|---|
textFragments | java.util.List<com.aspose.pdf.TextFragment> |
appendParagraph(TextParagraph textParagraph, int rotation)
public void appendParagraph(TextParagraph textParagraph, int rotation)
Appends paragraph with rotation
Parameters:
Parameter | Type | Description |
---|---|---|
textParagraph | TextParagraph | TextParagraph object |
rotation | int | int value |