com.softwarefx.chartfx.desktop
Enum HitType

java.lang.Object
  java.lang.Enum<HitType>
      com.softwarefx.chartfx.desktop.HitType

All Implemented Interfaces:

Serializable, Comparable<HitType>

public enum HitType
extends Enum<HitType>

Specifies what element of the chart was clicked during a HitTest.

Enum Constant Summary

AXIS
Click was simulated on an Axis.

AXIS_SECTION
Click was simulated on an AxisSection.

BACKGROUND
Click was simulated on the Background.

BETWEEN
Click was simulated between chart objects.

CROSSHAIR
Click was simulated on a CrossHair.

CUSTOM_GRID_LINE
Click was simulated on a CustromGridLine.

DATA_GRID
Click was simulated on a DataGrid.

DRAG
Click was simulated where a user was dragging an element.

INSIDE_AREA
Click was simulated on the inside chart area.

LEGEND_BOX
Click was simulated on a Legend.

NONE
No click was simulated.

OTHER
Click was simulated an element not listed.

POINT
Click was simulated on a Point.

SCROLL
Click was simulated on a scroll bar.

TITLE
Click was simulated on a Title.

ZOOM
Click was simulated on zoom.

Method Summary

static EnumSet<HitType>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static HitType	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(EnumSet<HitType> value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(HitType value) Returns a numeric value that represents the given EnumSet or Enum item.
static HitType	valueOf(String name) Returns the enum constant of this type with the specified name.
static HitType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final HitType NONE

No click was simulated.

BACKGROUND

public static final HitType BACKGROUND

Click was simulated on the Background.

INSIDE_AREA

public static final HitType INSIDE_AREA

Click was simulated on the inside chart area.

BETWEEN

public static final HitType BETWEEN

Click was simulated between chart objects.

POINT

public static final HitType POINT

Click was simulated on a Point.

AXIS

public static final HitType AXIS

Click was simulated on an Axis.

TITLE

public static final HitType TITLE

Click was simulated on a Title.

CUSTOM_GRID_LINE

public static final HitType CUSTOM_GRID_LINE

Click was simulated on a CustromGridLine.

DRAG

public static final HitType DRAG

Click was simulated where a user was dragging an element.

CROSSHAIR

public static final HitType CROSSHAIR

Click was simulated on a CrossHair.

ZOOM

public static final HitType ZOOM

Click was simulated on zoom.

SCROLL

public static final HitType SCROLL

Click was simulated on a scroll bar.

LEGEND_BOX

public static final HitType LEGEND_BOX

Click was simulated on a Legend.

DATA_GRID

public static final HitType DATA_GRID

Click was simulated on a DataGrid.

OTHER

public static final HitType OTHER

Click was simulated an element not listed.

AXIS_SECTION

public static final HitType AXIS_SECTION

Click was simulated on an AxisSection.

Method Detail

values

public static HitType[] 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 (HitType c : HitType.values())
    System.out.println(c);

Returns:

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

valueOf

public static HitType valueOf(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:

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

NullPointerException - if the argument is null

getEnumSetValue

public static EnumSet<HitType> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static HitType getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(HitType value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<HitType> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.