com.googlecode.wickedcharts.highcharts.options.interaction
Class InteractionFunction

java.lang.Object
  com.googlecode.wickedcharts.highcharts.options.Function
      com.googlecode.wickedcharts.highcharts.options.interaction.InteractionFunction

All Implemented Interfaces:

IProcessableOption, Serializable

public abstract class InteractionFunction
extends Function
implements IProcessableOption

This javascript function sends an AJAX request to the server. That request contains some information about what point and series the user has selected in the chart. That information is available on the server side as an InteractionEvent object.

Author:

Tom Hombergs (tom.hombergs@gmail.com)

See Also:

Serialized Form

Field Summary

static String

PROCESSING_KEY The key under which InteractionFunctions are registered in the parent options.

Constructor Summary

InteractionFunction(Options parentOptions)
Constructor.

Method Summary

String	getProcessingKey()
abstract void	onInteraction(InteractionEvent event) This method is called on the server side when the InteractionFunction is called on the client side.

Methods inherited from class com.googlecode.wickedcharts.highcharts.options.Function

addParameter, getFunction, setFunction

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSING_KEY

public static final String PROCESSING_KEY

The key under which InteractionFunctions are registered in the parent options. See Options.markForProcessing(IProcessableOption) .

See Also:

Constant Field Values

Constructor Detail

InteractionFunction

public InteractionFunction(Options parentOptions)

Constructor.

Parameters:

parentOptions - the Options object that contain this function.

Method Detail

getProcessingKey

public String getProcessingKey()

Specified by:

getProcessingKey in interface IProcessableOption

onInteraction

public abstract void onInteraction(InteractionEvent event)

This method is called on the server side when the InteractionFunction is called on the client side.

Parameters:

event - the InteractionEvent containing information about which Point of which Series and which Chart has been interacted with.