com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class Field

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

        Specified by:
        isSynchronized in interface com.aspose.ms.System.Collections.ICollection
        Returns:
        boolean value
      • size

        public int size()

        Gets number of subfields in this field. (For example number of items in radio button field).

        Specified by:
        size in interface com.aspose.ms.System.Collections.ICollection
        Returns:
        int value
      • getSyncRoot

        public Object getSyncRoot()

        Synchronization object.

        Specified by:
        getSyncRoot in interface com.aspose.ms.System.Collections.ICollection
        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(com.aspose.ms.System.Array array,
                  int index)

        Copies subfields of this field into array starting from specified index.

        Specified by:
        copyTo in interface com.aspose.ms.System.Collections.ICollection
        Parameters:
        array - Array where field must be copied.
        index - Starting index where fields will be copied.
      • iterator

        public com.aspose.ms.System.Collections.IEnumerator iterator()

        Returns enumerator of contained fields.

        Specified by:
        iterator in interface com.aspose.ms.System.Collections.IEnumerable
        Specified by:
        iterator in interface Iterable
        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