com.objex.panywhere.subtext
Class TableSubtextLegendItem

java.lang.Object
  extended by com.objex.panywhere.SubtextLegendItem
      extended by com.objex.panywhere.subtext.TableSubtextLegendItem
All Implemented Interfaces:
ComparableLegendItem, java.io.Serializable

public class TableSubtextLegendItem
extends SubtextLegendItem
implements java.io.Serializable

TableSubtextLegendItem represents the legend text for data that is linked to complex table fields. This means that the subtext item will have N rows, where N is the maximum number of rows that will be rendered per person on the subtext legend.
One subtext line will be rendered on first row of the table subtext legend item while the remainder of the rows will have a blank as the subtext legend text.

See Also:
TableData, Serialized Form

Nested Class Summary
static class TableSubtextLegendItem.Row
          Row defines a single row of subtext legend item in a TableSubtextItem.
 
Nested classes/interfaces inherited from class com.objex.panywhere.SubtextLegendItem
SubtextLegendItem.MultiColumnSubtextLegendItem
 
Field Summary
 
Fields inherited from class com.objex.panywhere.SubtextLegendItem
PROP_SAMPLE_PROPERTY
 
Constructor Summary
TableSubtextLegendItem()
          Creates a new TableSubtextLegendItem instance
 
Method Summary
 void addSubItem(int ai_rrn, SubtextLegendItem a_item)
          Add a subjext legend item using the specified relative record number.
 void addSubItem(TableSubtextLegendItem.Row a_row)
          Add subitems for legend items that represent a table.
 int getRowCount()
           
 java.util.Map<java.lang.Integer,TableSubtextLegendItem.Row> getSubitemRows()
           
 void setSubitemRows(java.util.Map<java.lang.Integer,TableSubtextLegendItem.Row> subitems)
          Sets new map of Row objects each representing a row of subtext legend item data.
 
Methods inherited from class com.objex.panywhere.SubtextLegendItem
addCondition, addPropertyChangeListener, getColumn, getConditions, getFieldid, getLegendDisplayText, getOrder, getRow, getRrn, getSampleProperty, getTableid, hasConditions, removePropertyChangeListener, setColumn, setConditions, setFieldid, setLegendDisplayText, setOrder, setRow, setRowCount, setRrn, setSampleProperty, setTableid, toConditionsMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableSubtextLegendItem

public TableSubtextLegendItem()
Creates a new TableSubtextLegendItem instance

Method Detail

getRowCount

public int getRowCount()
Overrides:
getRowCount in class SubtextLegendItem
Returns:
The number of table rows (max) represented by this table subtext. This number must match the maximum number of rows of TableData rows any person has in the pedigree.

addSubItem

public void addSubItem(TableSubtextLegendItem.Row a_row)
Add subitems for legend items that represent a table. Each Item added will represent a ROW depening on the table's maxtablerowcount

Parameters:
a_row - The new Row with subtext legend items.

addSubItem

public void addSubItem(int ai_rrn,
                       SubtextLegendItem a_item)
Add a subjext legend item using the specified relative record number.

Parameters:
ai_rrn - RRN is just a unique number identifiying the row
a_item - Subject item being added

getSubitemRows

public java.util.Map<java.lang.Integer,TableSubtextLegendItem.Row> getSubitemRows()
Returns:
A map of Row objects each representing a row of subtext legend item data.

setSubitemRows

public void setSubitemRows(java.util.Map<java.lang.Integer,TableSubtextLegendItem.Row> subitems)
Sets new map of Row objects each representing a row of subtext legend item data.

Parameters:
subitems - The new map of Row objects each representing a row of subtext legend item data.