ilog.views.chart.faces.dhtml.interactor

Class IlvChartObjectSelectedFinder

java.lang.Object

ilog.views.chart.faces.dhtml.interactor.IlvChartObjectSelectedFinder

All Implemented Interfaces:

IlvChartConstants, IlvObjectSelectedFinder, Serializable

public class IlvChartObjectSelectedFinder
extends Object
implements IlvObjectSelectedFinder, IlvChartConstants

This class is responsible for finding the data set point picked on the view. The parameters passed to this action are:

• 0 : x coordinate of the point clicked on the image.
• 1 : y coordinate of the point clicked on the image.
• 2 : interval minimum bound along the x axis of the visible data interval.
• 3 : interval maximum bound along the x axis of the visible data interval.
• 4 : interval minimum bound along the y axis of the visible data interval.
• 5 : interval maximum bound along the y axis of the visible data interval.
• 6 : chart width in pixels.
• 7 : chart height in pixels.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from interface ilog.views.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

Constructor Summary

Constructors

Constructor and Description
IlvChartObjectSelectedFinder() Creates a new IlvChartObjectSelectedFinder instance.
IlvChartObjectSelectedFinder(int mode) Creates a new IlvChartObjectSelectedFinder instance.
IlvChartObjectSelectedFinder(String mode) Creates a new IlvChartObjectSelectedFinder instance.

Method Summary

Modifier and Type	Method and Description
Object	computeObjectSelected(IlvBasicView view, String[] params) Returns the clicked object from the view and the parameters of this clicked object.
Object	computeObjectSelected(IlvChart chart, String[] params, String chartId) Retrieves the selected object from the parameters.
protected IlvChartDataPicker	createDataPicker(int x, int y) Create the data picker that will be used to find the picked data set point.
int	getMode() Returns the picking mode.
IlvDataSetPoint	pickObject(IlvChart chart, String[] params) Returns the data set point picked according to the picking mode.
void	setMode(int mode) Sets the picking mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartObjectSelectedFinder

public IlvChartObjectSelectedFinder()

Creates a new IlvChartObjectSelectedFinder instance.

IlvChartObjectSelectedFinder

public IlvChartObjectSelectedFinder(int mode)

Creates a new IlvChartObjectSelectedFinder instance.

Parameters:

mode - The picking mode.

See Also:

IlvChartConstants.ITEM_PICKING, IlvChartConstants.NEAREST_ITEM_PICKING, IlvChartConstants.NEAREST_POINT_PICKING

IlvChartObjectSelectedFinder

public IlvChartObjectSelectedFinder(String mode)

Creates a new IlvChartObjectSelectedFinder instance.

Parameters:

mode - The picking mode. Valid values are "ITEM", "NEAREST_ITEM, and "NEAREST_POINT".

Method Detail

setMode

public void setMode(int mode)

Sets the picking mode.
Valid values are:

• IlvChartConstants.NEAREST_POINT_PICKING, the IlvChart.getNearestPoint(picker) method is used.
• IlvChartConstants.NEAREST_ITEM_PICKING, the IlvChart.getNearestPoint(picker, result) method is used.
• IlvChartConstants.ITEM_PICKING, the IlvChart.getNearestPoint(picker) method is used.

Parameters:

mode - The picking mode.

Since:

JViews 7.5

getMode

public int getMode()

Returns the picking mode.

Returns:

The picking mode.

Since:

JViews 7.5

See Also:

setMode(int)

pickObject

public IlvDataSetPoint pickObject(IlvChart chart,
                                  String[] params)

Returns the data set point picked according to the picking mode.

Parameters:

chart - The chart from which the display point is to be retrieved.

params - The parameters for this action:

• 0 : x coordinate of the point clicked on the image.
• 1 : y coordinate of the point clicked on the image.
• 2 : interval minimum bound along the x axis of the visible data interval.
• 3 : interval maximum bound along the x axis of the visible data interval.
• 4 : interval minimum bound along the y axis of the visible data interval.
• 5 : interval maximum bound along the y axis of the visible data interval.
• 6 : chart width in pixels.
• 7 : chart height in pixels.

Returns:

The data set point if found, null otherwise.

computeObjectSelected

public Object computeObjectSelected(IlvBasicView view,
                                    String[] params)

Description copied from interface: IlvObjectSelectedFinder

Returns the clicked object from the view and the parameters of this clicked object. Each IlvDHTMLObjectSelectInteractor subclass must define how to access to the model from the view and what are the parameters necessary to find the object and set a default instance of this class.

Specified by:

computeObjectSelected in interface IlvObjectSelectedFinder

Parameters:

view - The view that contains the object clicked.

params - An array of parameters.

Returns:

The clicked object or a collection of objects.

computeObjectSelected

public Object computeObjectSelected(IlvChart chart,
                                    String[] params,
                                    String chartId)

Retrieves the selected object from the parameters.

Parameters:

chart - The chart instance.

params - The array of parameters.

chartId - The ID of the JSF chart view component.

Returns:

The data set point selected or null.

createDataPicker

protected IlvChartDataPicker createDataPicker(int x,
                                              int y)

Create the data picker that will be used to find the picked data set point.

This implementation returns an IlvDefaultChartDataPicker instance.

Parameters:

x - x coordinate of the point clicked on the image.

y - y coordinate of the point clicked on the image.

Returns:

A data picker instance.