| java.lang.Object | |||
| ↳ | com.pdftron.pdf.Annot | ||
| ↳ | com.pdftron.pdf.annots.Markup | ||
| ↳ | com.pdftron.pdf.annots.Line | ||
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
The purpose of a line annotation (PDF 1.3) is to display a single straight line on the page. When opened, it shall display a pop-up window containing the text of the associated note.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | e_Butt | The Constant e_Butt. | |||||||||
| int | e_Circle | The Constant e_Circle. | |||||||||
| int | e_ClosedArrow | The Constant e_ClosedArrow. | |||||||||
| int | e_Diamond | The Constant e_Diamond. | |||||||||
| int | e_Inline | This integer list represents the caption position of the Line annotation. | |||||||||
| int | e_LineArrow | This integer list represents the intent of the Line annotation. | |||||||||
| int | e_LineDimension | The Constant e_LineDimension. | |||||||||
| int | e_None | The Constant e_None. | |||||||||
| int | e_OpenArrow | The Constant e_OpenArrow. | |||||||||
| int | e_RClosedArrow | The Constant e_RClosedArrow. | |||||||||
| int | e_ROpenArrow | The Constant e_ROpenArrow. | |||||||||
| int | e_Slash | The Constant e_Slash. | |||||||||
| int | e_Square | For each line, one can choose a style for the start of the line and a syle for the end of line respectively. | |||||||||
| int | e_Top | The Constant e_Top. | |||||||||
| int | e_Unknown | The Constant e_Unknown. | |||||||||
| int | e_null | The Constant e_null. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.pdftron.pdf.annots.Markup
| |||||||||||
|
From class
com.pdftron.pdf.Annot
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Line(Obj d)
Creates an Line annotation and initialize it using given Cos/SDF object.
| |||||||||||
|
Line()
Creates an empty Line annotation.
| |||||||||||
|
Line(Annot annot)
Creates an Line annotation and initialize it using given annotation object.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static Line |
create(Doc doc, Rect pos)
Creates a new Line annotation, in the specified document.
| ||||||||||
| int |
getCaptionPosition()
Get the caption position of a line.
| ||||||||||
| Point |
getEndPoint()
Get the coordinates of the end of a line.
| ||||||||||
| int |
getEndStyle()
Get the ending syle of the end of a line.
| ||||||||||
| int |
getIntentType()
Get the intent type of the line.
| ||||||||||
| double |
getLeaderLineExtensionLength()
Get the leader line extension length of a line.
| ||||||||||
| double |
getLeaderLineLength()
Get the leader line length of a line.
| ||||||||||
| double |
getLeaderLineOffset()
Get the leader line offset length of a line.
| ||||||||||
| boolean |
getShowCaption()
Get the option of whether to show caption.
| ||||||||||
| Point |
getStartPoint()
Get the coordinates of the start of a line.
| ||||||||||
| int |
getStartStyle()
Get the ending syle of the start of a line.
| ||||||||||
| double |
getTextHOffset()
Get the horizontal offset of the caption.
| ||||||||||
| double |
getTextVOffset()
Get the vertical offset of the caption.
| ||||||||||
| void |
setCaptionPosition(int style)
Set the caption position of a line.
| ||||||||||
| void |
setEndPoint(Point ep)
Set the coordinates of the end of a line.
| ||||||||||
| void |
setEndStyle(int est)
Set the ending syle of the end of a line
(Optional; PDF 1.4)
Note: Default value: e_None. | ||||||||||
| void |
setIntentType(int style)
Set the intent type of the line.
| ||||||||||
| void |
setLeaderLineExtensionLength(double ll)
Set the leader line extension length of a line.
| ||||||||||
| void |
setLeaderLineLength(double ll)
Set the leader line length of a line.
| ||||||||||
| void |
setLeaderLineOffset(double ll)
Set the leader line offset length of a line.
| ||||||||||
| void |
setShowCaption(boolean showCaption)
Set the option of whether to show caption.
| ||||||||||
| void |
setStartPoint(Point sp)
Set the coordinates of the start of a line.
| ||||||||||
| void |
setStartStyle(int sst)
Set the ending syle of the start of a line
(Optional; PDF 1.4.)
Note: Default value: e_None. | ||||||||||
| void |
setTextHOffset(double offset)
Set the horizontal offset of the caption.
| ||||||||||
| void |
setTextVOffset(double offset)
Set the vertical offset of the caption.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.pdftron.pdf.annots.Markup
| |||||||||||
|
From class
com.pdftron.pdf.Annot
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Constants
public static final int e_Butt
The Constant e_Butt.
public static final int e_Circle
The Constant e_Circle.
public static final int e_ClosedArrow
The Constant e_ClosedArrow.
public static final int e_Diamond
The Constant e_Diamond.
public static final int e_Inline
This integer list represents the caption position of the Line annotation. For each line, one can specify the purpose of the line by choosing a intent type defined by the "IntentType" enum. e_LineArrow - The line is an arrow e_LineDimension - This line is intented to function as a dimension line.
public static final int e_LineArrow
This integer list represents the intent of the Line annotation. * For each line, one can specify the purpose of the line by choosing a intent type defined by the "IntentType" enum. e_LineArrow - The line is an arrow e_LineDimension - This line is intented to function as a dimension line.
public static final int e_LineDimension
The Constant e_LineDimension.
public static final int e_None
The Constant e_None.
public static final int e_OpenArrow
The Constant e_OpenArrow.
public static final int e_RClosedArrow
The Constant e_RClosedArrow.
public static final int e_ROpenArrow
The Constant e_ROpenArrow.
public static final int e_Slash
The Constant e_Slash.
public static final int e_Square
For each line, one can choose a style for the start of the line and a syle for the end of line respectively. The styles are defined by the the following integer list.
public static final int e_Top
The Constant e_Top.
public static final int e_Unknown
The Constant e_Unknown.
public static final int e_null
The Constant e_null.
Public Constructors
public Line (Obj d)
Creates an Line annotation and initialize it using given Cos/SDF object.
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
Parameters
| d | the input Cos/SDF object |
|---|
public Line ()
Creates an empty Line annotation.
public Line (Annot annot)
Creates an Line annotation and initialize it using given annotation object.
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
Parameters
| annot | the input annotation object |
|---|
Throws
| PDFNetException |
|---|
Public Methods
public static Line create (Doc doc, Rect pos)
Creates a new Line annotation, in the specified document.
Parameters
| doc | A document to which the annotation is added. |
|---|---|
| pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
Returns
- A newly created blank Line annotation.
Throws
| PDFNetException |
|---|
public int getCaptionPosition ()
Get the caption position of a line.
Note: Caption position describs the annotation's caption positioning. Valid values are e_Inline, meaning the caption shall be centered inside the line, and e_Top, meaning the caption shall be on top of the line. Default value: Inline
Returns
- A cap position value from the "CapPos" enum.
Throws
| PDFNetException |
|---|
public Point getEndPoint ()
Get the coordinates of the end of a line.
Returns
- A Point struct, whose x entry specifies the x coordinate of the end of the line and the y entry specifies the y coordinate of the end of the line.
Throws
| PDFNetException |
|---|
public int getEndStyle ()
Get the ending syle of the end of a line.
Note: Default value: e_None.
Returns
- A enum value from the "EndingStyle" enum, whose value corrsponding to the ending style of the start point.
Throws
| PDFNetException |
|---|
public int getIntentType ()
Get the intent type of the line.
Note: Intent type describes the intent of the line annotation. Valid values shall be "e_LineArrow", which means that the annotation is intended to function as an arrow, and "e_LineDimension", which means that the annotation is intended to function as a dimension line.
Returns
- An intent type value from the "IntentType" enum.
Throws
| PDFNetException |
|---|
public double getLeaderLineExtensionLength ()
Get the leader line extension length of a line.
Note: Usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
The leader line extension length is a non-negative number that shall represents the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. Default value: 0 (no leader line extensions)
Returns
- A number denoting the length of the leader line extension in px.
Throws
| PDFNetException |
|---|
public double getLeaderLineLength ()
Get the leader line length of a line.
Note: usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
Leader length is length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value shall mean that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by L); a negative value shall indicate the opposite direction. Default value: 0 (no leader lines)
Returns
- A number denoting the length of the leader line in px.
Throws
| PDFNetException |
|---|
public double getLeaderLineOffset ()
Get the leader line offset length of a line.
Note: usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
Leader line offset number is a non-negative number that shall represent the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
Returns
- A number denoting the length of the leader line offset in px.
Throws
| PDFNetException |
|---|
public boolean getShowCaption ()
Get the option of whether to show caption.
Note: If true, the text specified by the Contents or RCentries shall be replicated as a caption in the appearance of the line. The text shall be rendered in a manner appropriate to the content, taking into account factors such as writing direction. Default value: false.
Returns
- A boolean value indicating whether the caption will be shown.
Throws
| PDFNetException |
|---|
public Point getStartPoint ()
Get the coordinates of the start of a line.
Returns
- A Point struct, whose x entry specifies the x coordinate of the start of the line and the y entry specifies the y coordinate of the start of the line.
Throws
| PDFNetException |
|---|
public int getStartStyle ()
Get the ending syle of the start of a line.
Note: Default value: e_None.
Returns
- A enum value from the "EndingStyle" enum, whose value corrsponding to the ending style of the start point.
Throws
| PDFNetException |
|---|
public double getTextHOffset ()
Get the horizontal offset of the caption.
Note: The horizontal offset specifies the offset of the caption text from its normal position. Specifially the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. Default value: 0 (no offset from normal horizontal positioning)
Returns
- A number denoting the horizontal offset of caption in px.
Throws
| PDFNetException |
|---|
public double getTextVOffset ()
Get the vertical offset of the caption.
Note: The vertical offset specifies the offset of the caption text from its normal position. Specifially the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down. Default value: 0(no offset from normal vertical positioning).
Returns
- A number denoting the vertical offset of caption in px.
Throws
| PDFNetException |
|---|
public void setCaptionPosition (int style)
Set the caption position of a line. (PDF 1.7)
Note: Caption position describs the annotation's caption positioning. Valid values are e_Inline, meaning the caption shall be centered inside the line, and e_Top, meaning the caption shall be on top of the line. Default value: Inline.
Parameters
| style | A cap position value from the "CapPos" enum. |
|---|
Throws
| PDFNetException |
|---|
public void setEndPoint (Point ep)
Set the coordinates of the end of a line.
Parameters
| ep | - A Point struct whose x entry is going to be set as the x coordinate of the end point of the line, whose y entry is going to be set as the y coordinate of the end point of the line. |
|---|
Throws
| PDFNetException |
|---|
public void setEndStyle (int est)
Set the ending syle of the end of a line (Optional; PDF 1.4)
Note: Default value: e_None.
Parameters
| est | A enum value from the "EndingStyle" enum, whose value corrsponding to the ending style of the start point. |
|---|
Throws
| PDFNetException |
|---|
public void setIntentType (int style)
Set the intent type of the line. (For PDF 1.
Note: Intent type describes the intent of the line annotation. Valid values shall be "e_LineArrow", which means that the annotation is intended to function as an arrow, and "e_LineDimension", which means that the annotation is intended to function as a dimension line.6)
Parameters
| style | An intent type value from the "IntentType" enum. |
|---|
Throws
| PDFNetException |
|---|
public void setLeaderLineExtensionLength (double ll)
Set the leader line extension length of a line. (PDF 1.6)
Note: Usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
The leader line extension length is a non-negative number that shall represents the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. Default value: 0 (no leader line extensions)
Parameters
| ll | the new leader line extension length |
|---|
Throws
| PDFNetException |
|---|
public void setLeaderLineLength (double ll)
Set the leader line length of a line. (PDF 1.6)
Note: Usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
Leader length is length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value shall mean that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by L); a negative value shall indicate the opposite direction. Default value: 0 (no leader lines)
Parameters
| ll | the new leader line length |
|---|
Throws
| PDFNetException |
|---|
public void setLeaderLineOffset (double ll)
Set the leader line offset length of a line. (PDF 1.7)
Note: Usually if this entry is specified, the line is intended to be a dimension line(see "IT" entry).
Leader line offset number is a non-negative number that shall represent the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
Parameters
| ll | A number denoting the length of the leader line offset in px. |
|---|
Throws
| PDFNetException |
|---|
public void setShowCaption (boolean showCaption)
Set the option of whether to show caption.
Note: If true, the text specified by the Contents or RCentries shall be replicated as a caption in the appearance of the line. The text shall be rendered in a manner appropriate to the content, taking into account factors such as writing direction. Default value: false.
Parameters
| showCaption | A boolean value indicating whether the caption will be shown. |
|---|
Throws
| PDFNetException |
|---|
public void setStartPoint (Point sp)
Set the coordinates of the start of a line.
Parameters
| sp | A Point struct whose x entry is going to be set as the x coordinate of the start point of the line, whose y entry is going to be set as the y coordinate of the start point of the line. |
|---|
Throws
| PDFNetException |
|---|
public void setStartStyle (int sst)
Set the ending syle of the start of a line (Optional; PDF 1.4.)
Note: Default value: e_None.
Parameters
| sst | A enum value from the "EndingStyle" enum, whose value corrsponding to the ending style of the start point. |
|---|
Throws
| PDFNetException |
|---|
public void setTextHOffset (double offset)
Set the horizontal offset of the caption. (For PDF 1.7 )
Note: The horizontal offset specifies the offset of the caption text from its normal position. Specifially the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. Default value: 0 (no offset from normal horizontal positioning)
Parameters
| offset | A umber denoting the horizontal offset of caption in px. |
|---|
Throws
| PDFNetException |
|---|
public void setTextVOffset (double offset)
Set the vertical offset of the caption. (For PDF 1.7 )
Note: The vertical offset specifies the offset of the caption text from its normal position. Specifially the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down. Default value: 0(no offset from normal vertical positioning).
Parameters
| offset | A number denoting the vertical offset of caption in px. |
|---|
Throws
| PDFNetException |
|---|