HighlightAnnotation
public final class HighlightAnnotation
extends PdfAnnotation
| java.lang.Object | ||
| ↳ | android.graphics.pdf.component.PdfAnnotation | |
| ↳ | android.graphics.pdf.component.HighlightAnnotation | |
Represents a highlight annotation in a PDF document.
If the highlight color is not explicitly set using ERROR(/#setColor(android.graphics.Color)), the default color is yellow.
Summary
Public constructors | |
|---|---|
HighlightAnnotation(List<RectF> boundsList) Creates a new highlight annotation with the specified bounds list. | |
Public methods | |
|---|---|
List<RectF> | getBoundsList() Returns the bounding rectangles of the highlight annotation. |
int | getColor() Returns the highlight color of the annotation. |
void | setBoundsList(List<RectF> boundsList) Sets the bounding rectangles of the highlight annotation. |
void | setColor(int color) Sets the highlight color of the annotation. |
Inherited methods | |
|---|---|
Public constructors
HighlightAnnotation
public HighlightAnnotation (List<RectF> boundsList)
Creates a new highlight annotation with the specified bounds list.
The default highlight color is yellow
| Parameters | |
|---|---|
boundsList | List: The bounding rectangle of the annotation. This value cannot be null. |
Public methods
getBoundsList
public List<RectF> getBoundsList ()
Returns the bounding rectangles of the highlight annotation.
| Returns | |
|---|---|
List<RectF> | The bounding rectangles. This value cannot be null. |
getColor
public int getColor ()
Returns the highlight color of the annotation.
| Returns | |
|---|---|
int | The highlight color. |
setBoundsList
public void setBoundsList (List<RectF> boundsList)
Sets the bounding rectangles of the highlight annotation. Each rect in the list mBoundsList represent an absolute position of highlight inside the page of the document
| Parameters | |
|---|---|
boundsList | List: The new bounding rectangles. This value cannot be null. |
| Throws | |
|---|---|
IllegalArgumentException | if the given bounds list is empty |
setColor
public void setColor (int color)
Sets the highlight color of the annotation.
| Parameters | |
|---|---|
color | int: The new highlight color. |