HighlightAnnotation

Summary: Ctors | Methods | Inherited Methods

public final class HighlightAnnotation
extends PdfAnnotation

Represents a highlight annotation in a PDF document.

If the highlight color is not explicitly set using ERROR(setColor(Color)/#setColor(android.graphics.Color) setColor(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

From class android.graphics.pdf.component.PdfAnnotation

int


      getPdfAnnotationType()

Returns the type of the annotation.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

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.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.