RMLabels (ReportMill 12 API)

java.lang.Object
- com.reportmill.base.RMObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMLabels

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener
```
public class RMLabels
extends RMShape
```
This class represents a block of labels.

Field Summary
- Fields inherited from class com.reportmill.shape.RMShape
  WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors
Constructor and Description

RMLabels()
Creates a new labels template.

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

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`childrenSuperSelectImmediately()` Editor method - indicates that labels child should super-select immediately.
`RMLabels`	`clone()` Standard clone implementation.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`void`	`fixSize()` Resets labels block width and height if any of labels other attributes have changed.
`java.lang.Object`	`fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` 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.
`float`	`getLabelHeight()` Returns the height of an individual label.
`float`	`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.
`boolean`	`getPaginate()` Returns whether the labels should paginate.
`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.
`float`	`getSpacingHeight()` Returns the spacing between labels vertically.
`float`	`getSpacingWidth()` Returns the spacing between labels horizontally.
`void`	`paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g)` Paint labels shapes.
`void`	`setDatasetKey(java.lang.String aKeyPath)` Sets the dataset key associated with labels.
`void`	`setHeight(float 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`	`setPaginate(boolean aFlag)` Sets whether the labels should paginate.
`void`	`setReportMill(com.reportmill.base.ReportMill reportMill)` Report Generation.
`void`	`setReportMillDeep(com.reportmill.base.ReportMill aReportMill)` Override to stifle child rpg.
`void`	`setSpacingHeight(float aValue)` Sets the spacing between labels vertically.
`void`	`setSpacingWidth(float aValue)` Sets the spacing between labels horizontally.
`void`	`setWidth(float aWidth)` Overrides shape method to recalc spacing width.
`com.reportmill.archiver.RXElement`	`toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner)` XML archival.

Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, addChild, addChild, addChild, addChild, animUpdate, bounds, bringShapesToFront, checkBindings, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, createLayout, createPartClone, divideShapeFromEdge, divideShapeFromTop, doLayout, firePropertyChange, fromXML, fromXMLShapeChildren, fromXMLShapeLayout, get, get, getAction, getAncestor, getAncestorCount, getAncestorInCommon, getAnim, getAnim, getAnimator, getAnimator, getAspectMapped, getAspects, getAutosizing, getAutosizingDefault, getBinder, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDocument, getEffect, getFill, getFloat, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getImageFill, getLayout, getLineWidth, getMaskPath, getMaximumSize, getMaximumSizeProperty, getMaxX, getMaxY, getMinimumSize, getMinimumSizeProperty, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getPreferredSize, getPreferredSizeImpl, getPreferredSizeProperty, getPreferredSizeX, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isHittable, isHittableChild, isLocked, isMouseDown, isMouseOver, isRoot, isShowing, isUnderlined, isValid, isViewing, isVisible, isVisibleChild, isVisibleDeep, layoutReset, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeFromParent, repaint, repaint, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeightToFit, setHover, setLayout, setLayoutEnabled, setLineWidth, setLocked, setMaximumSize, setMinimumSize, setName, setOpacity, setOutline, setParent, setPreferredSize, setReportMillBindings, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setUrl, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, superSelectable, toString, toXML, toXMLShapeChildren, toXMLShapeLayout, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject
addListener, addPropertyChangeListener, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing

Methods inherited from class java.lang.Object
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 float getSpacingWidth()
```
    Returns the spacing between labels horizontally.
  - setSpacingWidth
```
public void setSpacingWidth(float aValue)
```
    Sets the spacing between labels horizontally.
  - getSpacingHeight
```
public float getSpacingHeight()
```
    Returns the spacing between labels vertically.
  - setSpacingHeight
```
public void setSpacingHeight(float aValue)
```
    Sets the spacing between labels vertically.
  - getPaginate
```
public boolean getPaginate()
```
    Returns whether the labels should paginate.
  - setPaginate
```
public void setPaginate(boolean aFlag)
```
    Sets whether the labels should paginate.
  - getLabelWidth
```
public float getLabelWidth()
```
    Returns the width of an individual label.
  - getLabelHeight
```
public float getLabelHeight()
```
    Returns the height of an individual label.
  - setWidth
```
public void setWidth(float aWidth)
```
    Overrides shape method to recalc spacing width.
    
    Overrides:
    
    setWidth in class RMShape
  - setHeight
```
public void setHeight(float value)
```
    Overrides shape method to recalc spacing height.
    
    Overrides:
    
    setHeight in class RMShape
  - fixSize
```
public void fixSize()
```
    Resets labels block width and height if any of labels other attributes have changed.
  - setReportMill
```
public void setReportMill(com.reportmill.base.ReportMill reportMill)
```
    Report Generation.
    
    Overrides:
    
    setReportMill in class RMShape
  - setReportMillDeep
```
public void setReportMillDeep(com.reportmill.base.ReportMill aReportMill)
```
    Override to stifle child rpg.
    
    Overrides:
    
    setReportMillDeep in class RMShape
  - paintShape
```
public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
              java.awt.Graphics2D g)
```
    Paint labels shapes.
    
    Overrides:
    
    paintShape in class RMShape
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
    
    Overrides:
    
    equals in class RMShape
  - clone
```
public RMLabels clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class RMShape
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Editor method - indicates that labels child should super-select immediately.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape
  - toXMLShape
```
public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                           java.lang.Object anOwner)
```
    XML archival.
    
    Overrides:
    
    toXMLShape in class RMShape
  - fromXMLShape
```
public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                            com.reportmill.archiver.RXElement anElement,
                            java.lang.Object anOwner)
```
    XML unarchival.
    
    Overrides:
    
    fromXMLShape in class RMShape

Class RMLabels

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class com.reportmill.base.RMObject

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

getPaginate

setPaginate

getLabelWidth

getLabelHeight

setWidth

setHeight

fixSize

setReportMill

setReportMillDeep

paintShape

equals

clone

childrenSuperSelectImmediately

toXMLShape

fromXMLShape