com.steema.teechart.tools
Class ColorBand

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.tools.Tool
          extended by com.steema.teechart.tools.ToolAxis
              extended by com.steema.teechart.tools.ColorBand

public class ColorBand
extends ToolAxis

Title: ColorBand class

Description: Color band tool, use it to display a coloured rectangle (band) at the specified axis and position.

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

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.tools.ToolAxis
iAxis
 
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
ColorBand()
           
ColorBand(IBaseChart c)
           
 
Method Summary
 void chartEvent(ChartDrawEvent e)
           
 boolean clicked(int x, int y)
           
 void dragFinished(ChangeEvent e)
           
 void dragMoving(ChangeEvent e)
           
 ChartBrush getBrush()
          Element Brush characteristics.
 Color getColor()
          SThe Band Color.
 java.lang.String getDescription()
          Gets descriptive text.
 boolean getDrawBehind()
          Draws the Colorband behind the series values when true.
 double getEnd()
          The End Axis value of colorband.
 ColorLine getEndLine()
          Contains formatting properties for the automatic line used to drag the end value of the ColorBand tool at runtime.
 ChartPen getEndLinePen()
           
 Gradient getGradient()
          Sets Band colour gradient.
 boolean getResizeEnd()
          Gets or sets if the ColorBand tool allows mouse dragging of the edge corresponding to the end value.
 boolean getResizeStart()
           
 double getStart()
          The Start Axis value of colorband.
 ColorLine getStartLine()
          Contains formatting properties for the automatic line used to drag the start value of the ColorBand tool at runtime.
 ChartPen getStartLinePen()
           
 java.lang.String getSummary()
          Gets detailed descriptive text.
 int getTransparency()
          The Transparency of ColorBand as percentage.
 Cursor mouseEvent(FrameworkMouseEvent e, Cursor c)
           
 void setAxis(Axis value)
          Sets the axis to which a Tool will belong.
 void setColor(Color value)
          Sets Band Color.
 void setDrawBehind(boolean value)
          Draws the Colorband behind the series values when true.
 void setEnd(double value)
          Sets End Axis value of colorband.
 void setResizeEnd(boolean value)
           
 void setResizeStart(boolean value)
           
 void setStart(double value)
          Sets Start Axis value of colorband.
 void setTransparency(int value)
          Sets the Transparency of ColorBand as percentage.
 
Methods inherited from class com.steema.teechart.tools.ToolAxis
checkDrawHidden, getAxis, getPen
 
Methods inherited from class com.steema.teechart.tools.Tool
dispose, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, 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

ColorBand

public ColorBand()

ColorBand

public ColorBand(IBaseChart c)
Method Detail

mouseEvent

public Cursor mouseEvent(FrameworkMouseEvent e,
                         Cursor c)
Overrides:
mouseEvent in class Tool

setAxis

public void setAxis(Axis value)
Description copied from class: ToolAxis
Sets the axis to which a Tool will belong.
Default value: null

Overrides:
setAxis in class ToolAxis
Parameters:
value - Axis

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

getDrawBehind

public boolean getDrawBehind()
Draws the Colorband behind the series values when true.
Default value: true

Returns:
boolean

setDrawBehind

public void setDrawBehind(boolean value)
Draws the Colorband behind the series values when true.
Default value: true

Parameters:
value - boolean

getStart

public double getStart()
The Start Axis value of colorband.

Returns:
double

setStart

public void setStart(double value)
Sets Start Axis value of colorband.

Parameters:
value - double

getEnd

public double getEnd()
The End Axis value of colorband.

Returns:
double

setEnd

public void setEnd(double value)
Sets End Axis value of colorband.

Parameters:
value - double

getTransparency

public int getTransparency()
The Transparency of ColorBand as percentage.
Default value: 0

Returns:
int

setTransparency

public void setTransparency(int value)
Sets the Transparency of ColorBand as percentage.
Default value: 0

Parameters:
value - int

getGradient

public Gradient getGradient()
Sets Band colour gradient.

Returns:
Gradient

getColor

public Color getColor()
SThe Band Color.

Returns:
Color

setColor

public void setColor(Color value)
Sets Band Color.

Parameters:
value - Color

getBrush

public ChartBrush getBrush()
Element Brush characteristics.

Returns:
ChartBrush

getStartLine

public ColorLine getStartLine()
Contains formatting properties for the automatic line used to drag the start value of the ColorBand tool at runtime.

Returns:
ColorLine

getEndLine

public ColorLine getEndLine()
Contains formatting properties for the automatic line used to drag the end value of the ColorBand tool at runtime.

Returns:
ColorLine

getResizeEnd

public boolean getResizeEnd()
Gets or sets if the ColorBand tool allows mouse dragging of the edge corresponding to the end value.

Returns:
boolean

setResizeEnd

public void setResizeEnd(boolean value)

getResizeStart

public boolean getResizeStart()

setResizeStart

public void setResizeStart(boolean value)

getStartLinePen

public ChartPen getStartLinePen()

getEndLinePen

public ChartPen getEndLinePen()

clicked

public boolean clicked(int x,
                       int y)

chartEvent

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

dragFinished

public void dragFinished(ChangeEvent e)

dragMoving

public void dragMoving(ChangeEvent e)