Package com.inductiveautomation.rm.shape.rm2dshapes

Class RMPieChart

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMParentShape

com.inductiveautomation.rm.shape.rm2dshapes.AbstractRM2DShape

com.inductiveautomation.rm.shape.rm2dshapes.RMScriptableChart

com.inductiveautomation.rm.shape.rm2dshapes.RMPieChart

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, Unexpandable, PropertyChangeListener, Cloneable, EventListener

public class RMPieChart
extends RMScriptableChart

This shape is used as the pie chart component for the reporting module. It renders using a JFreeChart pie plot.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARCHIVE_NAME
static final String	DEFAULT_LABEL_FORMAT
static final int	LABELS_NONE
static final int	LABELS_OUTSET
static final int	LABELS_SIMPLE
static final int	SORT_KEYS_ASC
static final int	SORT_KEYS_DESC
static final int	SORT_NONE
static final int	SORT_VALUES_ASC
static final int	SORT_VALUES_DESC
static final int	STYLE_3D
static final int	STYLE_PIE
static final int	STYLE_RING

Fields inherited from class com.inductiveautomation.rm.shape.rm2dshapes.AbstractRM2DShape

DEFAULT_COLORS, logger, USE_RASTER_ATTRIB, USE_RASTER_PROPERTY_STRING

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Constructor Summary

Constructors

Constructor	Description
RMPieChart()

Method Summary

Modifier and Type	Method	Description
RMShape	fromXML(RXArchiver anArchiver, RXElement e)	XML unarchival.
Color[]	getColors()
String	getDatasetKey()	Returns the dataset key associated with this shape.
Font	getLabelFont()
String	getLabelFormat()
String	getLabelKey()
int	getLabelStyle()
Font	getLegendFont()
Color	getSectionOutline()
int	getSort()
int	getStyle()
String	getValueKey()
boolean	isChartShadowVisible()
boolean	isLegend()
protected void	render(Graphics2D g, int width, int height)	This is where implementations of AbstractRM2DShape actual paint themselves to a graphics context, to produce either a vector or raster graphic.
protected RMShape	rpgShape(ReportOwner owner, RMShape aParent)	Generate report with report owner.
void	setChartShadowVisible(boolean chartShadowVisible)
void	setColors(Color[] colors)
void	setDatasetKey(String key)
void	setLabelFont(Font labelFont)
void	setLabelFormat(String labelFormat)
void	setLabelKey(String labelKey)
void	setLabelStyle(int labelStyle)
void	setLegend(boolean legend)
void	setLegendFont(Font legendFont)
void	setSectionOutline(Color outline)
void	setSort(int sort)	Set to @NonKeyMappable because key mapping isn't working.
void	setStyle(int style)
void	setValueKey(String valueKey)
RXElement	toXML(RXArchiver anArchiver)	XML archival.

Methods inherited from class com.inductiveautomation.rm.shape.rm2dshapes.RMScriptableChart

applyConfigureChartScript, getScript, isScriptEnabled, setReportData, setScript, setScriptEnabled

Methods inherited from class com.inductiveautomation.rm.shape.rm2dshapes.AbstractRM2DShape

clone, getDefaultColorCodes, getDefaultColors, getDisplayedFill, getRenderContext, getUseRaster, getUserRasterInternal, isRpg, setDirty, setIsRpg, setRenderContext, setUseRaster, useImageForVector, writeEnd, writeStart

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape

addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, cloneDeep, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXMLChildren, fromXMLShape, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, layoutChildren, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXMLChildren, toXMLShape

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getChildClipShape, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShape, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgBindings, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ARCHIVE_NAME

public static final String ARCHIVE_NAME

See Also:

• Constant Field Values

LABELS_NONE

public static final int LABELS_NONE

See Also:

• Constant Field Values

LABELS_SIMPLE

public static final int LABELS_SIMPLE

See Also:

• Constant Field Values

LABELS_OUTSET

public static final int LABELS_OUTSET

See Also:

• Constant Field Values

SORT_NONE

public static final int SORT_NONE

See Also:

• Constant Field Values

SORT_KEYS_ASC

public static final int SORT_KEYS_ASC

See Also:

• Constant Field Values

SORT_KEYS_DESC

public static final int SORT_KEYS_DESC

See Also:

• Constant Field Values

SORT_VALUES_ASC

public static final int SORT_VALUES_ASC

See Also:

• Constant Field Values

SORT_VALUES_DESC

public static final int SORT_VALUES_DESC

See Also:

• Constant Field Values

STYLE_PIE

public static final int STYLE_PIE

See Also:

• Constant Field Values

STYLE_3D

public static final int STYLE_3D

See Also:

• Constant Field Values

STYLE_RING

public static final int STYLE_RING

See Also:

• Constant Field Values

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT

See Also:

• Constant Field Values

Constructor Details

RMPieChart

public RMPieChart()

Method Details

rpgShape

protected RMShape rpgShape(ReportOwner owner,
 RMShape aParent)

Description copied from class: RMShape

Generate report with report owner.

Overrides:

rpgShape in class RMShape

render

protected void render(Graphics2D g,
 int width,
 int height)

Description copied from class: AbstractRM2DShape

This is where implementations of AbstractRM2DShape actual paint themselves to a graphics context, to produce either a vector or raster graphic.

Specified by:

render in class AbstractRM2DShape

getColors

public Color[] getColors()

setColors

public void setColors(Color[] colors)

getDatasetKey

public String getDatasetKey()

Description copied from class: RMShape

Returns the dataset key associated with this shape.

Overrides:

getDatasetKey in class RMShape

setDatasetKey

public void setDatasetKey(String key)

getLabelKey

public String getLabelKey()

setLabelKey

public void setLabelKey(String labelKey)

getValueKey

public String getValueKey()

setValueKey

public void setValueKey(String valueKey)

getSort

public int getSort()

setSort

public void setSort(int sort)

Set to @NonKeyMappable because key mapping isn't working.

getStyle

public int getStyle()

setStyle

public void setStyle(int style)

isLegend

public boolean isLegend()

setLegend

public void setLegend(boolean legend)

getLabelStyle

public int getLabelStyle()

setLabelStyle

public void setLabelStyle(int labelStyle)

getLabelFormat

public String getLabelFormat()

setLabelFormat

public void setLabelFormat(String labelFormat)

getLabelFont

public Font getLabelFont()

setLabelFont

public void setLabelFont(Font labelFont)

getLegendFont

public Font getLegendFont()

setLegendFont

public void setLegendFont(Font legendFont)

getSectionOutline

public Color getSectionOutline()

setSectionOutline

public void setSectionOutline(Color outline)

isChartShadowVisible

public boolean isChartShadowVisible()

setChartShadowVisible

public void setChartShadowVisible(boolean chartShadowVisible)

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

Overrides:

toXML in class RMScriptableChart

fromXML

public RMShape fromXML(RXArchiver anArchiver,
 RXElement e)

XML unarchival.

Specified by:

fromXML in interface Archivable

Overrides:

fromXML in class RMScriptableChart