com.itextpdf.kernel.pdf.annot

Class PdfWidgetAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfWidgetAnnotation

All Implemented Interfaces:

Serializable

public class PdfWidgetAnnotation
extends PdfAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIDDEN
static int	HIDDEN_BUT_PRINTABLE
static int	VISIBLE
static int	VISIBLE_BUT_DOES_NOT_PRINT

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

Accepted, Canceled, Completed, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Constructor and Description
PdfWidgetAnnotation(PdfDictionary pdfObject)
PdfWidgetAnnotation(Rectangle rect)

Method Summary

Modifier and Type	Method and Description
PdfName	getHighlightMode() Getter for the annotation's highlighting mode.
PdfName	getSubtype() Gets a PdfName which value is a subtype of this annotation.
void	releaseFormFieldFromWidgetAnnotation() This method removes all widget annotation entries from the form field the given annotation merged with.
PdfWidgetAnnotation	setHighlightMode(PdfName mode) Setter for the annotation's highlighting mode.
PdfWidgetAnnotation	setParent(PdfObject parent)
PdfWidgetAnnotation	setVisibility(int visibility) Set the visibility flags of the Widget annotation Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getBorderStyle, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setBorderStyle, setBorderStyle, setColor, setColor, setColor, setContents, setContents, setDashPattern, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setQuadPoints, setRectangle, setRolloverAppearance, setRolloverAppearance, setStructParentIndex, setTitle

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIDDEN

public static final int HIDDEN

See Also:

Constant Field Values

VISIBLE_BUT_DOES_NOT_PRINT

public static final int VISIBLE_BUT_DOES_NOT_PRINT

See Also:

Constant Field Values

HIDDEN_BUT_PRINTABLE

public static final int HIDDEN_BUT_PRINTABLE

See Also:

Constant Field Values

VISIBLE

public static final int VISIBLE

See Also:

Constant Field Values

Constructor Detail

PdfWidgetAnnotation

public PdfWidgetAnnotation(Rectangle rect)

PdfWidgetAnnotation

public PdfWidgetAnnotation(PdfDictionary pdfObject)

Method Detail

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, “Annotation Types” for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

setParent

public PdfWidgetAnnotation setParent(PdfObject parent)

setHighlightMode

public PdfWidgetAnnotation setHighlightMode(PdfName mode)

Setter for the annotation's highlighting mode. Possible values are

• PdfAnnotation.HIGHLIGHT_NONE - No highlighting.
• PdfAnnotation.HIGHLIGHT_INVERT - Invert the contents of the annotation rectangle.
• PdfAnnotation.HIGHLIGHT_OUTLINE - Invert the annotation's border.
• PdfAnnotation.HIGHLIGHT_PUSH - Display the annotation?s down appearance, if any.
• PdfAnnotation.HIGHLIGHT_TOGGLE - Same as P.

Parameters:

mode - The new value for the annotation's highlighting mode.

Returns:

The widget annotation which this method was called on.

getHighlightMode

public PdfName getHighlightMode()

Getter for the annotation's highlighting mode.

Returns:

Current value of the annotation's highlighting mode.

releaseFormFieldFromWidgetAnnotation

public void releaseFormFieldFromWidgetAnnotation()

This method removes all widget annotation entries from the form field the given annotation merged with.

setVisibility

public PdfWidgetAnnotation setVisibility(int visibility)

Set the visibility flags of the Widget annotation Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT

Parameters:

visibility - visibility option

Returns:

the edited widget annotation