netcharts.pro.charts.time
Class NFTimechart

java.lang.Object
  netcharts.pro.common.NFGraph
      netcharts.pro.common.zoomable.NFZoomableChart
          netcharts.pro.common.rectangular.NFDataChart
              netcharts.pro.charts.time.NFTimechart

All Implemented Interfaces:

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

public class NFTimechart
extends NFDataChart

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

See Also:

Serialized Form

Field Summary

static int	TASK_ANIMATION_STYLE_FADE Task animation style fade
static int	TASK_ANIMATION_STYLE_NONE No task animation style
static int	TASK_ANIMATION_STYLE_SCALE Task animation style scale

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

GRID_ANIMATION_STYLE_FADE, GRID_ANIMATION_STYLE_NONE

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, BAR3D, BOX, BUBBLE, COMBO, DIAGRAM, DIAL, DWELL_ANIMATION_STYLE_HIGHLIGHT, DWELL_ANIMATION_STYLE_NONE, FADE, HEATMAP, HIGHLIGHT, HISTOGRAM, LABEL_ANIMATION_STYLE_FADE, LABEL_ANIMATION_STYLE_NONE, LEGEND_ANIMATION_STYLE_FADE, LEGEND_ANIMATION_STYLE_NONE, LEGEND_DWELL_ANIMATION_STYLE_HIGHLIGHT, LEGEND_DWELL_ANIMATION_STYLE_NONE, LINE, MULTIPIE, PARETO, PIE, POLAR, RADAR, STOCK, STRIP, TIME, XY

Constructor Summary

NFTimechart()
Constructs a default chart object.

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

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

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

Method Summary

void	addTimeSet(NFTimeSet timeSet) Adds a time set to the current list of timesets.
java.lang.String	getDefaultData() Returns a string of default data
int	getTaskAnimationStyle() Get the task animation style.
int	getTaskHeight() Gets the task height factor to use when drawing tasks.
NFTimeSeries	getTimeSeries() Get the time series.
int	getType() Gets the chart type.
boolean	getUseUniqueTaskColors() Get whether the use of unique task colors is being enforced.
void	resetState() Resets all of the parameter values to their initial state.
void	setTaskAnimationStyle(int style) Set the task animation style.
void	setTaskHeight(int taskHeight) Sets the task height factor to use when drawing tasks.
void	setTimeSeries(NFTimeSeries timeSeries) Set the time series.
void	setUseUniqueTaskColors(boolean useUniqueTaskColors) Enable or disable the use of unique task colors within the chart.
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.rectangular.NFDataChart

addGrid, getAutoscalePad, getAxesSizes, getAxisThickness, getBottomAxis, getBottomAxisSeries, getGrid, getGridAnimationStyle, getGridDepth, getGridSeries, getLeftAxis, getLeftAxisSeries, getRightAxis, getRightAxisSeries, getTopAxis, getTopAxisSeries, getXAxis, getYAxis, setAutoscalePad, setAxesSizes, setAxisThickness, setBottomAxis, setBottomAxisSeries, setGrid, setGridAnimationStyle, 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, zoom

Methods inherited from class netcharts.pro.common.NFGraph

addChartActionListener, addGraphObserver, addNote, addPropertyChangeListener, display, dwellDisplay, dwellPress, finalize, getActiveClicks, getAlwaysUpdate, getAntiAlias, getAntiAliasMode, getBackgroundActiveLabel, getBackgroundFillPattern, getBackgroundRegion, getBuildAnimationEnabled, getCDL, getChartElementSpacing, getChartName, getChartSize, getColorTable, getDataActiveLabelsEnabled, getDwell, getDwellAnimation, getDwellAnimationHighlight, getDwellAnimationStyle, getDwellOffset, getErrors, getFooter, getGraph, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphGraphics, getHeader, getLabelAnimationStyle, getLeftTitle, getLegend, getLegendAnimationStyle, getLegendDwellAnimation, getLegendDwellAnimationHighlight, getLegendDwellAnimationStyle, getLicenseActivationKey, getMetaData, getMinimumSize, getNoteSeries, getNumberFormat, getNumErrors, getPanel, getPlotArea, getPreferredSize, getRightTitle, getRootPanel, getRubberband, getScaleFactor, getTitleSpacing, getToggleDataVisibility, getVersion, 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, setBackgroundActiveLabel, setBackgroundFillPattern, setBackgroundRegion, setBuildAnimationEnabled, setChartElementSpacing, setChartName, setChartSize, setColorTable, setDataActiveLabelsEnabled, setDocumentBase, setDwell, setDwellAnimation, setDwellAnimationHighlight, setDwellAnimationStyle, setDwellOffset, setFooter, setHeader, setLabelAnimationStyle, setLeftTitle, setLegend, setLegendAnimationStyle, setLegendDwellAnimation, setLegendDwellAnimationHighlight, setLegendDwellAnimationStyle, setLicenseKey, setLicenseKey, setLicenseLocation, setMetaData, setNoteSeries, setNumberFormat, setParentApplet, setPlotArea, setRightTitle, setRubberband, setScaleFactor, setSize, setSize, setTitleSpacing, setToggleDataVisibility, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

TASK_ANIMATION_STYLE_NONE

public static final int TASK_ANIMATION_STYLE_NONE

No task animation style

See Also:

Constant Field Values

TASK_ANIMATION_STYLE_SCALE

public static final int TASK_ANIMATION_STYLE_SCALE

Task animation style scale

See Also:

Constant Field Values

TASK_ANIMATION_STYLE_FADE

public static final int TASK_ANIMATION_STYLE_FADE

Task animation style fade

See Also:

Constant Field Values

Constructor Detail

NFTimechart

public NFTimechart()

Constructs a default chart object.

NFTimechart

public NFTimechart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFTimechart

public NFTimechart(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.

NFTimechart

public NFTimechart(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

Specified by:

getDefaultData in class NFGraph

Returns:

The default data used to initialize a chart.

addTimeSet

public void addTimeSet(NFTimeSet timeSet)

Adds a time set to the current list of timesets.

Parameters:

timeSet - The timeset to add.

setTimeSeries

public void setTimeSeries(NFTimeSeries timeSeries)
                   throws NFParamException

Set the time series. This is a vector of timesets. To set a property on the time series, you must first retrieve the series, then set the property (properties) and finally set the line series.

     NFTimechart chart = new NFTimechart();
     NFTimeSeries ts = chart.getTimeSeries();
     NFTimeSet set = (NFTimeSet)ts.elementAt(0);
     // Set some of the properties on the NFTimeSet
     ...
     ts.setElementAt(set, 0);
     chart.setTimeSeries(ts);
 

Parameters:

timeSeries -

Throws:

NFParamException

getTimeSeries

public NFTimeSeries getTimeSeries()

Get the time series. This is a vector of timesets. To set a property on the time series, you must first retrieve the series, then set the property (properties) and finally set the line series.

     NFTimechart chart = new NFTimechart();
     NFTimeSeries ts = chart.getTimeSeries();
     NFTimeSet set = (NFTimeSet)ts.elementAt(0);
     // Set some of the properties on the NFTimeSet
     ...
     ts.setElementAt(set, 0);
     chart.setTimeSeries(ts);
 

Returns:

timeSeries

getType

public int getType()

Gets the chart type.

Specified by:

getType in class NFGraph

Returns:

the type of this chart, always netcharts.pro.charts.time.NFGraph.TIME

setUseUniqueTaskColors

public void setUseUniqueTaskColors(boolean useUniqueTaskColors)

Enable or disable the use of unique task colors within the chart. When set to true, each Task will use the next available color table entry.

If a color is specified for a unique task via the addElement method of NFTimeSet, the specified color will be used instead of the next available color table entry.

Parameters:

useUniqueTaskColors - True to use unique colors, false to disable.

getUseUniqueTaskColors

public boolean getUseUniqueTaskColors()

Get whether the use of unique task colors is being enforced.

The default value is false.

Returns:

True if the use of unique task colors is enabled, false otherwise.

setTaskHeight

public void setTaskHeight(int taskHeight)

Sets the task height factor to use when drawing tasks.

Parameters:

taskHeight -

getTaskHeight

public int getTaskHeight()

Gets the task height factor to use when drawing tasks.

Returns:

taskHeight

setTaskAnimationStyle

public void setTaskAnimationStyle(int style)

Set the task animation style.

If the value passed is not a valid task animation style, TASK_ANIMATION_STYLE_NONE will be used.

Parameters:

style - One of TASK_ANIMATION_STYLE_NONE (default), TASK_ANIMATION_STYLE_SCALE or TASK_ANIMATION_STYLE_FADE

getTaskAnimationStyle

public int getTaskAnimationStyle()

Get the task animation style.

Returns:

type One of TASK_ANIMATION_STYLE_NONE (default), TASK_ANIMATION_STYLE_SCALE or TASK_ANIMATION_STYLE_FADE

writeExternal

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

Writes this chart into an object for serialization.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class NFDataChart

Throws:

java.io.IOException

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFDataChart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFDataChart