Package com.storedobject.office

Class ODT.TextElement

java.lang.Object

com.storedobject.office.ODT.Element

com.storedobject.office.ODT.TextElement

Direct Known Subclasses:

ODT.Document, ODT.Section, ODT.TableCell

Enclosing class:

ODT<T>

public abstract static class ODT.TextElement
extends ODT.Element

Represents a text element that can contain one or more sections and tables.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
ODT.Image	getImage(int index)	Retrieves an Image from the list of images present in this instance at the specified index.
ODT.Image	getImage(String name)	Retrieves an image by its name from the list of images associated with this instance.
int	getImagesCount()	Retrieves the total number of images associated with this instance.
ODT.Section	getSection(int index)	Retrieves a section under this at the specified index.
ODT.Section	getSection(String name)	Retrieves a section under this by its name.
int	getSectionCount()	Get the number of sections under this.
ODT.Table	getTable(int index)	Retrieves a table under this by its index.
ODT.Table	getTable(String name)	Retrieves a Table under this with the specified name.
int	getTableCount()	Retrieves the total number of tables present under this instance.
boolean	remove()	Removes this element from the output.

Methods inherited from class com.storedobject.office.ODT.Element

getCell, getDocument, getName, getParent, getParentCell, getParentRow, getParentSection, getParentTable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getImagesCount

public int getImagesCount()

Retrieves the total number of images associated with this instance. If the image list has not been initialized, it will be built prior to retrieval.

Returns:

The number of images available. Returns 0 if there are no images.

getImage

public ODT.Image getImage(int index)

Retrieves an Image from the list of images present in this instance at the specified index. If the image list has not been initialized, it will be built before accessing the image.

Parameters:

index - The zero-based index of the Image to retrieve. Must be within the range of existing images (0 to the number of images - 1).

Returns:

The Image at the specified index, or null if the index is out of bounds or the image cannot be retrieved.

getImage

public ODT.Image getImage(String name)

Retrieves an image by its name from the list of images associated with this instance. If the image list is not initialized, it will be built prior to the retrieval operation.

Parameters:

name - The name of the image to retrieve. Must not be null.

Returns:

The Image object with the specified name, or null if no image with the given name exists.

getSectionCount

public int getSectionCount()

Get the number of sections under this.

Returns:

Number of sections.

getSection

public ODT.Section getSection(int index)

Retrieves a section under this at the specified index.

Parameters:

index - The index of the section to be retrieved. Must be a zero-based index.

Returns:

The Section at the specified index, or null if the index is invalid or the section list is empty.

getSection

public ODT.Section getSection(String name)

Retrieves a section under this by its name.

Parameters:

name - The name of the section to retrieve.

Returns:

The Section with the specified name, or null if no matching section is found.

getTableCount

public int getTableCount()

Retrieves the total number of tables present under this instance.

Returns:

The number of tables available. If there are no tables, it returns 0.

getTable

public ODT.Table getTable(int index)

Retrieves a table under this by its index.

Parameters:

index - The zero-based index of the table to retrieve. Must be within the range of existing tables (0 to the number of tables - 1).

Returns:

The ODT.Table at the specified index, or null if the index is out of bounds or the table cannot be retrieved.

getTable

public ODT.Table getTable(String name)

Retrieves a Table under this with the specified name.

Parameters:

name - the name of the table to be retrieved; must not be null.

Returns:

the Table object with the specified name, or null if no table with the given name exists.

remove

public boolean remove()

Description copied from class: ODT.Element

Removes this element from the output.

Overrides:

remove in class ODT.Element

Returns:

Returns true unless the element was already removed.