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

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_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

boolean	canEdit()
void	fieldValueChanged()
String	getAppearanceState()
Color	getBackground()
Color	getBorderColor()
String	getCaption()
JComponent	getEditingComponent()
com.qoppa.pdf.form.priv.QFormField	getField()
int	getHighlightMode()
int	getHorzTextAlign()
boolean	isEditable()
void	setAppearanceState(String aState)
void	setBackground(Color background)
void	setBorderColor(Color borderColor)
void	setCaption(String caption)
void	setField(com.qoppa.pdf.form.priv.QFormField 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, getBorderStyle, getBorderWidth, getColor, getComponent, getContents, getCreationDate, getCreator, getFlags, getName, getOpacity, getRectangle, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreationDate, setCreator, setFlags, setInvisible, setLayer, setLocked, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setReadOnly, setRectangle, setSubtype, setTriggerActions, shiftRectangle

Field Detail

HIGH_NONE

public static final int HIGH_NONE

See Also:

Constant Field Values

HIGH_INVERT

public static final int HIGH_INVERT

See Also:

Constant Field Values

HIGH_OUTLINE

public static final int HIGH_OUTLINE

See Also:

Constant Field Values

HIGH_PUSH

public static final int HIGH_PUSH

See Also:

Constant Field Values

HIGH_TOGGLE

public static final int HIGH_TOGGLE

See Also:

Constant Field Values

Method Detail

canEdit

public boolean canEdit()

getAppearanceState

public String getAppearanceState()

getBackground

public Color getBackground()

getCaption

public String getCaption()

getBorderColor

public Color getBorderColor()

getHighlightMode

public int getHighlightMode()

getField

public com.qoppa.pdf.form.priv.QFormField getField()

setHighlightMode

public void setHighlightMode(int highlightMode)

setAppearanceState

public void setAppearanceState(String aState)

setBackground

public void setBackground(Color background)

setBorderColor

public void setBorderColor(Color borderColor)

setCaption

public void setCaption(String caption)

fieldValueChanged

public void fieldValueChanged()
                       throws PDFException

Throws:

PDFException

isEditable

public boolean isEditable()

setField

public void setField(com.qoppa.pdf.form.priv.QFormField field)

setHidden

public 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

public 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

public JComponent getEditingComponent()

getHorzTextAlign

public int getHorzTextAlign()

setWidgetHighlight

public 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.