Field

java.lang.Object
- com.aspose.pdf.BaseParagraph
- - com.aspose.pdf.Annotation
  - - com.aspose.pdf.WidgetAnnotation
    - - com.aspose.pdf.Field

All Implemented Interfaces:

com.aspose.ms.System.ICloneable, Cloneable, Iterable<WidgetAnnotation>

Direct Known Subclasses:

ButtonField, CheckboxField, ChoiceField, RadioButtonOptionField, SignatureField, TextBoxField
```
public class Field
extends WidgetAnnotation
implements Iterable<WidgetAnnotation>, Cloneable
```
Base class for acro form fields.

Field Summary

Fields
Modifier and Type Field and Description

static int _FileSelect
_FileSelect

static int _Password
_Password
- Fields inherited from class com.aspose.pdf.Annotation
  _disableUpdateAppearance

Fields
Modifier and Type	Field and Description
`static int`	`_FileSelect` _FileSelect
`static int`	`_Password` _Password

Constructor Summary

Constructors
Constructor and Description

Field(IDocument doc)
Creates field for use in Generator.

Constructors
Constructor and Description
`Field(IDocument doc)` Creates field for use in Generator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(WidgetAnnotation item)`
`void`	`clear()`
`boolean`	`contains(WidgetAnnotation item)`
`void`	`copyTo(Field[] array, int index)` Copies subfields of this field into array starting from specified index.
`void`	`copyTo(WidgetAnnotation[] array, int arrayIndex)`
`void`	`flatten()` Removes this field and place its value directly on the page.
`WidgetAnnotation`	`get_Item(int index)` Gets subfield contained in this field by index.
`WidgetAnnotation`	`get_Item(String name)` Gets subfield contained in this field by name of the subfield.
`String`	`getAlternateName()` Gets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface).
`int`	`getAnnotationIndex()` Gets index of this anotation on the page.
`String`	`getMappingName()` Gets mapping name of the field that shall be used when exporting interactive form field data from the document.
`static double`	`getMaxFontSize()` Maximal font size which can be used for field contents. -1 to don't check size.
`int`	`getPageIndex()` Gets index of page which contains this field.
`String`	`getPartialName()` Gets partial name of the field.
`Rectangle`	`getRect()` Gets the field rectangle.
`Object`	`getSyncRoot()` Synchronization object.
`int`	`getTabOrder()` Gets or sets tab order of the field.
`String`	`getValue()` Gets value of the field.
`static boolean`	`isFitIntoRectangle()` If true then font size will reduced to fit text to specified rectangle.
`boolean`	`isGroup()` Gets boolean value which indicates is this field non-terminal field i.e. group of fields.
`boolean`	`isReadOnly()`
`boolean`	`isSharedField()` Property for Generator support.
`boolean`	`isSynchronized()` Returns true if dictionary is synchronized.
`Iterator<WidgetAnnotation>`	`iterator()` Returns enumerator of contained fields.
`boolean`	`recalculate()` Recaculates all calculated fields on the form.
`boolean`	`remove(WidgetAnnotation item)`
`void`	`setAlternateName(String value)` Sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface).
`void`	`setAnnotationIndex(int value)` Sets index of this anotation on the page.
`static void`	`setFitIntoRectangle(boolean value)` If true then font size will reduced to fit text to specified rectangle.
`void`	`setMappingName(String value)` Sets mapping name of the field that shall be used when exporting interactive form field data from the document.
`static void`	`setMaxFontSize(double value)` Maximal font size which can be used for field contents. -1 to don't check size.
`void`	`setPartialName(String value)` Sets partial name of the field.
`void`	`setPosition(Point point)` Set position of the field.
`void`	`setRect(Rectangle value)` Sets the field rectangle.
`void`	`setSharedField(boolean value)` Property for Generator support.
`void`	`setTabOrder(int value)` Gets or sets tab order of the field.
`void`	`setValue(String value)` Set value.
`int`	`size()` Gets number of subfields in this field.
`void`	`updateAppearances()` Update appearances value.

Methods inherited from class com.aspose.pdf.WidgetAnnotation
accept, getAnnotationActions, getAnnotationType, getDefaultAppearance, getExportable, getHighlighting, getOnActivated, getParent, getReadOnly, getRequired, setDefaultAppearance, setExportable, setHighlighting, setOnActivated, setReadOnly, setRequired

Methods inherited from class com.aspose.pdf.BaseParagraph
deepClone, getHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndex

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - _Password
```
public static final int _Password
```
    _Password
    
    See Also:
    
    Constant Field Values
  - _FileSelect
```
public static final int _FileSelect
```
    _FileSelect
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Field
```
public Field(IDocument doc)
```
    Creates field for use in Generator.
    
    Parameters:
    
    doc - Document where field will be created.
- Method Detail
  - getPartialName
```
public String getPartialName()
```
    Gets partial name of the field.
    
    Returns:
    
    String value
  - setPartialName
```
public void setPartialName(String value)
```
    Sets partial name of the field.
    
    Parameters:
    
    value - String value
  - getAlternateName
```
public String getAlternateName()
```
    Gets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat.
    
    Returns:
    
    String value
  - setAlternateName
```
public void setAlternateName(String value)
```
    Sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat.
    
    Parameters:
    
    value - String value
  - getMappingName
```
public String getMappingName()
```
    Gets mapping name of the field that shall be used when exporting interactive form field data from the document.
    
    Returns:
    
    String value
  - setMappingName
```
public void setMappingName(String value)
```
    Sets mapping name of the field that shall be used when exporting interactive form field data from the document.
    
    Parameters:
    
    value - String value
  - recalculate
```
public boolean recalculate()
```
    Recaculates all calculated fields on the form.
    
    Returns:
    
    true if field value was changed during recalculation.
  - getValue
```
public String getValue()
```
    Gets value of the field.
    
    Returns:
    
    String value
  - setValue
```
public void setValue(String value)
```
    Set value.
    
    Parameters:
    
    value - String value
  - isSynchronized
```
public boolean isSynchronized()
```
    Returns true if dictionary is synchronized.
    
    Returns:
    
    boolean value
  - size
```
public int size()
```
    Gets number of subfields in this field. (For example number of items in radio button field).
    
    Returns:
    
    int value
  - getSyncRoot
```
public Object getSyncRoot()
```
    Synchronization object.
    
    Returns:
    
    object value
  - isGroup
```
public boolean isGroup()
```
    Gets boolean value which indicates is this field non-terminal field i.e. group of fields.
    
    Returns:
    
    boolean value
  - copyTo
```
public void copyTo(Field[] array,
                   int index)
```
    Copies subfields of this field into array starting from specified index.
    
    Parameters:
    
    array - Array where field must be copied.
    
    index - Starting index where fields will be copied.
  - iterator
```
public Iterator<WidgetAnnotation> iterator()
```
    Returns enumerator of contained fields.
    
    Specified by:
    
    iterator in interface Iterable<WidgetAnnotation>
    
    Returns:
    
    Enumerator object.
  - flatten
```
public void flatten()
```
    Removes this field and place its value directly on the page.
    
    Overrides:
    
    flatten in class Annotation
  - get_Item
```
public WidgetAnnotation get_Item(String name)
```
    Gets subfield contained in this field by name of the subfield.
    
    Parameters:
    
    name - Contained subfield name.
    
    Returns:
    
    Field instance.
  - get_Item
```
public WidgetAnnotation get_Item(int index)
```
    Gets subfield contained in this field by index.
    
    Parameters:
    
    index - Index of the reuqested subfield.
    
    Returns:
    
    Field instance.
  - setPosition
```
public void setPosition(Point point)
```
    Set position of the field.
    
    Parameters:
    
    point - Point where field should be positioned.
  - updateAppearances
```
public void updateAppearances()
```
    Update appearances value.
  - getAnnotationIndex
```
public int getAnnotationIndex()
```
    Gets index of this anotation on the page.
    
    Returns:
    
    int value
  - setAnnotationIndex
```
public void setAnnotationIndex(int value)
```
    Sets index of this anotation on the page.
    
    Parameters:
    
    value - int value
  - getPageIndex
```
public int getPageIndex()
```
    Gets index of page which contains this field.
    
    Overrides:
    
    getPageIndex in class Annotation
    
    Returns:
    
    int value
  - getRect
```
public Rectangle getRect()
```
    Gets the field rectangle.
    
    Overrides:
    
    getRect in class Annotation
    
    Returns:
    
    the field rectangle.
  - setRect
```
public void setRect(Rectangle value)
```
    Sets the field rectangle.
    
    Overrides:
    
    setRect in class Annotation
    
    Parameters:
    
    value - the field rectangle.
  - isSharedField
```
public boolean isSharedField()
```
    Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
    
    Returns:
    
    boolean value
  - setSharedField
```
public void setSharedField(boolean value)
```
    Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
    
    Parameters:
    
    value - boolean value
  - isFitIntoRectangle
```
public static boolean isFitIntoRectangle()
```
    If true then font size will reduced to fit text to specified rectangle.
    
    Returns:
    
    boolean value
  - setFitIntoRectangle
```
public static void setFitIntoRectangle(boolean value)
```
    If true then font size will reduced to fit text to specified rectangle.
    
    Parameters:
    
    value - boolean value
  - getMaxFontSize
```
public static double getMaxFontSize()
```
    Maximal font size which can be used for field contents. -1 to don't check size.
    
    Returns:
    
    double value
  - setMaxFontSize
```
public static void setMaxFontSize(double value)
```
    Maximal font size which can be used for field contents. -1 to don't check size.
    
    Parameters:
    
    value - double value
  - getTabOrder
```
public int getTabOrder()
```
    Gets or sets tab order of the field.
    
    Returns:
    
    int value
  - setTabOrder
```
public void setTabOrder(int value)
```
    Gets or sets tab order of the field.
    
    Parameters:
    
    value - int value
  - add
```
public void add(WidgetAnnotation item)
```
  - clear
```
public void clear()
```
  - contains
```
public boolean contains(WidgetAnnotation item)
```
  - copyTo
```
public void copyTo(WidgetAnnotation[] array,
                   int arrayIndex)
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - remove
```
public boolean remove(WidgetAnnotation item)
```

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class Field

Field Summary

Fields inherited from class com.aspose.pdf.Annotation

Constructor Summary

Method Summary

Methods inherited from class com.aspose.pdf.WidgetAnnotation

Methods inherited from class com.aspose.pdf.Annotation

Methods inherited from class com.aspose.pdf.BaseParagraph

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

_Password

_FileSelect

Constructor Detail

Method Detail

getPartialName

setPartialName

getAlternateName

setAlternateName

getMappingName

setMappingName

recalculate

getValue

setValue

isSynchronized

size

getSyncRoot

isGroup

copyTo

iterator

flatten

get_Item

get_Item

setPosition

updateAppearances

getAnnotationIndex

setAnnotationIndex

getPageIndex

getRect

setRect

isSharedField

setSharedField

isFitIntoRectangle

setFitIntoRectangle

getMaxFontSize

setMaxFontSize

getTabOrder

setTabOrder

add

clear

contains

copyTo

isReadOnly

remove