ShapeAnnotation Class
Serves as a base class for PDF shape annotations, such as circle and square.
Declaration
public abstract class ShapeAnnotation extends MarkupAnnotationRemarks
CircleAnnotation and SquareAnnotation inherit from the ShapeAnnotation class and share the following style settings in addition to their geometric parameters:
- Border Style
Method: setBorderStyle(AnnotationBorderStyle value)
Defines the appearance of the annotation outline.
- Interior Color
Method: setInteriorColor(PdfColor value)
Defines the fill appearance inside closed shapes (such as circle, square, and polygon annotations).
- Border Effect
Method: setBorderEffect(AnnotationBorderEffect value)
Specifies additional visual effects for the annotation border, such as glow or decorative effects.
- Padding
Method: setPadding(Padding value)
Specifies the internal spacing between the annotation boundary and its content, such as title and comment text.
Refer to the following help topic for additional information: Drawing Annotations.
Inherited Members
Inheritance
Methods
getBorderEffect() Method
Returns the shape annotation border effect.
Declaration
public AnnotationBorderEffect getBorderEffect()Returns
| Type | Description |
|---|---|
| AnnotationBorderEffect | The shape annotation border effect. |
getBorderStyle() Method
Returns the shape annotation border style.
Declaration
public AnnotationBorderStyle getBorderStyle()Returns
| Type | Description |
|---|---|
| AnnotationBorderStyle | The shape annotation border style. |
getInteriorColor() Method
Returns the interior color.
Declaration
public PdfColor getInteriorColor()Returns
| Type | Description |
|---|---|
| PdfColor | The interior color. |
getPadding() Method
Returns the shape annotation padding.
Declaration
public Padding getPadding()Returns
| Type | Description |
|---|---|
| Padding | The shape annotation padding. |
setBorderEffect(AnnotationBorderEffect value) Method
Sets the shape annotation border effect.
Declaration
public void setBorderEffect(AnnotationBorderEffect value)Parameters
| Name | Type | Description |
|---|---|---|
| value | AnnotationBorderEffect | The shape annotation border effect. |
setBorderStyle(AnnotationBorderStyle value) Method
Sets the shape annotation border style.
Declaration
public void setBorderStyle(AnnotationBorderStyle value)Parameters
| Name | Type | Description |
|---|---|---|
| value | AnnotationBorderStyle | The shape annotation border style. |
setInteriorColor(PdfColor value) Method
Sets the interior color.
Declaration
public void setInteriorColor(PdfColor value)Parameters
| Name | Type | Description |
|---|---|---|
| value | PdfColor | The interior color. |
setPadding(Padding value) Method
Sets the shape annotation padding.
Declaration
public void setPadding(Padding value)Parameters
| Name | Type | Description |
|---|---|---|
| value | Padding | The shape annotation padding. |