com.spire.pdf.widget
Class PdfTextBoxFieldWidget

java.lang.Object
  com.spire.pdf.fields.PdfField
      com.spire.pdf.widget.PdfFieldWidget
          com.spire.pdf.widget.PdfStyledFieldWidget
              com.spire.pdf.widget.PdfTextBoxFieldWidget

All Implemented Interfaces:

IPdfWrapper, IPdfTextBoxField

public class PdfTextBoxFieldWidget
extends PdfStyledFieldWidget
implements IPdfTextBoxField

Represents the text box field of an existing PDF documents form.

Constructor Summary

PdfTextBoxFieldWidget(PdfDictionary dictionary, PdfCrossTable crossTable)

Method Summary

PdfRGBColor	getBackColor() Gets the back color of the field
java.awt.geom.Rectangle2D	getBounds() Gets the bounds.
java.lang.String	getDefaultValue() Gets the default value of the field.
PdfFontBase	getFont() Gets the font.
PdfRGBColor	getForeColor() Gets the fore color of the field.
PdfHighlightMode	getHighlightMode() Gets the HighLightMode of the Field.
boolean	getInsertSpaces() Meaningful only if the MaxLength property is set and the Multiline, Password properties are false.
int	getMaxLength() Gets the maximum length of the field, in characters.
boolean	getMultiline() Gets a value indicating whether this is multiline.
boolean	getPassword() Gets a value indicating whether this is password field.
boolean	getScrollable() Gets a value indicating whether this is scrollable.
boolean	getSpellCheck() Gets a value indicating whether to check spelling.
java.lang.String	getText() Gets value of the text box field.
PdfTextAlignment	getTextAlignment() Gets the text alignment in a text box.
PdfTextBoxWidgetItemCollection	getWidgetItems() Gets the collection of text box field items.
void	setBackColor(PdfRGBColor value) Sets the back color of the field
void	setDefaultValue(java.lang.String value) Sets the default value of the field.
void	setFont(PdfFontBase value) Sets the font.
void	setForeColor(PdfRGBColor value) Sets the fore color of the field.
void	setHighlightMode(PdfHighlightMode value) Sets the HighLightMode of the Field.
void	setInsertSpaces(boolean value)
void	setMaxLength(int value)
void	setMultiline(boolean value)
void	setPassword(boolean value)
void	setScrollable(boolean value)
void	setSpellCheck(boolean value)
void	setText(java.lang.String value) Sets the Text
void	setTextAlignment(PdfTextAlignment value) Sets the text alignment in a text box.

Methods inherited from class com.spire.pdf.widget.PdfStyledFieldWidget

getActions, getBorderColor, getBorderStyle, getBorderWidth, getGotFocus, getLocation, getLostFocus, getMouseDown, getMouseEnter, getMouseLeave, getSize, getVisible, setBorderColor, setBorderStyle, setBorderWidth, setBounds, setGotFocus, setLocation, setLostFocus, setMouseDown, setMouseEnter, setMouseLeave, setSize

Methods inherited from class com.spire.pdf.widget.PdfFieldWidget

getName, getPage, getToolTip, importFieldValue, setReadOnly, setRequired

Methods inherited from class com.spire.pdf.fields.PdfField

getExport, getFlatten, getForm, getMappingName, getReadOnly, setExport, setFlatten, setToolTip

Methods inherited from interface com.spire.pdf.widget.IPdfTextBoxField

getName

Constructor Detail

PdfTextBoxFieldWidget

public PdfTextBoxFieldWidget(PdfDictionary dictionary,
                             PdfCrossTable crossTable)

Method Detail

getBackColor

public PdfRGBColor getBackColor()

Gets the back color of the field

Overrides:

getBackColor in class PdfStyledFieldWidget

getBounds

public java.awt.geom.Rectangle2D getBounds()

Gets the bounds.

Overrides:

getBounds in class PdfStyledFieldWidget

getForeColor

public PdfRGBColor getForeColor()

Gets the fore color of the field.

setForeColor

public void setForeColor(PdfRGBColor value)

Sets the fore color of the field.

getTextAlignment

public PdfTextAlignment getTextAlignment()

Gets the text alignment in a text box.

setTextAlignment

public void setTextAlignment(PdfTextAlignment value)

Sets the text alignment in a text box.

getHighlightMode

public PdfHighlightMode getHighlightMode()

Gets the HighLightMode of the Field.

setHighlightMode

public void setHighlightMode(PdfHighlightMode value)

Sets the HighLightMode of the Field.

getText

public java.lang.String getText()

Gets value of the text box field.

setText

public void setText(java.lang.String value)

Sets the Text

Parameters:

value - Text files

getFont

public PdfFontBase getFont()

Gets the font.

Overrides:

getFont in class PdfStyledFieldWidget

setFont

public void setFont(PdfFontBase value)

Sets the font.

Overrides:

setFont in class PdfStyledFieldWidget

getDefaultValue

public java.lang.String getDefaultValue()

Gets the default value of the field.

setDefaultValue

public void setDefaultValue(java.lang.String value)

Sets the default value of the field.

getSpellCheck

public boolean getSpellCheck()

Gets a value indicating whether to check spelling.

setSpellCheck

public void setSpellCheck(boolean value)

getInsertSpaces

public boolean getInsertSpaces()

Meaningful only if the MaxLength property is set and the Multiline, Password properties are false. If set, the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLength, and the text is laid out into those combs.

setInsertSpaces

public void setInsertSpaces(boolean value)

getMultiline

public boolean getMultiline()

Gets a value indicating whether this is multiline.

setMultiline

public void setMultiline(boolean value)

getPassword

public boolean getPassword()

Gets a value indicating whether this is password field.

setPassword

public void setPassword(boolean value)

getScrollable

public boolean getScrollable()

Gets a value indicating whether this is scrollable.

setScrollable

public void setScrollable(boolean value)

getMaxLength

public int getMaxLength()

Gets the maximum length of the field, in characters.

setMaxLength

public void setMaxLength(int value)

getWidgetItems

public PdfTextBoxWidgetItemCollection getWidgetItems()

Gets the collection of text box field items.

setBackColor

public void setBackColor(PdfRGBColor value)

Sets the back color of the field