Package net.pricefx.common.apibuilder.chart

Class AbstractChartEvent<C extends AbstractChartBuilder<?>,E extends AbstractChartEvent<C,E>>

Object

ObjectIdentity

BacklinkBuilder<C>

AbstractChartEvent<C,E>

Direct Known Subclasses:

ChartEvents.OnCellClick, ChartEvents.OnChartClick, ChartEvents.OnRowClick

public abstract class AbstractChartEvent<C extends AbstractChartBuilder<?>,E extends AbstractChartEvent<C,E>>
extends BacklinkBuilder<C>

Common base class for the click-event configuration builders returned by AbstractChartBuilder.onRowClick() and AbstractChartBuilder.onCellClick(), and by each concrete chart type's own onClick() method, for example ScatterChart.onClick(). You never instantiate this class or a concrete subclass of it directly.

Call triggerEvent(String) to name the Dashboard event this click should fire; the returned AbstractChartEvent.TriggerEvent builder then configures what data, if any, accompanies that event. The triggered event is typically consumed by an embedded Dashboard to refresh another portlet in reaction to the click.

See Also:

• AbstractChartEvent.TriggerEvent
• Interactive Embedded Dashboards

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractChartEvent.TriggerEvent<T extends AbstractChartEvent<C,E>.TriggerEvent<?>>	Base class for the event-payload builders returned by a concrete triggerEvent(String) implementation, for example ChartEvents.OnRowClick.RowClickTriggerEvent.

Field Summary

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractChartEvent(C backLink)

Method Summary

Modifier and Type	Method	Description
protected E	getThis()
abstract <T extends AbstractChartEvent<C, E>.TriggerEvent<?>> T	triggerEvent(String eventName)	Names the Dashboard event this click should fire, returning a builder for configuring what data accompanies it.

Methods inherited from class BacklinkBuilder

back, getParent

Methods inherited from class ObjectIdentity

addInvocation, addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

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

Constructor Details

AbstractChartEvent

protected AbstractChartEvent(C backLink)

Method Details

getThis

protected E getThis()

triggerEvent

public abstract <T extends AbstractChartEvent<C,
E>.TriggerEvent<?>>
T triggerEvent(String eventName)

Names the Dashboard event this click should fire, returning a builder for configuring what data accompanies it. The concrete return type differs per event kind, for example ChartEvents.OnRowClick.triggerEvent(String) returns a ChartEvents.OnRowClick.RowClickTriggerEvent, which is why this method is declared abstract here rather than implemented once for every event kind.

A Dashboard-wide-unique event name is recommended, typically obtained via api.dashboardWideEvent(String) rather than a hardcoded literal, since Dashboard events are global across browser tabs.

Parameters:

eventName - the name of the Dashboard event to fire on click. Must be neither null nor empty.

Returns:

a new AbstractChartEvent.TriggerEvent builder for this event. Never null.

Throws:

IllegalArgumentException - if eventName is null or empty