com.steema.teechart.tools
Class SeriesBand

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.tools.Tool
          com.steema.teechart.tools.ToolSeries
              com.steema.teechart.tools.SeriesBand

All Implemented Interfaces:

java.io.Serializable

public class SeriesBand
extends ToolSeries

Title: SeriesBand class

Description: Series Band tool.

Use it to display a band between two (line) series.

created 2003-12-14 by mkaul@leuze.de

Copyright (c) 2005-2008 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL

See Also:

Serialized Form

Field Summary

Fields inherited from class com.steema.teechart.tools.ToolSeries

iSeries

Fields inherited from class com.steema.teechart.tools.Tool

bBrush, clickTolerance, listenerList, pPen

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

SeriesBand()

SeriesBand(IBaseChart c)

Method Summary

void	chartEvent(ChartDrawEvent ce)
protected void	doAfterDrawValues(java.lang.Object sender)
protected void	doBeforeDrawValues(java.lang.Object sender)
protected void	drawBandTool()
double	getBoundValue() Constant value to be used as one of the limits of band filled areas.
ChartBrush	getBrush() Element Brush characteristics.
java.lang.String	getDescription() Gets descriptive text.
boolean	getDrawBehindSeries() Flag which causes filling to occur before or after the series are displayed.
Gradient	getGradient() The gradient colors used to fill the area between the two series.
ChartPen	getPen() Indicates the kind of pen used to draw Series Band.
Series	getSeries2() Second series associated to this tool.
java.lang.String	getSummary() Gets detailed descriptive text.
int	getTransparency() The amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage.
void	setBoundValue(double value) Sets a constant value to be used as one of the limits of band filled areas.
void	setBrush(ChartBrush value) Set Brush characteristics.
void	setDrawBehindSeries(boolean value) Sets a flag which causes filling to occur before or after the series are displayed.
void	setGradient(Gradient value) Sets the gradient colors used to fill the area between the two series.
void	setPen(ChartPen value) Determines the kind of pen used to draw Series Band.
void	setSeries(Series value) Sets the Series with which Tools are associated. Default value: null
void	setSeries2(Series value) Sets the second series associated to this tool. SeriesBand tool needs two series to fill the area in between them.
protected void	SetSeries2(Series value)
void	setTransparency(int value) Sets the amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage.

Methods inherited from class com.steema.teechart.tools.ToolSeries

getHorizAxis, getSeries, getVertAxis

Methods inherited from class com.steema.teechart.tools.Tool

addMouseMotionListener, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, getBitmapEditor, mouseEvent, readResolve, removeMouseMotionListener, setActive, setChart, toString

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesBand

public SeriesBand()

SeriesBand

public SeriesBand(IBaseChart c)

Method Detail

getBoundValue

public double getBoundValue()

Constant value to be used as one of the limits of band filled areas.
Note: BoundValue property is only used when the property is not set (ie: is null).

Returns:

double

setBoundValue

public void setBoundValue(double value)

Sets a constant value to be used as one of the limits of band filled areas.
Note: BoundValue property is only used when the property is not set (ie: is null).

Parameters:

value - double

getDrawBehindSeries

public boolean getDrawBehindSeries()

Flag which causes filling to occur before or after the series are displayed.
Default value: true

Returns:

boolean

setDrawBehindSeries

public void setDrawBehindSeries(boolean value)

Sets a flag which causes filling to occur before or after the series are displayed.
Default value: true

Parameters:

value - boolean

getDescription

public java.lang.String getDescription()

Gets descriptive text.

Overrides:

getDescription in class Tool

Returns:

String

getSummary

public java.lang.String getSummary()

Gets detailed descriptive text.

Overrides:

getSummary in class Tool

Returns:

String

getSeries2

public Series getSeries2()

Second series associated to this tool.
SeriesBand tool needs two series to fill the area in between them.

Returns:

Series

setSeries2

public void setSeries2(Series value)

Sets the second series associated to this tool.
SeriesBand tool needs two series to fill the area in between them.

Parameters:

value - Series

getBrush

public ChartBrush getBrush()

Element Brush characteristics.

Returns:

ChartBrush

setBrush

public void setBrush(ChartBrush value)

Set Brush characteristics.

Parameters:

value - ChartBrush

getPen

public ChartPen getPen()

Indicates the kind of pen used to draw Series Band.

Returns:

ChartPen

setPen

public void setPen(ChartPen value)

Determines the kind of pen used to draw Series Band.

Parameters:

value - ChartPen

getTransparency

public int getTransparency()

The amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage. Default value: 0

Returns:

int

setTransparency

public void setTransparency(int value)

Sets the amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage. Default value: 0

Parameters:

value - int

getGradient

public Gradient getGradient()

The gradient colors used to fill the area between the two series.

Returns:

Gradient

setGradient

public void setGradient(Gradient value)

Sets the gradient colors used to fill the area between the two series.

Parameters:

value - Gradient

chartEvent

public void chartEvent(ChartDrawEvent ce)

Overrides:

chartEvent in class Tool

setSeries

public void setSeries(Series value)

Description copied from class: ToolSeries

Sets the Series with which Tools are associated.
Default value: null

Overrides:

setSeries in class ToolSeries

Parameters:

value - Series

SetSeries2

protected void SetSeries2(Series value)

doBeforeDrawValues

protected void doBeforeDrawValues(java.lang.Object sender)

doAfterDrawValues

protected void doAfterDrawValues(java.lang.Object sender)

drawBandTool

protected void drawBandTool()