Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]
public class

# TextWidget

extends Widget

java.lang.Object
↳ | com.pdftron.pdf.Annot
| ↳ | com.pdftron.pdf.annots.Widget
|  | ↳ | com.pdftron.pdf.annots.TextWidget

## Class Overview

An object representing a Text Box used in a PDF Form.

## Summary

[Expand] Inherited Constants
From class com.pdftron.pdf.annots.Widget
int | e_Always | This enum represents the circumstances under which the icon shall be scaled inside the annotation rectangle .
int | e_Anamorphic | This integer list represents the scale type of the Widget annotation e_Anamorphic - Scale the icon to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height).
int | e_CAboveI | The Constant e_CAboveI.
int | e_CBelowI | The Constant e_CBelowI.
int | e_CLeftIRight | The Constant e_CLeftIRight.
int | e_COverlayI | The Constant e_COverlayI.
int | e_CRightILeft | The Constant e_CRightILeft.
int | e_Never | The Constant e_Never.
int | e_NoCaption | The Constant e_NoCaption.
int | e_NoIcon | This enum represents the Icon and Caption Relation of the Widget annotation e_NoIcon - No icon; caption only e_NoCaption - No caption; icon only e_CBelowI - Caption below the icon e_CAboveI - Caption above the icon e_CRightILeft - Caption to the right of the icon e_CLeftIRight - Caption to the left of the icon e_COverlayI - Caption overlaid directly on the icon Default value: e_NoIcon.
int | e_Proportional | The Constant e_Proportional.
int | e_WhenBigger | The Constant e_WhenBigger.
int | e_WhenSmaller | The Constant e_WhenSmaller.
int | e_invert | The Constant e_invert.
int | e_none | This integer list spedifies the Highlighting mode of the Widget Annotation e_none - No highlighting.
int | e_outline | The Constant e_outline.
int | e_push | The Constant e_push.
int | e_toggle | The Constant e_toggle.
From class com.pdftron.pdf.Annot
int | e_3D | The Constant e_3D.
int | e_Caret | The Constant e_Caret.
int | e_Circle | The Constant e_Circle.
int | e_FileAttachment | The Constant e_FileAttachment.
int | e_FreeText | The Constant e_FreeText.
int | e_Highlight | The Constant e_Highlight.
int | e_Ink | The Constant e_Ink.
int | e_Line | The Constant e_Line.
int | e_Link | The Constant e_Link.
int | e_Movie | The Constant e_Movie.
int | e_Polygon | The Constant e_Polygon.
int | e_Polyline | The Constant e_Polyline.
int | e_Popup | The Constant e_Popup.
int | e_PrinterMark | The Constant e_PrinterMark.
int | e_Projection | The Constant e_Projection.
int | e_Redact | The Constant e_Redact.
int | e_RichMedia | The Constant e_RichMedia.
int | e_Screen | The Constant e_Screen.
int | e_Sound | The Constant e_Sound.
int | e_Square | The Constant e_Square.
int | e_Squiggly | The Constant e_Squiggly.
int | e_Stamp | The Constant e_Stamp.
int | e_StrikeOut | The Constant e_StrikeOut.
int | e_Text | PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):.
int | e_TrapNet | The Constant e_TrapNet.
int | e_Underline | The Constant e_Underline.
int | e_Unknown | The Constant e_Unknown.
int | e_Watermark | The Constant e_Watermark.
int | e_Widget | The Constant e_Widget.
int | e_action_trigger_activate | Triggered when the annotation is activated.
int | e_action_trigger_annot_blur | Triggered when the annotation loses the input focus
int | e_action_trigger_annot_down | Triggered when the mouse button is pressed inside the annotation's active area
int | e_action_trigger_annot_enter | Triggered when the cursor enters the annotation's active area
int | e_action_trigger_annot_exit | Triggered when the cursor exits the annotation's active area
int | e_action_trigger_annot_focus | Triggered when the annotation receives the input focus
int | e_action_trigger_annot_page_close | Triggered when the page containing the annotation is closed
int | e_action_trigger_annot_page_invisible | Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface
int | e_action_trigger_annot_page_open | Triggered when the page containing the annotation is opened
int | e_action_trigger_annot_page_visible | Triggered when the page containing the annotation becomes visible
int | e_action_trigger_annot_up | Triggered when the mouse button is released inside the annotation's active area
int | e_down | The Constant e_down.
int | e_hidden | The Constant e_hidden.
int | e_invisible | Flags specifying various characteristics of the annotation.
int | e_locked | The Constant e_locked.
int | e_locked_contents | The Constant e_locked_contents.
int | e_no_rotate | The Constant e_no_rotate.
int | e_no_view | The Constant e_no_view.
int | e_no_zoom | The Constant e_no_zoom.
int | e_normal | An annotation can define as many as three separate appearances: The normal appearance is used when the annotation is not interacting with the user.
int | e_print | The Constant e_print.
int | e_read_only | The Constant e_read_only.
int | e_rollover | The Constant e_rollover.
int | e_toggle_no_view | The Constant e_toggle_no_view.

Public Constructors
| TextWidget(Obj d) Creates a Text Widget annotation and initialize it using given Cos/SDF object.
| TextWidget() Create an empty Text Widget annotation.
| TextWidget(Annot annot) Creates a Text Widget annotation and initialize it using given annotation object.

Public Methods
static TextWidget | create(Doc doc, Rect pos, String field_name) Creates a new Text Widget annotation, in the specified document.
static TextWidget | create(Doc doc, Rect pos, Field field) Creates a new Text Widget annotation, in the specified document.
static TextWidget | create(Doc doc, Rect pos) Creates a new Text Widget annotation, in the specified document.
String | getText() Retrieves the text content of the Text Widget.
void | setText(String text) Sets the text content of the Text Widget.

[Expand] Inherited Methods
From class com.pdftron.pdf.annots.Widget
void | SetScaleCondition(int sd) Set the condition under which the icon should be scaled.
static Widget | create(Doc doc, Rect pos, Field field) Creates a new Widget annotation, in the specified document.
Action | getAction() Get the action of the Widget annotation.
ColorPt | getBackgroundColor() Get the background color of the Widget annotation.
int | getBackgroundColorCompNum() Get the number indicating background color space of the Widget annotation.
ColorPt | getBorderColor() Get the border color of the Widget annotation.
int | getBorderColorCompNum() Get the number indicating border color space of the Widget annotation.
Field | getField() Get the field corresponding to the Widget annotation.
boolean | getFitFull() Get the fit full option being used.
Font | getFont() Retrieves the font used for displaying text in this Widget.
double | getFontSize() Returns the font size used in this Widget Annotation.
double | getHIconLeftOver() Get the horizontal leftover of the icon within the annotatin.
int | getHighlightingMode() Get the HighlightingMode of the Widget Annotation.
int | getIconCaptionRelation() Get the Icon and caption relationship of the Widget annotation.
String | getMouseDownCaptionText() Get the button down caption text of the Widget annotation.
Obj | getMouseDownIcon() Get the Mouse Down icon associated with the Widget annotation.
String | getRolloverCaptionText() Get the roll over caption text of the Widget annotation.
Obj | getRolloverIcon() Get the rollover icon associated with the Widget annotation.
int | getScaleCondition() Get the condition under which the icon should be scaled.
int | getScaleType() Get the Scale Type of the Widget annotation.
String | getStaticCaptionText() Get static caption text of the Widget annotation.
Obj | getStaticIcon() Get the static icon associated with the Widget annotation.
ColorPt | getTextColor() Returns the text color of the Widget Annotation.
int | getTextColorCompNum() Returns the number of color components in the text color of the Widget Annotation.
double | getVIconLeftOver() Get the vertical leftover of the icon within the annotatin.
void | setAction(Action action) Set the action of the Widget annotation (Optional; PDF 1.2 ) Note: The action is an action that shall be performed when the annotation is activated
void | setBackgroundColor(ColorPt c, int CompNum) Set the background color of the Widget.
void | setBorderColor(ColorPt c, int CompNum) Set the border color of the Widget.
void | setFitFull(boolean ff) Set the fit full option being used.
void | setFont(Font font) Specifies a font to be used for text in this Widget.
void | setFontSize(double font_size) Sets the font size of the Widget Annotation.
void | setHIconLeftOver(double hl) Set the horizontal leftover of the icon within the annotatin.
void | setHighlightingMode(int mode) Set the HighlightingMode of the Widget Annotation.
void | setIconCaptionRelation(int icr) Set the Icon and caption relationship of the Widget annotation.
void | setMouseDownCaptionText(String ct) Set the button down caption text of the Widget annotation.
void | setMouseDownIcon(Obj ic) Set the Mouse Down icon associated with the Widget annotation.
void | setRolloverCaptionText(String ct) Set the roll over caption text of the Widget annotation.
void | setRolloverIcon(Obj ic) Set the rollover icon associated with the Widget annotation.
void | setScaleType(int st) Set the Scale Type of the Widget annotation.
void | setStaticCaptionText(String ct) Set static caption text of the Widget annotation.
void | setStaticIcon(Obj ic) Set the static icon associated with the Widget annotation.
void | setTextColor(ColorPt color, int col_comp) Sets the text color of the Widget Annotation.
void | setVIconLeftOver(double vl) Set the vertical leftover of the icon within the annotatin.
From class com.pdftron.pdf.Annot
int | GetStructParent() Get the struct parent of an annotation.
static Annot | __Create(long impl, Object ref)
long | __GetHandle()
Object | __GetRefHandle()
static Annot | create(Doc doc, int type, Rect pos) Creates a new annotation of a given type, in the specified document.
void | deleteCustomData(String key) Deletes custom data associated with the given key.
boolean | equals(Object d) Compares two annotations for equality.
void | flatten(Page page) Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page.
String | getActiveAppearanceState() Get the annotation's active appearance state.
Obj | getAppearance(int annot_state, String app_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Obj | getAppearance() Get the annotation's appearance for the given combination of annotation and appearance states.
Obj | getAppearance(int annot_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Annot.BorderStyle | getBorderStyle() Get the border style for the annotation.
ColorPt | getColorAsCMYK() Get an annotation's color.
ColorPt | getColorAsGray() Get an annotation's color.
ColorPt | getColorAsRGB() Get an annotation's color.
int | getColorCompNum() Get the color space the annotation's color is represented in.
String | getContents() Get the annotation contents.
String | getCustomData(String key) Returns custom data associated with the given key.
Date | getDate() Gets an annotation's last modified date.
boolean | getFlag(int flag) Determine if the give flag is marked flagged
Obj | getOptionalContent() Get optional content of an annotation.
Page | getPage() Get the page the annotation is associated with.
Rect | getRect() Get annoation bound rectangle
int | getRotation() Get the rotation value of the annotation.
Obj | getSDFObj() Get the SDFObj.
Obj | getTriggerAction(int trigger) Get the Action associated with the selected Annot Trigger event.
int | getType() Get the annotation type.
Obj | getUniqueID() Get the annotiation unique ID.
Rect | getVisibleContentBox() It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered.
int | hashCode()
boolean | isMarkup() Checks if annoation is markup.
boolean | isValid() Checks if Annot is valid.
void | refreshAppearance() Regenerates the appearance stream for the annotation.
void | refreshAppearance(RefreshOptions opts) A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
void | removeAppearance() Removes the annotation's default appearance.
void | removeAppearance(int annot_state, String app_state) Removes the annotation's appearance for the given combination of annotation and appearance states.
void | resize(Rect pos) Resize annotation
void | setActiveAppearanceState(String astate) Set the annotation's active appearance state.
void | setAppearance(Obj app_stream, int annot_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setAppearance(Obj app_stream) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setAppearance(Obj app_stream, int annot_state, String app_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setBorderStyle(Annot.BorderStyle bs) Set the border style for the annotation.
void | setColor(ColorPt cpt) Set an annotation's color.
void | setColor(ColorPt cpt, int comp_num) Set an annotation's color.
void | setContents(String ct) Set annotation contents.
void | setCustomData(String key, String value) Sets the custom data associated with the specified key.
void | setDate(Date date) Sets an annotation's last modified date.
void | setDateToNow() Sets an annotation's last modified date to the current time.
void | setFlag(int flag, boolean value) Set the value of given Flag.
void | setOptionalContent(Obj oc) Set optional content of an annotation.
void | setPage(Page page) Set the reference to a page the annotation is associated with.
void | setRect(Rect pos) Set the size and location of an annotation on its page.
void | setRotation(int rot) Set the rotation value of the annotation.
void | setStructParent(int keyval) Set the struct parent of an annotation.
void | setUniqueID(String icon_name) Set the unique identifier for this annotation.
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public TextWidget (Obj d)

Creates a Text Widget annotation and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Parameters

d | The object to use to initialize the Text Widget

#### public TextWidget ()

Create an empty Text Widget annotation.

#### public TextWidget (Annot annot)

Creates a Text Widget annotation and initialize it using given annotation object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Parameters

annot | The annotation to use.

##### Throws

PDFNetException |

## Public Methods

#### public static TextWidget create (Doc doc, Rect pos, String field_name)

Creates a new Text Widget annotation, in the specified document.

##### Parameters

doc | The document to which the annotation is added.
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates.
field_name | The name of the field for which to create a Text widget.

##### Returns

- A newly created blank Text Widget annotation.

##### Throws

PDFNetException |

#### public static TextWidget create (Doc doc, Rect pos, Field field)

Creates a new Text Widget annotation, in the specified document.

##### Parameters

doc | The document to which the annotation is added.
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates.
field | the field for which to create a Text Widget.

##### Returns

- A newly created blank Widget annotation.

##### Throws

PDFNetException |

#### public static TextWidget create (Doc doc, Rect pos)

Creates a new Text Widget annotation, in the specified document.

##### Parameters

doc | The document to which the annotation is added.
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates.

##### Returns

- A newly created blank Text Widget annotation.

##### Throws

PDFNetException |

#### public String getText ()

Retrieves the text content of the Text Widget.

##### Returns

- The Text Widget contents.

##### Throws

PDFNetException |

#### public void setText (String text)

Sets the text content of the Text Widget.

##### Parameters

text | The text to be displayed in the Text Widget.

##### Throws

PDFNetException |