com.qoppa.pdf.annotations
Interface WidgetText

All Superinterfaces:

Annotation, Widget

public interface WidgetText

extends Widget

Interface to a text field Widget annotation. These annotations are used to display text fields in a document.

Author:

Qoppa Software

Field Summary

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

HIGH_INVERT, HIGH_NONE, HIGH_OUTLINE, HIGH_PUSH, 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	doNotScroll()
int	getMaxLength()
boolean	isCombFormat() Indicates whether this text widget is in the comb format.
boolean	isMultiLine()
boolean	isPassword()
void	setMaxLength(int maxLength)
double	stringWidth(String str)

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

canEdit, fieldValueChanged, getAppearanceState, getBackground, getBorderColor, getCaption, getEditingComponent, getField, getHighlightMode, getHorzTextAlign, isEditable, setAppearanceState, setBackground, setBorderColor, setCaption, setField, setHidden, setHighlightMode, setPrintable, setWidgetHighlight

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

getActions, getBorderStyle, getBorderWidth, getColor, getComponent, getContents, getCreationDate, getCreator, getFlags, getModifiedDate, getName, getOpacity, getRectangle, getSubject, 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, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setReadOnly, setRectangle, setSubject, setSubtype, setTriggerActions, shiftRectangle

Method Detail

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

isMultiLine

public boolean isMultiLine()

doNotScroll

public boolean doNotScroll()

isCombFormat

public boolean isCombFormat()

Indicates whether this text widget is in the comb format. Comb format is when all characters in the text field are spaced out equally according to the max number of characters For a field to be in comb format, the comb property must be set, the maximum number of characters bigger than 0 and the text field can not be multi-lines.

Returns:

boolean comb format

isPassword

public boolean isPassword()

stringWidth

public double stringWidth(String str)