Package com.inductiveautomation.rm.shape
Class RMTableRow
- java.lang.Object
-
- All Implemented Interfaces:
Archivable
,DeepChangeListener
,RMPropertyChanger
,RMTypes
,java.beans.PropertyChangeListener
,java.lang.Cloneable
,java.util.EventListener
public class RMTableRow extends RMSwitchShape
This class models a table row in a table.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RMTableRow.ColumnResizeMode
-
Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes
RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
VersionAlternate
static java.lang.String
VersionFirstOnly
static java.lang.String
VersionReprint
static java.lang.String
VersionSplitHeader
static java.lang.String
VersionStandard
static java.lang.String
VersionTopNOthers
-
Fields inherited from class com.inductiveautomation.rm.shape.RMShape
BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE
-
-
Constructor Summary
Constructors Constructor Description RMTableRow()
Creates a plain, unstructured table row.RMTableRow(boolean isStructured)
Creates a table row allowing the user to specify whether it should be structured.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(RMShape aChild, int anIndex)
Overrides standard shape method to turn off structuring if child isn't text.boolean
childrenSuperSelectImmediately()
Editor method - states that children super-select immediately when table row is structured.protected void
fromXMLChildren(RXArchiver anArchiver, RXElement anElement)
Override to make sure structured children are sorted by X (wasn't necessarily so before RM14).protected void
fromXMLShape(RXArchiver anArchiver, RXElement anElement)
XML unarchival.RMTextShape
getColumn(int anIndex)
Returns the column at the given index (assumes row is structured and column is RMTextShape).boolean
getDeleteVerticalSpansOfHiddenShapes()
Returns whether layout deletes vertical spans of hidden shapes.double
getMinSplitHeight()
Returns the minimum distance in points from the top of the row that this row can split.double
getMinSplitRemainderHeight()
Returns the minimum distance in points from the bottom of the row that this row can split.boolean
getMoveToBottom()
Returns whether this row should be moved to the bottom of the table during report generation.int
getNumberOfChildrenToStayWith()
Returns the number of children this table row needs to be accompanied by, if some children run off page bottom.int
getNumberOfColumns()
Returns the number of columns in this table row (really just child count).java.lang.String
getPageBreakKey()
Returns the key used to determine whether row should force a page break.boolean
getPrintEvenIfGroupIsEmpty()
Returns whether this row should print even if it has no children (assumed to be a header/summary row).boolean
getReprintWhenWrapped()
Returns whether this row is reprinted on a new page when its children cross a page boundary.RMTableRow
getRowAbove()
Returns the row above this one in the template.boolean
getShiftShapesBelowHiddenShapesUp()
Returns whether to shift shapes below hidden shapes up.boolean
getSyncStructureWithAlternates()
Returns whether table row should synchronize the column widths of alternate versions.boolean
getSyncStructureWithRowAbove()
Returns whether table row should synchronize the column widths of the row immediately above it.RMTable
getTable()
Returns the parent of this table row.java.lang.String
getTitle()
Returns the title for this table row.boolean
isDeletable()
Override this for shapes (like a table row) that don't don't make sense to delete by themselves.boolean
isStructured()
Returns whether this table row is structured.void
paintShape(RMShapePainter aPntr)
Paints table row.void
setDeleteVerticalSpansOfHiddenShapes(boolean aValue)
Sets whether layout deletes vertical spans of hidden shapes.void
setMinSplitHeight(double aValue)
Sets the minimum distance in points from the top of the row that this row can split.void
setMinSplitRemainderHeight(double aValue)
Sets the minimum distance in points from the top of the row that this row can split.void
setMoveToBottom(boolean aFlag)
Sets whether this row should be moved to the bottom of the table during report generation.void
setNumberOfChildrenToStayWith(int aValue)
Sets the number of children this table row needs to be accompanied by, if some children run off page bottom.void
setNumberOfColumns(int aCount)
Sets the number of columns in this table row.void
setPageBreakKey(java.lang.String aString)
Sets the key used to determine whether row should force a page break.void
setPrintEvenIfGroupIsEmpty(boolean aFlag)
Returns whether this row should print even if it has no children (assumed to be a header/summary row).void
setReprintWhenWrapped(boolean aFlag)
Sets whether this row is reprinted on a new page when its children cross a page boundary.void
setShiftShapesBelowHiddenShapesUp(boolean aValue)
Sets whether to shift shapes below hidden shapes up.void
setStructured(boolean aFlag)
Sets whether this table row should be structured.void
setSyncStructureWithAlternates(boolean aFlag)
Sets whether table row should synchronize the column widths of alternate versions.void
setSyncStructureWithRowAbove(boolean aFlag)
Sets whether table row should synchronize the column widths of the row immediately above it.void
setTitle(java.lang.String aTitle)
Sets the title for this table row.void
syncStructureWithShape(RMParentShape aShape)
The syncStructureWithShape() method sync's the column widths of receiver to those of given shape.java.lang.String
toString()
Returns a string description of the table row.protected RXElement
toXMLShape(RXArchiver anArchiver)
XML archival.protected void
transferAttributes(RMSwitchShape toShape)
Overrides switch shape method to specify additional attributes to be transferred when setVersion is called.-
Methods inherited from class com.inductiveautomation.rm.shape.RMSwitchShape
acceptsChildren, clone, cloneDeep, getAlternates, getAlternates, getChildAnimator, getDefaultVersionName, getPropertyNames, getVersion, getVersion, getVersionKey, getVersionNames, hasVersion, removeVersion, rpgAll, rpgAllSuper, setChildAnimator, setVersion, setVersionKey, setWidth, shapeHidden, shapeShown, superSelectable, toXML, toXMLChildren
-
Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape
addChild, addChild, addChild, addLayoutChild, bringShapesToFront, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXML, 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
-
Methods inherited from class com.inductiveautomation.rm.shape.RMShape
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, getChildClipShape, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, 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, 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, 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
-
-
-
-
Field Detail
-
VersionStandard
public static final java.lang.String VersionStandard
- See Also:
- Constant Field Values
-
VersionFirstOnly
public static final java.lang.String VersionFirstOnly
- See Also:
- Constant Field Values
-
VersionReprint
public static final java.lang.String VersionReprint
- See Also:
- Constant Field Values
-
VersionAlternate
public static final java.lang.String VersionAlternate
- See Also:
- Constant Field Values
-
VersionTopNOthers
public static final java.lang.String VersionTopNOthers
- See Also:
- Constant Field Values
-
VersionSplitHeader
public static final java.lang.String VersionSplitHeader
- See Also:
- Constant Field Values
-
-
Method Detail
-
getTable
public RMTable getTable()
Returns the parent of this table row.
-
getTitle
public java.lang.String getTitle()
Returns the title for this table row.
-
setTitle
public void setTitle(java.lang.String aTitle)
Sets the title for this table row.
-
isStructured
public boolean isStructured()
Returns whether this table row is structured.
-
setStructured
public void setStructured(boolean aFlag)
Sets whether this table row should be structured.
-
getSyncStructureWithRowAbove
public boolean getSyncStructureWithRowAbove()
Returns whether table row should synchronize the column widths of the row immediately above it.
-
setSyncStructureWithRowAbove
public void setSyncStructureWithRowAbove(boolean aFlag)
Sets whether table row should synchronize the column widths of the row immediately above it.
-
getSyncStructureWithAlternates
public boolean getSyncStructureWithAlternates()
Returns whether table row should synchronize the column widths of alternate versions.
-
setSyncStructureWithAlternates
public void setSyncStructureWithAlternates(boolean aFlag)
Sets whether table row should synchronize the column widths of alternate versions.
-
getColumn
public RMTextShape getColumn(int anIndex)
Returns the column at the given index (assumes row is structured and column is RMTextShape).
-
getNumberOfColumns
public int getNumberOfColumns()
Returns the number of columns in this table row (really just child count).
-
setNumberOfColumns
public void setNumberOfColumns(int aCount)
Sets the number of columns in this table row.
-
getNumberOfChildrenToStayWith
public int getNumberOfChildrenToStayWith()
Returns the number of children this table row needs to be accompanied by, if some children run off page bottom.
-
setNumberOfChildrenToStayWith
public void setNumberOfChildrenToStayWith(int aValue)
Sets the number of children this table row needs to be accompanied by, if some children run off page bottom.
-
getReprintWhenWrapped
public boolean getReprintWhenWrapped()
Returns whether this row is reprinted on a new page when its children cross a page boundary.
-
setReprintWhenWrapped
public void setReprintWhenWrapped(boolean aFlag)
Sets whether this row is reprinted on a new page when its children cross a page boundary.
-
getPrintEvenIfGroupIsEmpty
public boolean getPrintEvenIfGroupIsEmpty()
Returns whether this row should print even if it has no children (assumed to be a header/summary row).
-
setPrintEvenIfGroupIsEmpty
public void setPrintEvenIfGroupIsEmpty(boolean aFlag)
Returns whether this row should print even if it has no children (assumed to be a header/summary row).
-
getMoveToBottom
public boolean getMoveToBottom()
Returns whether this row should be moved to the bottom of the table during report generation.
-
setMoveToBottom
public void setMoveToBottom(boolean aFlag)
Sets whether this row should be moved to the bottom of the table during report generation.
-
getMinSplitHeight
public double getMinSplitHeight()
Returns the minimum distance in points from the top of the row that this row can split.
-
setMinSplitHeight
public void setMinSplitHeight(double aValue)
Sets the minimum distance in points from the top of the row that this row can split.
-
getMinSplitRemainderHeight
public double getMinSplitRemainderHeight()
Returns the minimum distance in points from the bottom of the row that this row can split.
-
setMinSplitRemainderHeight
public void setMinSplitRemainderHeight(double aValue)
Sets the minimum distance in points from the top of the row that this row can split.
-
getPageBreakKey
public java.lang.String getPageBreakKey()
Returns the key used to determine whether row should force a page break.
-
setPageBreakKey
public void setPageBreakKey(java.lang.String aString)
Sets the key used to determine whether row should force a page break.
-
getDeleteVerticalSpansOfHiddenShapes
public boolean getDeleteVerticalSpansOfHiddenShapes()
Returns whether layout deletes vertical spans of hidden shapes.
-
setDeleteVerticalSpansOfHiddenShapes
public void setDeleteVerticalSpansOfHiddenShapes(boolean aValue)
Sets whether layout deletes vertical spans of hidden shapes.
-
getShiftShapesBelowHiddenShapesUp
public boolean getShiftShapesBelowHiddenShapesUp()
Returns whether to shift shapes below hidden shapes up.
-
setShiftShapesBelowHiddenShapesUp
public void setShiftShapesBelowHiddenShapesUp(boolean aValue)
Sets whether to shift shapes below hidden shapes up.
-
syncStructureWithShape
public void syncStructureWithShape(RMParentShape aShape)
The syncStructureWithShape() method sync's the column widths of receiver to those of given shape.
-
getRowAbove
public RMTableRow getRowAbove()
Returns the row above this one in the template.
-
addChild
public void addChild(RMShape aChild, int anIndex)
Overrides standard shape method to turn off structuring if child isn't text.- Overrides:
addChild
in classRMParentShape
-
transferAttributes
protected void transferAttributes(RMSwitchShape toShape)
Overrides switch shape method to specify additional attributes to be transferred when setVersion is called.- Overrides:
transferAttributes
in classRMSwitchShape
-
childrenSuperSelectImmediately
public boolean childrenSuperSelectImmediately()
Editor method - states that children super-select immediately when table row is structured.- Overrides:
childrenSuperSelectImmediately
in classRMShape
-
paintShape
public void paintShape(RMShapePainter aPntr)
Paints table row.- Overrides:
paintShape
in classRMSwitchShape
-
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 classRMShape
-
toXMLShape
protected RXElement toXMLShape(RXArchiver anArchiver)
XML archival.- Overrides:
toXMLShape
in classRMSwitchShape
-
fromXMLShape
protected void fromXMLShape(RXArchiver anArchiver, RXElement anElement)
XML unarchival.- Overrides:
fromXMLShape
in classRMSwitchShape
-
fromXMLChildren
protected void fromXMLChildren(RXArchiver anArchiver, RXElement anElement)
Override to make sure structured children are sorted by X (wasn't necessarily so before RM14).- Overrides:
fromXMLChildren
in classRMParentShape
-
-