com.reportmill.shape.graph
Class RMGraphArea

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.graph.RMGraphArea

All Implemented Interfaces:

com.reportmill.shape.RMShapePainter.Paint, java.lang.Cloneable

public class RMGraphArea
extends RMShape
implements com.reportmill.shape.RMShapePainter.Paint

This class represents the actual graph area (a place holder really).

Field Summary

static java.lang.String	GRAPH_PART_3D
static java.lang.String	GRAPH_PART_BARS
static java.lang.String	GRAPH_PART_GRAPH_AREA
static java.lang.String	GRAPH_PART_LABEL_AXIS
static java.lang.String	GRAPH_PART_NONE
static java.lang.String	GRAPH_PART_PIE
static java.lang.String	GRAPH_PART_SERIES
static java.lang.String	GRAPH_PART_VALUE_AXIS
static java.lang.String	LAYOUT_ABREAST
static java.lang.String	LAYOUT_LAYER
static java.lang.String	LAYOUT_MERGE
static java.lang.String	LAYOUT_SEPARATE
static java.lang.String	LAYOUT_STACK

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

RMGraphArea()
Creates a new graph area.

Method Summary

java.lang.Object	clone() Standard clone implementation.
RMShape	cloneDeep() Overrides clone deep to avoid cloning children (just do rebuild).
void	copy(java.lang.Object anObj) Standard copy implementation.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
RMGraphPart3D	get3D() Returns the 3d shape.
RMGraphPartBars	getBars() Returns the bars shape.
RMRect	getBoundsMarked() Overrides shape implementation to reflect that transformed children may extend outside bounds.
RMFill	getFill(int anIndex) Returns the specific fill at the given index.
int	getFillCount() Override to use selected shape.
java.util.List	getFills() Returns this list of fills - a special list that can be operated on directly.
RMFont	getFont() Overrides shape implementation to pass on to selected shape.
RMFormat	getFormat() Overrides shape implementation to pass on to selected shape.
RMGraph	getGraph() Returns the graph that owns this graph area.
java.lang.String	getItemsLayout() Returns the layout of section items.
RMGraphPartLabelAxis	getLabelAxis() Returns the label axis shape.
RMXString.Outline	getOutline() Returns the outline for the shape.
RMGraphPartPie	getPie() Returns the pie shape.
java.lang.String	getSelectedPart() Returns the currently selected part.
RMShape	getSelectedPartShape() Returns the selected part shape.
RMGraphPartSeries	getSelectedSeries() Returns the selected series part.
RMGraphPartSeries	getSeries(int anIndex) Returns the individual series object and the given index.
int	getSeriesCount() Returns the number of series.
java.lang.String	getSeriesLayout() Returns the layout of series values.
RMColor	getTextColor() Returns the text color for the shape.
RMGraphPartValueAxis	getValueAxis() Returns the value axis shape.
boolean	isAbreast() Returns whether section items layout is abreast.
boolean	isLayered() Returns whether section items layout is layered.
boolean	isMeshed() Returns whether series layout is meshed.
boolean	isSeparated() Returns whether series layout is separated.
boolean	isStacked() Returns whether section items layout is stacked.
boolean	isUnderlined() Returns whether the shape is underlined.
boolean	isVertical() Returns whether graph area is considered vertical.
void	paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g) Overrides paintShape to suppress drawing.
void	rebuild() Notifies graph area that something crucial has changed requiring a rebuild.
void	rebuild3D() Notifies graph area that its 3D state has changed and 3D shape needs to be rebuilt.
void	rebuildImmediately() Notifies graph area that something crucial has changed requiring a rebuild.
RMShape	rpgClone(com.reportmill.base.ReportMill aRM, RMGraphRPG graphRPG) Returns a clone with report generation performed on it.
void	setFont(RMFont aFont) Overrides shape implementation to pass on to selected shape.
void	setFormat(RMFormat aFormat) Overrides shape implementation to pass on to selected shape.
void	setHeight(double aValue) Override to rebuild sample graph.
void	setItemsLayout(java.lang.String aLayout) Sets the layout of section items.
void	setNeedsRepaint() Overrides shape implementation to repaint parent.
void	setOutline(RMXString.Outline anOutline) Sets the outline for the shape.
void	setSelectedPart(java.awt.geom.Point2D aPoint) Sets the currently selected part by point.
void	setSelectedPart(java.lang.String aPart) Sets the currently selected part.
void	setSeriesLayout(java.lang.String aLayout) Sets the layout of series values.
void	setTextColor(RMColor aColor) Sets the text color for the shape.
void	setUnderlined(boolean aFlag) Sets the shape to underline.
void	setWidth(double aValue) Override to rebuild sample graph.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML archival.
void	toXMLDeep(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML archival - override shape implementation to suppress archival of children.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addChild, addChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createLayout, delete, didChange, divideShapeFromEdge, divideShapeFromTop, doLayout, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDatasetKey, getDatasetKeyDeep, getDatasetKeyShape, getDocument, getFill, getFill, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getListKey, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getToolClassName, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getXY, getXYP, getY, groupShapes, height, indexOf, indexOf, intersects, invalidate, isAncestor, isDescendant, isLocked, isRoot, isValid, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, revalidate, rpgClone, rpgCloneBase, rpgCloneChildren, rpgCloneNotification, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeightDeep, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setNeedsRepaint, setOpacity, setParent, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTime, setUrl, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, superSelectable, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.base.RMObject

didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

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

Field Detail

GRAPH_PART_NONE

public static final java.lang.String GRAPH_PART_NONE

See Also:

Constant Field Values

GRAPH_PART_GRAPH_AREA

public static final java.lang.String GRAPH_PART_GRAPH_AREA

See Also:

Constant Field Values

GRAPH_PART_VALUE_AXIS

public static final java.lang.String GRAPH_PART_VALUE_AXIS

See Also:

Constant Field Values

GRAPH_PART_LABEL_AXIS

public static final java.lang.String GRAPH_PART_LABEL_AXIS

See Also:

Constant Field Values

GRAPH_PART_BARS

public static final java.lang.String GRAPH_PART_BARS

See Also:

Constant Field Values

GRAPH_PART_PIE

public static final java.lang.String GRAPH_PART_PIE

See Also:

Constant Field Values

GRAPH_PART_3D

public static final java.lang.String GRAPH_PART_3D

See Also:

Constant Field Values

GRAPH_PART_SERIES

public static final java.lang.String GRAPH_PART_SERIES

See Also:

Constant Field Values

LAYOUT_MERGE

public static final java.lang.String LAYOUT_MERGE

See Also:

Constant Field Values

LAYOUT_SEPARATE

public static final java.lang.String LAYOUT_SEPARATE

See Also:

Constant Field Values

LAYOUT_ABREAST

public static final java.lang.String LAYOUT_ABREAST

See Also:

Constant Field Values

LAYOUT_STACK

public static final java.lang.String LAYOUT_STACK

See Also:

Constant Field Values

LAYOUT_LAYER

public static final java.lang.String LAYOUT_LAYER

See Also:

Constant Field Values

Constructor Detail

RMGraphArea

public RMGraphArea()

Creates a new graph area.

Method Detail

getGraph

public RMGraph getGraph()

Returns the graph that owns this graph area.

getSeriesLayout

public java.lang.String getSeriesLayout()

Returns the layout of series values.

setSeriesLayout

public void setSeriesLayout(java.lang.String aLayout)

Sets the layout of series values.

getItemsLayout

public java.lang.String getItemsLayout()

Returns the layout of section items.

setItemsLayout

public void setItemsLayout(java.lang.String aLayout)

Sets the layout of section items.

isVertical

public boolean isVertical()

Returns whether graph area is considered vertical.

isMeshed

public boolean isMeshed()

Returns whether series layout is meshed.

isSeparated

public boolean isSeparated()

Returns whether series layout is separated.

isAbreast

public boolean isAbreast()

Returns whether section items layout is abreast.

isStacked

public boolean isStacked()

Returns whether section items layout is stacked.

isLayered

public boolean isLayered()

Returns whether section items layout is layered.

getSelectedPart

public java.lang.String getSelectedPart()

Returns the currently selected part.

setSelectedPart

public void setSelectedPart(java.lang.String aPart)

Sets the currently selected part.

getSelectedPartShape

public RMShape getSelectedPartShape()

Returns the selected part shape.

getFillCount

public int getFillCount()

Override to use selected shape.

Overrides:

getFillCount in class RMShape

getFill

public RMFill getFill(int anIndex)

Returns the specific fill at the given index.

Overrides:

getFill in class RMShape

getFills

public java.util.List getFills()

Returns this list of fills - a special list that can be operated on directly.

Overrides:

getFills in class RMShape

getTextColor

public RMColor getTextColor()

Returns the text color for the shape.

Overrides:

getTextColor in class RMShape

setTextColor

public void setTextColor(RMColor aColor)

Sets the text color for the shape.

Overrides:

setTextColor in class RMShape

getFont

public RMFont getFont()

Overrides shape implementation to pass on to selected shape.

Overrides:

getFont in class RMShape

setFont

public void setFont(RMFont aFont)

Overrides shape implementation to pass on to selected shape.

Overrides:

setFont in class RMShape

isUnderlined

public boolean isUnderlined()

Returns whether the shape is underlined.

Overrides:

isUnderlined in class RMShape

setUnderlined

public void setUnderlined(boolean aFlag)

Sets the shape to underline.

Overrides:

setUnderlined in class RMShape

getOutline

public RMXString.Outline getOutline()

Returns the outline for the shape.

Overrides:

getOutline in class RMShape

setOutline

public void setOutline(RMXString.Outline anOutline)

Sets the outline for the shape.

Overrides:

setOutline in class RMShape

getFormat

public RMFormat getFormat()

Overrides shape implementation to pass on to selected shape.

Overrides:

getFormat in class RMShape

setFormat

public void setFormat(RMFormat aFormat)

Overrides shape implementation to pass on to selected shape.

Overrides:

setFormat in class RMShape

setNeedsRepaint

public void setNeedsRepaint()

Overrides shape implementation to repaint parent.

Overrides:

setNeedsRepaint in class RMShape

getBoundsMarked

public RMRect getBoundsMarked()

Overrides shape implementation to reflect that transformed children may extend outside bounds.

Overrides:

getBoundsMarked in class RMShape

setSelectedPart

public void setSelectedPart(java.awt.geom.Point2D aPoint)

Sets the currently selected part by point.

getValueAxis

public RMGraphPartValueAxis getValueAxis()

Returns the value axis shape.

getLabelAxis

public RMGraphPartLabelAxis getLabelAxis()

Returns the label axis shape.

getBars

public RMGraphPartBars getBars()

Returns the bars shape.

getPie

public RMGraphPartPie getPie()

Returns the pie shape.

getSeriesCount

public int getSeriesCount()

Returns the number of series.

getSeries

public RMGraphPartSeries getSeries(int anIndex)

Returns the individual series object and the given index.

getSelectedSeries

public RMGraphPartSeries getSelectedSeries()

Returns the selected series part.

get3D

public RMGraphPart3D get3D()

Returns the 3d shape.

paintShape

public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
                       java.awt.Graphics2D g)

Overrides paintShape to suppress drawing.

Specified by:

paintShape in interface com.reportmill.shape.RMShapePainter.Paint

setWidth

public void setWidth(double aValue)

Override to rebuild sample graph.

Overrides:

setWidth in class RMShape

setHeight

public void setHeight(double aValue)

Override to rebuild sample graph.

Overrides:

setHeight in class RMShape

rebuild

public void rebuild()

Notifies graph area that something crucial has changed requiring a rebuild.

rebuildImmediately

public void rebuildImmediately()

Notifies graph area that something crucial has changed requiring a rebuild.

rebuild3D

public void rebuild3D()

Notifies graph area that its 3D state has changed and 3D shape needs to be rebuilt.

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class RMShape

copy

public void copy(java.lang.Object anObj)

Standard copy implementation.

Overrides:

copy in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill aRM,
                        RMGraphRPG graphRPG)

Returns a clone with report generation performed on it.

cloneDeep

public RMShape cloneDeep()

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

Overrides:

cloneDeep in class RMShape

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

toXMLDeep

public void toXMLDeep(com.reportmill.archiver.RXArchiver anArchiver,
                      com.reportmill.archiver.RXElement anElement)

XML archival - override shape implementation to suppress archival of children.

Overrides:

toXMLDeep in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape