com.steema.teechart.tools
Class Tool

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.tools.Tool
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Annotation, GridTranspose, Rotate, ToolAxis, ToolSeries

public class Tool
extends TeeBase

Title: Tool class

Description: Base Tool class.

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

Company: Steema Software SL

See Also:
Serialized Form

Field Summary
protected  ChartBrush bBrush
           
static int clickTolerance
           
protected  javax.swing.event.EventListenerList listenerList
           
protected  ChartPen pPen
           
 
Fields inherited from class com.steema.teechart.TeeBase
chart
 
Constructor Summary
protected Tool()
           
protected Tool(IBaseChart c)
           
 
Method Summary
 void addMouseMotionListener(java.awt.event.MouseMotionListener l)
           
 void chartEvent(ChartDrawEvent ce)
           
protected  void fireChanged(javax.swing.event.ChangeEvent ce)
           
protected  void fireClicked(FrameworkMouseEvent e)
           
protected  void fireDragged(javax.swing.event.ChangeEvent e)
           
protected  void fireDragging(javax.swing.event.ChangeEvent e)
           
protected  void fireMouse(FrameworkMouseEvent e)
           
protected  void fireResized(javax.swing.event.ChangeEvent e)
           
 boolean getActive()
          Enables/Disables the indexed Tool.
Default value: true
 java.net.URL getBitmapEditor()
          Returns the URL of the associated icon for a given Tool class.
This icon is used at Tools gallery listbox and Tools Editor dialog.
 java.lang.String getDescription()
          Gets descriptive text.
 java.lang.String getSummary()
          Gets detailed descriptive text.
 java.awt.Cursor mouseEvent(FrameworkMouseEvent e, java.awt.Cursor c)
           
protected  java.lang.Object readResolve()
           
 void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
           
 void setActive(boolean value)
          Enables/Disables the indexed Tool.
Default value: true
 void setChart(IBaseChart value)
          Chart associated with this object.
 java.lang.String 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
 

Field Detail

clickTolerance

public static int clickTolerance

pPen

protected ChartPen pPen

bBrush

protected ChartBrush bBrush

listenerList

protected transient javax.swing.event.EventListenerList listenerList
Constructor Detail

Tool

protected Tool(IBaseChart c)

Tool

protected Tool()
Method Detail

readResolve

protected java.lang.Object readResolve()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)

fireMouse

protected void fireMouse(FrameworkMouseEvent e)

fireChanged

protected void fireChanged(javax.swing.event.ChangeEvent ce)

fireClicked

protected void fireClicked(FrameworkMouseEvent e)

fireDragged

protected void fireDragged(javax.swing.event.ChangeEvent e)

fireDragging

protected void fireDragging(javax.swing.event.ChangeEvent e)

fireResized

protected void fireResized(javax.swing.event.ChangeEvent e)

setActive

public void setActive(boolean value)
Enables/Disables the indexed Tool.
Default value: true

Parameters:
value - boolean

getActive

public boolean getActive()
Enables/Disables the indexed Tool.
Default value: true

Returns:
boolean

setChart

public void setChart(IBaseChart value)
Description copied from class: TeeBase
Chart associated with this object.

Overrides:
setChart in class TeeBase
Parameters:
value - IBaseChart

chartEvent

public void chartEvent(ChartDrawEvent ce)

mouseEvent

public java.awt.Cursor mouseEvent(FrameworkMouseEvent e,
                                  java.awt.Cursor c)

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Returns:
String

getSummary

public java.lang.String getSummary()
Gets detailed descriptive text.

Returns:
String

getBitmapEditor

public java.net.URL getBitmapEditor()
Returns the URL of the associated icon for a given Tool class.
This icon is used at Tools gallery listbox and Tools Editor dialog.

Returns:
URL