com.qoppa.pdf.annotations

Interface GestureList

public interface GestureList

This class represents a list of gestures in an Ink (Pencil) annotation. A gesture is composed of a list of connected vertices. A gesture list can have any number of gestures to represent a complete pencil annotation.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
Vertices	addGesture() Add a new gesture to the gesture list.
Vertices	getGesture(int index) Returns the Vertices object that containts the vertices for one gesture.
int	getGestureCount() Returns the number of gestures in this list.
boolean	isModified() Flag indicating whether the gesture list has been modified.
void	removeGesture(int index) Removes a gesture from the list.
void	setModified(boolean mod) Explicitly flag this gesture list as modified.

Method Detail

addGesture

Vertices addGesture()

Add a new gesture to the gesture list. The method returns a Vertices object which can then be used to add all the individual vertices to the gesture.

Returns:

A Vertices object to add vertex points to the gesture.

getGesture

Vertices getGesture(int index)

Returns the Vertices object that containts the vertices for one gesture. The Vertices object is mutable, so any changes to add or remove vertices will be reflected in the gesture.

Parameters:

index - The index of the gesture to get.

Returns:

a Vertices object that represents the gesture.

getGestureCount

int getGestureCount()

Returns the number of gestures in this list.

Returns:

The number of gestures in the list.

removeGesture

void removeGesture(int index)

Removes a gesture from the list.

Parameters:

index - The index of the gesture that needs to be removed.

isModified

boolean isModified()

Flag indicating whether the gesture list has been modified.

Returns:

true if the list has been modified, false otherwise.

setModified

void setModified(boolean mod)

Explicitly flag this gesture list as modified.

Parameters:

mod - New value of the modified flag.