ilog.views.servlet

Class IlvManagerPopupServletSupport

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuServletSupport

ilog.views.servlet.IlvManagerPopupServletSupport

Direct Known Subclasses:

IlvFacesManagerPopupSupport

public class IlvManagerPopupServletSupport
extends IlvPopupMenuServletSupport

The IlvPopupMenuServletSupport class defines a servlet support dedicated to dynamic pop-up requests.

This implementation of a IlvPopupMenuServletSupport returns IlvManagerView instance and the selected IlvGraphic through the getGraphicComponent() and getSelectedObject() methods, respectively.

To use pop-up menus, extend the IlvManagerServletSupport like the following example:

 public class ExampleSupport extends IlvManagerServletSupport {
 
   public ExampleSupport(ServletContext context) {
     setPopupEnabled(true);
     getPopupMenuSupport().setMenuFactory(new ExampleFactory());
   }
 
   [...]
 
 }
 

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
IlvManagerPopupServletSupport(IlvManagerServletSupport support) Creates a IlvPopupMenuServletSupport.

Method Summary

Modifier and Type	Method and Description
protected ServerActionListener	createListener() Returns the server action listener that manages the actions that come from the pop-up menu.
protected Object	getGraphicComponent(jakarta.servlet.http.HttpServletRequest request) Returns the manager view by calling the support.getManagerView().
protected String	getMenuModelId(jakarta.servlet.http.HttpServletRequest request) Returns the menu model ID from the request.
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 IlvManagerServletSupport	getSupport() Returns the image generating servlet support.
void	installListeners() Installs the listeners to properly handle the pop-up menu actions.
protected void	prepareComponent(jakarta.servlet.http.HttpServletRequest request, Object graphicComponent) Configures the graphic component to be in a correct state before the selected object is picked.
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, savePopupMenuModelInSession, setMenuFactory, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvManagerPopupServletSupport

public IlvManagerPopupServletSupport(IlvManagerServletSupport support)

Creates a IlvPopupMenuServletSupport.

Parameters:

support - The manager servlet support.

Method Detail

getSupport

protected IlvManagerServletSupport getSupport()

Returns the image generating servlet support.

Returns:

The servlet support.

getGraphicComponent

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

Returns the manager view by calling the support.getManagerView().

Specified by:

getGraphicComponent in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The manager view instance.

Throws:

jakarta.servlet.ServletException

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.

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 IlvGraphic instance.

Throws:

jakarta.servlet.ServletException

See Also:

IlvPopupMenuServletSupport.getGraphicComponent(HttpServletRequest)

prepareComponent

protected void prepareComponent(jakarta.servlet.http.HttpServletRequest request,
                                Object graphicComponent)
                         throws jakarta.servlet.ServletException

Configures the graphic component to be in a correct state before the selected object is picked. This implementation does nothing. Subclasses can override this method to do specific configuration. Overridden to set the requested visible layers on the view.

Overrides:

prepareComponent in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

graphicComponent - The graphic component.

Throws:

jakarta.servlet.ServletException - If an error occurs during configuration.

getMenuModelId

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

Returns the menu model ID from the request.

Specified by:

getMenuModelId in class IlvPopupMenuServletSupport

Parameters:

request - The HTTP request.

Returns:

The menu model ID.

Throws:

jakarta.servlet.ServletException

createListener

protected ServerActionListener 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 IlvPopupMenuServerActionListener.

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