com.compdfkit.core.annotation.form

Class CPDFPushbuttonWidget

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.form.CPDFWidget

com.compdfkit.core.annotation.form.CPDFPushbuttonWidget

public class CPDFPushbuttonWidget
extends CPDFWidget

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

Nested Class Summary

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.form.CPDFWidget

CPDFWidget.BorderStyle, CPDFWidget.CheckStyle, CPDFWidget.WidgetType

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.Type

Field Summary

Fields inherited from class com.compdfkit.core.annotation.CPDFAnnotation

annotPtr, apRotation, pdfPage

Method Summary

Modifier and Type	Method and Description
void	close() When the object is no longer in use, call this method to release resources.
CPDFAction	getButtonAction() Gets response action of PushButtonget.
java.lang.String	getButtonTitle() Gets PushButton label.
int	getFontColor() Gets font color of PushButton.
java.lang.String	getFontName() Gets font name of PushButton.
float	getFontSize() Gets font size of PushButton.
boolean	resetForm() Resets the state of PushButton.
boolean	setButtonAction(CPDFAction action) Sets response action of PushButtonget.
boolean	setButtonTitle(java.lang.String title) Sets PushButton label.
boolean	setFontColor(int color) Sets font color of PushButton.
boolean	setFontName(java.lang.String fontName) Sets PushButton font.
boolean	setFontSize(float fontsize) Sets font size of PushButton.

Methods inherited from class com.compdfkit.core.annotation.form.CPDFWidget

clearBorderColor, clearFillColor, getBorderColor, getBorderStyles, getBorderWidth, getCheckColor, getCheckStyle, getFieldFlag, getFieldName, getFieldType, getFillAlpha, getFillColor, getRect, getWidgetType, isReadOnly, setBorderColor, setBorderStyles, setBorderWidth, setCheckColor, setCheckStyle, setFieldFlag, setFieldName, setFieldType, setFillAlpha, setFillColor, setReadOnly, setRect, updateAp, updateAp

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, clearFilledRGBColor, clearFilledTransparency, getAppearanceByPixel, getApRotation, getBgRGBColor, getBorderRGBColor, getBorderStyle, getContent, getCreationDate, getFilledRGBColor, getFilledTransparency, getFlags, getName, getOverLayText, getRecentlyModifyDate, getRGBColor, getTitle, getTransparency, getType, hasAp, isAllowCorrectAnnotationAp, isHidden, isLocked, isValid, removeAp, removeFromPage, setAllowCorrectAnnotationAp, setBgRGBColor, setBorderRGBColor, setBorderStyle, setContent, setCreationDate, setFilledRGBColor, setFilledTransparency, setFlags, setHidden, setLocked, setName, setOverLayText, setRecentlyModifyDate, setRGBColor, setTitle, setTransparency, updateApWithBitmap, updateApWithImage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getButtonAction

public CPDFAction getButtonAction()

Gets response action of PushButtonget. There are multiple subtypes of the response action, and different response actions are determined according to CPDFAction.ActionType. The action type can be obtained throughCPDFAction.getActionType(), more: CPDFAction

Returns:

Returns response action of PushButton, more: CPDFAction

setButtonAction

public boolean setButtonAction(CPDFAction action)

Sets response action of PushButtonget. There are multiple subtypes of the response action, and different response actions are determined according to CPDFAction.ActionType. The action type can be obtained throughCPDFAction.getActionType(), more: CPDFAction

Parameters:

action - Response action of PushButton.

Returns:

Returns whether to successfully set response action of PushButton.

setButtonTitle

public boolean setButtonTitle(java.lang.String title)

Sets PushButton label.

Parameters:

title - PushButton label.

Returns:

Returns whether to successfully set PushButton label.

getButtonTitle

public java.lang.String getButtonTitle()

Gets PushButton label.

Returns:

Returns PushButton label.

setFontName

public boolean setFontName(java.lang.String fontName)

Sets PushButton font.

Parameters:

fontName - Font name of PushButton.

Returns:

Returns whether to successfully set PushButton font.

getFontName

public java.lang.String getFontName()

Gets font name of PushButton.

Returns:

Returns font name of PushButton.

setFontSize

public boolean setFontSize(float fontsize)

Sets font size of PushButton.

Parameters:

fontsize - Font size.

Returns:

Returns whether to successfully set font size of PushButton.

getFontSize

public float getFontSize()

Gets font size of PushButton.

Returns:

Returns font size of PushButton.

setFontColor

public boolean setFontColor(int color)

Sets font color of PushButton.

Parameters:

color - Font color.

Returns:

Returns whether to successfully set font color of PushButton.

getFontColor

public int getFontColor()

Gets font color of PushButton.

Returns:

Returns font color of PushButton.

resetForm

public boolean resetForm()

Resets the state of PushButton.

Overrides:

resetForm in class CPDFWidget

Returns:

Returns whether to successfully reset the state of PushButton.

close

public void close()

When the object is no longer in use, call this method to release resources.

Overrides:

close in class CPDFAnnotation