public interface PropertiesDoc extends ObjectDoc
Here the layout you may want to use:
[Table # ] + getIntroText() [Table # - ] + getCaptionText() // create table of size getColumnCount() x getRowCount() if getTableName() non null // merge cells (the first head row) and print getColumnNames() // print regular table head getCellValues() // loop [i,j]. In row i: if isRowGroupSubhead() then merge cells
For IEC 61850 tables, we need to support a "table title", and thus 2 heading rows, with both
table title/name and actual column names. That row is present if getTableName()
returns
non-null value.
The method getEntryDocs()
provides the list of individual entries, in case you need
formatting other than table.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INHERITED_FROM
Text to use to indicate inherited members.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getBookmarkIDs()
Returns array of bookmark IDs for every row
i , with potential null entries. |
java.lang.String |
getCaptionText()
Returns text that describes the caption (e.g., "Table 23 - [captionText]").
|
java.lang.String[][] |
getCellValues()
Returns the full table values, including heading rows (table name and column names), any
potential sub-head and the actual rows with values.
|
int |
getColumnCount()
Returns number of columns for the table; must be same as
TableSpec.colCount() from
the columns spec returned by getTableSpec() . |
java.util.List<? extends EntryDoc> |
getDataEntryDocs()
Returns (unmodifiable list of) data entries only.
|
java.util.List<? extends EntryDoc> |
getEntryDocs()
Returns (unmodifiable list of) all entries.
|
TextDescription.TextKind[] |
getFormats()
Returns array of applied formattings for the formattable cells in every row
i . |
int |
getHeadingEntriesCount()
Returns the number of header entries (
EntryDoc.Kind.tableName or
EntryDoc.Kind.columnLabels ) in this instance. |
java.lang.String |
getIntroText()
Returns text that will introduce the table (e.g.
|
int |
getRowCount()
Returns number of rows for the table.
|
EntryDoc.Kind[] |
getRowKinds()
Returns kinds for rows from
getCellValues() . |
java.lang.String |
getTableName()
Returns the name of the table; this will be the first heading row, when non-null.
|
TableSpec |
getTableSpec()
Returns columns specification.
|
boolean |
notEmpty()
Returns whether there are any non-heading entries (
EntryDoc.Kind.groupSubhead or
EntryDoc.Kind.data ) in this instance. |
getBmRegistry, getBookmarkID, getDescription, getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
static final java.lang.String INHERITED_FROM
boolean notEmpty()
EntryDoc.Kind.groupSubhead
or
EntryDoc.Kind.data
) in this instance. Use this one to determine whether to print
table at all.java.lang.String getIntroText()
java.lang.String getCaptionText()
int getHeadingEntriesCount()
EntryDoc.Kind.tableName
or
EntryDoc.Kind.columnLabels
) in this instance.java.util.List<? extends EntryDoc> getEntryDocs()
java.util.List<? extends EntryDoc> getDataEntryDocs()
java.lang.String getTableName()
TableSpec getTableSpec()
getTableName()
is null, labels from the columns
spec (or the corresponding entry) will be the first and only heading row, otherwise the
second heading row.int getRowCount()
int getColumnCount()
TableSpec.colCount()
from
the columns spec returned by getTableSpec()
.java.lang.String[][] getCellValues()
EntryDoc.Kind[] getRowKinds()
getCellValues()
.TextDescription.TextKind[] getFormats()
i
.
If the formattable cell in a row contains no formatting at all, returns null at index
i
. If no row contains formatting, returns null.
The formattable column index j
is always the same for this table, and can be
obtained from TableSpec.getFmtIdx()
. This helps optimise writing content in a format
other than raw text.
java.lang.String[] getBookmarkIDs()
i
, with potential null entries.Copyright 2009-2016 Tatjana (Tanja) Kostic