ilog.views.gantt.faces.dhtml.servlet

Class IlvFacesGanttPopupSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.gantt.servlet.IlvGanttPopupMenuSupport

ilog.views.gantt.faces.dhtml.servlet.IlvFacesGanttPopupSupport

public class IlvFacesGanttPopupSupport
extends IlvGanttPopupMenuSupport

This class defines the pop-up menu servlet support designed to answer to JSF pop-up menu attached to a JSF Gantt view requests.

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
IlvFacesGanttPopupSupport(IlvGanttServletSupport support) Creates an new IlvFacesGanttPopupSupport.

Method Summary

Modifier and Type	Method and Description
protected IlvServerAction	createListener() Returns a new instance of IlvFacesGanttPopupMenuAction which can handle pop-up menu actions.
protected IlvMenu	createMenu(javax.servlet.http.HttpServletRequest request, IlvMenuFactory factory, Object graphicObject, Object selectedObject, String menuModelId) Calls the menu factory to return the menu model.
protected IlvPopupMenuEncoder	getMenuEncoder(javax.servlet.http.HttpServletRequest request) Returns the menu encoder responsible for encoding the root IlvMenu into a code comprehensible for the client.
protected IlvMenu	getPopupMenuFromSession(javax.servlet.http.HttpServletRequest request) Retrieve menu model stored in the session with the MENU_SESSION_KEY key.
protected Object	getSelectedObject(javax.servlet.http.HttpServletRequest request, int x, int y) Returns the IlvHierarchyNode selected when the user triggered the pop-up menu.
protected Object	invokeFinder(IlvObjectSelectedFinder baseFinder, IlvHierarchyChart view, String[] params) Invokes the specified finder with the parameters extracted from the action.
protected void	savePopupMenuModelInSession(javax.servlet.http.HttpServletRequest request, IlvMenu root) Saves the generated menu in session using the MENU_SESSION_KEY key.

Methods inherited from class ilog.views.gantt.servlet.IlvGanttPopupMenuSupport

getChart, getGraphicComponent, getMenuModelId, installListeners, removeListeners

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

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

IlvFacesGanttPopupSupport

public IlvFacesGanttPopupSupport(IlvGanttServletSupport support)

Creates an new IlvFacesGanttPopupSupport.

Parameters:

support - The servlet support

Method Detail

getSelectedObject

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

Returns the IlvHierarchyNode selected when the user triggered the pop-up menu. The x coordinate is unused as the y coordinate is sufficient.

Overrides:

getSelectedObject in class IlvGanttPopupMenuSupport

Parameters:

request - The HTTP request.

x - x coordinate in image view coordinate system.

y - y coordinate in image view coordinate system.

Returns:

the selected hierarchy node.

Throws:

javax.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

invokeFinder

protected Object invokeFinder(IlvObjectSelectedFinder baseFinder,
                              IlvHierarchyChart view,
                              String[] params)

Invokes the specified finder with the parameters extracted from the action.

Parameters:

baseFinder - The finder to invoke.

view - The view component.

params - The action parameters.

Returns:

The object found by the finder.

getMenuEncoder

protected IlvPopupMenuEncoder getMenuEncoder(javax.servlet.http.HttpServletRequest request)
                                      throws javax.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:

javax.servlet.ServletException

createListener

protected IlvServerAction createListener()

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

Overrides:

createListener in class IlvGanttPopupMenuSupport

savePopupMenuModelInSession

protected void savePopupMenuModelInSession(javax.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(javax.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

createMenu

protected IlvMenu createMenu(javax.servlet.http.HttpServletRequest request,
                             IlvMenuFactory factory,
                             Object graphicObject,
                             Object selectedObject,
                             String menuModelId)
                      throws javax.servlet.ServletException

Calls the menu factory to return the menu model.

Overrides:

createMenu in class IlvGanttPopupMenuSupport

Parameters:

request - The HTTP servlet request.

factory - The menu factory.

graphicObject - The graphic component.

selectedObject - The selected object.

menuModelId - The menu model ID.

Returns:

The root menu of the model.

Throws:

javax.servlet.ServletException