Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

InvalidFormTypeOperationException

Skip navigation links

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

All Implemented Interfaces:

com.aspose.ms.System.ICloneable, Cloneable, Iterable<WidgetAnnotation>
```
public final class ButtonField
extends Field
```
Class represents push button field.

Field Summary
- Fields inherited from class com.aspose.pdf.Field
  _FileSelect, _Password
- Fields inherited from class com.aspose.pdf.Annotation
  _disableUpdateAppearance

Constructor Summary

Constructors
Constructor and Description
`ButtonField()` Button field constructor for Generator.
`ButtonField(IDocument doc, Rectangle rect)` ButtonField constructore.
`ButtonField(Page page, Rectangle rect)` ButtonField constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addImage(BufferedImage image)` Adds image into the field resources an draws it.
`void`	`addImage(BufferedImage image, boolean fillArea)` Adds image into the field resources an draws it.
`String`	`getAlternateCaption()` Gets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
`XForm`	`getAlternateIcon()` Gets alternate icon which shall be displayed when the mouse button is pressed within its active area.
`IconFit`	`getIconFit()` Gets icon fit object specifying how the widget annotation's icon shall be displayed within its annotation rectangle.
`int`	`getICPosition()` Gets icon caption position.
`String`	`getNormalCaption()` Gets normal caption.
`XForm`	`getNormalIcon()` Gets normal icon of the button which shall be displayed when it is not interacting with the user.
`String`	`getRolloverCaption()` Gets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
`XForm`	`getRolloverIcon()` Gets rollover icon of the button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
`void`	`setAlternateCaption(String value)` Sets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
`void`	`setAlternateIcon(XForm value)` Sets alternate icon which shall be displayed when the mouse button is pressed within its active area.
`void`	`setICPosition(int value)` Sets icon caption position.
`void`	`setNormalCaption(String value)` Sets normal caption.
`void`	`setNormalIcon(XForm value)` Sets normal icon of the button which shall be displayed when it is not interacting with the user.
`void`	`setRolloverCaption(String value)` Sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
`void`	`setRolloverIcon(XForm value)` Sets rollover icon of the button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.

Methods inherited from class com.aspose.pdf.Field
add, clear, contains, copyTo, copyTo, flatten, get_Item, get_Item, getAlternateName, getAnnotationIndex, getMappingName, getMaxFontSize, getPageIndex, getPartialName, getRect, getSyncRoot, getTabOrder, getValue, isFitIntoRectangle, isGroup, isReadOnly, isSharedField, isSynchronized, iterator, recalculate, remove, setAlternateName, setAnnotationIndex, setFitIntoRectangle, setMappingName, setMaxFontSize, setPartialName, setPosition, setRect, setSharedField, setTabOrder, setValue, size, updateAppearances

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

- Constructor Detail
  - ButtonField
```
public ButtonField()
```
    Button field constructor for Generator.
  - ButtonField
```
public ButtonField(Page page,
                   Rectangle rect)
```
    ButtonField constructor.
    
    Parameters:
    
    page - Page where button will be placed.
    
    rect - Rectangle where button is placed on the page.
  - ButtonField
```
public ButtonField(IDocument doc,
                   Rectangle rect)
```
    ButtonField constructore.
    
    Parameters:
    
    doc - Docuemtn where new field will be created.
    
    rect - Rectangle hwere button is placed on the page.
- Method Detail
  - getNormalCaption
```
public String getNormalCaption()
```
    Gets normal caption.
    
    Returns:
    
    String value
  - setNormalCaption
```
public void setNormalCaption(String value)
```
    Sets normal caption.
    
    Parameters:
    
    value - String value
  - getRolloverCaption
```
public String getRolloverCaption()
```
    Gets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
    
    Returns:
    
    String value
  - setRolloverCaption
```
public void setRolloverCaption(String value)
```
    Sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
    
    Parameters:
    
    value - String value
  - getAlternateCaption
```
public String getAlternateCaption()
```
    Gets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
    
    Returns:
    
    String value
  - setAlternateCaption
```
public void setAlternateCaption(String value)
```
    Sets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
    
    Parameters:
    
    value - String value
  - getNormalIcon
```
public XForm getNormalIcon()
```
    Gets normal icon of the button which shall be displayed when it is not interacting with the user.
    
    Returns:
    
    XForm object
  - setNormalIcon
```
public void setNormalIcon(XForm value)
```
    Sets normal icon of the button which shall be displayed when it is not interacting with the user.
    
    Parameters:
    
    value - XForm object
  - getRolloverIcon
```
public XForm getRolloverIcon()
```
    Gets rollover icon of the button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
    
    Returns:
    
    XForm object
  - setRolloverIcon
```
public void setRolloverIcon(XForm value)
```
    Sets rollover icon of the button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
    
    Parameters:
    
    value - XForm object
  - getAlternateIcon
```
public XForm getAlternateIcon()
```
    Gets alternate icon which shall be displayed when the mouse button is pressed within its active area.
    
    Returns:
    
    XForm object
  - setAlternateIcon
```
public void setAlternateIcon(XForm value)
```
    Sets alternate icon which shall be displayed when the mouse button is pressed within its active area.
    
    Parameters:
    
    value - XForm object
  - getIconFit
```
public IconFit getIconFit()
```
    Gets icon fit object specifying how the widget annotation's icon shall be displayed within its annotation rectangle.
    
    Returns:
    
    IconFit object
  - getICPosition
```
public int getICPosition()
```
    Gets icon caption position.
    
    Returns:
    
    icon caption position.
    
    See Also:
    
    IconCaptionPosition
  - setICPosition
```
public void setICPosition(int value)
```
    Sets icon caption position.
    
    Parameters:
    
    value - icon caption position.
    
    See Also:
    
    IconCaptionPosition
  - addImage
```
public void addImage(BufferedImage image)
```
    Adds image into the field resources an draws it.
    
    Parameters:
    
    image - Image ot add into text field.
  - addImage
```
public void addImage(BufferedImage image,
                     boolean fillArea)
```
    Adds image into the field resources an draws it.
    
    Parameters:
    
    image - Image ot add into text field.
    
    fillArea - boolean values

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class ButtonField

Field Summary

Fields inherited from class com.aspose.pdf.Field

Fields inherited from class com.aspose.pdf.Annotation

Constructor Summary

Method Summary

Methods inherited from class com.aspose.pdf.Field

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

Constructor Detail

ButtonField

ButtonField

ButtonField

Method Detail

getNormalCaption

setNormalCaption

getRolloverCaption

setRolloverCaption

getAlternateCaption

setAlternateCaption

getNormalIcon

setNormalIcon

getRolloverIcon

setRolloverIcon

getAlternateIcon

setAlternateIcon

getIconFit

getICPosition

setICPosition

addImage

addImage