com.reportmill.graphing
Class RMGraphLegend

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMRectangle
              com.reportmill.shape.RMText
                  com.reportmill.graphing.RMGraphLegend

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMGraphLegend
extends RMText

An inner class for Legend.

Field Summary

Fields inherited from class com.reportmill.shape.RMText

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_FULL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, WRAP_BASIC, WRAP_NONE, WRAP_SCALE

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

RMGraphLegend()
Creates a new graph legend.

Method Summary

RMShape	cloneDeep() Overrides clone deep to avoid cloning children (just do rebuild).
RMXString	createXString() Overrides RMText method to create an xstring that defaults to Arial 10.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
void	fromXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival - override to suppress unarchival of children (don't really need this).
RMColor	getColor(int anIndex) Returns the color at the given index.
RMGraph	getGraph() Returns the graph that owns this legend.
java.lang.String	getLegendText() Returns the legend text.
java.lang.String	getString(int anIndex) Returns the specific string at the given index.
int	getStringCount() Returns the number of legend strings.
void	rebuild() Notifies Legend to rebuild.
RMShape	rpgClone(com.reportmill.base.ReportMill aReportMill, RMGraph aGraph) Returns a RPG'd legend for the graph RPG.
void	setLegendText(java.lang.String aString) Sets the legend text.
void	setStrings(java.util.List aStringsList) Sets strings list.
void	setWidth(float aWidth) Overrides shape implementation to register for rebuild.
boolean	superSelectable() Editor method - indicates whether this shape can be super selected.
com.reportmill.archiver.RXElement	toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.
void	toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML archival - override to suppress archival of children.
void	validate() Overrides shape implementation to actually rebuild.

Methods inherited from class com.reportmill.shape.RMText

clone, copyText, fromXMLFinish, getAlign, getAlignString, getAlignVertical, getAlignVerticalString, getBoundsFromTextBounds, getCharSpacing, getCoalesceNewlines, getDrawsSelectionRect, getFont, getFormat, getFragPath, getFragPathShape, getHeightToFit, getHeightToFit, getLineGap, getLineHeightMax, getLineHeightMin, getLineSpacing, getLinkedText, getMargin, getMarginBottom, getMarginDefault, getMarginLeft, getMarginRight, getMarginString, getMarginTop, getMaskPath, getObject, getOutline, getPath, getPathInBounds, getPathInBounds, getPathShape, getPerformsWrap, getText, getTextBounds, getTextCharsShape, getTextColor, getTextLayout, getTextLayout, getTextOrigin, getTextPath, getTextPathShape, getVisibleEnd, getVisibleStart, getWidthToFit, getWraps, getXString, isAllTextVisible, isStructured, isUnderlined, length, paginate, paintShape, peerDidChange, repaint, resolvePageReferences, scaleFonts, scaleTextToFit, setAlign, setAlignVertical, setAlignVerticalString, setCharSpacing, setCoalesceNewlines, setDrawsSelectionRect, setFont, setFormat, setHeight, setHeightToFit, setLineGap, setLineHeightMax, setLineHeightMin, setLineSpacing, setLinkedText, setMargin, setMarginString, setObject, setOutline, setPathShape, setPerformsWrap, setRadius, setReportMill, setText, setTextColor, setUnderlined, setWraps, setXString, textDidChange, toString

Methods inherited from class com.reportmill.shape.RMRectangle

getRadius

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addChild, addChild, animUpdate, bounds, boundsChanged, boundsChanged, bringShapesToFront, checkBindings, childrenSuperSelectImmediately, 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, get, getAction, getAncestor, getAncestorCount, getAncestorInCommon, getAnim, getAnim, getAnimator, getAnimator, getAspectMapped, getAspects, getAutosizeHeight, getAutosizing, getBinder, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDatasetKey, getDocument, getEffect, getFill, getFill, getFillCount, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getImageFill, getLayout, getLineWidth, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOriginal, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isLocked, isMouseDown, isMouseOver, isRoot, isShowing, isValid, isViewing, isVisible, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeFromParent, repaint, revalidate, sendShapesToBack, setAction, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setFill, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setOpacity, setParent, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTime, setUrl, setVisible, setWidthToFit, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, sizesToFitChildren, toXML, undoerDisable, undoerEnable, undoerSetUndoTitle, 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

RMGraphLegend

public RMGraphLegend()

Creates a new graph legend.

Method Detail

getGraph

public RMGraph getGraph()

Returns the graph that owns this legend.

createXString

public RMXString createXString()

Overrides RMText method to create an xstring that defaults to Arial 10.

getLegendText

public java.lang.String getLegendText()

Returns the legend text.

setLegendText

public void setLegendText(java.lang.String aString)

Sets the legend text.

getStringCount

public int getStringCount()

Returns the number of legend strings.

getString

public java.lang.String getString(int anIndex)

Returns the specific string at the given index.

setStrings

public void setStrings(java.util.List aStringsList)

Sets strings list.

getColor

public RMColor getColor(int anIndex)

Returns the color at the given index.

validate

public void validate()

Overrides shape implementation to actually rebuild.

Overrides:

validate in class RMShape

rebuild

public void rebuild()

Notifies Legend to rebuild.

setWidth

public void setWidth(float aWidth)

Overrides shape implementation to register for rebuild.

Overrides:

setWidth in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMText

cloneDeep

public RMShape cloneDeep()

Overrides clone deep to avoid cloning children (just do rebuild).

Overrides:

cloneDeep in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill aReportMill,
                        RMGraph aGraph)

Returns a RPG'd legend for the graph RPG.

superSelectable

public boolean superSelectable()

Editor method - indicates whether this shape can be super selected.

Overrides:

superSelectable in class RMText

toXMLShape

public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                                    java.lang.Object anOwner)

XML archival.

Overrides:

toXMLShape in class RMText

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 RMText

toXMLShapeChildren

public void toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                               com.reportmill.archiver.RXElement anElement,
                               java.lang.Object anOwner)

XML archival - override to suppress archival of children.

Overrides:

toXMLShapeChildren in class RMShape

fromXMLShapeChildren

public void fromXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                                 com.reportmill.archiver.RXElement anElement,
                                 java.lang.Object anOwner)

XML unarchival - override to suppress unarchival of children (don't really need this).

Overrides:

fromXMLShapeChildren in class RMShape