ilog.views.chart.faces.servlet

Class IlvFacesChartPopupSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.chart.servlet.IlvChartPopupMenuSupport

ilog.views.chart.faces.servlet.IlvFacesChartPopupSupport

All Implemented Interfaces:

IlvChartConstants

public class IlvFacesChartPopupSupport
extends IlvChartPopupMenuSupport
implements IlvChartConstants

This class defines a pop-up menu support for the JSF chart.

Since:

JViews 7.5

Field Summary

Fields inherited from class ilog.views.util.servlet.IlvPopupMenuServletSupport

MENU_SESSION_KEY, REQUEST_TYPE, SERVLET_ACTION_NAME

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
IlvFacesChartPopupSupport(IlvChartServletSupport support) Creates an IlvFacesChartPopupSupport.

Method Summary

Modifier and Type	Method and Description
protected IlvChartServerAction	createListener() Returns a new instance of IlvFacesChartPopupAction which can handle pop-up menu actions.
protected IlvPopupMenuEncoder	getMenuEncoder(jakarta.servlet.http.HttpServletRequest request) Returns the menu encoder responsible for encoding the root IlvMenu into a code comprehensible for the client.
protected IlvMenu	getPopupMenuFromSession(jakarta.servlet.http.HttpServletRequest request) Retrieve menu model stored in the session with the MENU_SESSION_KEY key.
protected Object	getSelectedObject(jakarta.servlet.http.HttpServletRequest request, int x, int y) Returns the IlvDisplayPoint instance selected when user triggered the pop-up menu.
protected void	savePopupMenuModelInSession(jakarta.servlet.http.HttpServletRequest request, IlvMenu root) Saves the generated menu in session using the MENU_SESSION_KEY key.

Methods inherited from class ilog.views.chart.servlet.IlvChartPopupMenuSupport

createDataPicker, getChart, getGraphicComponent, getMenuModelId, getSupport, installListeners, removeListeners

Methods inherited from class ilog.views.util.servlet.IlvPopupMenuServletSupport

createMenu, createMenu, getMenuFactory, getServletContext, handleRequest, prepareComponent, setMenuFactory, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesChartPopupSupport

public IlvFacesChartPopupSupport(IlvChartServletSupport support)

Creates an IlvFacesChartPopupSupport.

Parameters:

support - The image servlet support.

Method Detail

getSelectedObject

protected Object getSelectedObject(jakarta.servlet.http.HttpServletRequest request,
                                   int x,
                                   int y)
                            throws jakarta.servlet.ServletException

Returns the IlvDisplayPoint instance selected when user triggered the pop-up menu. The point is retrieved according to the mode specified by the client.

Overrides:

getSelectedObject in class IlvChartPopupMenuSupport

Parameters:

request - The HTTP request.

x - x coordinate in image view coordinate system.

y - y coordinate in image view coordinate system.

Returns:

The selected display point.

Throws:

jakarta.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

getMenuEncoder

protected IlvPopupMenuEncoder getMenuEncoder(jakarta.servlet.http.HttpServletRequest request)
                                      throws jakarta.servlet.ServletException

Returns the menu encoder responsible for encoding the root IlvMenu into a code comprehensible for the client.
This method returns an IlvPopupMenuEncoder instance.

Overrides:

getMenuEncoder in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The menu encoder.

Throws:

jakarta.servlet.ServletException

createListener

protected IlvChartServerAction createListener()

Returns a new instance of IlvFacesChartPopupAction which can handle pop-up menu actions.

Overrides:

createListener in class IlvChartPopupMenuSupport

savePopupMenuModelInSession

protected void savePopupMenuModelInSession(jakarta.servlet.http.HttpServletRequest request,
                                           IlvMenu root)

Saves the generated menu in session using the MENU_SESSION_KEY key. Overridden to use the faces context to access the session.

Overrides:

savePopupMenuModelInSession in class IlvPopupMenuServletSupport

Parameters:

request - The Http request.

root - The root menu of the menu model.

Since:

JViews 8.0

getPopupMenuFromSession

protected IlvMenu getPopupMenuFromSession(jakarta.servlet.http.HttpServletRequest request)

Retrieve menu model stored in the session with the MENU_SESSION_KEY key. Overridden to use the faces context to access the session.

Overrides:

getPopupMenuFromSession in class IlvPopupMenuServletSupport

Parameters:

request - The Http request.

Returns:

The menu stored in session.

Since:

JViews 8.0