Class PDBorderStyleDictionary
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
- All Implemented Interfaces:
COSObjectable
This class represents a PDF /BS entry the border style dictionary.
- Version:
- $Revision: 1.1 $
- Author:
- Paul King
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Constant for the name of a beveled style.static final String
Constant for the name of a dashed style.static final String
Constant for the name of a inset style.static final String
Constant for the name of a solid style.static final String
Constant for the name of a underline style. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionreturns the dictionary.This will retrieve the dash style used for drawing the border.returns the dictionary.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
This will set the dash style used for drawing the border.void
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_SOLID
Constant for the name of a solid style.- See Also:
-
STYLE_DASHED
Constant for the name of a dashed style.- See Also:
-
STYLE_BEVELED
Constant for the name of a beveled style.- See Also:
-
STYLE_INSET
Constant for the name of a inset style.- See Also:
-
STYLE_UNDERLINE
Constant for the name of a underline style.- See Also:
-
-
Constructor Details
-
PDBorderStyleDictionary
public PDBorderStyleDictionary()Constructor. -
PDBorderStyleDictionary
Constructor.- Parameters:
dict
- a border style dictionary.
-
-
Method Details
-
getDictionary
returns the dictionary.- Returns:
- the dictionary
-
getCOSObject
returns the dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the dictionary
-
setWidth
public void setWidth(float w) This will set the border width in points, 0 = no border.- Parameters:
w
- float the width in points
-
getWidth
public float getWidth()This will retrieve the border width in points, 0 = no border.- Returns:
- The width of the border in points.
-
setStyle
This will set the border style, see the STYLE_* constants for valid values.- Parameters:
s
- the border style to use
-
getStyle
This will retrieve the border style, see the STYLE_* constants for valid values.- Returns:
- the style of the border
-
setDashStyle
This will set the dash style used for drawing the border.- Parameters:
d
- the dash style to use
-
getDashStyle
This will retrieve the dash style used for drawing the border.- Returns:
- the dash style of the border
-