com.steema.teechart.tools
Class ColorLine

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

public class ColorLine
extends ToolAxis

Title: ColorLine class

Description: Color Line tool. To draw custom lines at a axis value.

Copyright (c) 2005-2007 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
ColorLine()
           
ColorLine(Axis a)
           
ColorLine(IBaseChart c)
           
 
Method Summary
 void addDragListener(DragListener l)
           
protected  double calcValue()
           
 void chartEvent(ChartDrawEvent e)
           
 boolean clicked(int x, int y)
           
protected  void doDragLine()
           
protected  void doEndDragLine()
           
 boolean getAllowDrag()
          Allows mousedrag of Line when true.
 java.lang.String getDescription()
          Gets descriptive text.
 boolean getDragging()
           
 boolean getDragRepaint()
          Repaints the Chart while moving the ColorLine when true.
 boolean getDraw3D()
          Draws ColorLine in 3D when true.
 boolean getDrawBehind()
          Draws the ColorLine behind the series values.
 boolean getNoLimitDrag()
          Allows drag of ColorLine outside of the Chart rectangle.
 ColorLineStyle getStyle()
          Default value: ColorLineStyle.CUSTOM
 java.lang.String getSummary()
          Gets detailed descriptive text.
 double getValue()
          Determines Axis position where the ColorLine has to be drawn.
 Cursor mouseEvent(FrameworkMouseEvent e, Cursor c)
           
 void removeDragListener(DragListener l)
           
 void setAllowDrag(boolean value)
          Allows mousedrag of Line when true.
 void setDragging(boolean value)
           
 void setDragRepaint(boolean value)
          Set to true to repaint the Chart while moving the ColorLine.
 void setDraw3D(boolean value)
          Draws ColorLine in 3D when true.
 void setDrawBehind(boolean value)
          Draws the ColorLine behind the series values.
 void setNoLimitDrag(boolean value)
          Allows drag of ColorLine outside of the Chart rectangle.
 void setStyle(ColorLineStyle value)
          Default value: ColorLine.CUSTOM
 void setValue(double value)
          Sets the Axis position where the ColorLine has to be drawn.
 
Methods inherited from class com.steema.teechart.tools.ToolAxis
checkDrawHidden, getAxis, getPen, setAxis
 
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

ColorLine

public ColorLine()

ColorLine

public ColorLine(IBaseChart c)

ColorLine

public ColorLine(Axis a)
Method Detail

addDragListener

public void addDragListener(DragListener l)

removeDragListener

public void removeDragListener(DragListener l)

getDragging

public boolean getDragging()

setDragging

public void setDragging(boolean value)

getStyle

public ColorLineStyle getStyle()
Default value: ColorLineStyle.CUSTOM

Returns:
ColorLineStyle

setStyle

public void setStyle(ColorLineStyle value)
Default value: ColorLine.CUSTOM

Parameters:
value - ColorLineStyle

calcValue

protected double calcValue()

chartEvent

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

mouseEvent

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

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

doEndDragLine

protected void doEndDragLine()

doDragLine

protected void doDragLine()

clicked

public boolean clicked(int x,
                       int y)

getAllowDrag

public boolean getAllowDrag()
Allows mousedrag of Line when true.
Default value: true

Returns:
boolean

setAllowDrag

public void setAllowDrag(boolean value)
Allows mousedrag of Line when true.
Default value: true

Parameters:
value - boolean

getDragRepaint

public boolean getDragRepaint()
Repaints the Chart while moving the ColorLine when true.
Set to true to repaint the Chart while moving the ColorLine.
Default value: false

Returns:
boolean

setDragRepaint

public void setDragRepaint(boolean value)
Set to true to repaint the Chart while moving the ColorLine.
Default value: false

Parameters:
value - boolean

getDraw3D

public boolean getDraw3D()
Draws ColorLine in 3D when true.
Default value: true

Returns:
boolean

setDraw3D

public void setDraw3D(boolean value)
Draws ColorLine in 3D when true.
Default value: true

Parameters:
value - boolean

getDrawBehind

public boolean getDrawBehind()
Draws the ColorLine behind the series values.
Default value: false

Returns:
boolean

setDrawBehind

public void setDrawBehind(boolean value)
Draws the ColorLine behind the series values.
Default value: false

Parameters:
value - boolean

getNoLimitDrag

public boolean getNoLimitDrag()
Allows drag of ColorLine outside of the Chart rectangle.
Default value: false

Returns:
boolean

setNoLimitDrag

public void setNoLimitDrag(boolean value)
Allows drag of ColorLine outside of the Chart rectangle.
Default value: false

Parameters:
value - boolean

getValue

public double getValue()
Determines Axis position where the ColorLine has to be drawn.
Default value: 0

Returns:
double

setValue

public void setValue(double value)
Sets the Axis position where the ColorLine has to be drawn.
Default value: 0

Parameters:
value - double