Class PDAppearanceCharacteristicsDictionary
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
- All Implemented Interfaces:
COSObjectable
This class represents an appearance characteristics dictionary.
- Version:
- $Revision: 1.0 $
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis will retrieve the alternate caption.This will retrieve the alternate icon.This will retrieve the background color.This will retrieve the border color.Convert this standard java object to a COS object.returns the dictionary.This will retrieve the normal caption.This will retrieve the normal icon.This will retrieve the rollover caption.This will retrieve the rollover icon.int
This will retrieve the rotation of the annotation widget.void
setAlternateCaption
(String caption) This will set the alternate caption.void
This will set the background color.void
This will set the border color.void
setNormalCaption
(String caption) This will set the normal caption.void
setRolloverCaption
(String caption) This will set the rollover caption.void
setRotation
(int rotation) This will set the rotation.
-
Constructor Details
-
PDAppearanceCharacteristicsDictionary
Constructor.- Parameters:
dict
- dictionary
-
-
Method Details
-
getDictionary
returns the dictionary.- Returns:
- the dictionary
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getRotation
public int getRotation()This will retrieve the rotation of the annotation widget. It must be a multiple of 90. Default is 0- Returns:
- the rotation
-
setRotation
public void setRotation(int rotation) This will set the rotation.- Parameters:
rotation
- the rotation as a multiple of 90
-
getBorderColour
This will retrieve the border color.- Returns:
- the border color.
-
setBorderColour
This will set the border color.- Parameters:
c
- the border color
-
getBackground
This will retrieve the background color.- Returns:
- the background color.
-
setBackground
This will set the background color.- Parameters:
c
- the background color
-
getNormalCaption
This will retrieve the normal caption.- Returns:
- the normal caption.
-
setNormalCaption
This will set the normal caption.- Parameters:
caption
- the normal caption
-
getRolloverCaption
This will retrieve the rollover caption.- Returns:
- the rollover caption.
-
setRolloverCaption
This will set the rollover caption.- Parameters:
caption
- the rollover caption
-
getAlternateCaption
This will retrieve the alternate caption.- Returns:
- the alternate caption.
-
setAlternateCaption
This will set the alternate caption.- Parameters:
caption
- the alternate caption
-
getNormalIcon
This will retrieve the normal icon.- Returns:
- the normal icon.
-
getRolloverIcon
This will retrieve the rollover icon.- Returns:
- the rollover icon
-
getAlternateIcon
This will retrieve the alternate icon.- Returns:
- the alternate icon.
-