Package org.jpedal.annotation

Class Ink

java.lang.Object

org.jpedal.annotation.Annotation

org.jpedal.annotation.Markup

org.jpedal.annotation.Ink

public final class Ink
extends org.jpedal.annotation.Markup

Defines an Ink annotation.

An ink annotation represents a freehand "scribble" composed of one or more disjoint paths.

Constructor Summary

Constructors

Constructor	Description
Ink(float[] rect, float[] color, float[][] inkList, float lineWidth)	Create a new Ink annotation.
Ink(float[] rect, int flags, float[] color, float strokingAlpha, float nonStrokingAlpha, float[][] inkList, float lineWidth)	Create a new Ink annotation.
Ink(float[] rect, int flags, String contents, float[] color, float strokingAlpha, float nonStrokingAlpha, String title, float[][] inkList, float lineWidth)	Create a new Ink annotation.

Method Summary

Modifier and Type	Method	Description
org.jpedal.io.annotation.utils.AnnotDict	getDict()	Creates the annotation dictionary.

Methods inherited from class org.jpedal.annotation.Annotation

getFlagsValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Ink

public Ink(float[] rect,
 float[] color,
 float[][] inkList,
 float lineWidth)

Create a new Ink annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

color - the color of the annotation

inkList - An array of n arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates in default user space, specifying points along the path.

lineWidth - the width of the lines

Ink

public Ink(float[] rect,
 int flags,
 float[] color,
 float strokingAlpha,
 float nonStrokingAlpha,
 float[][] inkList,
 float lineWidth)

Create a new Ink annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

flags - the annotation's flags. See Annotation.getFlagsValue(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

color - the color of the annotation

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

inkList - An array of n arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates in default user space, specifying points along the path.

lineWidth - the width of the lines

Ink

public Ink(float[] rect,
 int flags,
 String contents,
 float[] color,
 float strokingAlpha,
 float nonStrokingAlpha,
 String title,
 float[][] inkList,
 float lineWidth)

Create a new Ink annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

flags - the annotation's flags. See Annotation.getFlagsValue(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

contents - text that shall be displayed or null

color - the color of the annotation

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

title - the text for the title bar

inkList - An array of n arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates in default user space, specifying points along the path.

lineWidth - the width of the lines

Method Details

getDict

public org.jpedal.io.annotation.utils.AnnotDict getDict()

Creates the annotation dictionary.

This method is considered as not part of the public API.

Overrides:

getDict in class org.jpedal.annotation.Markup

Returns:

a dictionary containing the relevant entries.