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

Access	Constructor and Description
protected	PDAnnotationSquareCircle(String the subtype the annotation represents. subType) Creates a Circle or Square annotation of the specified sub type.
protected	PDAnnotationSquareCircle(COSDictionary The annotations dictionary. dict) Constructor.

Method Summary

Modifier and Type	Method and Description
public abstract void	constructAppearances() Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation.
public PDBorderEffectDictionary	Returns: The border effect dictionary getBorderEffect() This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
public PDColor	Returns: object representing the color. getInteriorColor() This will retrieve the interior color of the drawn area color is in DeviceRGB color space.
public PDRectangle	Returns: the rectangle difference getRectDifference() This will get the rectangle difference rectangle.
public float[]	Returns: the differences. If the entry hasn't been set am empty array is returned. getRectDifferences() This will get the differences between the annotations "outer" rectangle defined by /Rect and the border.
public void	setBorderEffect(PDBorderEffectDictionary The border effect dictionary to set. be) This will set the border effect dictionary, specifying effects to be applied when drawing the line.
public void	setInteriorColor(PDColor color in the DeviceRGB color space. ic) This will set interior color of the drawn area color is in DeviceRGB colorspace.
public void	setRectDifference(PDRectangle the rectangle difference rd) This will set the rectangle difference rectangle.
public void	setRectDifferences(float from the annotations /Rect entry difference) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
public void	setRectDifferences(float left difference from the annotations /Rect entry differenceLeft, float top difference from the annotations /Rect entry differenceTop, float right difference from the annotations /Rect entry differenceRight, float bottom difference from the annotations /Rect entry differenceBottom) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.

PDAnnotationSquareCircle	back to summary
protected PDAnnotationSquareCircle(String subType) Creates a Circle or Square annotation of the specified sub type. Parameters subType:String the subtype the annotation represents.

PDAnnotationSquareCircle	back to summary
protected PDAnnotationSquareCircle(COSDictionary dict) Constructor. Parameters dict:COSDictionary The annotations dictionary.

Method Detail

constructAppearances	back to summary
public abstract void constructAppearances() Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing. Annotations @Override

constructAppearances

back to summary

public abstract void constructAppearances()

Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Annotations

@Override

getBorderEffect	back to summary
public PDBorderEffectDictionary getBorderEffect() This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line. Returns:PDBorderEffectDictionary The border effect dictionary

getBorderEffect

back to summary

public PDBorderEffectDictionary getBorderEffect()

This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.

Returns:PDBorderEffectDictionary: The border effect dictionary

getInteriorColor	back to summary
public PDColor getInteriorColor() This will retrieve the interior color of the drawn area color is in DeviceRGB color space. Returns:PDColor object representing the color.

getInteriorColor

back to summary

public PDColor getInteriorColor()

This will retrieve the interior color of the drawn area color is in DeviceRGB color space.

Returns:PDColor: object representing the color.

getRectDifference	back to summary
public PDRectangle getRectDifference() This will get the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example) Returns:PDRectangle the rectangle difference

getRectDifference

back to summary

public PDRectangle getRectDifference()

This will get the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)

Returns:PDRectangle: the rectangle difference

getRectDifferences	back to summary
public float[] getRectDifferences() This will get the differences between the annotations "outer" rectangle defined by /Rect and the border. Returns:float[] the differences. If the entry hasn't been set am empty array is returned.

getRectDifferences

back to summary

public float[] getRectDifferences()

This will get the differences between the annotations "outer" rectangle defined by /Rect and the border.

Returns:float[]: the differences. If the entry hasn't been set am empty array is returned.

setBorderEffect	back to summary
public void setBorderEffect(PDBorderEffectDictionary be) This will set the border effect dictionary, specifying effects to be applied when drawing the line. This is supported by PDF 1.5 and higher. Parameters be:PDBorderEffectDictionary The border effect dictionary to set.

setBorderEffect

back to summary

public void setBorderEffect(PDBorderEffectDictionary be)

This will set the border effect dictionary, specifying effects to be applied when drawing the line. This is supported by PDF 1.5 and higher.

Parameters

be:PDBorderEffectDictionary: The border effect dictionary to set.

setInteriorColor	back to summary
public void setInteriorColor(PDColor ic) This will set interior color of the drawn area color is in DeviceRGB colorspace. Parameters ic:PDColor color in the DeviceRGB color space.

setInteriorColor

back to summary

public void setInteriorColor(PDColor ic)

This will set interior color of the drawn area color is in DeviceRGB colorspace.

Parameters

ic:PDColor: color in the DeviceRGB color space.

setRectDifference	back to summary
public void setRectDifference(PDRectangle rd) This will set the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example) Parameters rd:PDRectangle the rectangle difference

setRectDifference

back to summary

public void setRectDifference(PDRectangle rd)

This will set the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)

Parameters

rd:PDRectangle: the rectangle difference

setRectDifferences	back to summary
public void setRectDifferences(float difference) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border. This will set an equal difference for all sides Parameters difference:float from the annotations /Rect entry

setRectDifferences

back to summary

public void setRectDifferences(float difference)

This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.

This will set an equal difference for all sides

Parameters

difference:float: from the annotations /Rect entry

setRectDifferences	back to summary
public void setRectDifferences(float differenceLeft, float differenceTop, float differenceRight, float differenceBottom) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border. Parameters differenceLeft:float left difference from the annotations /Rect entry differenceTop:float top difference from the annotations /Rect entry differenceRight:float right difference from the annotations /Rect entry differenceBottom:float bottom difference from the annotations /Rect entry

setRectDifferences

back to summary

public void setRectDifferences(float differenceLeft, float differenceTop, float differenceRight, float differenceBottom)

This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.

Parameters

differenceLeft:float: left difference from the annotations /Rect entry
differenceTop:float: top difference from the annotations /Rect entry
differenceRight:float: right difference from the annotations /Rect entry
differenceBottom:float: bottom difference from the annotations /Rect entry

public abstract Class PDAnnotationSquareCircle

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail