org.moxieapps.gwt.highcharts.client.events
Class SeriesCheckboxClickEvent

java.lang.Object
  org.moxieapps.gwt.highcharts.client.events.MouseEvent
      org.moxieapps.gwt.highcharts.client.events.SeriesEvent
          org.moxieapps.gwt.highcharts.client.events.SeriesCheckboxClickEvent

public class SeriesCheckboxClickEvent
extends SeriesEvent

Provides access to the raw information provided by Highcharts when a user clicks on the checkbox next to a series' name in the chart. This class should not be instantiated directly, but instead you should create a SeriesCheckboxClickEventHandler and register it via the SeriesPlotOptions.setSeriesCheckboxClickEventHandler(SeriesCheckboxClickEventHandler) method in order to access checkbox click events.

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

SeriesCheckboxClickEvent(com.google.gwt.core.client.JavaScriptObject event, com.google.gwt.core.client.JavaScriptObject series)
This constructor is intended for internal use only.

Method Summary

boolean

isChecked() Returns true if the checkbox state was checked on, or false if it was checked off.

Methods inherited from class org.moxieapps.gwt.highcharts.client.events.SeriesEvent

getSeriesId, getSeriesName

Methods inherited from class org.moxieapps.gwt.highcharts.client.events.MouseEvent

getClientX, getClientY, getNativeButton, getNativeEvent, getRelativeX, getRelativeY, getScreenX, getScreenY, isAltKeyDown, isControlKeyDown, isMetaKeyDown, isShiftKeyDown

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesCheckboxClickEvent

public SeriesCheckboxClickEvent(com.google.gwt.core.client.JavaScriptObject event,
                                com.google.gwt.core.client.JavaScriptObject series)

This constructor is intended for internal use only. You should not create click events directly, but instead should register a SeriesCheckboxClickEventHandler.

Parameters:

event - The native javascript object containing the details of the original event that was fired.

series - The native javascript object that represents the series instance that the event was triggered on.

Method Detail

isChecked

public boolean isChecked()

Returns true if the checkbox state was checked on, or false if it was checked off.

Returns:

Whether or not the checkbox was checked or not.