Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

InvalidFormTypeOperationException

Skip navigation links

java.lang.Object
- com.aspose.pdf.BaseParagraph
- - com.aspose.pdf.Annotation
  - - com.aspose.pdf.MarkupAnnotation
    - - com.aspose.pdf.LineAnnotation

All Implemented Interfaces:

com.aspose.ms.System.ICloneable, com.aspose.pdf.engine.ITitledAnnotation
```
public final class LineAnnotation
extends MarkupAnnotation
```
Class representing line annotation.

Field Summary
- Fields inherited from class com.aspose.pdf.Annotation
  _disableUpdateAppearance

Constructor Summary

Constructors
Constructor and 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(AnnotationSelector visitor)` Accepts visitor to annotation processing.
`int`	`getAnnotationType()` Gets type of annotation.
`Point`	`getCaptionOffset()` Gets caption text offset from its normal position.
`int`	`getCaptionPosition()` Gets annotation caption position.
`Point`	`getEnding()` Gets line ending point.
`int`	`getEndingStyle()` Gets ending style for end point of line.
`int`	`getIntent()` Gets the intent of the line annotation.
`Color`	`getInteriorColor()` Gets interior color of the annotation.
`double`	`getLeaderLine()` Gets leader line length.
`double`	`getLeaderLineExtension()` Gets length of leader line extension.
`double`	`getLeaderLineOffset()` Gets leader line offset.
`Measure`	`getMeasure()` Measure units specifed for this annotation.
`boolean`	`getShowCaption()` Gets boolean flag which determinies is contents must be shown as caption.
`Point`	`getStarting()` Gets starting point of line.
`int`	`getStartingStyle()` Gets line ending style for line starting point.
`void`	`setCaptionOffset(Point value)` Sets caption text offset from its normal position.
`void`	`setCaptionPosition(int value)` Sets annotation caption position.
`void`	`setEnding(Point value)` Sets line ending point.
`void`	`setEndingStyle(int value)` Sets ending style for end point of line.
`void`	`setIntent(int value)` Sets the intent of the line annotation.
`void`	`setInteriorColor(Color value)` Sets interior color of the annotation.
`void`	`setLeaderLine(double value)` Sets leader line length.
`void`	`setLeaderLineExtension(double value)` Sets length of leader line extension.
`void`	`setLeaderLineOffset(double value)` Sets leader line offset.
`void`	`setMeasure(Measure value)` Measure units specifed for this annotation.
`void`	`setShowCaption(boolean value)` Sets boolean flag which determinies is contents must be shown as caption.
`void`	`setStarting(Point value)` Sets starting point of line.
`void`	`setStartingStyle(int value)` Sets line ending style for line starting point.

Methods inherited from class com.aspose.pdf.MarkupAnnotation
getCreationDate, getInReplyTo, getOpacity, getPopup, getReplyType, getRichText, getSubject, getTitle, setInReplyTo, setOpacity, setPopup, setReplyType, setRichText, setSubject, setTitle

Methods inherited from class com.aspose.pdf.BaseParagraph
deepClone, getHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndex

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LineAnnotation
```
public LineAnnotation(IDocument document,
                      Point start,
                      Point end)
```
    Constructor for using with Generator.
    
    Parameters:
    
    document - Document where annotation will be created.
    
    start - Starting point.
    
    end - Ending point.
  - LineAnnotation
```
public LineAnnotation(Page page,
                      Rectangle rect,
                      Point start,
                      Point end)
```
    Creates new Line annotation on the specified page.
    
    Parameters:
    
    page - The document's page where annotation should be created.
    
    rect - The annotation rectangle, defining the location of the annotation on the page.
    
    start - A point, specifying the starting coordinate of the line.
    
    end - A point, specifying the ending coordinate of the line.
- Method Detail
  - getStarting
```
public Point getStarting()
```
    Gets starting point of line.
    
    Returns:
    
    Point value
  - setStarting
```
public void setStarting(Point value)
```
    Sets starting point of line.
    
    Parameters:
    
    value - Point value
  - getStartingStyle
```
public int getStartingStyle()
```
    Gets line ending style for line starting point.
    
    Returns:
    
    LineEnding element
    
    See Also:
    
    LineEnding
  - setStartingStyle
```
public void setStartingStyle(int value)
```
    Sets line ending style for line starting point.
    
    Parameters:
    
    value - LineEnding element
    
    See Also:
    
    LineEnding
  - getEnding
```
public Point getEnding()
```
    Gets line ending point.
    
    Returns:
    
    Point value
  - setEnding
```
public void setEnding(Point value)
```
    Sets line ending point.
    
    Parameters:
    
    value - Point value
  - getEndingStyle
```
public int getEndingStyle()
```
    Gets ending style for end point of line.
    
    Returns:
    
    LineEnding element
    
    See Also:
    
    LineEnding
  - setEndingStyle
```
public void setEndingStyle(int value)
```
    Sets ending style for end point of line.
    
    Parameters:
    
    value - LineEnding element
    
    See Also:
    
    LineEnding
  - getInteriorColor
```
public Color getInteriorColor()
```
    Gets interior color of the annotation.
    
    Returns:
    
    Color object
  - setInteriorColor
```
public void setInteriorColor(Color value)
```
    Sets interior color of the annotation.
    
    Parameters:
    
    value - Color object
  - getLeaderLine
```
public double getLeaderLine()
```
    Gets leader line length.
    
    Returns:
    
    double value
  - setLeaderLine
```
public void setLeaderLine(double value)
```
    Sets leader line length.
    
    Parameters:
    
    value - double value
  - getLeaderLineExtension
```
public double getLeaderLineExtension()
```
    Gets length of leader line extension.
    
    Returns:
    
    double value
  - setLeaderLineExtension
```
public void setLeaderLineExtension(double value)
```
    Sets length of leader line extension.
    
    Parameters:
    
    value - double value
  - getShowCaption
```
public boolean getShowCaption()
```
    Gets boolean flag which determinies is contents must be shown as caption.
    
    Returns:
    
    boolean value
  - setShowCaption
```
public void setShowCaption(boolean value)
```
    Sets boolean flag which determinies is contents must be shown as caption.
    
    Parameters:
    
    value - boolean value
  - getLeaderLineOffset
```
public double getLeaderLineOffset()
```
    Gets leader line offset.
    
    Returns:
    
    double value
  - setLeaderLineOffset
```
public void setLeaderLineOffset(double value)
```
    Sets leader line offset.
    
    Parameters:
    
    value - double value
  - getCaptionOffset
```
public Point getCaptionOffset()
```
    Gets caption text offset from its normal position.
    
    Returns:
    
    Point object
  - setCaptionOffset
```
public void setCaptionOffset(Point value)
```
    Sets caption text offset from its normal position.
    
    Parameters:
    
    value - Point object
  - getCaptionPosition
```
public int getCaptionPosition()
```
    Gets annotation caption position.
    
    Returns:
    
    CaptionPosition element
    
    See Also:
    
    CaptionPosition
  - setCaptionPosition
```
public void setCaptionPosition(int value)
```
    Sets annotation caption position.
    
    Parameters:
    
    value - CaptionPosition element
    
    See Also:
    
    CaptionPosition
  - getMeasure
```
public Measure getMeasure()
```
    Measure units specifed for this annotation.
    
    Returns:
    
    Measure object
  - setMeasure
```
public void setMeasure(Measure value)
```
    Measure units specifed for this annotation.
    
    Parameters:
    
    value - Measure object
  - accept
```
public void accept(AnnotationSelector visitor)
```
    Accepts visitor to annotation processing.
    
    Specified by:
    
    accept in class Annotation
    
    Parameters:
    
    visitor - Visitor object
  - getIntent
```
public int getIntent()
```
    Gets the intent of the line annotation.
    
    Returns:
    
    LineIntent element
    
    See Also:
    
    LineIntent
  - setIntent
```
public void setIntent(int value)
```
    Sets the intent of the line annotation.
    
    Parameters:
    
    value - LineIntent element
    
    See Also:
    
    LineIntent
  - getAnnotationType
```
public int getAnnotationType()
```
    Gets type of annotation.
    
    Specified by:
    
    getAnnotationType in class Annotation
    
    Returns:
    
    AnnotationType element
    
    See Also:
    
    AnnotationType

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class LineAnnotation

Field Summary

Fields inherited from class com.aspose.pdf.Annotation

Constructor Summary

Method Summary

Methods inherited from class com.aspose.pdf.MarkupAnnotation

Methods inherited from class com.aspose.pdf.Annotation

Methods inherited from class com.aspose.pdf.BaseParagraph

Methods inherited from class java.lang.Object

Constructor Detail

LineAnnotation

LineAnnotation

Method Detail

getStarting

setStarting

getStartingStyle

setStartingStyle

getEnding

setEnding

getEndingStyle

setEndingStyle

getInteriorColor

setInteriorColor

getLeaderLine

setLeaderLine

getLeaderLineExtension

setLeaderLineExtension

getShowCaption

setShowCaption

getLeaderLineOffset

setLeaderLineOffset

getCaptionOffset

setCaptionOffset

getCaptionPosition

setCaptionPosition

getMeasure

setMeasure

accept

getIntent

setIntent

getAnnotationType