com.objex.panywhere
Class SubtextLegendItem.MultiColumnSubtextLegendItem

java.lang.Object
  extended by com.objex.panywhere.SubtextLegendItem
      extended by com.objex.panywhere.SubtextLegendItem.MultiColumnSubtextLegendItem
All Implemented Interfaces:
ComparableLegendItem, java.io.Serializable
Enclosing class:
SubtextLegendItem

public static class SubtextLegendItem.MultiColumnSubtextLegendItem
extends SubtextLegendItem

A subtext legend item for complex multi-column subtext items. This is usually required for subtext that corresponds to subfields of a table field. The ROW NUMBER for multi-column subtext items are the same so that when rendered below a person's icon, the columns will be displayed on one row, each subsequent column(as determined by relative column number) to the right of the one before it.

See Also:
Serialized Form

Nested Class Summary
 
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
SubtextLegendItem.MultiColumnSubtextLegendItem()
          Creates new MultiColumnSubtextLegendItem
 
Method Summary
 void addItem(SubtextLegendItem a_item)
          Add a subtext legend item to this multi-column legend item
 java.util.List<SubtextLegendItem> getColumns()
           
 int getRownumber()
           
 java.util.Iterator<SubtextLegendItem> iterator()
           
 void setColumns(java.util.List<SubtextLegendItem> a_columns)
          Set the new list of subtext legend items with each element representing a column
 void setRownumber(int ai_row)
          Set the new row number corresponding to the order or row number for this aggregate item.
 
Methods inherited from class com.objex.panywhere.SubtextLegendItem
addCondition, addPropertyChangeListener, getColumn, getConditions, getFieldid, getLegendDisplayText, getOrder, getRow, getRowCount, 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

SubtextLegendItem.MultiColumnSubtextLegendItem

public SubtextLegendItem.MultiColumnSubtextLegendItem()
Creates new MultiColumnSubtextLegendItem

Method Detail

addItem

public void addItem(SubtextLegendItem a_item)
Add a subtext legend item to this multi-column legend item

Parameters:
a_item - A new legend item to be added. The ROW number and fieldid must be set on this item before its added

getColumns

public java.util.List<SubtextLegendItem> getColumns()
Returns:
A list of subtext legend items with each element representing a column

setColumns

public void setColumns(java.util.List<SubtextLegendItem> a_columns)
Set the new list of subtext legend items with each element representing a column

Parameters:
a_columns - The new list of subtext legend items for a single row

getRownumber

public int getRownumber()
Returns:
The row number corresponding to the order or row number for this aggregate item. All subtext items on this row will share this row number and hence will be rendered on the same line. This relates only to multi-column items

setRownumber

public void setRownumber(int ai_row)
Set the new row number corresponding to the order or row number for this aggregate item. All subtext items on this row will share this row number and hence will be rendered on the same line. This relates only to multi-column items

Parameters:
ai_row - New row or order number

iterator

public java.util.Iterator<SubtextLegendItem> iterator()
Returns:
An iterator of subtext legend items representing each column on a row