info.monitorenter.gui.chart
Enum Chart2D.ToolTipType

java.lang.Object
  java.lang.Enum<Chart2D.ToolTipType>
      info.monitorenter.gui.chart.Chart2D.ToolTipType

All Implemented Interfaces:

IToolTipType, java.io.Serializable, java.lang.Comparable<Chart2D.ToolTipType>

Enclosing class:

Chart2D

public static enum Chart2D.ToolTipType
extends java.lang.Enum<Chart2D.ToolTipType>
implements IToolTipType

Types of tool tip.

Version:

$Revision: 1.142.2.1 $

Author:

Achim Westermann

Enum Constant Summary

DATAVALUES
Chart data value tool tips are shown.

NONE
No tool tips are shown.

PIXEL
Pixel tool tips are shown (used for debugging).

VALUE_SNAP_TO_TRACEPOINTS
Snaps to the nearest TracePoint2D and shows it's value.

Method Summary

java.lang.String	getDescription() Returns a description of this tool tip type (for UI display).
java.lang.String	getToolTipText(Chart2D chart, java.awt.event.MouseEvent me) The base class implementation that returns the tool tip text for the given mouse event which is a NONE implementation here.
static Chart2D.ToolTipType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Chart2D.ToolTipType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATAVALUES

public static final Chart2D.ToolTipType DATAVALUES

Chart data value tool tips are shown.

Note that this implementation only works correctly for one left y axis and one bottom x axis as it does not search for the nearest trace. Displayed values will be formatted according to the formatting of the axes mentioned above.

NONE

public static final Chart2D.ToolTipType NONE

No tool tips are shown.

PIXEL

public static final Chart2D.ToolTipType PIXEL

Pixel tool tips are shown (used for debugging).

VALUE_SNAP_TO_TRACEPOINTS

public static final Chart2D.ToolTipType VALUE_SNAP_TO_TRACEPOINTS

Snaps to the nearest TracePoint2D and shows it's value.

Warning: due to the data structure of multiple axes this is very expensive!

Method Detail

values

public static Chart2D.ToolTipType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Chart2D.ToolTipType c : Chart2D.ToolTipType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Chart2D.ToolTipType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

Description copied from interface: IToolTipType

Returns a description of this tool tip type (for UI display).

Specified by:

getDescription in interface IToolTipType

Returns:

a description of this tool tip type (for UI display).

See Also:

IToolTipType.getDescription()

getToolTipText

public java.lang.String getToolTipText(Chart2D chart,
                                       java.awt.event.MouseEvent me)

Description copied from interface: IToolTipType

The base class implementation that returns the tool tip text for the given mouse event which is a NONE implementation here.

Specified by:

getToolTipText in interface IToolTipType

Parameters:

chart - the chart for computation of tool tips.

me - the corresponding mouse event.

Returns:

the tool tip text for the given mouse event.

See Also:

IToolTipType.getToolTipText(info.monitorenter.gui.chart.Chart2D, java.awt.event.MouseEvent)