WidgetAnnotation Class

Serves as a base class for widget annotations associated with PDF form fields.

Declaration

public abstract class WidgetAnnotation extends BaseAnnotation

Remarks

Refer to the following help topics for additional information:

• Create PDF Forms
• Access and Find PDF Form Fields

Inherited Members

clone(DocumentCloneContext context)

deepClone()

getAppearance()

getAppearanceName()

getBorder()

getBounds()

getColor()

getContent()

getHidden()

getInvisible()

getLocked()

getLockedContents()

getModified()

getName()

getNoRotate()

getNoView()

getNoZoom()

getPrint()

getReadOnly()

getToggleNoView()

objectClone()

setAppearance(AnnotationAppearances value)

setAppearanceName(String value)

setBorder(AnnotationBorder value)

setBounds(RectangleF value)

setColor(PdfColor value)

setContent(String value)

setHidden(boolean value)

setInvisible(boolean value)

setLocked(boolean value)

setLockedContents(boolean value)

setModified(OffsetDateTime value)

setName(String value)

setNoRotate(boolean value)

setNoView(boolean value)

setNoZoom(boolean value)

setPrint(boolean value)

setReadOnly(boolean value)

setToggleNoView(boolean value)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

BaseAnnotation

WidgetAnnotation

Methods

getAction() Method

Returns the widget annotation action.

Declaration

public InteractiveAction getAction()

Returns

Type	Description
InteractiveAction	The widget annotation action.

getActions() Method

Returns widget annotation actions.

Declaration

public WidgetAnnotationActions getActions()

Returns

Type	Description
WidgetAnnotationActions	Widget annotation actions.

getBackgroundColor() Method

Returns the widget annotation background color.

Declaration

public PdfColor getBackgroundColor()

Returns

Type	Description
PdfColor	The widget annotation background color.

getBorderStyle() Method

Returns the widget annotation border style.

Declaration

public AnnotationBorderStyle getBorderStyle()

Returns

Type	Description
AnnotationBorderStyle	The widget annotation border style.

getFieldName() Method

Returns the widget annotation field name.

Declaration

public String getFieldName()

Returns

Type	Description
String	The widget annotation field name.

getFont() Method

Returns the widget annotation font.

Declaration

public TextFont getFont()

Returns

Type	Description
TextFont	The widget annotation font.

getFontSize() Method

Returns the widget annotation font size.

Declaration

public double getFontSize()

Returns

Type	Description
double	The widget annotation font size.

getForeColor() Method

Returns the widget annotation foreground color.

Declaration

public PdfColor getForeColor()

Returns

Type	Description
PdfColor	The widget annotation foreground color.

getFormField() Method

Returns the form field associated with the widget annotation.

Declaration

public FormField getFormField()

Returns

Type	Description
FormField	The form field associated with the widget annotation.

getOutlineColor() Method

Returns the widget annotation outline color.

Declaration

public PdfColor getOutlineColor()

Returns

Type	Description
PdfColor	The widget annotation outline color.

getRotationAngle() Method

Returns the widget annotation rotation angle.

Declaration

public double getRotationAngle()

Returns

Type	Description
double	The widget annotation rotation angle.

getTextAlignment() Method

Returns the widget annotation text alignment.

Declaration

public FormFieldTextAlignment getTextAlignment()

Returns

Type	Description
FormFieldTextAlignment	The widget annotation text alignment.

getToolTip() Method

Returns the widget annotation tooltip.

Declaration

public String getToolTip()

Returns

Type	Description
String	The widget annotation tooltip.

setAction(InteractiveAction value) Method

Sets the widget annotation action.

Declaration

public void setAction(InteractiveAction value)

Parameters

Name	Type	Description
value	InteractiveAction	The widget annotation action.

setActions(WidgetAnnotationActions value) Method

Sets widget annotation actions.

Declaration

public void setActions(WidgetAnnotationActions value)

Parameters

Name	Type	Description
value	WidgetAnnotationActions	Widget annotation actions.

setBackgroundColor(PdfColor value) Method

Sets the widget annotation background color.

Declaration

public void setBackgroundColor(PdfColor value)

Parameters

Name	Type	Description
value	PdfColor	The widget annotation background color.

setBorderStyle(AnnotationBorderStyle value) Method

Sets the widget annotation border style.

Declaration

public void setBorderStyle(AnnotationBorderStyle value)

Parameters

Name	Type	Description
value	AnnotationBorderStyle	The widget annotation border style.

setFont(TextFont value) Method

Sets the widget annotation font.

Declaration

public void setFont(TextFont value)

Parameters

Name	Type	Description
value	TextFont	The widget annotation font.

setFontSize(double value) Method

Sets the widget annotation font size.

Declaration

public void setFontSize(double value)

Parameters

Name	Type	Description
value	double	The widget annotation font size.

setForeColor(PdfColor value) Method

Sets the widget annotation foreground color.

Declaration

public void setForeColor(PdfColor value)

Parameters

Name	Type	Description
value	PdfColor	The widget annotation foreground color.

setOutlineColor(PdfColor value) Method

Sets the widget annotation outline color.

Declaration

public void setOutlineColor(PdfColor value)

Parameters

Name	Type	Description
value	PdfColor	The widget annotation outline color.

setRotationAngle(double value) Method

Sets the widget annotation rotation angle.

Declaration

public void setRotationAngle(double value)

Parameters

Name	Type	Description
value	double	The widget annotation rotation angle.

setTextAlignment(FormFieldTextAlignment value) Method

Sets the widget annotation text alignment.

Declaration

public void setTextAlignment(FormFieldTextAlignment value)

Parameters

Name	Type	Description
value	FormFieldTextAlignment	The widget annotation text alignment.