com.icesoft.pdf.pobjects.annotations
Class BorderStyle

java.lang.Object
  com.icesoft.pdf.pobjects.Dictionary
      com.icesoft.pdf.pobjects.annotations.BorderStyle

public class BorderStyle

extends Dictionary

Refer to: 8.4.3 Border Styles

Key

Type

Value

Type

name

(Optional) The type of PDF object that this dictionary describes; if present, must be Border for a border style dictionary.

W

number

(Optional) The border width in points. If this value is 0, no border is drawn. Default value: 1.

S

name

(Optional) The border style:

S	(Solid) A solid rectangle surrounding the annotation.
D	(Dashed) A dashed rectangle surrounding the annotation. The dash pattern is specified by the D entry (see below).
B	(Beveled) A simulated embossed rectangle that appears to be raised above the surface of the page.
I	(Inset) A simulated engraved rectangle that appears to be recessed below the surface of the page.
U	(Underline) A single line along the bottom of the annotation rectangle.

Default value: S.

D

array

(Optional) A dash array defining a pattern of dashes and gaps to be used in drawing a dashed border (border style D above). The dash array is specified in the same format as in the line dash pattern parameter of the graphics state (see “Line Dash Pattern” on page 187). The dash phase is not specified and is assumed to be 0. For example, a D entry of [3 2] specifies a border drawn with 3-point dashes alternating with 2-point gaps. Default value: [3].

Since:

2.5

Author:

Mark Collette

Field Summary

static Color	DARK
static Color	DARKEST
static Color	LIGHT
static Color	LIGHTEST

Fields inherited from class com.icesoft.pdf.pobjects.Dictionary

entries, inited, library

Constructor Summary

BorderStyle(Library l, Hashtable h)
Creates a new instance of a BorderStyle.

Method Summary

float[]	getDashArray()
float	getStrokeWidth()
boolean	isStyleBeveled()
boolean	isStyleDashed()
boolean	isStyleInset()
boolean	isStyleSolid()
boolean	isStyleUnderline()

Methods inherited from class com.icesoft.pdf.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DARKEST

public static final Color DARKEST

DARK

public static final Color DARK

LIGHT

public static final Color LIGHT

LIGHTEST

public static final Color LIGHTEST

Constructor Detail

BorderStyle

public BorderStyle(Library l,
                   Hashtable h)

Creates a new instance of a BorderStyle.

Parameters:

l - document library.

h - dictionary entries.

Method Detail

getStrokeWidth

public float getStrokeWidth()

isStyleSolid

public boolean isStyleSolid()

isStyleDashed

public boolean isStyleDashed()

isStyleBeveled

public boolean isStyleBeveled()

isStyleInset

public boolean isStyleInset()

isStyleUnderline

public boolean isStyleUnderline()

getDashArray

public float[] getDashArray()