ilog.views.faces.dhtml.servlet

Class IlvFacesManagerPopupSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.servlet.IlvManagerPopupServletSupport

ilog.views.faces.dhtml.servlet.IlvFacesManagerPopupSupport

Direct Known Subclasses:

IltFacesGraphPopupSupport, IlvFacesDiagrammerPopupSupport

public class IlvFacesManagerPopupSupport
extends IlvManagerPopupServletSupport

This class defines the pop-up servlet support for the JSF Graphics Framework.

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
IlvFacesManagerPopupSupport(IlvManagerServletSupport support) Creates a pop-up support for JSF Framework components.

Method Summary

Modifier and Type	Method and Description
protected ServerActionListener	createListener() Returns a new instance of IlvFacesPopupMenuActionListener 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 IlvGraphic instance selected by the user when he triggered the pop-up menu.
protected Object	invokeFinder(IlvObjectSelectedFinder baseFinder, IlvManagerView view, String[] params) Invokes the specified finder with the parameters extracted from the action.
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.servlet.IlvManagerPopupServletSupport

getGraphicComponent, getMenuModelId, getSupport, installListeners, prepareComponent, removeListeners

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesManagerPopupSupport

public IlvFacesManagerPopupSupport(IlvManagerServletSupport support)

Creates a pop-up support for JSF Framework components.

Parameters:

support - The image generating servlet support.

Method Detail

getSelectedObject

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

Returns the IlvGraphic instance selected by the user when he triggered the pop-up menu.

Overrides:

getSelectedObject in class IlvManagerPopupServletSupport

Parameters:

request - The HTTP request.

x - x coordinate in image view coordinate system.

y - y coordinate in image view coordinate system.

Returns:

The selected IlvGraphic instance.

Throws:

jakarta.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

invokeFinder

protected Object invokeFinder(IlvObjectSelectedFinder baseFinder,
                              IlvManagerView 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(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 ServerActionListener createListener()

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

Overrides:

createListener in class IlvManagerPopupServletSupport

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