com.reportmill.shape
Class RMLabels

java.lang.Object
  com.reportmill.foundation.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMLabels

All Implemented Interfaces:

java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

public class RMLabels

extends RMShape

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth

Constructor Summary

RMLabels()

Method Summary

boolean	canBeUngrouped() Editor method.
boolean	childrenSuperSelectImmediately() Editor method.
java.lang.Object	clone() Standard implementation of Object clone.
void	copy(com.reportmill.foundation.RMObject anObj) Copies applicable attributes from the given object.
boolean	equals(java.lang.Object anObj) Standard implementation of Object equals.
void	fixSize()
java.lang.Object	fromXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement) XML unarchival.
java.lang.String	getListKey() Returns the "List Key" associated with this shape.
int	getNumberOfColumns()
int	getNumberOfRows()
boolean	getPaginate()
RMSort	getSort(int anIdex)
int	getSortCount()
java.util.List	getSorts()
float	getSpacingHeight()
float	getSpacingWidth()
java.lang.Object	initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver) Legacy unarchival.
float	labelHeight()
float	labelWidth()
RMShape	rpgClone(com.reportmill.foundation.ReportMill reportMill) A clone implementation that copies this shape and its children, performing data substituion as well.
void	rpgClonePreprocess(com.reportmill.foundation.ReportMill reportMill) An rpgClone hook called by RMDocument on all children before anything else.
void	setHeightDeep(float value, boolean constrain)
void	setListKey(java.lang.String aKeyPath) Sets the List Key associated with this shape.
void	setNumberOfColumns(int aValue)
void	setNumberOfRows(int aValue)
void	setPaginate(boolean aFlag)
void	setSpacingHeight(float aValue)
void	setSpacingWidth(float aValue)
void	setWidthDeep(float value, boolean constrain)
boolean	superSelectable() Editor method.
com.ribs.RXElement	toXML(com.ribs.RXArchiver anArchiver) XML archival.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsDragKeys, acceptsEvents, acceptsFirstEvent, acceptsFormat, addChild, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, bringShapesToFront, childHitByPoint, childrenHitByPath, cloneDeep, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, drawChildren, drawsFill, drawsStroke, dropKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsOfPath, getBoundsOrigin, getBoundsSize, getBoundsSuperSelected, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildLast, getChildren, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKeyDeep, getListKeyShape, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getY, groupShapes, handleAtPoint, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, hitChildren, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, page, pageBreakMax, pageBreakPageMax, pageMax, put, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setBoundsOrigin, setBoundsOrigin, setBoundsOriginX, setBoundsOriginY, setBoundsSize, setBoundsSize, setChildAnimator, setChildren, setColor, setColor, setDrawsFill, setDrawsStroke, setEverythingStretches, setFill, setFill, setFont, setFormat, setHeight, setHeightDeep, setHeightToFit, setLineWidth, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOnlyBottomAndRightMarginStretches, setOnlyTopAndRightMarginStretches, setOnlyWidthAndHeightStretches, setOpacity, setOrigin, setOrigin, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeDeep, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewXY, setSkewY, setStroke, setStroke, setStrokeColor, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectImmediately, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.foundation.RMObject

archiverClassName, didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMLabels

public RMLabels()

Method Detail

getListKey

public java.lang.String getListKey()

Description copied from class: RMShape

Returns the "List Key" associated with this shape. A List Key is a key path that specifies a specific list of objects in the document's datasource.

Overrides:

getListKey in class RMShape

setListKey

public void setListKey(java.lang.String aKeyPath)

Description copied from class: RMShape

Sets the List Key associated with this shape. Not all shapes support this (only List Key shapes, like table, graph, crosstab and labels). In fact this default implementation does nothing.

Overrides:

setListKey in class RMShape

getSorts

public java.util.List getSorts()

getSortCount

public int getSortCount()

getSort

public RMSort getSort(int anIdex)

getNumberOfRows

public int getNumberOfRows()

setNumberOfRows

public void setNumberOfRows(int aValue)

getNumberOfColumns

public int getNumberOfColumns()

setNumberOfColumns

public void setNumberOfColumns(int aValue)

getSpacingWidth

public float getSpacingWidth()

setSpacingWidth

public void setSpacingWidth(float aValue)

getSpacingHeight

public float getSpacingHeight()

setSpacingHeight

public void setSpacingHeight(float aValue)

getPaginate

public boolean getPaginate()

setPaginate

public void setPaginate(boolean aFlag)

labelWidth

public float labelWidth()

labelHeight

public float labelHeight()

rpgClonePreprocess

public void rpgClonePreprocess(com.reportmill.foundation.ReportMill reportMill)

Description copied from class: RMShape

An rpgClone hook called by RMDocument on all children before anything else.

Overrides:

rpgClonePreprocess in class RMShape

setWidthDeep

public void setWidthDeep(float value,
                         boolean constrain)

Overrides:

setWidthDeep in class RMShape

setHeightDeep

public void setHeightDeep(float value,
                          boolean constrain)

Overrides:

setHeightDeep in class RMShape

fixSize

public void fixSize()

rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill)

Description copied from class: RMShape

A clone implementation that copies this shape and its children, performing data substituion as well.

Overrides:

rpgClone in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Description copied from class: RMShape

Standard implementation of Object equals.

Overrides:

equals in class RMShape

clone

public java.lang.Object clone()

Description copied from class: RMShape

Standard implementation of Object clone. Null's out shape's parent and children.

Overrides:

clone in class RMShape

copy

public void copy(com.reportmill.foundation.RMObject anObj)

Description copied from class: RMShape

Copies applicable attributes from the given object.

Overrides:

copy in class RMShape

initWithArchiver

public java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)

Legacy unarchival.

Specified by:

initWithArchiver in interface com.reportmill.foundation.RMArchiver.Archiving

Overrides:

initWithArchiver in class RMShape

toXML

public com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape

superSelectable

public boolean superSelectable()

Description copied from class: RMShape

Editor method.

Overrides:

superSelectable in class RMShape

canBeUngrouped

public boolean canBeUngrouped()

Description copied from class: RMShape

Editor method.

Overrides:

canBeUngrouped in class RMShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

Description copied from class: RMShape

Editor method.

Overrides:

childrenSuperSelectImmediately in class RMShape