ButtonField

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation, com.aspose.pdf.WidgetAnnotation, com.aspose.pdf.Field

public class ButtonField extends Field

Class represents push button field.

Constructors

ConstructorDescription
ButtonField()Button field constructor for Generator.
ButtonField(Page page, Rectangle rect)ButtonField constructor.
ButtonField(IDocument doc, Rectangle rect)ButtonField constructore.

Methods

MethodDescription
getNormalCaption()Gets normal caption.
setNormalCaption(String value)Sets normal caption.
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.
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.
getAlternateCaption()Gets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
setAlternateCaption(String value)Sets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area.
getNormalIcon()Gets normal icon of the button which shall be displayed when it is not interacting with the user.
setNormalIcon(XForm value)Sets normal icon of the button which shall be displayed when it is not interacting with the user.
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.
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.
getAlternateIcon()Gets alternate icon which shall be displayed when the mouse button is pressed within its active area.
setAlternateIcon(XForm value)Sets alternate icon which shall be displayed when the mouse button is pressed within its active area.
getIconFit()Gets icon fit object specifying how the widget annotation’s icon shall be displayed within its annotation rectangle.
getICPosition()Gets icon caption position.
setICPosition(int value)Sets icon caption position.
addImage(BufferedImage image)Adds image into the field resources and draws it.
addImage(BufferedImage image, boolean fillArea)Adds image into the field resources an draws it.

ButtonField()

public ButtonField()

Button field constructor for Generator.

ButtonField(Page page, Rectangle rect)

public ButtonField(Page page, Rectangle rect)

ButtonField constructor.

Parameters:

ParameterTypeDescription
pagePagePage where button will be placed.
rectRectangleRectangle where button is placed on the page.

ButtonField(IDocument doc, Rectangle rect)

public ButtonField(IDocument doc, Rectangle rect)

ButtonField constructore.

Parameters:

ParameterTypeDescription
docIDocumentDocuemtn where new field will be created.
rectRectangleRectangle hwere button is placed on the page.

getNormalCaption()

public String getNormalCaption()

Gets normal caption.

Returns: java.lang.String - String value

setNormalCaption(String value)

public void setNormalCaption(String value)

Sets normal caption.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString 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: java.lang.String - String value

setRolloverCaption(String value)

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:

ParameterTypeDescription
valuejava.lang.StringString 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: java.lang.String - String value

setAlternateCaption(String value)

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:

ParameterTypeDescription
valuejava.lang.StringString 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 - XForm object

setNormalIcon(XForm value)

public void setNormalIcon(XForm value)

Sets normal icon of the button which shall be displayed when it is not interacting with the user.

Parameters:

ParameterTypeDescription
valueXFormXForm 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 - XForm object

setRolloverIcon(XForm value)

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:

ParameterTypeDescription
valueXFormXForm object

getAlternateIcon()

public XForm getAlternateIcon()

Gets alternate icon which shall be displayed when the mouse button is pressed within its active area.

Returns: XForm - XForm object

setAlternateIcon(XForm value)

public void setAlternateIcon(XForm value)

Sets alternate icon which shall be displayed when the mouse button is pressed within its active area.

Parameters:

ParameterTypeDescription
valueXFormXForm 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 - IconFit object

getICPosition()

public int getICPosition()

Gets icon caption position.

Returns: int - icon caption position.

setICPosition(int value)

public void setICPosition(int value)

Sets icon caption position.

Parameters:

ParameterTypeDescription
valueinticon caption position.

addImage(BufferedImage image)

public void addImage(BufferedImage image)

Adds image into the field resources and draws it.

Parameters:

ParameterTypeDescription
imagejava.awt.image.BufferedImageImage ot add into text field.

addImage(BufferedImage image, boolean fillArea)

public void addImage(BufferedImage image, boolean fillArea)

Adds image into the field resources an draws it.

Parameters:

ParameterTypeDescription
imagejava.awt.image.BufferedImageImage ot add into text field.
fillAreabooleanboolean values