com.googlecode.gchart.client
Class GChart.TouchedPointUpdateOption

java.lang.Object
  com.googlecode.gchart.client.GChart.TouchedPointUpdateOption

Enclosing class:

GChart

public static final class GChart.TouchedPointUpdateOption
extends java.lang.Object

Defines how the update method updates the touched point, that is, the point the user is considered to be hovered over.

See Also:

update

Field Summary

static GChart.TouchedPointUpdateOption	TOUCHED_POINT_CLEARED When this option is passed to the update method, any touched point is cleared as a consequence of the update.
static GChart.TouchedPointUpdateOption	TOUCHED_POINT_LOCKED When this option is passed to the update method, any previously touched point is locked in (remains unchanged).
static GChart.TouchedPointUpdateOption	TOUCHED_POINT_UPDATED When this option is passed to the update method, the touched point is updated so that it reflects whatever point is underneath the mouse cursor after the update completes.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOUCHED_POINT_CLEARED

public static final GChart.TouchedPointUpdateOption TOUCHED_POINT_CLEARED

When this option is passed to the update method, any touched point is cleared as a consequence of the update.

This option can be used when you want to "start fresh" with regards to hover feedback after an update, and want to assure that only explicit user-generated mouse move actions (rather than objects moving underneath a fixed-position mouse cursor) can trigger hover feedback.

See Also:

update, TOUCHED_POINT_LOCKED, TOUCHED_POINT_UPDATED

TOUCHED_POINT_LOCKED

public static final GChart.TouchedPointUpdateOption TOUCHED_POINT_LOCKED

When this option is passed to the update method, any previously touched point is locked in (remains unchanged).

For example, if the mouse is over a certain point before the update, and that point moves away from the mouse (without the mouse moving otherwise) as a consequence of the update, the hover feedback remains "locked in" to the original point, even though the mouse is no longer on top of that point.

This option is useful for hover widgets that modify the position, size, symbol of points/curves, and do not want the selected point/curve (and popup hover widget) to change as a consequence of such changes.

Note: If the currently touched point or the curve containing it is deleted, GChart sets the touched point reference to null. In that case, this option and TOUCHED_POINT_CLEARED behave the same way.

See Also:

update, TOUCHED_POINT_CLEARED, TOUCHED_POINT_UPDATED

TOUCHED_POINT_UPDATED

public static final GChart.TouchedPointUpdateOption TOUCHED_POINT_UPDATED

When this option is passed to the update method, the touched point is updated so that it reflects whatever point is underneath the mouse cursor after the update completes.

For example, if the mouse is not hovering over any point before the update, but the update repositions one of the points so that it is now underneath the mouse cursor, the hover feedback for that point will be displayed. Similarly, if the update moves a point away from the mouse cursor, previously displayed hover feedback will be eliminated.

See Also:

update, TOUCHED_POINT_CLEARED, TOUCHED_POINT_LOCKED