LineAnnotation
Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation, com.aspose.pdf.MarkupAnnotation
public final class LineAnnotation extends MarkupAnnotation
Class representing line annotation.
Constructors
Constructor | Description |
---|---|
LineAnnotation(IDocument document, Point start, Point end) | Constructor for using with Generator. |
LineAnnotation(Page page, Rectangle rect, Point start, Point end) | Creates new Line annotation on the specified page. |
Methods
Method | Description |
---|---|
getStarting() | Gets starting point of line. |
setStarting(Point value) | Sets starting point of line. |
getStartingStyle() | Gets line ending style for line starting point. |
setStartingStyle(int value) | Sets line ending style for line starting point. |
getEnding() | Gets line ending point. |
setEnding(Point value) | Sets line ending point. |
getEndingStyle() | Gets ending style for end point of line. |
setEndingStyle(int value) | Sets ending style for end point of line. |
getInteriorColor() | Gets interior color of the annotation. |
setInteriorColor(Color value) | Sets interior color of the annotation. |
getLeaderLine() | Gets leader line length. |
setLeaderLine(double value) | Sets leader line length. |
getLeaderLineExtension() | Gets length of leader line extension. |
setLeaderLineExtension(double value) | Sets length of leader line extension. |
getShowCaption() | Gets boolean flag which determinies is contents must be shown as caption. |
setShowCaption(boolean value) | Sets boolean flag which determinies is contents must be shown as caption. |
getLeaderLineOffset() | Gets leader line offset. |
setLeaderLineOffset(double value) | Sets leader line offset. |
getCaptionOffset() | Gets caption text offset from its normal position. |
setCaptionOffset(Point value) | Sets caption text offset from its normal position. |
getCaptionPosition() | Gets annotation caption position. |
setCaptionPosition(int value) | Sets annotation caption position. |
getMeasure() | Measure units specifed for this annotation. |
setMeasure(Measure value) | Measure units specifed for this annotation. |
accept(AnnotationSelector visitor) | Accepts visitor to annotation processing. |
getIntent() | Gets the intent of the line annotation. |
setIntent(int value) | Sets the intent of the line annotation. |
getAnnotationType() | Gets type of annotation. |
changeAfterResize(Matrix transform) | Updates the Starting and Ending points, according to the matrix transform. |
LineAnnotation(IDocument document, Point start, Point end)
public LineAnnotation(IDocument document, Point start, Point end)
Constructor for using with Generator.
Parameters:
Parameter | Type | Description |
---|---|---|
document | IDocument | Document where annotation will be created. |
start | Point | Starting point. |
end | Point | Ending point. |
LineAnnotation(Page page, Rectangle rect, Point start, Point end)
public LineAnnotation(Page page, Rectangle rect, Point start, Point end)
Creates new Line annotation on the specified page.
Parameters:
Parameter | Type | Description |
---|---|---|
page | Page | The document’s page where annotation should be created. |
rect | Rectangle | The annotation rectangle, defining the location of the annotation on the page. |
start | Point | A point, specifying the starting coordinate of the line. |
end | Point | A point, specifying the ending coordinate of the line. |
getStarting()
public Point getStarting()
Gets starting point of line.
Returns: Point - Point value
setStarting(Point value)
public void setStarting(Point value)
Sets starting point of line.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Point | Point value |
getStartingStyle()
public int getStartingStyle()
Gets line ending style for line starting point.
Returns: int - LineEnding element
setStartingStyle(int value)
public void setStartingStyle(int value)
Sets line ending style for line starting point.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | LineEnding element |
getEnding()
public Point getEnding()
Gets line ending point.
Returns: Point - Point value
setEnding(Point value)
public void setEnding(Point value)
Sets line ending point.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Point | Point value |
getEndingStyle()
public int getEndingStyle()
Gets ending style for end point of line.
Returns: int - LineEnding element
setEndingStyle(int value)
public void setEndingStyle(int value)
Sets ending style for end point of line.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | LineEnding element |
getInteriorColor()
public Color getInteriorColor()
Gets interior color of the annotation.
Returns: Color - Color object
setInteriorColor(Color value)
public void setInteriorColor(Color value)
Sets interior color of the annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Color | Color object |
getLeaderLine()
public double getLeaderLine()
Gets leader line length.
Returns: double - double value
setLeaderLine(double value)
public void setLeaderLine(double value)
Sets leader line length.
Parameters:
Parameter | Type | Description |
---|---|---|
value | double | double value |
getLeaderLineExtension()
public double getLeaderLineExtension()
Gets length of leader line extension.
Returns: double - double value
setLeaderLineExtension(double value)
public void setLeaderLineExtension(double value)
Sets length of leader line extension.
Parameters:
Parameter | Type | Description |
---|---|---|
value | double | double value |
getShowCaption()
public boolean getShowCaption()
Gets boolean flag which determinies is contents must be shown as caption.
Returns: boolean - boolean value
setShowCaption(boolean value)
public void setShowCaption(boolean value)
Sets boolean flag which determinies is contents must be shown as caption.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | boolean value |
getLeaderLineOffset()
public double getLeaderLineOffset()
Gets leader line offset.
Returns: double - double value
setLeaderLineOffset(double value)
public void setLeaderLineOffset(double value)
Sets leader line offset.
Parameters:
Parameter | Type | Description |
---|---|---|
value | double | double value |
getCaptionOffset()
public Point getCaptionOffset()
Gets caption text offset from its normal position.
Returns: Point - Point object
setCaptionOffset(Point value)
public void setCaptionOffset(Point value)
Sets caption text offset from its normal position.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Point | Point object |
getCaptionPosition()
public int getCaptionPosition()
Gets annotation caption position.
Returns: int - CaptionPosition element
setCaptionPosition(int value)
public void setCaptionPosition(int value)
Sets annotation caption position.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | CaptionPosition element |
getMeasure()
public Measure getMeasure()
Measure units specifed for this annotation.
Returns: Measure - Measure object
setMeasure(Measure value)
public void setMeasure(Measure value)
Measure units specifed for this annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Measure | Measure object |
accept(AnnotationSelector visitor)
public void accept(AnnotationSelector visitor)
Accepts visitor to annotation processing.
Parameters:
Parameter | Type | Description |
---|---|---|
visitor | AnnotationSelector | Visitor object |
getIntent()
public int getIntent()
Gets the intent of the line annotation.
Returns: int - LineIntent element
setIntent(int value)
public void setIntent(int value)
Sets the intent of the line annotation.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | LineIntent element |
getAnnotationType()
public AnnotationType getAnnotationType()
Gets type of annotation.
Returns: AnnotationType - AnnotationType element
changeAfterResize(Matrix transform)
public void changeAfterResize(Matrix transform)
Updates the Starting and Ending points, according to the matrix transform.
Parameters:
Parameter | Type | Description |
---|---|---|
transform | Matrix | Matrix specifying the transformation. |