org.pdfbox.pdmodel.interactive.annotation

Class PDBorderStyleDictionary

Implemented Interfaces:
COSObjectable

public class PDBorderStyleDictionary
extends java.lang.Object
implements COSObjectable

This class represents a PDF /BS entry the border style dictionary.
Version:
$Revision: 1.1 $
Author:
Paul King

Field Summary

static String
STYLE_BEVELED
Constant for the name of a beveled style.
static String
STYLE_DASHED
Constant for the name of a dashed style.
static String
STYLE_INSET
Constant for the name of a inset style.
static String
STYLE_SOLID
Constant for the name of a solid style.
static String
STYLE_UNDERLINE
Constant for the name of a underline style.

Constructor Summary

PDBorderStyleDictionary()
Constructor.
PDBorderStyleDictionary(COSDictionary dict)
Constructor.

Method Summary

COSBase
getCOSObject()
returns the dictionary.
PDLineDashPattern
getDashStyle()
This will retrieve the dash style used for drawing the border.
COSDictionary
getDictionary()
returns the dictionary.
String
getStyle()
This will retrieve the border style, see the STYLE_* constants for valid values.
float
getWidth()
This will retrieve the border width in points, 0 = no border.
void
setDashStyle(PDLineDashPattern d)
This will set the dash style used for drawing the border.
void
setStyle(String s)
This will set the border style, see the STYLE_* constants for valid values.
void
setWidth(float w)
This will set the border width in points, 0 = no border.

Field Details

STYLE_BEVELED

public static final String STYLE_BEVELED
Constant for the name of a beveled style.

STYLE_DASHED

public static final String STYLE_DASHED
Constant for the name of a dashed style.

STYLE_INSET

public static final String STYLE_INSET
Constant for the name of a inset style.

STYLE_SOLID

public static final String STYLE_SOLID
Constant for the name of a solid style.

STYLE_UNDERLINE

public static final String STYLE_UNDERLINE
Constant for the name of a underline style.

Constructor Details

PDBorderStyleDictionary

public PDBorderStyleDictionary()
Constructor.

PDBorderStyleDictionary

public PDBorderStyleDictionary(COSDictionary dict)
Constructor.
Parameters:
dict - a border style dictionary.

Method Details

getCOSObject

public COSBase getCOSObject()
returns the dictionary.
Specified by:
getCOSObject in interface COSObjectable
Returns:
the dictionary

getDashStyle

public PDLineDashPattern getDashStyle()
This will retrieve the dash style used for drawing the border.
Returns:
the dash style of the border

getDictionary

public COSDictionary getDictionary()
returns the dictionary.
Returns:
the dictionary

getStyle

public String getStyle()
This will retrieve the border style, see the STYLE_* constants for valid values.
Returns:
the style of the border

getWidth

public float getWidth()
This will retrieve the border width in points, 0 = no border.
Returns:
flaot the width of the border in points

setDashStyle

public void setDashStyle(PDLineDashPattern d)
This will set the dash style used for drawing the border.
Parameters:
d - the dash style to use

setStyle

public void setStyle(String s)
This will set the border style, see the STYLE_* constants for valid values.
Parameters:
s - the border style to use

setWidth

public void setWidth(float w)
This will set the border width in points, 0 = no border.
Parameters:
w - float the width in points