RadioButtonOptionField
Overview
RadioButtonOptionField is a class in Aspose.PDF FOSS for Java.
A single option in a radio button group.
This class provides 26 methods for working with RadioButtonOptionField objects in Java programs.
Available methods include: RadioButtonOptionField, getAppearance, getBorder, getCaption, getCharacteristics, getColor, getDefaultAppearance, getOptionName, getOptionValue, getPage, getPdfDictionary, getRect, and 11 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: appearance, border, caption, characteristics, color, defaultAppearance, and 6 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
optionValue | String | Read | Returns the value this option represents. |
rect | Rectangle | Read | Returns the rectangle of this option widget. |
pdfDictionary | PdfDictionary | Read | Returns the underlying PDF dictionary. |
style | BoxStyle | Read | Returns the per-option box style. |
characteristics | AppearanceCharacteristics | Read | Returns typed access to this option’s appearance characteristics |
| ({@code /MK} sub-dictionary on the kid widget). | |||
optionName | String | Read | Returns the export value (option name) of this option. |
page | Page | Read | Returns the page this option’s widget belongs to. |
border | org.aspose.pdf.annotations.Border | Read | Returns the border ({@code /BS} dictionary) attached to this option’s |
| widget, or {@code null} if absent. | |||
caption | String | Read | Returns the visible caption shown alongside this option ({@code /MK/CA}). |
color | org.aspose.pdf.Color | Read | Returns the border colour ({@code /MK/BC}) used for this option. |
defaultAppearance | String | Read | Returns the {@code /DA} default-appearance string for this option, or |
| null if not set. | |||
appearance | AppearanceDictionary | Read | Returns the typed appearance view over this option’s {@code /AP} |
| sub-dictionary. |
Methods
| Signature | Description |
|---|---|
RadioButtonOptionField(dict: PdfDictionary, page: Page) | Constructs a radio button option from a PDF dictionary. |
RadioButtonOptionField() | Creates a fresh, unattached radio-button option widget. |
RadioButtonOptionField(page: Page, rect: Rectangle) | Creates a fresh radio-button option widget attached to {@code page} with |
| the given rectangle. | |
getOptionValue() → String | Returns the value this option represents. |
getRect() → Rectangle | Returns the rectangle of this option widget. |
getPdfDictionary() → PdfDictionary | Returns the underlying PDF dictionary. |
getStyle() → BoxStyle | Returns the per-option box style. |
setStyle(style: BoxStyle) | Sets the per-option box style. |
getCharacteristics() → AppearanceCharacteristics | Returns typed access to this option’s appearance characteristics |
| ({@code /MK} sub-dictionary on the kid widget). | |
getOptionName() → String | Returns the export value (option name) of this option. |
setOptionName(name: String) | Sets the export value (option name) of this option. |
setWidth(width: double) | Sets the widget width by adjusting the right edge of {@code /Rect}. |
setHeight(height: double) | Sets the widget height by adjusting the top edge of {@code /Rect}. |
getPage() → Page | Returns the page this option’s widget belongs to. |
setRect(rect: Rectangle) | Sets the widget rectangle ({@code /Rect}) by directly writing into the |
| underlying dictionary. | |
getBorder() → org.aspose.pdf.annotations.Border | Returns the border ({@code /BS} dictionary) attached to this option’s |
| widget, or {@code null} if absent. | |
setBorder(border: org.aspose.pdf.annotations.Border) | Sets the border ({@code /BS} sub-dictionary) on this option’s widget. |
getCaption() → String | Returns the visible caption shown alongside this option ({@code /MK/CA}). |
setCaption(caption: String) | Sets the visible caption shown alongside this option ({@code /MK/CA}). |
getColor() → org.aspose.pdf.Color | Returns the border colour ({@code /MK/BC}) used for this option. |
setColor(color: org.aspose.pdf.Color) | Sets the border colour ({@code /MK/BC}) used for this option’s check |
| glyph and outline. | |
getDefaultAppearance() → String | Returns the {@code /DA} default-appearance string for this option, or |
| null if not set. | |
setDefaultAppearance(da: String) | Sets the {@code /DA} default-appearance string raw. |
setDefaultAppearance(da: org.aspose.pdf.annotations.DefaultAppearance) | Convenience overload — accepts a typed {@link org.aspose.pdf.annotations.DefaultAppearance} |
| and serialises it via its {@code toString()}. | |
getAppearance() → AppearanceDictionary | Returns the typed appearance view over this option’s {@code /AP} |
| sub-dictionary. | |
regenerateAppearance() | Rebuilds the {@code /AP/N} appearance streams for this option from its |
| current {@code /Rect}, {@code style} and {@link #getOptionName()}. |
