Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary

Modifier and Type	Field and Description
private final COSDictionary	dictionary

Access	Constructor and Description
public	PDAppearanceCharacteristicsDictionary(COSDictionary dictionary dict) Constructor.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the alternate caption. getAlternateCaption() This will retrieve the alternate caption.
public PDFormXObject	Returns: the alternate icon. getAlternateIcon() This will retrieve the alternate icon.
public PDColor	Returns: the background color. getBackground() This will retrieve the background color.
public PDColor	Returns: the border color. getBorderColour() This will retrieve the border color.
private PDColor	getColor(COSName itemName)
public COSDictionary	Returns: the dictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. returns the dictionary.
public String	Returns: the normal caption. getNormalCaption() This will retrieve the normal caption.
public PDFormXObject	Returns: the normal icon. getNormalIcon() This will retrieve the normal icon.
public String	Returns: the rollover caption. getRolloverCaption() This will retrieve the rollover caption.
public PDFormXObject	Returns: the rollover icon getRolloverIcon() This will retrieve the rollover icon.
public int	Returns: the rotation getRotation() This will retrieve the rotation of the annotation widget.
public void	setAlternateCaption(String the alternate caption caption) This will set the alternate caption.
public void	setBackground(PDColor the background color c) This will set the background color.
public void	setBorderColour(PDColor the border color c) This will set the border color.
public void	setNormalCaption(String the normal caption caption) This will set the normal caption.
public void	setRolloverCaption(String the rollover caption caption) This will set the rollover caption.
public void	setRotation(int the rotation as a multiple of 90 rotation) This will set the rotation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dictionary	back to summary
private final COSDictionary dictionary

PDAppearanceCharacteristicsDictionary	back to summary
public PDAppearanceCharacteristicsDictionary(COSDictionary dict) Constructor. Parameters dict:COSDictionary dictionary

Method Detail

getAlternateCaption	back to summary
public String getAlternateCaption() This will retrieve the alternate caption. Returns:String the alternate caption.

getAlternateCaption

back to summary

public String getAlternateCaption()

This will retrieve the alternate caption.

Returns:String: the alternate caption.

getAlternateIcon	back to summary
public PDFormXObject getAlternateIcon() This will retrieve the alternate icon. Returns:PDFormXObject the alternate icon.

getAlternateIcon

back to summary

public PDFormXObject getAlternateIcon()

This will retrieve the alternate icon.

Returns:PDFormXObject: the alternate icon.

getBackground	back to summary
public PDColor getBackground() This will retrieve the background color. Returns:PDColor the background color.

getBackground

back to summary

public PDColor getBackground()

This will retrieve the background color.

Returns:PDColor: the background color.

getBorderColour	back to summary
public PDColor getBorderColour() This will retrieve the border color. Returns:PDColor the border color.

getBorderColour

back to summary

public PDColor getBorderColour()

This will retrieve the border color.

Returns:PDColor: the border color.

getColor	back to summary
private PDColor getColor(COSName itemName)

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. returns the dictionary. Returns:COSDictionary the dictionary Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

returns the dictionary.

Returns:COSDictionary

the dictionary

Annotations

@Override

getNormalCaption	back to summary
public String getNormalCaption() This will retrieve the normal caption. Returns:String the normal caption.

getNormalCaption

back to summary

public String getNormalCaption()

This will retrieve the normal caption.

Returns:String: the normal caption.

getNormalIcon	back to summary
public PDFormXObject getNormalIcon() This will retrieve the normal icon. Returns:PDFormXObject the normal icon.

getNormalIcon

back to summary

public PDFormXObject getNormalIcon()

This will retrieve the normal icon.

Returns:PDFormXObject: the normal icon.

getRolloverCaption	back to summary
public String getRolloverCaption() This will retrieve the rollover caption. Returns:String the rollover caption.

getRolloverCaption

back to summary

public String getRolloverCaption()

This will retrieve the rollover caption.

Returns:String: the rollover caption.

getRolloverIcon	back to summary
public PDFormXObject getRolloverIcon() This will retrieve the rollover icon. Returns:PDFormXObject the rollover icon

getRolloverIcon

back to summary

public PDFormXObject getRolloverIcon()

This will retrieve the rollover icon.

Returns:PDFormXObject: the rollover icon

getRotation	back to summary
public int getRotation() This will retrieve the rotation of the annotation widget. It must be a multiple of 90. Default is 0 Returns:int the rotation

getRotation

back to summary

public int getRotation()

This will retrieve the rotation of the annotation widget. It must be a multiple of 90. Default is 0

Returns:int: the rotation

setAlternateCaption	back to summary
public void setAlternateCaption(String caption) This will set the alternate caption. Parameters caption:String the alternate caption

setAlternateCaption

back to summary

public void setAlternateCaption(String caption)

This will set the alternate caption.

Parameters

caption:String: the alternate caption

setBackground	back to summary
public void setBackground(PDColor c) This will set the background color. Parameters c:PDColor the background color

setBackground

back to summary

public void setBackground(PDColor c)

This will set the background color.

Parameters

c:PDColor: the background color

setBorderColour	back to summary
public void setBorderColour(PDColor c) This will set the border color. Parameters c:PDColor the border color

setBorderColour

back to summary

public void setBorderColour(PDColor c)

This will set the border color.

Parameters

c:PDColor: the border color

setNormalCaption	back to summary
public void setNormalCaption(String caption) This will set the normal caption. Parameters caption:String the normal caption

setNormalCaption

back to summary

public void setNormalCaption(String caption)

This will set the normal caption.

Parameters

caption:String: the normal caption

setRolloverCaption	back to summary
public void setRolloverCaption(String caption) This will set the rollover caption. Parameters caption:String the rollover caption

setRolloverCaption

back to summary

public void setRolloverCaption(String caption)

This will set the rollover caption.

Parameters

caption:String: the rollover caption

setRotation	back to summary
public void setRotation(int rotation) This will set the rotation. Parameters rotation:int the rotation as a multiple of 90

setRotation

back to summary

public void setRotation(int rotation)

This will set the rotation.

Parameters

rotation:int: the rotation as a multiple of 90

public Class PDAppearanceCharacteristicsDictionary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail