WidgetAnnotation

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation

public class WidgetAnnotation extends Annotation

Class representing widget annotation.

Constructors

ConstructorDescription
WidgetAnnotation(IDocument doc)Create annotation (used for Generator)

Methods

MethodDescription
getOnActivated()Get an action which shall be performed when the annotation is activated.
setOnActivated(PdfAction value)Set an action which shall be performed when the annotation is activated.
getAnnotationActions()Gets the annotation actions.
getHighlighting()Annotation highlighting mode.
setHighlighting(int value)Annotation highlighting mode.
getParent()Gets annotation parent.
getDefaultAppearance()Gets default appearance of the field.
setDefaultAppearance(DefaultAppearance value)Sets default appearance of the field.
getReadOnly()Gets read only status of the field.
setReadOnly(boolean value)Sets read only status of the field.
getRequired()Gets required status of the field.
setRequired(boolean value)Sets read only status of the field.
getExportable()Gets exportable flag of the field.
setExportable(boolean value)Sets read only status of the field.
getAnnotationType()Gets type of annotation.
accept(AnnotationSelector visitor)Accepts visitor.
getCheckedStateName()Returns name of “checked” state according to existing state names.

WidgetAnnotation(IDocument doc)

public WidgetAnnotation(IDocument doc)

Create annotation (used for Generator)

Parameters:

ParameterTypeDescription
docIDocumentDocument where annotation will be created.

getOnActivated()

public PdfAction getOnActivated()

Get an action which shall be performed when the annotation is activated.

Returns: PdfAction - PdfAction object

setOnActivated(PdfAction value)

public void setOnActivated(PdfAction value)

Set an action which shall be performed when the annotation is activated.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getAnnotationActions()

public AnnotationActionCollection getAnnotationActions()

Gets the annotation actions.

Returns: AnnotationActionCollection - AnnotationActionCollection object

getHighlighting()

public int getHighlighting()

Annotation highlighting mode.

Returns: int - HighlightingMode value

setHighlighting(int value)

public void setHighlighting(int value)

Annotation highlighting mode.

Parameters:

ParameterTypeDescription
valueintHighlightingMode value

getParent()

public Field getParent()

Gets annotation parent.

Returns: Field - Field object

getDefaultAppearance()

public DefaultAppearance getDefaultAppearance()

Gets default appearance of the field.

Returns: DefaultAppearance - DefaultAppearance object

setDefaultAppearance(DefaultAppearance value)

public void setDefaultAppearance(DefaultAppearance value)

Sets default appearance of the field.

Parameters:

ParameterTypeDescription
valueDefaultAppearanceDefaultAppearance object

getReadOnly()

public boolean getReadOnly()

Gets read only status of the field.

Returns: boolean - boolean value

setReadOnly(boolean value)

public void setReadOnly(boolean value)

Sets read only status of the field.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getRequired()

public boolean getRequired()

Gets required status of the field.

Returns: boolean - boolean value

setRequired(boolean value)

public void setRequired(boolean value)

Sets read only status of the field.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getExportable()

public boolean getExportable()

Gets exportable flag of the field.

Returns: boolean - boolean value

setExportable(boolean value)

public void setExportable(boolean value)

Sets read only status of the field.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getAnnotationType()

public AnnotationType getAnnotationType()

Gets type of annotation.

Returns: AnnotationType - AnnotationType element

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

Accepts visitor.

Parameters:

ParameterTypeDescription
visitorAnnotationSelectorVisitor to be accepted.

getCheckedStateName()

public final String getCheckedStateName()

Returns name of “checked” state according to existing state names.

Returns: java.lang.String - The name of the “checked” state for this annotation.