Class PDAppearanceCharacteristicsDictionary
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
- All Implemented Interfaces:
COSObjectable
public class PDAppearanceCharacteristicsDictionary extends java.lang.Object implements COSObjectable
This class represents an appearance characteristics dictionary.- Version:
- $Revision: 1.0 $
-
-
Constructor Summary
Constructors Constructor Description PDAppearanceCharacteristicsDictionary(COSDictionary dict)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAlternateCaption()
This will retrieve the alternate caption.PDXObjectForm
getAlternateIcon()
This will retrieve the alternate icon.PDGamma
getBackground()
This will retrieve the background color.PDGamma
getBorderColour()
This will retrieve the border color.COSBase
getCOSObject()
Convert this standard java object to a COS object.COSDictionary
getDictionary()
returns the dictionary.java.lang.String
getNormalCaption()
This will retrieve the normal caption.PDXObjectForm
getNormalIcon()
This will retrieve the normal icon.java.lang.String
getRolloverCaption()
This will retrieve the rollover caption.PDXObjectForm
getRolloverIcon()
This will retrieve the rollover icon.int
getRotation()
This will retrieve the rotation of the annotation widget.void
setAlternateCaption(java.lang.String caption)
This will set the alternate caption.void
setBackground(PDGamma c)
This will set the background color.void
setBorderColour(PDGamma c)
This will set the border color.void
setNormalCaption(java.lang.String caption)
This will set the normal caption.void
setRolloverCaption(java.lang.String caption)
This will set the rollover caption.void
setRotation(int rotation)
This will set the rotation.
-
-
-
Constructor Detail
-
PDAppearanceCharacteristicsDictionary
public PDAppearanceCharacteristicsDictionary(COSDictionary dict)
Constructor.- Parameters:
dict
- dictionary
-
-
Method Detail
-
getDictionary
public COSDictionary getDictionary()
returns the dictionary.- Returns:
- the dictionary
-
getCOSObject
public COSBase 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
public PDGamma getBorderColour()
This will retrieve the border color.- Returns:
- the border color.
-
setBorderColour
public void setBorderColour(PDGamma c)
This will set the border color.- Parameters:
c
- the border color
-
getBackground
public PDGamma getBackground()
This will retrieve the background color.- Returns:
- the background color.
-
setBackground
public void setBackground(PDGamma c)
This will set the background color.- Parameters:
c
- the background color
-
getNormalCaption
public java.lang.String getNormalCaption()
This will retrieve the normal caption.- Returns:
- the normal caption.
-
setNormalCaption
public void setNormalCaption(java.lang.String caption)
This will set the normal caption.- Parameters:
caption
- the normal caption
-
getRolloverCaption
public java.lang.String getRolloverCaption()
This will retrieve the rollover caption.- Returns:
- the rollover caption.
-
setRolloverCaption
public void setRolloverCaption(java.lang.String caption)
This will set the rollover caption.- Parameters:
caption
- the rollover caption
-
getAlternateCaption
public java.lang.String getAlternateCaption()
This will retrieve the alternate caption.- Returns:
- the alternate caption.
-
setAlternateCaption
public void setAlternateCaption(java.lang.String caption)
This will set the alternate caption.- Parameters:
caption
- the alternate caption
-
getNormalIcon
public PDXObjectForm getNormalIcon()
This will retrieve the normal icon.- Returns:
- the normal icon.
-
getRolloverIcon
public PDXObjectForm getRolloverIcon()
This will retrieve the rollover icon.- Returns:
- the rollover icon
-
getAlternateIcon
public PDXObjectForm getAlternateIcon()
This will retrieve the alternate icon.- Returns:
- the alternate icon.
-
-