Package com.inductiveautomation.rm.shape
Class RMLabels
- 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.RMLabels
-
- All Implemented Interfaces:
Archivable
,DeepChangeListener
,RMPropertyChanger
,RMTypes
,java.beans.PropertyChangeListener
,java.lang.Cloneable
,java.util.EventListener
public class RMLabels extends RMParentShape
This class represents a block of labels.
-
-
Nested Class Summary
-
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
DATAKEY_PROP
static java.lang.String
LAYOUT_PROP
-
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 RMLabels()
Creates a new labels template.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
childrenSuperSelectImmediately()
Editor method - indicates that labels child should super-select immediately.RMLabels
clone()
Override to clone grouping.void
fixSize()
Resets labels block width and height if any of labels other attributes have changed.protected void
fromXMLShape(RXArchiver anArchiver, RXElement anElement)
XML unarchival.java.lang.String
getDatasetKey()
Returns the dataset key associated with labels.RMGrouping
getGrouping()
Returns the grouping for this labels shape.RMLabel
getLabel()
Returns the default label shape.LabelFormat
getLabelFormat()
double
getLabelHeight()
Returns the height of an individual label.double
getLabelWidth()
Returns the width of an individual label.int
getNumberOfColumns()
Returns the number of columns in the labels block.int
getNumberOfRows()
Returns the number of rows in the labels block.RMSort
getSort(int anIndex)
Returns the specific sort at the given index.int
getSortCount()
Returns the number of sorts associated with labels.java.util.List
getSorts()
Returns the list of sorts associated with labels.double
getSpacingHeight()
Returns the spacing between labels vertically.double
getSpacingWidth()
Returns the spacing between labels horizontally.void
paintShape(RMShapePainter aPntr)
Paint labels shapes.RMShape
rpgAll(ReportOwner anRptOwner, RMShape aParent)
Report Generation.void
setDatasetKey(java.lang.String aKeyPath)
Sets the dataset key associated with labels.void
setHeight(double value)
Overrides shape method to recalc spacing height.void
setLabelFormat(LabelFormat labelFormat)
void
setLabelHeight(double height)
void
setLabelWidth(double width)
void
setNumberOfColumns(int aValue)
Sets the number of columns in the labels block.void
setNumberOfRows(int aValue)
Sets the number of rows in the labels block.void
setSize(RMSize aSize)
Overridden because we want the size of the RMLabels to be the computed size determined by the size and numbers of the individual labelsvoid
setSpacingHeight(double aValue)
Sets the spacing between labels vertically.void
setSpacingWidth(double aValue)
Sets the spacing between labels horizontally.void
setWidth(double aWidth)
Overrides shape method to recalc spacing width.protected RXElement
toXMLShape(RXArchiver anArchiver)
XML archival.void
updateLabelSizes()
-
Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape
addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, cloneDeep, computePrefHeight, 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, setLayout, setNeedsLayout, setSourceURL, 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, isDeletable, 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, 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
-
-
-
-
Field Detail
-
DATAKEY_PROP
public static final java.lang.String DATAKEY_PROP
- See Also:
- Constant Field Values
-
LAYOUT_PROP
public static final java.lang.String LAYOUT_PROP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLabelFormat
public LabelFormat getLabelFormat()
-
setLabelFormat
public void setLabelFormat(LabelFormat labelFormat)
-
getLabel
public RMLabel getLabel()
Returns the default label shape.
-
getDatasetKey
public java.lang.String getDatasetKey()
Returns the dataset key associated with labels.- Overrides:
getDatasetKey
in classRMShape
-
setDatasetKey
public void setDatasetKey(java.lang.String aKeyPath)
Sets the dataset key associated with labels.
-
getGrouping
public RMGrouping getGrouping()
Returns the grouping for this labels shape.
-
getSorts
public java.util.List getSorts()
Returns the list of sorts associated with labels.
-
getSortCount
public int getSortCount()
Returns the number of sorts associated with labels.
-
getSort
public RMSort getSort(int anIndex)
Returns the specific sort at the given index.
-
getNumberOfRows
public int getNumberOfRows()
Returns the number of rows in the labels block.
-
setNumberOfRows
public void setNumberOfRows(int aValue)
Sets the number of rows in the labels block.
-
getNumberOfColumns
public int getNumberOfColumns()
Returns the number of columns in the labels block.
-
setNumberOfColumns
public void setNumberOfColumns(int aValue)
Sets the number of columns in the labels block.
-
getSpacingWidth
public double getSpacingWidth()
Returns the spacing between labels horizontally.
-
setSpacingWidth
public void setSpacingWidth(double aValue)
Sets the spacing between labels horizontally.
-
getSpacingHeight
public double getSpacingHeight()
Returns the spacing between labels vertically.
-
setSpacingHeight
public void setSpacingHeight(double aValue)
Sets the spacing between labels vertically.
-
getLabelWidth
public double getLabelWidth()
Returns the width of an individual label.
-
setLabelWidth
public void setLabelWidth(double width)
-
getLabelHeight
public double getLabelHeight()
Returns the height of an individual label.
-
setLabelHeight
public void setLabelHeight(double height)
-
setWidth
public void setWidth(double aWidth)
Overrides shape method to recalc spacing width.- Overrides:
setWidth
in classRMParentShape
-
setHeight
public void setHeight(double value)
Overrides shape method to recalc spacing height.- Overrides:
setHeight
in classRMParentShape
-
fixSize
public void fixSize()
Resets labels block width and height if any of labels other attributes have changed.
-
updateLabelSizes
public void updateLabelSizes()
-
rpgAll
public RMShape rpgAll(ReportOwner anRptOwner, RMShape aParent)
Report Generation.- Overrides:
rpgAll
in classRMParentShape
-
paintShape
public void paintShape(RMShapePainter aPntr)
Paint labels shapes.- Overrides:
paintShape
in classRMShape
-
clone
public RMLabels clone()
Override to clone grouping.- Overrides:
clone
in classRMParentShape
-
childrenSuperSelectImmediately
public boolean childrenSuperSelectImmediately()
Editor method - indicates that labels child should super-select immediately.- Overrides:
childrenSuperSelectImmediately
in classRMShape
-
toXMLShape
protected RXElement toXMLShape(RXArchiver anArchiver)
XML archival.- Overrides:
toXMLShape
in classRMParentShape
-
fromXMLShape
protected void fromXMLShape(RXArchiver anArchiver, RXElement anElement)
XML unarchival.- Overrides:
fromXMLShape
in classRMParentShape
-
-