com.steema.teechart.tools
Class SeriesRegion

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.tools.Tool
          extended by com.steema.teechart.tools.ToolSeries
              extended by com.steema.teechart.tools.SeriesRegion

public class SeriesRegion
extends ToolSeries

Title: SeriesRegion class

Description: Series Region tool.

It colors bounded area under the (series) curve.

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

Company: Steema Software SL


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, InternalUse
 
Constructor Summary
SeriesRegion()
           
SeriesRegion(IBaseChart c)
           
 
Method Summary
 void chartEvent(ChartDrawEvent ce)
           
 boolean getAutoBound()
          If true, region left and right bounds are equal to series minimum and maximum x value.
 ChartBrush getBrush()
          Element Brush characteristics.
 java.lang.String getDescription()
          Gets descriptive text.
 boolean getDrawBehindSeries()
          If true, draw region behind series.
 Gradient getGradient()
          The gradient colors used to fill the area in the region.
 double getLowerBound()
          Defines region left (series not mandatory values) lower bound.
 double getOrigin()
          Region bottom or upper limit.
 ChartPen getPen()
          Indicates the kind of pen used to draw Series Region.
 java.lang.String getSummary()
          Gets detailed descriptive text.
 int getTransparency()
          The amount of semi-glass effect (opacity) to apply when filling the area in the region as percentage.
 double getUpperBound()
          Defines region right (series not mandatory values) upper bound.
 boolean getUseOrigin()
          If true, region bottom or upper limit is defined by .
 void setAutoBound(boolean value)
           
 void setBrush(ChartBrush value)
          Set Brush characteristics.
 void setDrawBehindSeries(boolean value)
           
 void setGradient(Gradient value)
          Sets the gradient colors used to fill the area in the region.
 void setLowerBound(double value)
           
 void setOrigin(double value)
           
 void setPen(ChartPen value)
          Determines the kind of pen used to draw Series Region.
 void setTransparency(int value)
          Sets the amount of semi-glass effect (opacity) to apply when filling the area in the region as percentage.
 void setUpperBound(double value)
           
 void setUseOrigin(boolean value)
           
 
Methods inherited from class com.steema.teechart.tools.ToolSeries
getHorizAxis, getSeries, getVertAxis, setSeries
 
Methods inherited from class com.steema.teechart.tools.Tool
dispose, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, mouseEvent, readResolve, setActive, setChart, toString
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SeriesRegion

public SeriesRegion()

SeriesRegion

public SeriesRegion(IBaseChart c)
Method Detail

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

getAutoBound

public boolean getAutoBound()
If true, region left and right bounds are equal to series minimum and maximum x value.

Returns:
boolean

setAutoBound

public void setAutoBound(boolean value)

getLowerBound

public double getLowerBound()
Defines region left (series not mandatory values) lower bound.

Returns:
double

setLowerBound

public void setLowerBound(double value)

getUpperBound

public double getUpperBound()
Defines region right (series not mandatory values) upper bound.

Returns:
double

setUpperBound

public void setUpperBound(double value)

getOrigin

public double getOrigin()
Region bottom or upper limit. Used only if is true.

Returns:
double

setOrigin

public void setOrigin(double value)

getUseOrigin

public boolean getUseOrigin()
If true, region bottom or upper limit is defined by .

Returns:
boolean

setUseOrigin

public void setUseOrigin(boolean value)

getDrawBehindSeries

public boolean getDrawBehindSeries()
If true, draw region behind series. If false, draw region over series.

Returns:
boolean

setDrawBehindSeries

public void setDrawBehindSeries(boolean value)

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 Region.

Returns:
ChartPen

setPen

public void setPen(ChartPen value)
Determines the kind of pen used to draw Series Region.

Parameters:
value - ChartPen

getTransparency

public int getTransparency()
The amount of semi-glass effect (opacity) to apply when filling the area in the region 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 in the region as percentage. Default value: 0

Parameters:
value - int

getGradient

public Gradient getGradient()
The gradient colors used to fill the area in the region.

Returns:
Gradient

setGradient

public void setGradient(Gradient value)
Sets the gradient colors used to fill the area in the region.

Parameters:
value - Gradient

chartEvent

public void chartEvent(ChartDrawEvent ce)
Overrides:
chartEvent in class Tool