FormFieldParagraph
Overview
FormFieldParagraph is a class in Aspose.PDF FOSS for Java.
Inherits from: BaseParagraph.
{@link BaseParagraph} adapter that lets form-field widgets participate in paragraph-based collections such as {@link Cell#getParagraphs()}, {@link Page#getParagraphs()} and {@link FloatingBox#getParagraphs()}.
This class provides 18 methods for working with FormFieldParagraph objects in Java programs.
Available methods include: FormFieldParagraph, asField, asOption, getField, getHorizontalAlignment, getHyperlink, getMargin, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, and 6 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: field, firstParagraphInColumn, horizontalAlignment, hyperlink, inLineParagraph, inNewPage, and 2 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
field | Object | Read | Returns the wrapped form field. |
margin | MarginInfo | Read | Gets the margin information for this paragraph. |
horizontalAlignment | HorizontalAlignment | Read | Gets the horizontal alignment of this paragraph within its container. |
inLineParagraph | boolean | Read | Returns whether this paragraph is an inline element. |
keptWithNext | boolean | Read | Returns whether this paragraph should be kept together with the next paragraph |
| on the same page during layout. | |||
firstParagraphInColumn | boolean | Read | Returns whether this paragraph is the first in its column. |
inNewPage | boolean | Read | Returns whether this paragraph should start on a new page during layout. |
hyperlink | Hyperlink | Read | Returns the hyperlink attached to this paragraph (web, local or file |
| target), or {@code null} if the paragraph is not clickable. |
Methods
| Signature | Description |
|---|---|
FormFieldParagraph(field: Field) | Wraps a {@link Field} subclass (e.g. |
FormFieldParagraph(option: RadioButtonOptionField) | Wraps a {@link RadioButtonOptionField} option. |
getField() → Object | Returns the wrapped form field. |
asField() → Field | Convenience: returns the wrapped object as a {@link Field}, or null if |
| it is a {@link RadioButtonOptionField} (which does not extend Field). | |
asOption() → RadioButtonOptionField | Convenience: returns the wrapped object as a {@link RadioButtonOptionField}, |
| or null if it is a {@link Field} subclass. | |
getMargin() → MarginInfo | Gets the margin information for this paragraph. |
setMargin(margin: MarginInfo) | Sets the margin information for this paragraph. |
getHorizontalAlignment() → HorizontalAlignment | Gets the horizontal alignment of this paragraph within its container. |
setHorizontalAlignment(horizontalAlignment: HorizontalAlignment) | Sets the horizontal alignment of this paragraph within its container. |
isInLineParagraph() → boolean | Returns whether this paragraph is an inline element. |
setInLineParagraph(inLineParagraph: boolean) | Sets whether this paragraph should be treated as an inline element. |
isKeptWithNext() → boolean | Returns whether this paragraph should be kept together with the next paragraph |
| on the same page during layout. | |
setKeptWithNext(keptWithNext: boolean) | Sets whether this paragraph should be kept together with the next paragraph |
| on the same page during layout. | |
isFirstParagraphInColumn() → boolean | Returns whether this paragraph is the first in its column. |
setFirstParagraphInColumn(firstParagraphInColumn: boolean) | Sets whether this paragraph is the first in its column. |
isInNewPage() → boolean | Returns whether this paragraph should start on a new page during layout. |
setInNewPage(inNewPage: boolean) | Sets whether this paragraph should start on a new page during layout. |
getHyperlink() → Hyperlink | Returns the hyperlink attached to this paragraph (web, local or file |
| target), or {@code null} if the paragraph is not clickable. | |
setHyperlink(hyperlink: Hyperlink) | Attaches a hyperlink to this paragraph. |