com.steema.teechart.tools
Class MarksTip

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

public class MarksTip
extends ToolSeries

Title: MarksTip class

Description: Marks Tip.
Marks tip tool, use it to display "tips" or "hints" when the end-user moves or clicks the mouse over a series point.

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

Company: Steema Software SL


Field Summary
protected  TextResolver customToolTip
           
 
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
MarksTip()
           
MarksTip(IBaseChart c)
           
 
Method Summary
 java.lang.String getDescription()
          Gets descriptive text.
 int getHideDelay()
          The time period during which the Tool Tip appears.
 int getInitialDelay()
           
 MarksTipMouseAction getMouseAction()
          Activates Mark Tip on mouse move or click.
 int getMouseDelay()
          The time lag before the Tool Tip appears.
 MarksStyle getStyle()
          Defines the text format of the Mark ToolTip.
 java.lang.String getSummary()
          Gets detailed descriptive text.
 Cursor mouseEvent(FrameworkMouseEvent e, Cursor c)
           
protected  java.lang.Object readResolve()
           
 void removeToolTipResolver()
           
 void setActive(boolean value)
          Enables/Disables the indexed Tool.
 void setHideDelay(int value)
          Sets the time period during which the Tool Tip appears.
 void setInitialDelay(int value)
           
 void setMouseAction(MarksTipMouseAction value)
          Activates Mark Tip on mouse move or click.
 void setMouseDelay(int value)
          Sets the time lag before the Tool Tip appears.
 void setStyle(MarksStyle value)
          Defines the text format of the Mark ToolTip.
 void setToolTipResolver(TextResolver resolver)
           
 
Methods inherited from class com.steema.teechart.tools.ToolSeries
getHorizAxis, getSeries, getVertAxis, setSeries
 
Methods inherited from class com.steema.teechart.tools.Tool
chartEvent, dispose, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, 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

customToolTip

protected transient TextResolver customToolTip
Constructor Detail

MarksTip

public MarksTip()

MarksTip

public MarksTip(IBaseChart c)
Method Detail

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class Tool

setToolTipResolver

public void setToolTipResolver(TextResolver resolver)

removeToolTipResolver

public void removeToolTipResolver()

getStyle

public MarksStyle getStyle()
Defines the text format of the Mark ToolTip.
Default value: MarksStyle.Label

Returns:
MarksStyle

setStyle

public void setStyle(MarksStyle value)
Defines the text format of the Mark ToolTip.
Default value: MarksStyle.Label

Parameters:
value - MarksStyle

getMouseAction

public MarksTipMouseAction getMouseAction()
Activates Mark Tip on mouse move or click.
Default value: MarksTipMouseAction.Move

Returns:
MarksTipMouseAction

setMouseAction

public void setMouseAction(MarksTipMouseAction value)
Activates Mark Tip on mouse move or click.
Default value: MarksTipMouseAction.Move

Parameters:
value - MarksTipMouseAction

getMouseDelay

public int getMouseDelay()
The time lag before the Tool Tip appears.
Default value: 500

Returns:
int

setMouseDelay

public void setMouseDelay(int value)
Sets the time lag before the Tool Tip appears.
Default value: 500

Parameters:
value - int

getHideDelay

public int getHideDelay()
The time period during which the Tool Tip appears.
Default value: 4000 (ms)

Returns:
int

setHideDelay

public void setHideDelay(int value)
Sets the time period during which the Tool Tip appears.
Default value: 4000 (ms)

Parameters:
value - int

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

mouseEvent

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

setActive

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

Overrides:
setActive in class Tool
Parameters:
value - boolean

getInitialDelay

public int getInitialDelay()

setInitialDelay

public void setInitialDelay(int value)