netcharts.pro.charts.bar
Class NFBarchart

java.lang.Object
  |
  +--netcharts.pro.common.NFGraph
        |
        +--netcharts.pro.common.zoomable.NFZoomableChart
              |
              +--netcharts.pro.common.rectangular.NFDataChart
                    |
                    +--netcharts.pro.common.barset.NFAbstractBarchart
                          |
                          +--netcharts.pro.charts.bar.NFBarchart

All Implemented Interfaces:

java.io.Externalizable, NFDragObserver, NFDwellObserver, NFGraphObserver, NFScrollObserver, java.io.Serializable

public class NFBarchart

extends NFAbstractBarchart

Represents a bar chart. Provides the ability to configure the chart via object manipulation or directly from CDL.

See Also:

Serialized Form

Fields inherited from class netcharts.pro.common.barset.NFAbstractBarchart

barchartTypeMap, BOTTOMUP, GROUP, GROUPSTACK, HORIZONTAL, ITEM, orientationMap, ROWS, STACK, stackDisplayOrderMap, stackTypeMap, TOPDOWN, TOTAL, VERTICAL

Fields inherited from class netcharts.pro.common.zoomable.NFZoomableChart

NOZOOM, zoomActionsMap, ZOOMIN, ZOOMOUT

Fields inherited from class netcharts.pro.common.NFGraph

ANTIALIAS_OFF, ANTIALIAS_ON, ANTIALIAS_ONDRAW, ANTIALIAS_ONTEXT, antiAliasModeMap, BAR, BOX, BUBBLE, COMBO, DIAGRAM, DIAL, HEATMAP, LINE, MULTIPIE, PARETO, PIE, POLAR, RADAR, STOCK, STRIP, TIME, XY

Constructor Summary

NFBarchart()
Constructs a default chart object.

NFBarchart(javax.swing.JPanel panel)
Constructs a chart object on the given JPanel.

NFBarchart(javax.swing.JPanel panel, java.util.Properties initProperties)
Constructs a chart object on the given JPanel.

NFBarchart(java.util.Properties initProperties)
Constructs a chart object on the given JPanel.

Method Summary

int	getBarchartType() Get barchart type, either GROUP (default), STACK, GROUPSTACK or ROWS.
java.lang.String	getDefaultData() Returns a string of default data
int	getDepth() Get 3DDepth
NFVector	getGroupStackLabels() Get the labels to be displayed under each stack in a GROUPSTACK chart.
NFVector	getGroupStackSegmentLabels() Get the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode.
int	getOrientation() Get bar orientation, either VERTICAL (default) or HORIZONTAL
boolean	getShowGroupStackLabels() Get whether the group stack labels should be displayed when in GROUPSTACK mode.
int	getType() Gets the chart type.
void	resetState() Resets all of the parameter values to their initial state.
void	setBarchartType(int type) Set barchart type, either GROUP (default), STACK, GROUPSTACK or ROWS.
void	setDepth(int depth) Set 3DDepth
void	setGroupStackLabels(NFVector groupStackLabels) Set the labels to be displayed under each stack in a GROUPSTACK chart.
void	setGroupStackSegmentLabels(NFVector groupStackSegmentLabels) Set the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode.
void	setOrientation(int orientation) Set bar orientation, either VERTICAL (default) or HORIZONTAL.
void	setShowGroupStackLabels(boolean showGroupStackLabels) Set whether the group stack labels should be displayed when in GROUPSTACK mode.
void	writeChart(java.lang.StringBuffer sb) Writes this chart into a string buffer
void	writeExternal(java.io.ObjectOutput out) Writes this chart into an object for serialization.

Methods inherited from class netcharts.pro.common.barset.NFAbstractBarchart

addBarSet, getBarActiveLabels, getBarBorder, getBarSeries, getBarValueLabel, getBarValueLabelRegion, getBarWidth, getDataLabels, getStackDisplayOrder, getStackType, getZAxisLabels, setBarActiveLabels, setBarBorder, setBarSeries, setBarValueLabel, setBarValueLabelRegion, setBarWidth, setDataLabels, setStackDisplayOrder, setStackType, setZAxisLabels

Methods inherited from class netcharts.pro.common.rectangular.NFDataChart

addGrid, getAutoscalePad, getAxesSizes, getAxisThickness, getBottomAxis, getBottomAxisSeries, getGrid, getGridDepth, getGridSeries, getLeftAxis, getLeftAxisSeries, getRightAxis, getRightAxisSeries, getTopAxis, getTopAxisSeries, setAutoscalePad, setAxesSizes, setAxisThickness, setBottomAxis, setBottomAxisSeries, setGrid, setGridDepth, setGridSeries, setLeftAxis, setLeftAxisSeries, setRightAxis, setRightAxisSeries, setTopAxis, setTopAxisSeries

Methods inherited from class netcharts.pro.common.zoomable.NFZoomableChart

getMouseControlDown, getMouseMetaDown, getMouseShiftDown, getZoomingEnabled, setMouseControlDown, setMouseMetaDown, setMouseShiftDown, setZoomingEnabled

Methods inherited from class netcharts.pro.common.NFGraph

addChartActionListener, addGraphObserver, addNote, addPropertyChangeListener, display, dwellDisplay, dwellPress, finalize, getActiveClicks, getAlwaysUpdate, getAntiAlias, getAntiAliasMode, getBackgroundFillPattern, getBackgroundRegion, getCDL, getChartElementSpacing, getChartName, getChartSize, getColorTable, getDataActiveLabelsEnabled, getDwell, getDwellOffset, getErrors, getFooter, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphGraphics, getHeader, getLeftTitle, getLegend, getMetaData, getMinimumSize, getNoteSeries, getNumberFormat, getNumErrors, getPanel, getPlotArea, getPreferredSize, getRightTitle, getRootPanel, getScaleFactor, graphDrawn, graphTooSmall, initializeFromFile, initializeFromString, initializeFromURL, loadFromTemplate, loadFromTemplate, loadFromTemplate, loadLicenseFile, paint, postDrag, postScroll, preDrag, preScroll, readExternal, removeChartActionListener, removeGraphObserver, removePropertyChangeListener, sendData, sendData, sendData, sendData, sendUpdate, set, set, set, set, set, set, setActiveClicks, setAlwaysUpdate, setAntiAlias, setAntiAliasMode, setBackgroundFillPattern, setBackgroundRegion, setChartElementSpacing, setChartName, setChartSize, setColorTable, setDataActiveLabelsEnabled, setDocumentBase, setDwell, setDwellOffset, setFooter, setHeader, setLeftTitle, setLegend, setLicenseKey, setMetaData, setNoteSeries, setNumberFormat, setParentApplet, setPlotArea, setRightTitle, setScaleFactor, setSize, setSize, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NFBarchart

public NFBarchart()

Constructs a default chart object.

NFBarchart

public NFBarchart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFBarchart

public NFBarchart(java.util.Properties initProperties)

Constructs a chart object on the given JPanel.

Parameters:

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

NFBarchart

public NFBarchart(javax.swing.JPanel panel,
                  java.util.Properties initProperties)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

Method Detail

getDefaultData

public java.lang.String getDefaultData()

Returns a string of default data

Overrides:

getDefaultData in class NFGraph

Following copied from class: netcharts.pro.common.NFGraph

Returns:

The default data used to initialize a chart.

setOrientation

public void setOrientation(int orientation)

Set bar orientation, either VERTICAL (default) or HORIZONTAL.

If the value passed is not a valid format type, VERTICAL will be used.

Parameters:

orientation - One of HORIZONTAL, VERTICAL

getOrientation

public int getOrientation()

Get bar orientation, either VERTICAL (default) or HORIZONTAL

Returns:

orientation One of HORIZONTAL, VERTICAL

setBarchartType

public void setBarchartType(int type)

Set barchart type, either GROUP (default), STACK, GROUPSTACK or ROWS.

If the value passed is not a valid barchart type, GROUP will be used.

Parameters:

type - One of GROUP, STACK, or ROWS

getBarchartType

public int getBarchartType()

Get barchart type, either GROUP (default), STACK, GROUPSTACK or ROWS.

Returns:

type One of GROUP, STACK, GROUPSTACK or ROWS

setDepth

public void setDepth(int depth)

Set 3DDepth

Parameters:

depth - 3D shadow depth

getDepth

public int getDepth()

Get 3DDepth

Returns:

depth 3D shadow depth

setShowGroupStackLabels

public void setShowGroupStackLabels(boolean showGroupStackLabels)

Set whether the group stack labels should be displayed when in GROUPSTACK mode.

Parameters:

showGroupStackLabels - true if the labels should be shown

getShowGroupStackLabels

public boolean getShowGroupStackLabels()

Get whether the group stack labels should be displayed when in GROUPSTACK mode.

Returns:

true if the labels should be shown, false otherwise

setGroupStackLabels

public void setGroupStackLabels(NFVector groupStackLabels)

Set the labels to be displayed under each stack in a GROUPSTACK chart. The vector contains a list of string values.

Returns:

groupStackLabels

getGroupStackLabels

public NFVector getGroupStackLabels()

Get the labels to be displayed under each stack in a GROUPSTACK chart. The vector contains a list of string values.

Returns:

groupStackLabels

setGroupStackSegmentLabels

public void setGroupStackSegmentLabels(NFVector groupStackSegmentLabels)

Set the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode. The vector contains a list of string values.

Returns:

groupStackSegmentLabels

getGroupStackSegmentLabels

public NFVector getGroupStackSegmentLabels()

Get the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode. The vector contains a list of string values.

Returns:

groupStackSegmentLabels

getType

public int getType()

Gets the chart type.

Overrides:

getType in class NFGraph

Returns:

the type of this chart, always netcharts.pro.charts.bar.NFGraph.BAR

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Writes this chart into an object for serialization.

Overrides:

writeExternal in class NFAbstractBarchart

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFAbstractBarchart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFAbstractBarchart