com.reportmill.shape

Class RMCrossTab

java.lang.Object

com.reportmill.base.RMListenerList

com.reportmill.base.RMObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMCrossTab

All Implemented Interfaces:

DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMCrossTab
extends RMShape

Manages a table of RMCells, which is really a stack of RMCellRows.

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
RMCrossTab() Creates a new crosstab.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(int anIndex, int refColumn, int refRow) Adds a column at the given index.
void	addColumnDivider(double anX) Adds a column divider at the given x coordinate.
void	addRow(int anIndex, int refRow, int refColumn) Adds a row at the given index.
void	addRowDivider(double aY) Adds a row divider at the given y coordinate.
RMCrossTab	clone() Standard clone implementation.
RMCrossTab	cloneDeep() Clone deep.
RMShapeLayout	createLayout() Overrides shape implementation to create a crosstab layout.
RMShape	divideShapeFromTop(float anAmount) Divides the shape by a given amount from the top.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival generic - break fromXML into fromXMLShape and fromXMLShapeChildren.
java.lang.Object	fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
RMCrossTabCell	getCell(int aRow, int aColumn) Returns the cell at the given row and column indexes.
java.awt.Rectangle	getCellRect(java.awt.geom.Rectangle2D aRect) Returns the cell rect for the given rectangle2d.
int	getColumn(double anX) Returns the specific column index for the given point.
RMCrossTabColumn	getColumn(int anIndex) Returns the specific column at the given index.
int	getColumnCount() Returns the number of rows for this table.
java.lang.String	getDatasetKey() Returns the dataset key.
java.lang.String	getFilterKey() Returns the optional key chain expression string used to prune the table list derived from dataset key.
int	getHeaderColumnCount() Returns the number header columns for table.
int	getHeaderRowCount() Returns the number of header rows for table.
java.util.List	getObjects() Returns objects (bogus implementation to indicate Objects property type).
int	getRow(double aY) Returns the specific row index for the given point.
RMCrossTabRow	getRow(int anIndex) Returns the specific row at the given index.
int	getRowCount() Returns the number of rows.
void	mergeCells(int aRow1, int aCol1, int aRow2, int aCol2) Merges a range of cells into one cell.
void	removeColumn(int anIndex) Removes the column at the given index.
void	removeRow(int anIndex) Removes the row at the given index.
void	reset(RMCrossTabCell[][] newCells, java.util.List rows, java.util.List cols, int rowHeaders, int colHeaders) Resets the table given a new list of cells, rows & columns.
void	setColumnCount(int aColumnCount) Sets the number of columns for this table.
void	setDatasetKey(java.lang.String aKey) Sets the dataset key.
void	setFilterKey(java.lang.String aKeyExpr) Sets the optional key chain expression string used to prune the table list derived from dataset key.
void	setHeaderColumnCount(int aCount) Sets the number header columns for table.
void	setHeaderRowCount(int aCount) Sets the number of header rows for table.
void	setObjects(java.util.List aList) Sets objects.
void	setObjectsAndReportMill(java.util.List aList, ReportMill aReportMill) Sets objects.
void	setReportMill(ReportMill aReportMill) Sets a reportmill for this crosstab (which really gets the dataset and calls setObjects).
void	setReportMillDeep(ReportMill aReportMill) Override to stifle child rpg.
void	setRowCount(int aRowCount) Sets the number of rows.
void	splitCellIntoColumns(RMCrossTabCell aCell) Splits a cell into 2 columns through it's mid point.
void	splitCellIntoRows(RMCrossTabCell aCell) Splits a cell into 2 rows through it's mid point.
com.reportmill.archiver.RXElement	toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.
void	toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML archival - override to suppress archival of children.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addAction, addActions, addBinding, addChild, addChild, addChild, addChild, addDeepChangeListener, addListener, addMouseListener, animUpdate, bounds, bringShapesToFront, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, createPartClone, deepChange, divideShapeFromEdge, doLayout, fromXMLShapeChildren, fromXMLShapeLayout, get, get, getAction, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestSize, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getImageFill, getLayout, getLayout, getLayoutInfo, getLineWidth, getMaskPath, getMaximumSize, getMaximumSizeProperty, getMaxX, getMaxY, getMinimumSize, getMinimumSizeProperty, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getPreferredSize, getPreferredSize, getPreferredSizeProperty, getPropertyNameMapped, getPropertyNames, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isHittable, isHittableChild, isLocked, isMaximumSizeSet, isMinimumSizeSet, isRoot, isRSS, isShowing, isUnderlined, isViewing, isVisible, isVisibleChild, layoutReset, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShape, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeAction, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBestSize, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHover, setLayout, setLayoutInfo, setLineWidth, setLocked, setMaximumSize, setMinimumSize, setName, setOpacity, setOutline, setParent, setPreferredSize, setReportMillBindings, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSizeP, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, superSelectable, toString, toXML, toXMLShapeLayout, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from class com.reportmill.base.RMListenerList

getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMCrossTab

public RMCrossTab()

Creates a new crosstab.

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows.

getRow

public RMCrossTabRow getRow(int anIndex)

Returns the specific row at the given index.

getColumnCount

public int getColumnCount()

Returns the number of rows for this table.

getColumn

public RMCrossTabColumn getColumn(int anIndex)

Returns the specific column at the given index.

getCell

public RMCrossTabCell getCell(int aRow,
                     int aColumn)

Returns the cell at the given row and column indexes.

getRow

public int getRow(double aY)

Returns the specific row index for the given point.

getColumn

public int getColumn(double anX)

Returns the specific column index for the given point.

getCellRect

public java.awt.Rectangle getCellRect(java.awt.geom.Rectangle2D aRect)

Returns the cell rect for the given rectangle2d.

addRow

public void addRow(int anIndex,
          int refRow,
          int refColumn)

Adds a row at the given index. If reference row index is provided, the referenced row object is copied for new row. If reference column index is provided, previous columns cells are merged, successive column cells are cloned.

removeRow

public void removeRow(int anIndex)

Removes the row at the given index.

addColumn

public void addColumn(int anIndex,
             int refColumn,
             int refRow)

Adds a column at the given index. If reference column index is provided, the referenced column object is copied for new column. If reference row index is provided, previous row cells are merged, successive row cells are cloned.

removeColumn

public void removeColumn(int anIndex)

Removes the column at the given index.

setRowCount

public void setRowCount(int aRowCount)

Sets the number of rows.

setColumnCount

public void setColumnCount(int aColumnCount)

Sets the number of columns for this table.

getHeaderRowCount

public int getHeaderRowCount()

Returns the number of header rows for table.

setHeaderRowCount

public void setHeaderRowCount(int aCount)

Sets the number of header rows for table.

getHeaderColumnCount

public int getHeaderColumnCount()

Returns the number header columns for table.

setHeaderColumnCount

public void setHeaderColumnCount(int aCount)

Sets the number header columns for table.

getDatasetKey

public java.lang.String getDatasetKey()

Returns the dataset key.

Overrides:

getDatasetKey in class RMShape

setDatasetKey

public void setDatasetKey(java.lang.String aKey)

Sets the dataset key.

getFilterKey

public java.lang.String getFilterKey()

Returns the optional key chain expression string used to prune the table list derived from dataset key.

setFilterKey

public void setFilterKey(java.lang.String aKeyExpr)

Sets the optional key chain expression string used to prune the table list derived from dataset key.

addColumnDivider

public void addColumnDivider(double anX)

Adds a column divider at the given x coordinate.

addRowDivider

public void addRowDivider(double aY)

Adds a row divider at the given y coordinate.

splitCellIntoColumns

public void splitCellIntoColumns(RMCrossTabCell aCell)

Splits a cell into 2 columns through it's mid point.

splitCellIntoRows

public void splitCellIntoRows(RMCrossTabCell aCell)

Splits a cell into 2 rows through it's mid point.

mergeCells

public void mergeCells(int aRow1,
              int aCol1,
              int aRow2,
              int aCol2)

Merges a range of cells into one cell.

createLayout

public RMShapeLayout createLayout()

Overrides shape implementation to create a crosstab layout.

setReportMill

public void setReportMill(ReportMill aReportMill)

Sets a reportmill for this crosstab (which really gets the dataset and calls setObjects).

Overrides:

setReportMill in class RMShape

setReportMillDeep

public void setReportMillDeep(ReportMill aReportMill)

Override to stifle child rpg.

Overrides:

setReportMillDeep in class RMShape

getObjects

public java.util.List getObjects()

Returns objects (bogus implementation to indicate Objects property type).

setObjects

public void setObjects(java.util.List aList)

Sets objects.

setObjectsAndReportMill

public void setObjectsAndReportMill(java.util.List aList,
                           ReportMill aReportMill)

Sets objects.

divideShapeFromTop

public RMShape divideShapeFromTop(float anAmount)

Divides the shape by a given amount from the top. Returns a clone of the given shape with bounds set to the remainder. Divies children among the two shapes (recursively calling divide shape for those stradling).

Overrides:

divideShapeFromTop in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

clone

public RMCrossTab clone()

Standard clone implementation.

Overrides:

clone in class RMShape

cloneDeep

public RMCrossTab cloneDeep()

Clone deep.

Overrides:

cloneDeep in class RMShape

toXMLShape

public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                           java.lang.Object anOwner)

XML archival.

Overrides:

toXMLShape in class RMShape

toXMLShapeChildren

public void toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                      com.reportmill.archiver.RXElement anElement,
                      java.lang.Object anOwner)

XML archival - override to suppress archival of children.

Overrides:

toXMLShapeChildren in class RMShape

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                       com.reportmill.archiver.RXElement anElement,
                       java.lang.Object anOwner)

XML unarchival generic - break fromXML into fromXMLShape and fromXMLShapeChildren.

Overrides:

fromXML in class RMShape

fromXMLShape

public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                            com.reportmill.archiver.RXElement anElement,
                            java.lang.Object anOwner)

XML unarchival.

Overrides:

fromXMLShape in class RMShape

reset

public void reset(RMCrossTabCell[][] newCells,
         java.util.List rows,
         java.util.List cols,
         int rowHeaders,
         int colHeaders)

Resets the table given a new list of cells, rows & columns.