public class

Paragraph

extends ContentNode
java.lang.Object
   ↳ com.pdftron.layout.ContentElement
     ↳ com.pdftron.layout.ContentNode
       ↳ com.pdftron.layout.Paragraph

Class Overview

A Paragraph is a content node that contains a list of TextRun objects.

Summary

Nested Classes
enum Paragraph.TextJustification  
Public Methods
static void AddTabStop(long self, double val)
static double GetBorderThickness(long self)
static double GetDefaultTabStop(long self)
static double GetEndIndent(long self)
static double GetNextTabStop(long self, double val)
static int GetSpacesPerTab(long self)
static double GetStartIndent(long self)
static double GetTextIndent(long self)
static boolean IsDisplayRtl(long self)
static void SetBorder(long self, double thickness, int red, int green, int blue)
static void SetDefaultTabStop(long self, double val)
static void SetDisplayRtl(long self, boolean val)
static void SetEndIndent(long self, double val)
static void SetSpacesPerTab(long self, int val)
static void SetStartIndent(long self, double val)
static void SetTextIndent(long self, double val)
void addTabStop(double val)
Adds a tab stop to the paragraph.
TextRun addText(String text)
Add another text run to the paragraph
double getBorderThickness()
Retrieves the border thickness for the paragraph.
double getDefaultTabStop()
Retrieves the default tab stop value for the paragraph.
double getEndIndent()
Retrieves the end indent for the paragraph.
Paragraph.TextJustification getJustificationMode()
Get justification mode for the paragraph
double getNextTabStop(double val)
Retrieves the next tab stop value based on the given position.
double getSpaceAfter()
Get the "space after" value for the paragraph style
double getSpaceBefore()
Get the "space before" value for the paragraph style
int getSpacesPerTab()
Retrieves the number of spaces per tab for the paragraph.
double getStartIndent()
Retrieves the start indent for the paragraph.
double getTextIndent()
Retrieves the text indent for the paragraph.
boolean isDisplayRtl()
Retrieves the display right-to-left (RTL) mode for the paragraph.
void setBorder(double thickness, int red, int green, int blue)
Sets the border properties for the paragraph.
void setDefaultTabStop(double val)
Sets the default tab stop value for the paragraph.
void setDisplayRtl(boolean val)
Sets the display right-to-left (RTL) mode for the paragraph.
void setEndIndent(double val)
Sets the end indent for the paragraph.
void setJustificationMode(Paragraph.TextJustification val)
Set justification mode for paragraph style
void setSpaceAfter(double val)
Set the "space after" value for paragraph style
void setSpaceBefore(double val)
Set the "space before" value for the paragraph style
void setSpacesPerTab(int val)
Sets the number of spaces per tab for the paragraph.
void setStartIndent(double val)
Sets the start indent for the paragraph.
void setTextIndent(double val)
Sets the text indent for the paragraph.
[Expand]
Inherited Methods
From class com.pdftron.layout.ContentNode
From class com.pdftron.layout.ContentElement
From class java.lang.Object

Public Methods

public static void AddTabStop (long self, double val)

Throws
PDFNetException

public static double GetBorderThickness (long self)

Throws
PDFNetException

public static double GetDefaultTabStop (long self)

Throws
PDFNetException

public static double GetEndIndent (long self)

Throws
PDFNetException

public static double GetNextTabStop (long self, double val)

Throws
PDFNetException

public static int GetSpacesPerTab (long self)

Throws
PDFNetException

public static double GetStartIndent (long self)

Throws
PDFNetException

public static double GetTextIndent (long self)

Throws
PDFNetException

public static boolean IsDisplayRtl (long self)

Throws
PDFNetException

public static void SetBorder (long self, double thickness, int red, int green, int blue)

Throws
PDFNetException

public static void SetDefaultTabStop (long self, double val)

Throws
PDFNetException

public static void SetDisplayRtl (long self, boolean val)

Throws
PDFNetException

public static void SetEndIndent (long self, double val)

Throws
PDFNetException

public static void SetSpacesPerTab (long self, int val)

Throws
PDFNetException

public static void SetStartIndent (long self, double val)

Throws
PDFNetException

public static void SetTextIndent (long self, double val)

Throws
PDFNetException

public void addTabStop (double val)

Adds a tab stop to the paragraph.

Parameters
val The tab stop value to add.
Throws
PDFNetException

public TextRun addText (String text)

Add another text run to the paragraph

Parameters
text The text to add
Returns
  • The newly created TextRun object
Throws
PDFNetException

public double getBorderThickness ()

Retrieves the border thickness for the paragraph.

Returns
  • The border thickness value for the paragraph.
Throws
PDFNetException

public double getDefaultTabStop ()

Retrieves the default tab stop value for the paragraph.

Returns
  • The default tab stop value for the paragraph.
Throws
PDFNetException

public double getEndIndent ()

Retrieves the end indent for the paragraph.

Returns
  • The end indent value for the paragraph.
Throws
PDFNetException

public Paragraph.TextJustification getJustificationMode ()

Get justification mode for the paragraph

Returns
  • Justification mode for paragraph style
Throws
PDFNetException

public double getNextTabStop (double val)

Retrieves the next tab stop value based on the given position.

Parameters
val The position to find the next tab stop from.
Returns
  • The next tab stop value.
Throws
PDFNetException

public double getSpaceAfter ()

Get the "space after" value for the paragraph style

Returns
  • "space after" value for paragraph style
Throws
PDFNetException

public double getSpaceBefore ()

Get the "space before" value for the paragraph style

Returns
  • "space before" value for paragraph style
Throws
PDFNetException

public int getSpacesPerTab ()

Retrieves the number of spaces per tab for the paragraph.

Returns
  • The number of spaces per tab for the paragraph.
Throws
PDFNetException

public double getStartIndent ()

Retrieves the start indent for the paragraph.

Returns
  • The start indent value for the paragraph.
Throws
PDFNetException

public double getTextIndent ()

Retrieves the text indent for the paragraph.

Returns
  • The text indent value for the paragraph.
Throws
PDFNetException

public boolean isDisplayRtl ()

Retrieves the display right-to-left (RTL) mode for the paragraph.

Returns
  • The RTL mode value for the paragraph.
Throws
PDFNetException

public void setBorder (double thickness, int red, int green, int blue)

Sets the border properties for the paragraph.

Parameters
thickness The border thickness value to set.
red The red component of the border color.
green The green component of the border color.
blue The blue component of the border color.
Throws
PDFNetException

public void setDefaultTabStop (double val)

Sets the default tab stop value for the paragraph.

Parameters
val The default tab stop value to set.
Throws
PDFNetException

public void setDisplayRtl (boolean val)

Sets the display right-to-left (RTL) mode for the paragraph.

Parameters
val The RTL mode value to set.
Throws
PDFNetException

public void setEndIndent (double val)

Sets the end indent for the paragraph.

Parameters
val The end indent value to set.
Throws
PDFNetException

public void setJustificationMode (Paragraph.TextJustification val)

Set justification mode for paragraph style

Parameters
val The justification mode to set
Throws
PDFNetException

public void setSpaceAfter (double val)

Set the "space after" value for paragraph style

Parameters
val The "space after" value to set
Throws
PDFNetException

public void setSpaceBefore (double val)

Set the "space before" value for the paragraph style

Parameters
val The "space before" value to set
Throws
PDFNetException

public void setSpacesPerTab (int val)

Sets the number of spaces per tab for the paragraph.

Parameters
val The number of spaces per tab to set.
Throws
PDFNetException

public void setStartIndent (double val)

Sets the start indent for the paragraph.

Parameters
val The start indent value to set.
Throws
PDFNetException

public void setTextIndent (double val)

Sets the text indent for the paragraph.

Parameters
val The text indent value to set.
Throws
PDFNetException