Package org.zkoss.chart

Class ChartsEvent

java.lang.Object

org.zkoss.zk.ui.event.Event

org.zkoss.chart.ChartsEvent

All Implemented Interfaces:

Serializable

public class ChartsEvent
extends org.zkoss.zk.ui.event.Event

Represents an event cause by user's interaction with the Highcharts.

Author:

jumperchen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ChartsEvent(String name, org.zkoss.zk.ui.Component target, int sIndex, int pIndex, Comparable<?> category, boolean checked, boolean isDrilldown)

Method Summary

Modifier and Type	Method	Description
Comparable<?>	getCategory()	Returns the category value, if any.
static ChartsEvent	getChartsEvent(org.zkoss.zk.au.AuRequest request)
Point	getPoint()	Returns the point object, if any.
int	getPointIndex()	Returns the point index, if any.
Series	getSeries()	Returns the series object.
int	getSeriesIndex()	Returns the series index, if any.
boolean	isChecked()	Returns the checkbox event whether is checked, if any.
boolean	isDrilldown()

Methods inherited from class org.zkoss.zk.ui.event.Event

getData, getEvent, getName, getPage, getTarget, isPropagatable, stopPropagation, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartsEvent

public ChartsEvent(String name,
                   org.zkoss.zk.ui.Component target,
                   int sIndex,
                   int pIndex,
                   Comparable<?> category,
                   boolean checked,
                   boolean isDrilldown)

Method Detail

getChartsEvent

public static final ChartsEvent getChartsEvent(org.zkoss.zk.au.AuRequest request)

getCategory

public Comparable<?> getCategory()

Returns the category value, if any.

getPointIndex

public int getPointIndex()

Returns the point index, if any.

Only support for ChartsEvents.ON_PLOT_CLICK

Returns:

-1 if not a point event

getSeriesIndex

public int getSeriesIndex()

Returns the series index, if any.

isChecked

public boolean isChecked()

Returns the checkbox event whether is checked, if any.

Only support for ChartsEvents.ON_PLOT_CHECKBOX_CLICK

Returns:

false if not a checkbox event

isDrilldown

public boolean isDrilldown()

getPoint

public Point getPoint()

Returns the point object, if any.

Only support for ChartsEvents.ON_PLOT_CLICK

Returns:

null if not a point event

getSeries

public Series getSeries()

Returns the series object.