Method
| Return type
| Brief description
|
appendHorizontalRule()
| HorizontalRule
| Creates and appends a new
HorizontalRule
.
|
appendImage(image)
| InlineImage
| Creates and appends a new
InlineImage
from the specified image blob.
|
appendImage(image)
| InlineImage
| Appends the given
InlineImage
.
|
appendListItem(listItem)
| ListItem
| Appends the given
ListItem
.
|
appendListItem(text)
| ListItem
| Creates and appends a new
ListItem
containing the specified text contents.
|
appendParagraph(paragraph)
| Paragraph
| Appends the given
Paragraph
.
|
appendParagraph(text)
| Paragraph
| Creates and appends a new
Paragraph
containing the specified text contents.
|
appendTable()
| Table
| Creates and appends a new
Table
.
|
appendTable(cells)
| Table
| Appends a new
Table
containing a
TableCell
for each specified string value.
|
appendTable(table)
| Table
| Appends the given
Table
.
|
clear()
| FooterSection
| Clears the contents of the element.
|
copy()
| FooterSection
| Returns a detached, deep copy of the current element.
|
editAsText()
| Text
| Obtains a
Text
version of the current element, for editing.
|
findElement(elementType)
| RangeElement
| Searches the contents of the element for a descendant of the specified type.
|
findElement(elementType, from)
| RangeElement
| Searches the contents of the element for a descendant of the specified type, starting from the
specified
RangeElement
.
|
findText(searchPattern)
| RangeElement
| Searches the contents of the element for the specified text pattern using regular expressions.
|
findText(searchPattern, from)
| RangeElement
| Searches the contents of the element for the specified text pattern, starting from a given
search result.
|
getAttributes()
| Object
| Retrieves the element's attributes.
|
getChild(childIndex)
| Element
| Retrieves the child element at the specified child index.
|
getChildIndex(child)
| Integer
| Retrieves the child index for the specified child element.
|
getImages()
| InlineImage[]
| Retrieves all the
InlineImages
contained in the section.
|
getListItems()
| ListItem[]
| Retrieves all the
ListItems
contained in the section.
|
getNumChildren()
| Integer
| Retrieves the number of children.
|
getParagraphs()
| Paragraph[]
| Retrieves all the
Paragraphs
contained in the section (including
ListItems
).
|
getParent()
| ContainerElement
| Retrieves the element's parent element.
|
getTables()
| Table[]
| Retrieves all the
Tables
contained in the section.
|
getText()
| String
| Retrieves the contents of the element as a text string.
|
getTextAlignment()
| TextAlignment
| Gets the text alignment.
|
getType()
| ElementType
| Retrieves the element's
ElementType
.
|
insertHorizontalRule(childIndex)
| HorizontalRule
| Creates and inserts a new
HorizontalRule
at the specified index.
|
insertImage(childIndex, image)
| InlineImage
| Creates and inserts an
InlineImage
from the specified image blob, at the specified
index.
|
insertImage(childIndex, image)
| InlineImage
| Inserts the given
InlineImage
at the specified index.
|
insertListItem(childIndex, listItem)
| ListItem
| Inserts the given
ListItem
at the specified index.
|
insertListItem(childIndex, text)
| ListItem
| Creates and inserts a new
ListItem
at the specified index, containing the specified
text contents.
|
insertParagraph(childIndex, paragraph)
| Paragraph
| Inserts the given
Paragraph
at the specified index.
|
insertParagraph(childIndex, text)
| Paragraph
| Creates and inserts a new
Paragraph
at the specified index, containing the specified
text contents.
|
insertTable(childIndex)
| Table
| Creates and inserts a new
Table
at the specified index.
|
insertTable(childIndex, cells)
| Table
| Creates and inserts a new
Table
containing the specified cells, at the specified index.
|
insertTable(childIndex, table)
| Table
| Inserts the given
Table
at the specified index.
|
removeChild(child)
| FooterSection
| Removes the specified child element.
|
removeFromParent()
| FooterSection
| Removes the element from its parent.
|
replaceText(searchPattern, replacement)
| Element
| Replaces all occurrences of a given text pattern with a given replacement string, using regular
expressions.
|
setAttributes(attributes)
| FooterSection
| Sets the element's attributes.
|
setText(text)
| FooterSection
| Sets the contents as plain text.
|
setTextAlignment(textAlignment)
| FooterSection
| Sets the text alignment.
|