ilog.views.chart.servlet

Class IlvPickPointAction

java.lang.Object

ilog.views.chart.servlet.IlvPickPointAction

All Implemented Interfaces:

IlvChartServerAction, EventListener

public class IlvPickPointAction
extends Object
implements IlvChartServerAction

A class to perform data point picking on the server side. This action should be used with an IlvChartPickInteractor DHTML interactor, and expects the following parameters:

• The picking event x-coordinate (int)
• The picking event y-coordinate (int)

All parameters are expressed in display coordinate system.

Since:

JViews 6.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	ITEM_PICKING The constant describing the item picking mode.
static int	NEAREST_ITEM_PICKING The constant describing the nearest item picking mode.
static int	NEAREST_POINT_PICKING The constant describing the nearest point picking mode.

Fields inherited from interface ilog.views.chart.servlet.IlvChartServerAction

REQUEST_THREAD, SWING_EVENT_THREAD

Constructor Summary

Constructors

Constructor and Description
IlvPickPointAction() Creates a new PickPointAction object.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(IlvChartServerActionEvent event) Performs the action requested from the client side.
protected IlvChartDataPicker	createDataPicker(int x, int y) Creates a new IlvChartDataPicker object.
int	getExecutionThread() Returns the action execution thread.
int	getPickingMode() Returns the picking mode.
protected IlvDisplayPoint	pickData(IlvChart chart, int x, int y) Returns a display point depending on the current picking mode.
protected void	pointSelected(IlvDisplayPoint pickedPoint) Called when a display point has been picked.
void	setPickingMode(int mode) Sets the picking mode.

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_PICKING

public static final int ITEM_PICKING

The constant describing the item picking mode.

See Also:

setPickingMode(int), Constant Field Values

NEAREST_ITEM_PICKING

public static final int NEAREST_ITEM_PICKING

The constant describing the nearest item picking mode.

Since:

JViews 8.5

See Also:

setPickingMode(int), Constant Field Values

NEAREST_POINT_PICKING

public static final int NEAREST_POINT_PICKING

The constant describing the nearest point picking mode.

See Also:

setPickingMode(int), Constant Field Values

Constructor Detail

IlvPickPointAction

public IlvPickPointAction()

Creates a new PickPointAction object.

Method Detail

getPickingMode

public final int getPickingMode()

Returns the picking mode.

See Also:

setPickingMode(int)

setPickingMode

public void setPickingMode(int mode)

Sets the picking mode. The picking mode defines how a point is retrieved by the pickData() method. If the mode is ITEM_PICKING, the display point is retrieved by calling IlvChart.getDisplayItem(ilog.views.chart.IlvChartDataPicker). If the mode is NEAREST_ITEM_PICKING, the display point is retrieved by calling IlvChart.getNearestItem(ilog.views.chart.IlvChartDataPicker, double[]). If the mode is NEAREST_POINT_PICKING, the display point is retrieved by calling IlvChart.getNearestPoint(ilog.views.chart.IlvChartDataPicker). The default value is NEAREST_POINT_PICKING.

See Also:

ITEM_PICKING, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING

createDataPicker

protected IlvChartDataPicker createDataPicker(int x,
                                              int y)

Creates a new IlvChartDataPicker object. By default it returns an instance of IlvDefaultChartDataPicker. This method is called by pickData(ilog.views.chart.IlvChart, int, int).

See Also:

IlvDefaultChartDataPicker

actionPerformed

public void actionPerformed(IlvChartServerActionEvent event)
                     throws javax.servlet.ServletException

Performs the action requested from the client side. This method is invoked on the thread as specified by the getExecutionThread() method.

Specified by:

actionPerformed in interface IlvChartServerAction

Parameters:

event - The server action event.

Throws:

javax.servlet.ServletException - Some request parameters are missing.

pickData

protected IlvDisplayPoint pickData(IlvChart chart,
                                   int x,
                                   int y)

Returns a display point depending on the current picking mode.

See Also:

createDataPicker(int, int), setPickingMode(int)

pointSelected

protected void pointSelected(IlvDisplayPoint pickedPoint)

Called when a display point has been picked. The default implementation does nothing.

getExecutionThread

public int getExecutionThread()

Returns the action execution thread. The default implementation returns IlvChartServerAction.SWING_EVENT_THREAD.

Specified by:

getExecutionThread in interface IlvChartServerAction