|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.lowagie.text.pdf.BaseField
com.lowagie.text.pdf.RadioCheckField
public class RadioCheckField
Creates a radio or a check field.
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 | |
|---|---|
private boolean |
checked
Holds value of property checked. |
private int |
checkType
Holds value of property checkType. |
private String |
onValue
Holds value of property onValue. |
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 |
private static String[] |
typeChars
|
| Fields inherited from class com.lowagie.text.pdf.BaseField |
|---|
alignment, backgroundColor, BORDER_WIDTH_MEDIUM, BORDER_WIDTH_THICK, BORDER_WIDTH_THIN, borderColor, borderStyle, borderWidth, box, COMB, DO_NOT_SCROLL, DO_NOT_SPELL_CHECK, EDIT, fieldName, FILE_SELECTION, font, fontSize, HIDDEN, HIDDEN_BUT_PRINTABLE, maxCharacterLength, MULTILINE, options, PASSWORD, READ_ONLY, REQUIRED, rotation, text, textColor, visibility, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT, writer |
| 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. |
| Methods inherited from class com.lowagie.text.pdf.BaseField |
|---|
breakLines, getAlignment, getBackgroundColor, getBorderAppearance, getBorderColor, getBorderStyle, getBorderWidth, getBox, getFieldName, getFont, getFontSize, getHardBreaks, getMaxCharacterLength, getOptions, getRealFont, getRotation, getText, getTextColor, getVisibility, getWriter, moveFields, setAlignment, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setBox, setFieldName, setFont, setFontSize, setMaxCharacterLength, setOptions, setRotation, setRotationFromPage, setText, setTextColor, setVisibility, setWriter, trimRight |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int TYPE_CHECK
public static final int TYPE_CIRCLE
public static final int TYPE_CROSS
public static final int TYPE_DIAMOND
public static final int TYPE_SQUARE
public static final int TYPE_STAR
private static String[] typeChars
private int checkType
private String onValue
private boolean checked
| Constructor Detail |
|---|
public RadioCheckField(PdfWriter writer,
Rectangle box,
String fieldName,
String onValue)
writer - the document PdfWriterbox - the field location and dimensionsfieldName - the field name. It must not be nullonValue - the value when the field is checked| Method Detail |
|---|
public int getCheckType()
public void setCheckType(int checkType)
TYPE_CHECK,
TYPE_CIRCLE,
TYPE_CROSS,
TYPE_DIAMOND,
TYPE_SQUARE and
TYPE_STAR.
checkType - the checked symbolpublic String getOnValue()
public void setOnValue(String onValue)
onValue - the value when the field is checkedpublic boolean isChecked()
public void setChecked(boolean checked)
checked - the state of the field, true for checked
and false for unchecked
public PdfAppearance getAppearance(boolean isRadio,
boolean on)
throws IOException,
DocumentException
isRadio - true for a radio field and false
for a check fieldon - true for the checked state, false
otherwise
IOException - on error
DocumentException - on errorpublic PdfAppearance getAppearanceRadioCircle(boolean on)
on - true for the checked state, false
otherwise
public PdfFormField getRadioGroup(boolean noToggleToOff,
boolean radiosInUnison)
addKid().
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)
public PdfFormField getRadioField()
throws IOException,
DocumentException
getRadioGroup(boolean,boolean).
IOException - on error
DocumentException - on error
public PdfFormField getCheckField()
throws IOException,
DocumentException
IOException - on error
DocumentException - on error
protected PdfFormField getField(boolean isRadio)
throws IOException,
DocumentException
isRadio - true to get a radio field, false to get
a check field
IOException - on error
DocumentException - on error
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||