com.lowagie.text.pdf
public class RadioCheckField 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(); RadioCheckField bt = new RadioCheckField(writer, new Rectangle(100, 100, 200, 200), "radio", "v1"); bt.setCheckType(RadioCheckField.TYPE_CIRCLE); bt.setBackgroundColor(Color.cyan); bt.setBorderStyle(PdfBorderDictionary.STYLE_SOLID); bt.setBorderColor(Color.red); bt.setTextColor(Color.yellow); bt.setBorderWidth(BaseField.BORDER_WIDTH_THICK); bt.setChecked(false); PdfFormField f1 = bt.getRadioField(); bt.setOnValue("v2"); bt.setChecked(true); bt.setBox(new Rectangle(100, 300, 200, 400)); PdfFormField f2 = bt.getRadioField(); bt.setChecked(false); PdfFormField top = bt.getRadioGroup(true, false); bt.setOnValue("v3"); bt.setBox(new Rectangle(100, 500, 200, 600)); PdfFormField f3 = bt.getRadioField(); top.addKid(f1); top.addKid(f2); top.addKid(f3); writer.addAnnotation(top); bt = new RadioCheckField(writer, new Rectangle(300, 300, 400, 400), "check1", "Yes"); bt.setCheckType(RadioCheckField.TYPE_CHECK); bt.setBorderWidth(BaseField.BORDER_WIDTH_THIN); bt.setBorderColor(Color.black); bt.setBackgroundColor(Color.white); PdfFormField ck = bt.getCheckField(); writer.addAnnotation(ck); document.close();
Field Summary | |
---|---|
boolean | checked
Holds value of property checked. |
int | checkType
Holds value of property checkType. |
String | onValue
Holds value of property onValue. |
static String[] | typeChars |
static int | TYPE_CHECK A field with the symbol check |
static int | TYPE_CIRCLE A field with the symbol circle |
static int | TYPE_CROSS A field with the symbol cross |
static int | TYPE_DIAMOND A field with the symbol diamond |
static int | TYPE_SQUARE A field with the symbol square |
static int | TYPE_STAR A field with the symbol star |
Constructor Summary | |
---|---|
RadioCheckField(PdfWriter writer, Rectangle box, String fieldName, String onValue)
Creates a new instance of RadioCheckField |
Method Summary | |
---|---|
PdfAppearance | getAppearance(boolean isRadio, boolean on)
Gets the field appearance. |
PdfAppearance | getAppearanceRadioCircle(boolean on)
Gets the special field appearance for the radio circle. |
PdfFormField | getCheckField()
Gets the check field. |
int | getCheckType()
Getter for property checkType. |
protected PdfFormField | getField(boolean isRadio)
Gets a radio or check field. |
String | getOnValue()
Getter for property onValue. |
PdfFormField | getRadioField()
Gets the radio field. |
PdfFormField | getRadioGroup(boolean noToggleToOff, boolean radiosInUnison)
Gets a radio group. |
boolean | isChecked()
Getter for property checked. |
void | setChecked(boolean checked)
Sets the state of the field to checked or unchecked. |
void | setCheckType(int checkType)
Sets the checked symbol. |
void | setOnValue(String onValue)
Sets the value when the field is checked. |
Parameters: writer the document PdfWriter
box the field location and dimensions fieldName the field name. It must not be null
onValue the value when the field is checked
Parameters: isRadio true
for a radio field and false
for a check field on true
for the checked state, false
otherwise
Returns: the appearance
Throws: IOException on error DocumentException on error
Parameters: on true
for the checked state, false
otherwise
Returns: the appearance
Returns: the check field
Throws: IOException on error DocumentException on error
Returns: Value of property checkType.
Parameters: isRadio true
to get a radio field, false
to get
a check field
Returns: the field
Throws: IOException on error DocumentException on error
Returns: Value of property onValue.
Returns: the radio field
Throws: IOException on error DocumentException on error
addKid()
.Parameters: noToggleToOff if true
, exactly one radio button must be selected at all
times; clicking the currently selected button has no effect.
If false
, clicking
the selected button deselects it, leaving no button selected. radiosInUnison if true
, a group of radio buttons within a radio button field that
use the same value for the on state will turn on and off in unison; that is if
one is checked, they are all checked. If false
, the buttons are mutually exclusive
(the same behavior as HTML radio buttons)
Returns: the radio group
Returns: Value of property checked.
Parameters: checked the state of the field, true
for checked
and false
for unchecked
TYPE_CHECK
,
TYPE_CIRCLE
,
TYPE_CROSS
,
TYPE_DIAMOND
,
TYPE_SQUARE
and
TYPE_STAR
.Parameters: checkType the checked symbol
Parameters: onValue the value when the field is checked