ilog.views.chart.servlet

Class IlvChartPopupMenuSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.chart.servlet.IlvChartPopupMenuSupport

Direct Known Subclasses:

IlvFacesChartPopupSupport

public class IlvChartPopupMenuSupport
extends IlvPopupMenuServletSupport

This class is the chart specific servlet support for dynamic pop-up menu requests from the client.

Since:

JViews 7.5

Field Summary

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

MENU_SESSION_KEY, REQUEST_TYPE, SERVLET_ACTION_NAME

Constructor Summary

Constructors

Constructor and Description
IlvChartPopupMenuSupport(IlvChartServletSupport support) Creates an IlvChartPopupMenuSupport.

Method Summary

Modifier and Type	Method and Description
protected IlvChartDataPicker	createDataPicker(int x, int y) Creates the data picker used to retrieve the selected object on the view.
protected IlvChartServerAction	createListener() Returns the server action listener that manages the actions that come from the pop-up menu.
protected IlvChart	getChart(javax.servlet.http.HttpServletRequest request) Returns the IlvChart instance used to render the image.
protected Object	getGraphicComponent(javax.servlet.http.HttpServletRequest request) Returns the IlvChart instance used to render the image.
protected String	getMenuModelId(javax.servlet.http.HttpServletRequest request) Returns the menu model ID set on the client interactor of the view.
protected Object	getSelectedObject(javax.servlet.http.HttpServletRequest request, int x, int y) Returns the IlvDisplayPoint instance selected when user triggered the pop-up menu.
protected IlvChartServletSupport	getSupport() Returns the image servlet support.
void	installListeners() Installs the listeners to properly handle the pop-up menu actions.
void	removeListeners() Removes the listeners previously installed through the installListeners() method.

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

createMenu, createMenu, getMenuEncoder, getMenuFactory, getPopupMenuFromSession, getServletContext, handleRequest, prepareComponent, savePopupMenuModelInSession, setMenuFactory, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartPopupMenuSupport

public IlvChartPopupMenuSupport(IlvChartServletSupport support)

Creates an IlvChartPopupMenuSupport.

Parameters:

support - The standard servlet support.

Method Detail

getGraphicComponent

protected Object getGraphicComponent(javax.servlet.http.HttpServletRequest request)
                              throws javax.servlet.ServletException

Returns the IlvChart instance used to render the image.

Specified by:

getGraphicComponent in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The chart.

Throws:

javax.servlet.ServletException

getChart

protected IlvChart getChart(javax.servlet.http.HttpServletRequest request)
                     throws javax.servlet.ServletException

Returns the IlvChart instance used to render the image.
This method calls the getGraphicComponent(HttpServletRequest request) method and casts the returned value to IlvChart.

Returns:

The chart.

Throws:

javax.servlet.ServletException

getSelectedObject

protected Object getSelectedObject(javax.servlet.http.HttpServletRequest request,
                                   int x,
                                   int y)
                            throws javax.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.

Specified by:

getSelectedObject in class IlvPopupMenuServletSupport

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:

javax.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

getMenuModelId

protected String getMenuModelId(javax.servlet.http.HttpServletRequest request)
                         throws javax.servlet.ServletException

Returns the menu model ID set on the client interactor of the view.

Specified by:

getMenuModelId in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The menu model ID.

Throws:

javax.servlet.ServletException

createDataPicker

protected IlvChartDataPicker createDataPicker(int x,
                                              int y)

Creates the data picker used to retrieve the selected object on the view.

Parameters:

x - The x coordinate of the clicked point.

y - The y coordinate of the clicked point.

Returns:

The data picker.

getSupport

protected IlvChartServletSupport getSupport()

Returns the image servlet support.

Returns:

The servlet support.

createListener

protected IlvChartServerAction createListener()

Returns the server action listener that manages the actions that come from the pop-up menu.

By default this method returns a new instance of IlvPopupChartServerAction.

Subclasses may override this method to register a custom listener.

installListeners

public void installListeners()

Installs the listeners to properly handle the pop-up menu actions.

Specified by:

installListeners in class IlvPopupMenuServletSupport

removeListeners

public void removeListeners()

Removes the listeners previously installed through the installListeners() method.

Specified by:

removeListeners in class IlvPopupMenuServletSupport