Package com.reportmill.shape
Class RMLabels
- java.lang.Object
-
- com.reportmill.base.RMObject
-
- com.reportmill.shape.RMShape
-
- com.reportmill.shape.RMLabels
-
- All Implemented Interfaces:
RMArchiver.Archiving
,java.lang.Cloneable
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 Description RMLabels()
Creates a new labels template.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canBeUngrouped()
Editor method - indicates that labels block can't be ungrouped.boolean
childrenSuperSelectImmediately()
Editor method - indicates that labels child should super-select immediately.java.lang.Object
clone()
Standard clone implementation.void
copy(java.lang.Object anObj)
Standard copy 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
fromXML(RXArchiver anArchiver, RXElement anElement)
XML unarchival.java.lang.String
getListKey()
Returns the list key associated with labels.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 anIdex)
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.java.lang.Object
initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.float
labelHeight()
Returns the height of an individual label.float
labelWidth()
Returns the width of an individual label.RMShape
rpgClone(ReportMill reportMill)
RPG clone - returns individual pages of RPG labels.void
rpgClonePreprocess(ReportMill reportMill)
RPG clone - actual work happens in preprocess so RM knows how many pages are needed.void
setHeightDeep(float value, boolean constrain)
Overrides shape method to recalc spacing height.void
setListKey(java.lang.String aKeyPath)
Sets the list key associated with labels.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
setSpacingHeight(float aValue)
Sets the spacing between labels vertically.void
setSpacingWidth(float aValue)
Sets the spacing between labels horizontally.void
setWidthDeep(float value, boolean constrain)
Overrides shape method to recalc spacing width.boolean
superSelectable()
Editor method - indicates that labels block is super-selectable.RXElement
toXML(RXArchiver anArchiver)
XML archival.-
Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsDragKeys, acceptsFormat, acceptsMouse, addChild, addChild, addChildBelowLastChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, delete, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, dropKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWhoDraw, getChildrenWhoHitTest, getChildSortedByX, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLineWidth, getListKeyDeep, getListKeyShape, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getToolClassName, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getXY, getXYP, getY, groupShapes, hasPageBreaks, height, indexOf, indexOf, intersects, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageBreakMax, pageBreakPageMax, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightToFit, setLineWidth, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOpacity, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y
-
Methods inherited from class com.reportmill.base.RMObject
didUndo, getAnimAttribute, getClassNameShort
-
-
-
-
Method Detail
-
getListKey
public java.lang.String getListKey()
Returns the list key associated with labels.- Overrides:
getListKey
in classRMShape
-
setListKey
public void setListKey(java.lang.String aKeyPath)
Sets the list key associated with labels.- Overrides:
setListKey
in classRMShape
-
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 anIdex)
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.
-
labelWidth
public float labelWidth()
Returns the width of an individual label.
-
labelHeight
public float labelHeight()
Returns the height of an individual label.
-
setWidthDeep
public void setWidthDeep(float value, boolean constrain)
Overrides shape method to recalc spacing width.- Overrides:
setWidthDeep
in classRMShape
-
setHeightDeep
public void setHeightDeep(float value, boolean constrain)
Overrides shape method to recalc spacing height.- Overrides:
setHeightDeep
in classRMShape
-
fixSize
public void fixSize()
Resets labels block width and height if any of labels other attributes have changed.
-
rpgClonePreprocess
public void rpgClonePreprocess(ReportMill reportMill)
RPG clone - actual work happens in preprocess so RM knows how many pages are needed.- Overrides:
rpgClonePreprocess
in classRMShape
-
rpgClone
public RMShape rpgClone(ReportMill reportMill)
RPG clone - returns individual pages of RPG labels.
-
equals
public boolean equals(java.lang.Object anObj)
Standard equals implementation.
-
clone
public java.lang.Object clone()
Standard clone implementation.
-
copy
public void copy(java.lang.Object anObj)
Standard copy implementation.
-
initWithArchiver
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.- Specified by:
initWithArchiver
in interfaceRMArchiver.Archiving
- Overrides:
initWithArchiver
in classRMShape
-
toXML
public RXElement toXML(RXArchiver anArchiver)
XML archival.
-
fromXML
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
XML unarchival.
-
superSelectable
public boolean superSelectable()
Editor method - indicates that labels block is super-selectable.- Overrides:
superSelectable
in classRMShape
-
canBeUngrouped
public boolean canBeUngrouped()
Editor method - indicates that labels block can't be ungrouped.- Overrides:
canBeUngrouped
in classRMShape
-
childrenSuperSelectImmediately
public boolean childrenSuperSelectImmediately()
Editor method - indicates that labels child should super-select immediately.- Overrides:
childrenSuperSelectImmediately
in classRMShape
-
-