ilog.views.gantt.servlet

Class IlvGanttPopupMenuSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.gantt.servlet.IlvGanttPopupMenuSupport

Direct Known Subclasses:

IlvFacesGanttPopupSupport

public class IlvGanttPopupMenuSupport
extends IlvPopupMenuServletSupport

This class is the gantt 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
IlvGanttPopupMenuSupport(IlvGanttServletSupport support) Creates an IlvGanttPopuMenuSupport.

Method Summary

Modifier and Type	Method and Description
protected IlvServerAction	createListener() Returns the server action listener that manages the actions that come from the pop-up menu.
protected IlvMenu	createMenu(jakarta.servlet.http.HttpServletRequest request, IlvMenuFactory factory, Object graphicObject, Object selectedObject, String menuModelId) Calls the menu factory to return the menu model.
protected IlvHierarchyChart	getChart(jakarta.servlet.http.HttpServletRequest request) Returns the chart used for the specified request.
protected Object	getGraphicComponent(jakarta.servlet.http.HttpServletRequest request) Returns the chart used for the specified request.
protected String	getMenuModelId(jakarta.servlet.http.HttpServletRequest request) Returns the menu model ID set on the client interactor of the view.
protected Object	getSelectedObject(jakarta.servlet.http.HttpServletRequest request, int x, int y) Returns the IlvHierarchyNode selected when the user triggered the pop-up menu.
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, 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

IlvGanttPopupMenuSupport

public IlvGanttPopupMenuSupport(IlvGanttServletSupport support)

Creates an IlvGanttPopuMenuSupport.

Parameters:

support - The IlvGanttServletSupport instance.

Method Detail

getGraphicComponent

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

Returns the chart used for the specified request. This method delegates the retrieval of chart to the IlvGanttServletSupport instance.

Specified by:

getGraphicComponent in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The graphic component.

Throws:

jakarta.servlet.ServletException

getChart

protected IlvHierarchyChart getChart(jakarta.servlet.http.HttpServletRequest request)
                              throws jakarta.servlet.ServletException

Returns the chart used for the specified request. Call this method is similar to a call to (IlvHierarchyChart)getGraphicComponent(request).

Throws:

jakarta.servlet.ServletException

getSelectedObject

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

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 hierarchy node.

Throws:

jakarta.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

getMenuModelId

protected String getMenuModelId(jakarta.servlet.http.HttpServletRequest request)
                         throws jakarta.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:

jakarta.servlet.ServletException

createMenu

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

Calls the menu factory to return the menu model.

Overrides:

createMenu in class IlvPopupMenuServletSupport

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:

jakarta.servlet.ServletException

createListener

protected IlvServerAction 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 IlvPopupMenuAction.

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