com.inductiveautomation.rm.shape

Class RMCrossTabFrame

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMParentShape

com.inductiveautomation.rm.shape.RMCrossTabFrame

All Implemented Interfaces:

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

public class RMCrossTabFrame
extends RMParentShape

This class wraps a shape around a crosstab to constrain the crosstab's bounds to a region on the page. It also provides support for paginating to multiple pages.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Constructor Summary

Constructors

Constructor and Description
RMCrossTabFrame() Creates a new crosstab.

Method Summary

Modifier and Type	Method and Description
boolean	childrenSuperSelectImmediately() Editor method.
protected double	computePrefHeight(double aWidth) Override to return preferred height of table.
protected RMCrossTab	createTable() Creates the RMCrossTab.
protected void	fromXMLShape(RXArchiver anArchiver, RXElement anElement) XML Unarchival.
int	getColumnCount()
java.lang.String	getDatasetKey() Returns the dataset key associated with this shape.
java.lang.String	getFilterKey()
int	getFormatStyle()
int	getHeaderColumnCount()
int	getHeaderRowCount()
boolean	getReprintHeaderRows() Returns whether a paginating table will reprint header rows.
int	getRowCount()
RMCrossTab	getTable() Returns the crosstab associated with this crosstab.
boolean	isDeletable() Override this for shapes (like a table row) that don't don't make sense to delete by themselves.
void	paintShape(RMShapePainter g) Paints crosstab.
RMShape	rpgAll(ReportOwner anRptOwner, RMShape aParent) Override to constrain child crosstab to frame.
void	setColumnCount(int cols)
void	setDatasetKey(java.lang.String key)
void	setFilterKey(java.lang.String filterKey)
void	setFormatStyle(int formatStyle) note -- any changes to these styles or their ordering need to also be made to RMCrosstab.
void	setHeaderColumnCount(int colHeaders)
void	setHeaderRowCount(int rows)
void	setReprintHeaderRows(boolean aFlag) Sets whether a paginating table will reprint header rows.
void	setRowCount(int rows)
protected RXElement	toXMLShape(RXArchiver anArchiver) XML Archival.

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape

addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, clone, cloneDeep, computePrefWidth, divideShapeFromTop, fromXML, fromXMLChildren, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, layoutChildren, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML, toXMLChildren

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getChildClipShape, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDisplayedFill, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgBindings, rpgShape, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMCrossTabFrame

public RMCrossTabFrame()

Creates a new crosstab.

Method Detail

getTable

public RMCrossTab getTable()

Returns the crosstab associated with this crosstab.

createTable

protected RMCrossTab createTable()

Creates the RMCrossTab.

setRowCount

public void setRowCount(int rows)

getRowCount

public int getRowCount()

setColumnCount

public void setColumnCount(int cols)

getColumnCount

public int getColumnCount()

setHeaderRowCount

public void setHeaderRowCount(int rows)

getHeaderRowCount

public int getHeaderRowCount()

setHeaderColumnCount

public void setHeaderColumnCount(int colHeaders)

getHeaderColumnCount

public int getHeaderColumnCount()

setDatasetKey

public void setDatasetKey(java.lang.String key)

getDatasetKey

public java.lang.String getDatasetKey()

Description copied from class: RMShape

Returns the dataset key associated with this shape.

Overrides:

getDatasetKey in class RMShape

setFilterKey

public void setFilterKey(java.lang.String filterKey)

getFilterKey

public java.lang.String getFilterKey()

setFormatStyle

public void setFormatStyle(int formatStyle)

note -- any changes to these styles or their ordering need to also be made to RMCrosstab. These @Options are declared here to allow them to be forwarded to the composed RMCrosstab when selected from the CrosstabFrame's property selector

getFormatStyle

public int getFormatStyle()

getReprintHeaderRows

public boolean getReprintHeaderRows()

Returns whether a paginating table will reprint header rows.

setReprintHeaderRows

public void setReprintHeaderRows(boolean aFlag)

Sets whether a paginating table will reprint header rows.

rpgAll

public RMShape rpgAll(ReportOwner anRptOwner,
                      RMShape aParent)

Override to constrain child crosstab to frame.

Overrides:

rpgAll in class RMParentShape

paintShape

public void paintShape(RMShapePainter g)

Paints crosstab.

Overrides:

paintShape in class RMShape

computePrefHeight

protected double computePrefHeight(double aWidth)

Override to return preferred height of table.

Overrides:

computePrefHeight in class RMParentShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

Editor method.

Overrides:

childrenSuperSelectImmediately in class RMShape

isDeletable

public boolean isDeletable()

Description copied from class: RMShape

Override this for shapes (like a table row) that don't don't make sense to delete by themselves.

Overrides:

isDeletable in class RMShape

toXMLShape

protected RXElement toXMLShape(RXArchiver anArchiver)

XML Archival.

Overrides:

toXMLShape in class RMParentShape

fromXMLShape

protected void fromXMLShape(RXArchiver anArchiver,
                            RXElement anElement)

XML Unarchival.

Overrides:

fromXMLShape in class RMParentShape