ReportMill 11 API

com.reportmill.graphing
Class RMGraphArea

java.lang.Object
  extended by com.reportmill.base.RMObject
      extended by com.reportmill.shape.RMShape
          extended by com.reportmill.graphing.RMGraphArea
All Implemented Interfaces:
com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMGraphArea
extends RMShape

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
 void addChild(RMShape aShape, int anIndex)
          Overrides shape version to suppress property change.
 RMGraphArea clone()
          Standard clone implementation.
 RMShape cloneDeep()
          Overrides clone deep to avoid cloning children (just do rebuild).
 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).
 RMGraphPart3D get3D()
          Returns the 3d shape.
 RMGraphPartBars getBars()
          Returns the bars shape.
 com.reportmill.shape.fill.RMEffect getEffect()
          Override to use selected shape.
 RMFill getFill()
          Override to use selected shape.
 RMFill getFillSuper()
          Override to use selected shape.
 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.
 RMShape getSampleGraphArea()
          Returns a graph area configured like this one showing sample data.
 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.
 RMStroke getStroke()
          Override to use selected shape.
 RMStroke getStrokeSuper()
          Override to use selected shape.
 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 paint(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g)
          Overrides paint to suppress selected part.
 void paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g)
          Overrides paintShape to suppress normal shape paint.
 void paintShapeOver(com.reportmill.shape.RMShapePainter painter, java.awt.Graphics2D graphics)
          Overrides paintShapeOver to suppress normal shape paint.
 void propertyChange(java.beans.PropertyChangeEvent anEvent)
          Overrides normal version to suppress child changes and propagate part changes.
 void rebuild()
          Notifies graph area that something crucial has changed requiring a rebuild.
 void rebuildImmediately()
          Notifies graph area that something crucial has changed requiring a rebuild.
 RMShape removeChild(int anIndex)
          Overrides shape version to suppress property change.
 void repaint()
          Overrides shape implementation to repaint parent too.
 void revalidate()
          Overrides shape implementation to request rebuild.
 RMShape rpgClone(com.reportmill.base.ReportMill aRM, RMGraph aGraph)
          Returns a clone with report generation performed on it.
 void set3D(RMGraphPart3D aGraphPart3D)
          Sets the 3d shape.
 void setEffect(com.reportmill.shape.fill.RMEffect anEffect)
          Override to use selected shape.
 void setFill(RMFill aFill)
          Override to use selected shape.
 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 setItemsLayout(java.lang.String aLayout)
          Sets the layout of section items.
 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 setStroke(RMStroke aStroke)
          Override to use selected shape.
 void setTextColor(RMColor aColor)
          Sets the text color for the shape.
 void setUnderlined(boolean aFlag)
          Sets the shape to underline.
 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 shape implementation to suppress archival of children.
 void validate()
          Override validate to rebuild.
 
Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, 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, getFill, getFillCount, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getMaskPath, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOriginal, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStrokeColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getWidthToFit, 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, paintShapeAll, paintShapeChildren, put, removeBinding, removeBinding, removeChild, removeChildren, removeFromParent, repaint, resolvePageReferences, sendShapesToBack, setAction, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setOpacity, setParent, setReportMill, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStrokeColor, setTime, setUrl, setVisible, setWidth, setWidthToFit, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, sizesToFitChildren, superSelectable, toString, 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
 

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.


getStroke

public RMStroke getStroke()
Override to use selected shape.

Overrides:
getStroke in class RMShape

setStroke

public void setStroke(RMStroke aStroke)
Override to use selected shape.

Overrides:
setStroke in class RMShape

getStrokeSuper

public RMStroke getStrokeSuper()
Override to use selected shape.


getFill

public RMFill getFill()
Override to use selected shape.

Overrides:
getFill in class RMShape

setFill

public void setFill(RMFill aFill)
Override to use selected shape.

Overrides:
setFill in class RMShape

getFillSuper

public RMFill getFillSuper()
Override to use selected shape.


getEffect

public com.reportmill.shape.fill.RMEffect getEffect()
Override to use selected shape.

Overrides:
getEffect in class RMShape

setEffect

public void setEffect(com.reportmill.shape.fill.RMEffect anEffect)
Override to use selected shape.

Overrides:
setEffect 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

repaint

public void repaint()
Overrides shape implementation to repaint parent too.

Overrides:
repaint 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.


set3D

public void set3D(RMGraphPart3D aGraphPart3D)
Sets the 3d shape.


revalidate

public void revalidate()
Overrides shape implementation to request rebuild.

Overrides:
revalidate in class RMShape

validate

public void validate()
Override validate to rebuild.

Overrides:
validate 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.


addChild

public void addChild(RMShape aShape,
                     int anIndex)
Overrides shape version to suppress property change.

Overrides:
addChild in class RMShape

removeChild

public RMShape removeChild(int anIndex)
Overrides shape version to suppress property change.

Overrides:
removeChild in class RMShape

paint

public void paint(com.reportmill.shape.RMShapePainter aPainter,
                  java.awt.Graphics2D g)
Overrides paint to suppress selected part.

Overrides:
paint in class RMShape

paintShape

public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
                       java.awt.Graphics2D g)
Overrides paintShape to suppress normal shape paint.

Overrides:
paintShape in class RMShape

paintShapeOver

public void paintShapeOver(com.reportmill.shape.RMShapePainter painter,
                           java.awt.Graphics2D graphics)
Overrides paintShapeOver to suppress normal shape paint.

Overrides:
paintShapeOver in class RMShape

getSampleGraphArea

public RMShape getSampleGraphArea()
Returns a graph area configured like this one showing sample data.


propertyChange

public void propertyChange(java.beans.PropertyChangeEvent anEvent)
Overrides normal version to suppress child changes and propagate part changes.

Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Overrides:
propertyChange in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill aRM,
                        RMGraph aGraph)
Returns a clone with report generation performed on it.


equals

public boolean equals(java.lang.Object anObj)
Standard equals implementation.

Overrides:
equals in class RMShape

clone

public RMGraphArea clone()
Standard clone implementation.

Overrides:
clone in class RMShape

cloneDeep

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

Overrides:
cloneDeep 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

toXMLShapeChildren

public void toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
                               com.reportmill.archiver.RXElement anElement,
                               java.lang.Object anOwner)
XML archival - override shape implementation 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

ReportMill 11 API