com.reportmill.shape
Class RMTable

java.lang.Object
  com.reportmill.foundation.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMSplitShape
              com.reportmill.shape.RMTable

All Implemented Interfaces:

java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

public class RMTable

extends com.reportmill.shape.RMSplitShape

Field Summary

static int	DetailsPart
static int	HeaderPart
static int	SummaryPart

Fields inherited from class com.reportmill.shape.RMShape

HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth

Constructor Summary

RMTable()

Method Summary

RMTableRow	addDetails(java.lang.String aKey)
void	addGroupingKey(java.lang.String aKey)
void	addGroupingKey(java.lang.String aKey, int index, RMShape header, RMShape details, RMShape summary)
RMTableRow	addHeader(java.lang.String aKey)
RMTableRow	addSummary(java.lang.String aKey)
java.lang.Object	clone() Standard implementation of Object clone.
void	copy(com.reportmill.foundation.RMObject anObj) Copies applicable attributes from the given object.
boolean	equals(java.lang.Object anObj) Standard implementation of Object equals.
java.lang.Object	fromXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement) XML unarchival.
void	fromXMLDeep(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement) XML unarchival for shape children
float	getColumnSpacing()
boolean	getDoNewRPG() Returns whether table should use new RPG algorithm.
com.reportmill.foundation.RMGrouper	getGrouper()
RMGrouping	getGrouping(int index)
RMGrouping	getGrouping(java.lang.String aKey)
int	getGroupingCount()
java.lang.String	getListKey() Returns the "List Key" associated with this shape.
int	getNumberOfColumns()
int	getPageBreakGroupIndex()
java.lang.Boolean	getPaginate()
RMTableRow	getRow(int anIndex)
RMGrouping	getSelectedGrouping()
int	getSelectedGroupingIndex() Returns the currently selected grouping's index (for editing, mostly).
RMSort	getSelectedSort()
int	getSelectedSortIndex() Returns the currently selected grouping's currently selected sort (for editing, mostly).
boolean	getStartingPageBreak()
void	grouperWillChange()
int	handleAtPoint(RMPoint point, boolean isSuperSelected) Returns the index for the handle at the given point.
boolean	hasPageBreak()
java.lang.Object	initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver) Legacy archival.
void	moveGrouping(int sourceIndex, int destIndex)
RMTableRow	removeDetails(java.lang.String aKey)
void	removeGrouping(RMGrouping aGrouping)
RMTableRow	removeHeader(java.lang.String aKey)
RMTableRow	removeSummary(java.lang.String aKey)
RMShape	rpgClone(com.reportmill.foundation.ReportMill aReportMill) A clone implementation that copies this shape and its children, performing data substituion as well.
void	rpgClonePreprocess(com.reportmill.foundation.ReportMill aReportMill) An rpgClone hook called by RMDocument on all children before anything else.
void	setColumnSpacing(float aValue)
void	setDoNewRPG(boolean aFlag) Returns whether table should use new RPG algorithm.
void	setListKey(java.lang.String aKeyPath) Sets the List Key associated with this shape.
void	setNumberOfColumns(int aValue)
void	setPageBreakGroupIndex(int aValue)
void	setPaginate(java.lang.Boolean aValue)
void	setSelectedGroupingIndex(int anIndex) Sets the currently selected grouping by index (for editing, mostly).
void	setSelectedSortIndex(int anIndex) Sets the currently selected grouping's currently selected sort (for editing, mostly).
RMTableRow	setShowGroupPart(int part, int index, boolean flag)
RMTableRow	setShowGroupPart(int part, java.lang.String aKey, boolean flag)
void	setStartingPageBreak(boolean aFlag)
boolean	showDetailsAtIndex(int index)
boolean	showHeaderAtIndex(int index)
boolean	showSummaryAtIndex(int index)
com.ribs.RXElement	toXML(com.ribs.RXArchiver anArchiver) XML archival.

Methods inherited from class com.reportmill.shape.RMSplitShape

acceptsEvents, addChild, addChildWithTitle, arrangeChildren, canBeUngrouped, childrenSuperSelectImmediately, getChildWithTitle, getTitleForChild, removeChild, resizeBarAtPoint, resizeBarBounds, setHeightDeep, setWidthDeep

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsDragKeys, acceptsFirstEvent, acceptsFormat, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, bringShapesToFront, childHitByPoint, childrenHitByPath, cloneDeep, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, drawChildren, drawsFill, drawsStroke, dropKeyAtPoint, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsOfPath, getBoundsOrigin, getBoundsSize, getBoundsSuperSelected, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildLast, getChildren, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKeyDeep, getListKeyShape, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getY, groupShapes, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, hitChildren, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, page, pageBreakMax, pageBreakPageMax, pageMax, put, reclaimChildren, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setBoundsOrigin, setBoundsOrigin, setBoundsOriginX, setBoundsOriginY, setBoundsSize, setBoundsSize, setChildAnimator, setChildren, setColor, setColor, setDrawsFill, setDrawsStroke, setEverythingStretches, setFill, setFill, setFont, setFormat, setHeight, setHeightDeep, setHeightToFit, setLineWidth, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOnlyBottomAndRightMarginStretches, setOnlyTopAndRightMarginStretches, setOnlyWidthAndHeightStretches, setOpacity, setOrigin, setOrigin, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeDeep, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewXY, setSkewY, setStroke, setStroke, setStrokeColor, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectable, superSelectImmediately, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.foundation.RMObject

archiverClassName, didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

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

Field Detail

HeaderPart

public static int HeaderPart

DetailsPart

public static int DetailsPart

SummaryPart

public static int SummaryPart

Constructor Detail

RMTable

public RMTable()

Method Detail

getListKey

public java.lang.String getListKey()

Description copied from class: RMShape

Returns the "List Key" associated with this shape. A List Key is a key path that specifies a specific list of objects in the document's datasource.

Overrides:

getListKey in class RMShape

setListKey

public void setListKey(java.lang.String aKeyPath)

Description copied from class: RMShape

Sets the List Key associated with this shape. Not all shapes support this (only List Key shapes, like table, graph, crosstab and labels). In fact this default implementation does nothing.

Overrides:

setListKey in class RMShape

getGrouper

public com.reportmill.foundation.RMGrouper getGrouper()

getPaginate

public java.lang.Boolean getPaginate()

setPaginate

public void setPaginate(java.lang.Boolean aValue)

getDoNewRPG

public boolean getDoNewRPG()

Returns whether table should use new RPG algorithm. This should go once we trust new stuff.

setDoNewRPG

public void setDoNewRPG(boolean aFlag)

Returns whether table should use new RPG algorithm. This should go once we trust new stuff.

getPageBreakGroupIndex

public int getPageBreakGroupIndex()

setPageBreakGroupIndex

public void setPageBreakGroupIndex(int aValue)

getStartingPageBreak

public boolean getStartingPageBreak()

setStartingPageBreak

public void setStartingPageBreak(boolean aFlag)

hasPageBreak

public boolean hasPageBreak()

getNumberOfColumns

public int getNumberOfColumns()

setNumberOfColumns

public void setNumberOfColumns(int aValue)

getColumnSpacing

public float getColumnSpacing()

setColumnSpacing

public void setColumnSpacing(float aValue)

getGroupingCount

public int getGroupingCount()

getGrouping

public RMGrouping getGrouping(int index)

getGrouping

public RMGrouping getGrouping(java.lang.String aKey)

getSelectedGrouping

public RMGrouping getSelectedGrouping()

getSelectedSort

public RMSort getSelectedSort()

showHeaderAtIndex

public boolean showHeaderAtIndex(int index)

showDetailsAtIndex

public boolean showDetailsAtIndex(int index)

showSummaryAtIndex

public boolean showSummaryAtIndex(int index)

addGroupingKey

public void addGroupingKey(java.lang.String aKey)

addGroupingKey

public void addGroupingKey(java.lang.String aKey,
                           int index,
                           RMShape header,
                           RMShape details,
                           RMShape summary)

removeGrouping

public void removeGrouping(RMGrouping aGrouping)

moveGrouping

public void moveGrouping(int sourceIndex,
                         int destIndex)

getRow

public RMTableRow getRow(int anIndex)

addHeader

public RMTableRow addHeader(java.lang.String aKey)

removeHeader

public RMTableRow removeHeader(java.lang.String aKey)

addDetails

public RMTableRow addDetails(java.lang.String aKey)

removeDetails

public RMTableRow removeDetails(java.lang.String aKey)

addSummary

public RMTableRow addSummary(java.lang.String aKey)

removeSummary

public RMTableRow removeSummary(java.lang.String aKey)

setShowGroupPart

public RMTableRow setShowGroupPart(int part,
                                   java.lang.String aKey,
                                   boolean flag)

setShowGroupPart

public RMTableRow setShowGroupPart(int part,
                                   int index,
                                   boolean flag)

grouperWillChange

public void grouperWillChange()

getSelectedGroupingIndex

public int getSelectedGroupingIndex()

Returns the currently selected grouping's index (for editing, mostly).

setSelectedGroupingIndex

public void setSelectedGroupingIndex(int anIndex)

Sets the currently selected grouping by index (for editing, mostly).

getSelectedSortIndex

public int getSelectedSortIndex()

Returns the currently selected grouping's currently selected sort (for editing, mostly).

setSelectedSortIndex

public void setSelectedSortIndex(int anIndex)

Sets the currently selected grouping's currently selected sort (for editing, mostly).

handleAtPoint

public int handleAtPoint(RMPoint point,
                         boolean isSuperSelected)

Returns the index for the handle at the given point.

Overrides:

handleAtPoint in class RMShape

rpgClonePreprocess

public void rpgClonePreprocess(com.reportmill.foundation.ReportMill aReportMill)

Description copied from class: RMShape

An rpgClone hook called by RMDocument on all children before anything else.

Overrides:

rpgClonePreprocess in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill aReportMill)

Description copied from class: RMShape

A clone implementation that copies this shape and its children, performing data substituion as well.

Overrides:

rpgClone in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Description copied from class: RMShape

Standard implementation of Object equals.

Overrides:

equals in class RMShape

clone

public java.lang.Object clone()

Description copied from class: RMShape

Standard implementation of Object clone. Null's out shape's parent and children.

copy

public void copy(com.reportmill.foundation.RMObject anObj)

Description copied from class: RMShape

Copies applicable attributes from the given object.

Overrides:

copy in class RMShape

initWithArchiver

public java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)

Legacy archival.

toXML

public com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

public java.lang.Object fromXML(com.ribs.RXArchiver anArchiver,
                                com.ribs.RXElement anElement)

XML unarchival.

Overrides:

fromXML in class RMShape

fromXMLDeep

public void fromXMLDeep(com.ribs.RXArchiver anArchiver,
                        com.ribs.RXElement anElement)

XML unarchival for shape children

Overrides:

fromXMLDeep in class RMShape