public class

PushButtonFormElement

extends ButtonFormElement
java.lang.Object
   ↳ com.pspdfkit.forms.FormElement
     ↳ com.pspdfkit.forms.ButtonFormElement
       ↳ com.pspdfkit.forms.PushButtonFormElement

Class Overview

A simple push button that responds immediately to user input without retaining any state.

See Also

Summary

Public Methods
Action getAction()
Returns the action that should be performed once this push button is pressed.
Bitmap getBitmap()
Returns the bitmap set for this push button form element.
PushButtonFormField getFormField()
Retrieve parent form field.
FormType getType()
Gets form type for PushButtonFormElement.
void setAction(Action action)
Sets action to the link annotation.
void setBitmap(Bitmap bitmap)
Sets a custom bitmap for this button form element.
[Expand]
Inherited Methods
From class com.pspdfkit.forms.FormElement
From class java.lang.Object

Public Methods

public Action getAction ()

Returns the action that should be performed once this push button is pressed.

Returns
  • Action to be performed once this button is pressed, null when no action exists.

public Bitmap getBitmap ()

Returns the bitmap set for this push button form element.

Returns
  • Bitmap set for this push button, may be null.

public PushButtonFormField getFormField ()

Retrieve parent form field.

Returns
  • Attached parent form field.

public FormType getType ()

Gets form type for PushButtonFormElement. See FormType.

Returns

public void setAction (Action action)

Sets action to the link annotation.

Parameters
action Action to be activated when the push button form element is pressed, null to remove action.

public void setBitmap (Bitmap bitmap)

Sets a custom bitmap for this button form element.

Parameters
bitmap Bitmap to be used for this push button. Bitmap will be scaled to fit the form element bounding box.