com.qoppa.pdf.annotations

Interface Widget

All Superinterfaces:

Annotation

All Known Subinterfaces:

WidgetButton, WidgetCheckBox, WidgetChoice, WidgetCombo, WidgetList, WidgetPushButton, WidgetRadioButton, WidgetSignature, WidgetText

public interface Widget
extends Annotation

An abstract class that represents a Widget. Widget annotations are used to display PDF interactive fields. There are different classes to represent the different Widget types, such as buttons, lists, text fields, etc.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGH_INVERT
static int	HIGH_NONE
static int	HIGH_OUTLINE
static int	HIGH_PUSH
static int	HIGH_TOGGLE

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Modifier and Type	Method and Description
boolean	canEdit()
void	fieldValueChanged()
String	getAppearanceState()
Color	getBackground()
Color	getBorderColor()
String	getCaption()
JComponent	getEditingComponent()
FormField	getField()
int	getHighlightMode()
int	getHorzTextAlign()
int	getRotation() Returns the rotation of this widget in degrees.
boolean	isEditable()
void	setAppearanceState(String aState)
void	setBackground(Color background)
void	setBorderColor(Color borderColor)
void	setCaption(String caption)
void	setField(FormField field)
void	setHidden(boolean hidden) Sets this Annotation's HIDDEN flag.
void	setHighlightMode(int highlightMode)
void	setPrintable(boolean printable) Sets the value of the PRINTABLE flag.
void	setWidgetHighlight(boolean highlight) Flags this widget so that when displayed, it will display a highlight over the widget.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getContents, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

Field Detail

HIGH_NONE

static final int HIGH_NONE

See Also:

Constant Field Values

HIGH_INVERT

static final int HIGH_INVERT

See Also:

Constant Field Values

HIGH_OUTLINE

static final int HIGH_OUTLINE

See Also:

Constant Field Values

HIGH_PUSH

static final int HIGH_PUSH

See Also:

Constant Field Values

HIGH_TOGGLE

static final int HIGH_TOGGLE

See Also:

Constant Field Values

Method Detail

canEdit

boolean canEdit()

getAppearanceState

String getAppearanceState()

getBackground

Color getBackground()

getCaption

String getCaption()

getBorderColor

Color getBorderColor()

getHighlightMode

int getHighlightMode()

getField

FormField getField()

setHighlightMode

void setHighlightMode(int highlightMode)

setAppearanceState

void setAppearanceState(String aState)

setBackground

void setBackground(Color background)

setBorderColor

void setBorderColor(Color borderColor)

setCaption

void setCaption(String caption)

fieldValueChanged

void fieldValueChanged()
                throws PDFException

Throws:

PDFException

isEditable

boolean isEditable()

setField

void setField(FormField field)

setHidden

void setHidden(boolean hidden)

Description copied from interface: Annotation

Sets this Annotation's HIDDEN flag. A hidden annotation will not be displayed on the screen and will not print.

Specified by:

setHidden in interface Annotation

Parameters:

hidden - The new value of the HIDDEN flag.

setPrintable

void setPrintable(boolean printable)

Description copied from interface: Annotation

Sets the value of the PRINTABLE flag.

Specified by:

setPrintable in interface Annotation

Parameters:

printable - The new value for the PRINTABLE flag.

getEditingComponent

JComponent getEditingComponent()

getHorzTextAlign

int getHorzTextAlign()

setWidgetHighlight

void setWidgetHighlight(boolean highlight)

Flags this widget so that when displayed, it will display a highlight over the widget. This is intended so that a viewer will locate fields more easily on a form.

Parameters:

highlight - Boolean flag indicating whether the field should be highlighted.

getRotation

int getRotation()

Returns the rotation of this widget in degrees.

Returns:

int widget rotation in degrees