Package org.odftoolkit.odfdom.changes

Class Table<T>

java.lang.Object

org.odftoolkit.odfdom.changes.Component

org.odftoolkit.odfdom.changes.Table<T>

public class Table<T>
extends Component

A MultiCoomponent uses a single XML element to represent multiple components. This container can be used for spreadsheet row and cell components using repeated elements via an attribute.

Author:

svante.schubertATgmail.com

Field Summary

Fields

Modifier and Type	Field	Description
static int	ETERNITY	Used to indicate that the end position is not existing
static Integer	MAX_COLUMN_NUMBER_CALC	The maximal number of columns being generated.
static Integer	MAX_COLUMN_NUMBER_EXCEL
static Integer	MAX_ROW_NUMBER	The maximal number of rows being generated.

Fields inherited from class org.odftoolkit.odfdom.changes.Component

mRootElement

Constructor Summary

Constructors

Constructor	Description
Table(OdfElement componentElement, Component parent)

Method Summary

Modifier and Type	Method	Description
void	addChild(int index, Component c)	Adds the given component to the root element
static List<Integer>	collectColumnWidths(TableTableElement tableElement, List<TableTableColumnElement> columns)
Node	getChildNode(int index)
List	getChildren()
org.json.JSONArray	getPosition()
static String	getProperty(OdfStyleProperty prop, OdfStylableElement element)
static List<TableTableColumnElement>	getTableColumnElements(Element parent, List columns)	Returns all TableTableColumn descendants that exist within the tableElement, even within groups, columns and header elements
void	hasChangedWidth()
boolean	isWidthChangeRequired()
org.json.JSONArray	popTableGrid()
void	pushTableGrid(List<Integer> columnWidths)
void	pushTableGrid(org.json.JSONArray tableGrid)	OH PLEASE DELETE ME AFTER THE API WAS FIXED
Node	remove(int index)	Removes a component from the text element container.
int	repetition()	A multiple components can be represented by a single XML element
void	replaceLastTableGrid(org.json.JSONArray tableGrid)
void	requireLaterWidthChange(org.json.JSONArray start)
int	size()	All children of the root element will be traversed.

Methods inherited from class org.odftoolkit.odfdom.changes.Component

createChildComponent, createChildComponent, createComponent, get, get, getAllStyleGroupingIdProperties, getAllStyleGroupingIdProperties, getChildNode, getCorrectStartElementOfChild, getFamily, getFamilyDisplayName, getFamilyID, getFamilyID, getFamilyName, getLastChild, getMainStyleGroupingId, getMainStyleGroupingId, getNextSiblingOf, getOwnerDocument, getParent, getParentOf, getPosition, getPositionString, getRootComponent, getRootElement, getStyleNamePrefix, getStyleNamePrefix, hasRepeated, hasRepeated, indexOf, isComponentRoot, isComponentRoot, isComponentWrapper, isComponentWrapper, isCoveredComponentRoot, isDocumentRoot, isField, isFooterRoot, isHeaderRoot, isRowComponentRoot, isRowComponentRoot, isShapeElement, isTextComponentRoot, isTextComponentRoot, isTextSelection, isWhiteSpaceElement, toString

Methods inherited from class java.lang.Object

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

Field Detail

ETERNITY

public static final int ETERNITY

Used to indicate that the end position is not existing

See Also:

Constant Field Values

MAX_ROW_NUMBER

public static final Integer MAX_ROW_NUMBER

The maximal number of rows being generated. Unspecified by ODF but commonly used. Counting starts with 0.

MAX_COLUMN_NUMBER_CALC

public static final Integer MAX_COLUMN_NUMBER_CALC

The maximal number of columns being generated. Unspecified by ODF but commonly used. Counting starts with 0.

MAX_COLUMN_NUMBER_EXCEL

public static final Integer MAX_COLUMN_NUMBER_EXCEL

Constructor Detail

Table

public Table(OdfElement componentElement,
             Component parent)

Method Detail

repetition

public int repetition()

A multiple components can be represented by a single XML element

Overrides:

repetition in class Component

Returns:

the number of components the elements represents

getChildren

public List getChildren()

Overrides:

getChildren in class Component

addChild

public void addChild(int index,
                     Component c)

Adds the given component to the root element

Overrides:

addChild in class Component

Parameters:

c - the component of the row to be added

index - starting with 0 representing the position of the child, if -1 the new child will be appended

getChildNode

public Node getChildNode(int index)

Overrides:

getChildNode in class Component

Parameters:

index - the position of the row being returned

Returns:

either a text node of size 1 or an element being the root element of a component

remove

public Node remove(int index)

Removes a component from the text element container. Removes either an element representing a component or text node of size 1

Overrides:

remove in class Component

Parameters:

index - row position to be removed

Returns:

the row being removed

size

public int size()

All children of the root element will be traversed. If it is a text node the size is added, if it is an element and a component a size of one is added, if it is a marker, for known text marker elements (text:span, text:bookmark) the children are recursive checked

Overrides:

size in class Component

Returns:

the number of child components

getProperty

public static String getProperty(OdfStyleProperty prop,
                                 OdfStylableElement element)

Returns:

a property value.

collectColumnWidths

public static List<Integer> collectColumnWidths(TableTableElement tableElement,
                                                List<TableTableColumnElement> columns)

getTableColumnElements

public static List<TableTableColumnElement> getTableColumnElements(Element parent,
                                                                   List columns)

Returns all TableTableColumn descendants that exist within the tableElement, even within groups, columns and header elements

pushTableGrid

public void pushTableGrid(org.json.JSONArray tableGrid)

OH PLEASE DELETE ME AFTER THE API WAS FIXED

requireLaterWidthChange

public void requireLaterWidthChange(org.json.JSONArray start)

isWidthChangeRequired

public boolean isWidthChangeRequired()

hasChangedWidth

public void hasChangedWidth()

getPosition

public org.json.JSONArray getPosition()

pushTableGrid

public void pushTableGrid(List<Integer> columnWidths)

popTableGrid

public org.json.JSONArray popTableGrid()

replaceLastTableGrid

public void replaceLastTableGrid(org.json.JSONArray tableGrid)