Package com.smartgwt.client.widgets.chart

Class LegendHoverEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

com.smartgwt.client.event.AbstractSmartEvent<H>

com.smartgwt.client.widgets.events.BrowserEvent<LegendHoverHandler>

com.smartgwt.client.widgets.chart.LegendHoverEvent

public class LegendHoverEvent
extends BrowserEvent<LegendHoverHandler>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H extends Object>

Field Summary

Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent

jsObj

Constructor Summary

Constructors

Constructor	Description
LegendHoverEvent(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
protected void	dispatch(LegendHoverHandler handler)
static <S extends HasLegendHoverHandlers & HasHandlers> void	fire(S source, JavaScriptObject jsObj)	Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.
final GwtEvent.Type<LegendHoverHandler>	getAssociatedType()
FacetValue	getFacetValue()	facetValue that the mouse is over
Canvas	getFiringCanvas()	Returns the Canvas firing the event.
FacetValue	getMetricFacetValue()	for a multi-axis chart, facetValue representing the hovered-over metric.
static GwtEvent.Type<LegendHoverHandler>	getType()	Gets the type associated with this event.

Methods inherited from class com.smartgwt.client.widgets.events.BrowserEvent

getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDown

Methods inherited from class com.smartgwt.client.event.AbstractSmartEvent

getFiringInstanceAsJavaScriptObject

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LegendHoverEvent

public LegendHoverEvent(JavaScriptObject jsObj)

Method Details

getFiringCanvas

public Canvas getFiringCanvas()

Returns the Canvas firing the event.

Returns:

Canvas firing the event

fire

public static <S extends HasLegendHoverHandlers & HasHandlers>
void fire(S source,
 JavaScriptObject jsObj)

Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.

Type Parameters:

S - The event source

Parameters:

source - the source of the handlers

jsObj - the native event

getType

public static GwtEvent.Type<LegendHoverHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(LegendHoverHandler handler)

Specified by:

dispatch in class GwtEvent<LegendHoverHandler>

getAssociatedType

public final GwtEvent.Type<LegendHoverHandler> getAssociatedType()

Specified by:

getAssociatedType in class GwtEvent<LegendHoverHandler>

getFacetValue

public FacetValue getFacetValue()

facetValue that the mouse is over

Returns:

facetValue that the mouse is over

getMetricFacetValue

public FacetValue getMetricFacetValue()

for a multi-axis chart, facetValue representing the hovered-over metric. Null if chart is not multi-axis

Returns:

for a multi-axis chart, facetValue representing the hovered-over metric. Null if chart is not multi-axis