com.steema.teechart.tools
Class NearestPoint

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

public class NearestPoint
extends ToolSeries

Title: NearestPoint class

Description: Nearest tool, use it to display a graphical signal when the mouse is moving near a series point.

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

Company: Steema Software SL


Field Summary
 int point
           
 
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
NearestPoint()
           
NearestPoint(IBaseChart c)
           
NearestPoint(Series s)
           
 
Method Summary
 void addChangeListener(ChangeListener l)
           
 void chartEvent(ChartDrawEvent e)
           
 ChartBrush getBrush()
          Element Brush characteristics.
 java.lang.String getDescription()
          Gets descriptive text.
 NearestPointDirection getDirection()
           
 boolean getDrawLine()
          Draws a temporary line from the mouse coordinates to the nearest point.
 boolean getFullRepaint()
          Allows the whole Parent Chart to repainted when true.
 ChartPen getPen()
          Element Pen characteristics.
 int getSize()
          Defines the Size of the NearestTool shape.
 NearestPointStyle getStyle()
          The shape of the NearestTool.
 java.lang.String getSummary()
          Gets detailed descriptive text.
 Cursor mouseEvent(FrameworkMouseEvent e, Cursor c)
           
 void removeChangeListener(ChangeListener l)
           
 void setDirection(NearestPointDirection value)
           
 void setDrawLine(boolean value)
          Draws a temporary line from the mouse coordinates to the nearest point.
 void setFullRepaint(boolean value)
          Allows the whole Parent Chart to repainted when true.
 void setSize(int value)
          Defines the Size of the NearestTool shape.
 void setStyle(NearestPointStyle value)
          Sets the shape of the NearestTool.
 
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, 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
 

Field Detail

point

public int point
Constructor Detail

NearestPoint

public NearestPoint(Series s)

NearestPoint

public NearestPoint()

NearestPoint

public NearestPoint(IBaseChart c)
Method Detail

addChangeListener

public void addChangeListener(ChangeListener l)

removeChangeListener

public void removeChangeListener(ChangeListener l)

getSize

public int getSize()
Defines the Size of the NearestTool shape.
Default value: 20

Returns:
int

setSize

public void setSize(int value)
Defines the Size of the NearestTool shape.
Default value: 20

Parameters:
value - int

getStyle

public NearestPointStyle getStyle()
The shape of the NearestTool.
Default value: NearestPointStyle.Circle

Returns:
NearestPointStyle

setStyle

public void setStyle(NearestPointStyle value)
Sets the shape of the NearestTool.
Default value: NearestPointStyle.Circle

Parameters:
value - NearestPointStyle

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

getDrawLine

public boolean getDrawLine()
Draws a temporary line from the mouse coordinates to the nearest point.
Default value: true

Returns:
boolean

setDrawLine

public void setDrawLine(boolean value)
Draws a temporary line from the mouse coordinates to the nearest point.
Default value: true

Parameters:
value - boolean

getFullRepaint

public boolean getFullRepaint()
Allows the whole Parent Chart to repainted when true.
Default value: true

Returns:
boolean

setFullRepaint

public void setFullRepaint(boolean value)
Allows the whole Parent Chart to repainted when true.
Default value: true

Parameters:
value - boolean

getPen

public ChartPen getPen()
Element Pen characteristics.

Returns:
ChartPen

getBrush

public ChartBrush getBrush()
Element Brush characteristics.

Returns:
ChartBrush

chartEvent

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

mouseEvent

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

getDirection

public NearestPointDirection getDirection()

setDirection

public void setDirection(NearestPointDirection value)