com.lowagie.text.pdf
public class PushbuttonField extends BaseField
Example usage:
Document document = new Document(PageSize.A4, 50, 50, 50, 50); PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream("output.pdf")); document.open(); PdfContentByte cb = writer.getDirectContent(); Image img = Image.getInstance("image.png"); PushbuttonField bt = new PushbuttonField(writer, new Rectangle(100, 100, 200, 200), "Button1"); bt.setText("My Caption"); bt.setFontSize(0); bt.setImage(img); bt.setLayout(PushbuttonField.LAYOUT_ICON_TOP_LABEL_BOTTOM); bt.setBackgroundColor(Color.cyan); bt.setBorderStyle(PdfBorderDictionary.STYLE_SOLID); bt.setBorderColor(Color.red); bt.setBorderWidth(3); PdfFormField ff = bt.getField(); PdfAction ac = PdfAction.createSubmitForm("http://www.submit-site.com", null, 0); ff.setAction(ac); writer.addAnnotation(ff); document.close();
Field Summary | |
---|---|
boolean | iconFitToBounds
Holds value of property iconFitToBounds. |
float | iconHorizontalAdjustment
Holds value of property iconHorizontalAdjustment. |
PRIndirectReference | iconReference
Holds value of property iconReference. |
float | iconVerticalAdjustment
Holds value of property iconVerticalAdjustment. |
Image | image
Holds value of property image. |
int | layout
Holds value of property layout. |
static int | LAYOUT_ICON_LEFT_LABEL_RIGHT A layout option |
static int | LAYOUT_ICON_ONLY A layout option |
static int | LAYOUT_ICON_TOP_LABEL_BOTTOM A layout option |
static int | LAYOUT_LABEL_LEFT_ICON_RIGHT A layout option |
static int | LAYOUT_LABEL_ONLY A layout option |
static int | LAYOUT_LABEL_OVER_ICON A layout option |
static int | LAYOUT_LABEL_TOP_ICON_BOTTOM A layout option |
boolean | proportionalIcon
Holds value of property proportionalIcon. |
int | scaleIcon
Holds value of property scaleIcon. |
static int | SCALE_ICON_ALWAYS An icon scaling option |
static int | SCALE_ICON_IS_TOO_BIG An icon scaling option |
static int | SCALE_ICON_IS_TOO_SMALL An icon scaling option |
static int | SCALE_ICON_NEVER An icon scaling option |
PdfTemplate | template
Holds value of property template. |
PdfTemplate | tp |
Constructor Summary | |
---|---|
PushbuttonField(PdfWriter writer, Rectangle box, String fieldName)
Creates a new instance of PushbuttonField |
Method Summary | |
---|---|
float | calculateFontSize(float w, float h) |
PdfAppearance | getAppearance()
Gets the button appearance. |
PdfFormField | getField()
Gets the pushbutton field. |
float | getIconHorizontalAdjustment()
Getter for property iconHorizontalAdjustment. |
PRIndirectReference | getIconReference()
Gets the reference to an existing icon. |
float | getIconVerticalAdjustment()
Getter for property iconVerticalAdjustment. |
Image | getImage()
Getter for property image. |
int | getLayout()
Getter for property layout. |
int | getScaleIcon()
Getter for property scaleIcon. |
PdfTemplate | getTemplate()
Getter for property template. |
boolean | isIconFitToBounds()
Getter for property iconFitToBounds. |
boolean | isProportionalIcon()
Getter for property proportionalIcon. |
void | setIconFitToBounds(boolean iconFitToBounds)
If true the icon will be scaled to fit fully within the bounds of the annotation,
if false the border width will be taken into account. |
void | setIconHorizontalAdjustment(float iconHorizontalAdjustment)
A number between 0 and 1 indicating the fraction of leftover space to allocate at the left of the icon.
|
void | setIconReference(PRIndirectReference iconReference)
Sets the reference to an existing icon. |
void | setIconVerticalAdjustment(float iconVerticalAdjustment)
A number between 0 and 1 indicating the fraction of leftover space to allocate at the bottom of the icon.
|
void | setImage(Image image)
Sets the icon as an image. |
void | setLayout(int layout)
Sets the icon and label layout. |
void | setProportionalIcon(boolean proportionalIcon)
Sets the way the icon is scaled. |
void | setScaleIcon(int scaleIcon)
Sets the way the icon will be scaled. |
void | setTemplate(PdfTemplate template)
Sets the icon as a template. |
Parameters: writer the document PdfWriter
box the field location and dimensions fieldName the field name. If null
only the widget keys
will be included in the field allowing it to be used as a kid field.
Returns: the button appearance
Throws: IOException on error DocumentException on error
Returns: the pushbutton field
Throws: IOException on error DocumentException on error
Returns: Value of property iconHorizontalAdjustment.
Returns: the reference to an existing icon.
Returns: Value of property iconVerticalAdjustment.
Returns: Value of property image.
Returns: Value of property layout.
Returns: Value of property scaleIcon.
Returns: Value of property template.
Returns: Value of property iconFitToBounds.
Returns: Value of property proportionalIcon.
true
the icon will be scaled to fit fully within the bounds of the annotation,
if false
the border width will be taken into account. The default
is false
.Parameters: iconFitToBounds if true
the icon will be scaled to fit fully within the bounds of the annotation,
if false
the border width will be taken into account
Parameters: iconHorizontalAdjustment a number between 0 and 1 indicating the fraction of leftover space to allocate at the left of the icon
Parameters: iconReference the reference to an existing icon
Parameters: iconVerticalAdjustment a number between 0 and 1 indicating the fraction of leftover space to allocate at the bottom of the icon
Parameters: image the image
LAYOUT_LABEL_ONLY
,
LAYOUT_ICON_ONLY
, LAYOUT_ICON_TOP_LABEL_BOTTOM
,
LAYOUT_LABEL_TOP_ICON_BOTTOM
, LAYOUT_ICON_LEFT_LABEL_RIGHT
,
LAYOUT_LABEL_LEFT_ICON_RIGHT
and LAYOUT_LABEL_OVER_ICON
.
The default is LAYOUT_LABEL_ONLY
.Parameters: layout New value of property layout.
true
the icon is scaled proportionally,
if false
the scaling is done anamorphicaly.Parameters: proportionalIcon the way the icon is scaled
SCALE_ICON_ALWAYS
, SCALE_ICON_NEVER
,
SCALE_ICON_IS_TOO_BIG
and SCALE_ICON_IS_TOO_SMALL
.
The default is SCALE_ICON_ALWAYS
.Parameters: scaleIcon the way the icon will be scaled
Parameters: template the template