com.inductiveautomation.rm.shape

Class RMCrossTabCell

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMRectShape

com.inductiveautomation.rm.shape.RMTextShape

com.inductiveautomation.rm.shape.RMCrossTabCell

All Implemented Interfaces:

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

public class RMCrossTabCell
extends RMTextShape

A text shape subclass used to form the basis of a table.

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.RMTextShape

WRAP_BASIC, WRAP_NONE, WRAP_SCALE

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
RMCrossTabCell() Creates a new RMCrossTabCell.

Method Summary

Modifier and Type	Method and Description
void	clearContents() Clears the text and grouping from this cell.
RMCrossTabCell	clone() Standard clone implementation.
RMXString	createXString() Override to create an xstring that is aligned center by default.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
RMCrossTabCell	getCellAbove() Returns the cell just above this cell.
RMCrossTabCell	getCellAfter() Returns the cell after, or to the right of, this cell.
RMCrossTabCell	getCellBefore() Returns the cell before, or to the left of, this cell.
RMCrossTabCell	getCellBelow() Returns the cell just below this cell.
int	getCol() Returns the column of this cell.
int	getColEnd() Returns the end column of this cell.
int	getColSpan() Returns the number of columns this cell spans.
RMGroup	getGroup() Returns the group for this cell.
RMGrouping	getGrouping() Returns the grouping.
java.lang.String	getGroupingKey()
java.awt.Insets	getMarginDefault() Returns the default text margin for RMCell (top=5, left=5, right=5, bottom=5).
int	getRow() Returns the row of this cell.
int	getRowEnd() Returns the end row of this cell.
int	getRowSpan() Returns the number of rows this cell spans.
boolean	getShowBottomBorder() Returns whether cell shows bottom border.
boolean	getShowLeftBorder() Returns whether cell shows left border.
boolean	getShowRightBorder() Returns whether cell shows right border.
boolean	getShowTopBorder() Returns whether cell shows top border.
RMCrossTab	getTable() Returns the table for this cell.
boolean	isColumnHeader() Returns whether this cell is a column header cell.
boolean	isDeletable() Override this for shapes (like a table row) that don't don't make sense to delete by themselves.
boolean	isRowHeader() Returns whether this cell is a row header cell.
void	paintShape(RMShapePainter aPntr) Handles painting a crosstab cell.
protected void	setGroup(RMGroup aGroup) Sets the group for this cell.
void	setGrouping(RMGrouping aGrouping) Sets the grouping.
void	setGroupingKey(java.lang.String key)
void	setShowBorders(boolean left, boolean right, boolean top, boolean bottom) Convenience method to set all borders at once
void	setShowBottomBorder(boolean aFlag) Sets whether cell shows bottom border.
void	setShowLeftBorder(boolean aFlag) Sets whether cell shows left border.
void	setShowRightBorder(boolean aFlag) Sets whether cell shows right border.
void	setShowTopBorder(boolean aFlag) Sets whether cell shows top border.
RXElement	toXML(RXArchiver anArchiver) XML archival.

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

computePrefHeight, computePrefWidth, copyText, createDivideShapeRemainder, createTextLayout, fromXMLFinish, getAlignmentX, getAlignmentY, getAlignString, getAutosizingDefault, getCharSpacing, getCoalesceNewlines, getDateFormat, getDrawsSelectionRect, getFont, getLineGap, getLineHeightMax, getLineHeightMin, getLineSpacing, getLinkedText, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginString, getMarginTop, getMaskPath, getNegativeInRed, getNullFormat, getNumberFormat, getOutline, getPath, getPathInBounds, getPathInBounds, getPathShape, getPerformsWrap, getPropertyNames, getText, getTextColor, getTextLayout, getVisibleEnd, getVisibleStart, getWraps, getXString, isAllTextVisible, isStructured, isUnderlined, length, paginate, paintShapeBack, paintShapeText, paintTextRun, peerDidChange, propertyChange, resolvePageReferences, revalidate, rpgShape, scaleFonts, setAlignmentX, setAlignmentY, setCharSpacing, setCoalesceNewlines, setDateFormat, setDrawsSelectionRect, setFont, setFormat, setHeight, setLineGap, setLineHeightMax, setLineHeightMin, setLineSpacing, setLinkedText, setMargin, setMarginString, setNegativeInRed, setNullFormat, setNumberFormat, setOutline, setPathShape, setPerformsWrap, setRadius, setText, setTextColor, setUnderlined, setWidth, setWraps, setXString, superSelectable, toString

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

getRadius

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

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, divideShapeFromTop, get, get, getAlignment, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChild, getChildAnimator, getChildAnimator, getChildClipShape, getChildCount, getChildren, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, 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, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, rpgAll, rpgBindings, setAlignment, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTime, setTimeline, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, 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

RMCrossTabCell

public RMCrossTabCell()

Creates a new RMCrossTabCell.

Method Detail

createXString

public RMXString createXString()

Override to create an xstring that is aligned center by default.

Overrides:

createXString in class RMTextShape

getTable

public RMCrossTab getTable()

Returns the table for this cell.

getRow

public int getRow()

Returns the row of this cell.

getCol

public int getCol()

Returns the column of this cell.

getColSpan

public int getColSpan()

Returns the number of columns this cell spans.

getRowSpan

public int getRowSpan()

Returns the number of rows this cell spans.

getRowEnd

public int getRowEnd()

Returns the end row of this cell.

getShowLeftBorder

public boolean getShowLeftBorder()

Returns whether cell shows left border.

setShowLeftBorder

public void setShowLeftBorder(boolean aFlag)

Sets whether cell shows left border.

getShowRightBorder

public boolean getShowRightBorder()

Returns whether cell shows right border.

setShowRightBorder

public void setShowRightBorder(boolean aFlag)

Sets whether cell shows right border.

getShowTopBorder

public boolean getShowTopBorder()

Returns whether cell shows top border.

setShowTopBorder

public void setShowTopBorder(boolean aFlag)

Sets whether cell shows top border.

getShowBottomBorder

public boolean getShowBottomBorder()

Returns whether cell shows bottom border.

setShowBottomBorder

public void setShowBottomBorder(boolean aFlag)

Sets whether cell shows bottom border.

setShowBorders

public void setShowBorders(boolean left,
                           boolean right,
                           boolean top,
                           boolean bottom)

Convenience method to set all borders at once

getGrouping

public RMGrouping getGrouping()

Returns the grouping.

setGrouping

public void setGrouping(RMGrouping aGrouping)

Sets the grouping.

getGroupingKey

public java.lang.String getGroupingKey()

setGroupingKey

public void setGroupingKey(java.lang.String key)

getGroup

public RMGroup getGroup()

Returns the group for this cell.

setGroup

protected void setGroup(RMGroup aGroup)

Sets the group for this cell.

getColEnd

public int getColEnd()

Returns the end column of this cell.

getCellBefore

public RMCrossTabCell getCellBefore()

Returns the cell before, or to the left of, this cell.

getCellAfter

public RMCrossTabCell getCellAfter()

Returns the cell after, or to the right of, this cell.

getCellAbove

public RMCrossTabCell getCellAbove()

Returns the cell just above this cell.

getCellBelow

public RMCrossTabCell getCellBelow()

Returns the cell just below this cell.

isColumnHeader

public boolean isColumnHeader()

Returns whether this cell is a column header cell.

isRowHeader

public boolean isRowHeader()

Returns whether this cell is a row header cell.

getMarginDefault

public java.awt.Insets getMarginDefault()

Returns the default text margin for RMCell (top=5, left=5, right=5, bottom=5).

Overrides:

getMarginDefault in class RMTextShape

clearContents

public void clearContents()

Clears the text and grouping from this cell.

paintShape

public void paintShape(RMShapePainter aPntr)

Handles painting a crosstab cell.

Overrides:

paintShape in class RMTextShape

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 RMTextShape

clone

public RMCrossTabCell clone()

Standard clone implementation.

Overrides:

clone in class RMTextShape

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

Overrides:

toXML in class RMTextShape

fromXML

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

XML unarchival.

Specified by:

fromXML in interface Archivable

Overrides:

fromXML in class RMTextShape