Package org.jpedal.annotation

Class Square

java.lang.Object

org.jpedal.annotation.Annotation

org.jpedal.annotation.Markup

org.jpedal.annotation.Square

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

Defines a Square annotation.

Square annotations shall display a rectangle on the page.

Constructor Summary

Constructors

Constructor	Description
Square(float[] rect, float[] lineColor, float[] fillColor, float strokingAlpha, float nonStrokingAlpha, float lineWidth)	Create a new Square annotation.
Square(float[] rect, int flags, float[] lineColor, float[] fillColor, float strokingAlpha, float nonStrokingAlpha, float lineWidth)	Create a new Square annotation.
Square(float[] rect, int flags, String contents, float[] lineColor, float[] fillColor, float strokingAlpha, float nonStrokingAlpha, String title, float lineWidth)	Create a new Square 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

Square

public Square(float[] rect,
 float[] lineColor,
 float[] fillColor,
 float strokingAlpha,
 float nonStrokingAlpha,
 float lineWidth)

Create a new Square annotation.

Parameters:

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

lineColor - the line color of the annotation

fillColor - the fill color

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

lineWidth - the width of the lines

Square

public Square(float[] rect,
 int flags,
 float[] lineColor,
 float[] fillColor,
 float strokingAlpha,
 float nonStrokingAlpha,
 float lineWidth)

Create a new Square 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)

lineColor - the line color of the annotation

fillColor - the fill color

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

lineWidth - the width of the lines

Square

public Square(float[] rect,
 int flags,
 String contents,
 float[] lineColor,
 float[] fillColor,
 float strokingAlpha,
 float nonStrokingAlpha,
 String title,
 float lineWidth)

Create a new Square 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

lineColor - the line color of the annotation

fillColor - the fill color

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

title - the text for the title bar

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.