java.lang.Object | |
↳ | com.pdftron.pdf.annots.RadioButtonGroup |
An object representing a Group of Radio Buttons that can be used to create new Radio Buttons. If a group contains multiple buttons they will be connected.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
RadioButtonGroup(Field field)
Creates a RadioButtonGroup and initialize it using given Field object.
| |||||||||||
RadioButtonGroup()
Creates a null (non-valid) RadioButtonGroup.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
RadioButtonWidget |
add(Rect pos, String onstate)
Adds a new RadioButtonWidget to the RadioButtonGroup
| ||||||||||
RadioButtonWidget |
add(Rect pos)
Adds a new RadioButtonWidget to the RadioButtonGroup
| ||||||||||
void |
addGroupButtonsToPage(Page page)
Add all group buttons to the page
| ||||||||||
void |
close()
Frees the native memory of the object.
| ||||||||||
static RadioButtonGroup |
create(Doc doc)
Creates a new RadioButtonGroup in the specified document.
| ||||||||||
static RadioButtonGroup |
create(Doc doc, String field_name)
Creates a new RadioButtonGroup in the specified document.
| ||||||||||
void | destroy() | ||||||||||
RadioButtonWidget |
getButton(int index)
Retrieves the button at a given index.
| ||||||||||
Field |
getField()
Gets the field associated with this RadioButtonGroup
| ||||||||||
int |
getNumButtons()
Gets the number of buttons in this RadioButtonGroup
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.lang.AutoCloseable
|
Creates a RadioButtonGroup and initialize it using given Field object.
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
field | The field with which to initialize the RadioButtonGroup |
---|
Creates a null (non-valid) RadioButtonGroup.
Adds a new RadioButtonWidget to the RadioButtonGroup
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
---|---|
onstate | The onstate for this button. This will rarely need to be explicitly set. However, it can be used to allow multiple radiobuttons in a group to be on at once if they have the same onstate. |
PDFNetException |
---|
Adds a new RadioButtonWidget to the RadioButtonGroup
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates. |
---|
PDFNetException |
---|
Add all group buttons to the page
page | The page in which to add the buttons. |
---|
PDFNetException |
---|
Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.
PDFNetException |
---|
Creates a new RadioButtonGroup in the specified document.
doc | The document in which the RadioButtonGroup is created. |
---|
PDFNetException |
---|
Creates a new RadioButtonGroup in the specified document.
doc | The document in which the RadioButtonGroup is created. |
---|---|
field_name | The name of the field to create and use in this RadioButtonGroup. |
PDFNetException |
---|
Retrieves the button at a given index.
index | The index to use. |
---|
PDFNetException |
---|
Gets the field associated with this RadioButtonGroup
PDFNetException |
---|
Gets the number of buttons in this RadioButtonGroup
PDFNetException |
---|