| com.pnfsoftware.jeb.core.output.table.ITableDocument |
 Known Indirect Subclasses
|
Class Overview
A table document is used to represent tabular data. A unit formatter may choose to provide table documents to clients.
Table documents, similar to ITextDocuments, offer methods to retrieve only parts of
themselves.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract ICellCoordinates |
addressToCoordinates(String address)
Convert a cell address to cell coordinates.
| ||||||||||
| abstract String |
coordinatesToAddress(ICellCoordinates coordinates)
Convert cell coordinates to the cell address.
| ||||||||||
| abstract List<String> |
getColumnLabels()
Get the column labels for this table document.
| ||||||||||
| abstract int |
getRowCount()
Get the number of rows in this table document.
| ||||||||||
| abstract ITableDocumentPart |
getTable()
Get the entire document.
| ||||||||||
| abstract ITableDocumentPart |
getTablePart(int start, int count)
Get a part of the document.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.pnfsoftware.jeb.core.output.IGenericDocument
| |||||||||||
|
From interface
com.pnfsoftware.jeb.util.events.IEventSource
| |||||||||||
Public Methods
public abstract ICellCoordinates addressToCoordinates (String address)
Convert a cell address to cell coordinates.
Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.
Parameters
| address | address of a cell |
|---|
Returns
- coordinates of the cell, null on error
public abstract String coordinatesToAddress (ICellCoordinates coordinates)
Convert cell coordinates to the cell address.
Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.
Parameters
| coordinates | coordinates of a cell |
|---|
Returns
- the address of the cell, null on error
public abstract List<String> getColumnLabels ()
Get the column labels for this table document.
Returns
- the column labels
public abstract int getRowCount ()
Get the number of rows in this table document.
Returns
- the number of rows
public abstract ITableDocumentPart getTable ()
Get the entire document.
Returns
- a part representing the entire document
public abstract ITableDocumentPart getTablePart (int start, int count)
Get a part of the document.
Parameters
| start | starting row index |
|---|---|
| count | number of rows to be returned |
Returns
- the part