RMLabels (ReportMill 14 API)

java.lang.Object
- SnapObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMParentShape
    - - com.reportmill.shape.RMLabels

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, 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.reportmill.base.RMTypes
  RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Constructor Summary

Constructors
Constructor and Description

RMLabels()
Creates a new labels template.

Constructors
Constructor and Description
`RMLabels()` Creates a new labels template.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`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.
`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`	`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`	`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.

Methods inherited from class com.reportmill.shape.RMParentShape
addChild, addChild, addChild, addChild, bringShapesToFront, cloneDeep, divideShapeFromTop, fromXML, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isSourceURLSet, layout, relayout, removeChild, removeChild, removeChildren, sendShapesToBack, setLayout, setNeedsLayout, setSourceURL, toXML

Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getClipShape, getColor, getDatasetEntity, 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, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isUnderlined, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, rpgBindings, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, 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, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RMLabels
```
public RMLabels()
```
    Creates a new labels template.
- Method Detail
  - 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 class RMShape
  - 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.
  - getLabelHeight
```
public double getLabelHeight()
```
    Returns the height of an individual label.
  - setWidth
```
public void setWidth(double aWidth)
```
    Overrides shape method to recalc spacing width.
    
    Overrides:
    
    setWidth in class RMParentShape
  - setHeight
```
public void setHeight(double value)
```
    Overrides shape method to recalc spacing height.
    
    Overrides:
    
    setHeight in class RMParentShape
  - fixSize
```
public void fixSize()
```
    Resets labels block width and height if any of labels other attributes have changed.
  - rpgAll
```
public RMShape rpgAll(ReportOwner anRptOwner,
                      RMShape aParent)
```
    Report Generation.
    
    Overrides:
    
    rpgAll in class RMParentShape
  - paintShape
```
public void paintShape(RMShapePainter aPntr)
```
    Paint labels shapes.
    
    Overrides:
    
    paintShape in class RMShape
  - clone
```
public RMLabels clone()
```
    Override to clone grouping.
    
    Overrides:
    
    clone in class RMParentShape
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Editor method - indicates that labels child should super-select immediately.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape

Class RMLabels

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMParentShape

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class java.lang.Object

Constructor Detail

RMLabels

Method Detail

getLabel

getDatasetKey

setDatasetKey

getGrouping

getSorts

getSortCount

getSort

getNumberOfRows

setNumberOfRows

getNumberOfColumns

setNumberOfColumns

getSpacingWidth

setSpacingWidth

getSpacingHeight

setSpacingHeight

getLabelWidth

getLabelHeight

setWidth

setHeight

fixSize

rpgAll

paintShape

clone

childrenSuperSelectImmediately