ilog.tgo.faces.graph.dhtml.servlet

Class IltFacesGraphSelectionSupport

java.lang.Object

ilog.views.util.servlet.IlvSelectionSupport

ilog.tgo.faces.graph.dhtml.servlet.IltFacesGraphSelectionSupport

public class IltFacesGraphSelectionSupport
extends IlvSelectionSupport

This class describes the servlet support for selection requests in a graph view (either Network or Equipment).

Since:

JViews 7.5

See Also:

IlvSelectionSupport

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.util.servlet.IlvSelectionSupport

IlvSelectionSupport.IlvSelectionResponse

Field Summary

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

REQUEST_TYPE

Constructor Summary

Constructors

Constructor and Description
IltFacesGraphSelectionSupport(IltFacesGraphServletSupport support) Creates an IltFacesGraphSelectionSupport instance.

Method Summary

Modifier and Type	Method and Description
protected void	doGetDeselectAll(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response) Attempts to deselect all the objects that are currently selected.
protected void	doGetSelectAll(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response) Attempts to select all the selectable objects.
protected void	doGetSelectOne(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response, int x, int y) Clears the current selections and attempts to select the object at a given position If a selectable object is found with the specified position, it is selected.
protected void	doGetSelectOneById(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response, String id) Clears the current selections and attempts to select the object with the specified identifier.
protected void	doGetSelectOneMultiple(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response, int x, int y) Attempts to extend the selection with the object at a given position, if any.
protected void	doGetSelectOneMultipleById(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response, String id) Attempts to extend the selection with the object with the specified identifier, if any.
protected void	doGetUpdateAll(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response) Resynchronizes the selection on the client from the server-side state of selection.
protected void	doGetUpdatedCapabilities(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response) Updates the capabilities that have changed.
protected List	getAdditionalProperties(IlvSelectionSupport.IlvSelectionResponse response, Object object) Returns additional information about a selected object.
IltFacesGraphServletSupport	getServletSupport() Accesses the image servlet support.
boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Handles a selection request.
protected void	initializeResponseProperties(IlvSelectionSupport.IlvSelectionResponse response, jakarta.servlet.http.HttpServletRequest request) This method is overridden to add the graph view to the response properties.
void	installListeners() Installs the server listeners required by this selection support.
void	removeListeners() Removes the server listeners installed by installListeners() method.

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

doPostSetProperties, getLastSelectedObject, isResizable, setAdditionalProperties, setLastSelectedObject

Methods inherited from class java.lang.Object

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

Constructor Detail

IltFacesGraphSelectionSupport

public IltFacesGraphSelectionSupport(IltFacesGraphServletSupport support)

Creates an IltFacesGraphSelectionSupport instance.

Parameters:

support - The image servlet support.

Method Detail

getServletSupport

public IltFacesGraphServletSupport getServletSupport()

Accesses the image servlet support.

Returns:

The image servlet support (instance of IltFacesGraphServletSupport).

handleRequest

public boolean handleRequest(jakarta.servlet.http.HttpServletRequest request,
                             jakarta.servlet.http.HttpServletResponse response)
                      throws IOException,
                             jakarta.servlet.ServletException

Description copied from class: IlvSelectionSupport

Handles a selection request.

Overrides:

handleRequest in class IlvSelectionSupport

Parameters:

request - The HTTP servlet request.

response - The HTTP servlet response.

Returns:

false if the request is not recognized by this servlet.

Throws:

IOException

jakarta.servlet.ServletException

installListeners

public void installListeners()

Installs the server listeners required by this selection support.

Three listeners are mandatory to fully support the selection functionalities:

• image mode: This listener configures the graph view based on the current image mode set. It is also activated when the image mode changes.
• selection: This listener handles the selection when image mode is activated.
• move: This listener is responsible to map client side mouse drag into server side node move.

Specified by:

installListeners in class IlvSelectionSupport

See Also:

IlvSelectionSupport.installListeners()

removeListeners

public void removeListeners()

Removes the server listeners installed by installListeners() method.

Specified by:

removeListeners in class IlvSelectionSupport

See Also:

IlvSelectionSupport.removeListeners()

initializeResponseProperties

protected void initializeResponseProperties(IlvSelectionSupport.IlvSelectionResponse response,
                                            jakarta.servlet.http.HttpServletRequest request)
                                     throws jakarta.servlet.ServletException

This method is overridden to add the graph view to the response properties.

To retrieve it from the response object, use:

   IlpGraphView view = (IlpGraphView)response.getProperty(GRAPH_KEY);
 

Overrides:

initializeResponseProperties in class IlvSelectionSupport

Parameters:

response - The selection response object.

request - The HTTP request.

Throws:

jakarta.servlet.ServletException

getAdditionalProperties

protected List getAdditionalProperties(IlvSelectionSupport.IlvSelectionResponse response,
                                       Object object)

Returns additional information about a selected object.

Specified by:

getAdditionalProperties in class IlvSelectionSupport

Parameters:

response - The selection response object.

object - The object selected or deselected.

Returns:

An array list of additional information on a selected/deselected object. Each item of the list could be a String, an array, a List or Map. List and arrays are rendered as JSON arrays on the client and Map are rendered as JSON objects on the client.

Note that the two first objects must be:

• ID -- A unique identifier of the selected object.
• Movable -- true if this object is movable, false otherwise.
• Type -- the type of the selected object.

doGetUpdateAll

protected void doGetUpdateAll(jakarta.servlet.http.HttpServletRequest request,
                              IlvSelectionSupport.IlvSelectionResponse response)
                       throws IOException,
                              jakarta.servlet.ServletException

Resynchronizes the selection on the client from the server-side state of selection.

Specified by:

doGetUpdateAll in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

Throws:

IOException

jakarta.servlet.ServletException

doGetSelectOne

protected void doGetSelectOne(jakarta.servlet.http.HttpServletRequest request,
                              IlvSelectionSupport.IlvSelectionResponse response,
                              int x,
                              int y)
                       throws IOException,
                              jakarta.servlet.ServletException

Clears the current selections and attempts to select the object at a given position If a selectable object is found with the specified position, it is selected. The response updates the client-side selection accordingly.

Specified by:

doGetSelectOne in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

x - The x coordinate of the point in view coordinates.

y - The y coordinate of the point in view coordinates

Throws:

IOException

jakarta.servlet.ServletException

doGetSelectOneMultiple

protected void doGetSelectOneMultiple(jakarta.servlet.http.HttpServletRequest request,
                                      IlvSelectionSupport.IlvSelectionResponse response,
                                      int x,
                                      int y)
                               throws IOException,
                                      jakarta.servlet.ServletException

Attempts to extend the selection with the object at a given position, if any. The response updates the client-side selection accordingly. If a selectable object is found at the specified position it is added or removed to the selection: an already selected object is deselected; an unselected object is selected. Otherwise (there was no selectable object), the selection is unchanged.

Specified by:

doGetSelectOneMultiple in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

x - The x coordinate of the point in view coordinates.

y - The y coordinate of the point in view coordinates.

Throws:

IOException

jakarta.servlet.ServletException

doGetUpdatedCapabilities

protected void doGetUpdatedCapabilities(jakarta.servlet.http.HttpServletRequest request,
                                        IlvSelectionSupport.IlvSelectionResponse response)
                                 throws jakarta.servlet.ServletException

Updates the capabilities that have changed.

Overrides:

doGetUpdatedCapabilities in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

Throws:

jakarta.servlet.ServletException

doGetDeselectAll

protected void doGetDeselectAll(jakarta.servlet.http.HttpServletRequest request,
                                IlvSelectionSupport.IlvSelectionResponse response)
                         throws IOException,
                                jakarta.servlet.ServletException

Attempts to deselect all the objects that are currently selected. The response updates the client-side selection accordingly.

Overrides:

doGetDeselectAll in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

Throws:

IOException

jakarta.servlet.ServletException

Since:

JViews 8.1

doGetSelectAll

protected void doGetSelectAll(jakarta.servlet.http.HttpServletRequest request,
                              IlvSelectionSupport.IlvSelectionResponse response)
                       throws IOException,
                              jakarta.servlet.ServletException

Attempts to select all the selectable objects. The response updates the client-side selection accordingly.

Overrides:

doGetSelectAll in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

Throws:

IOException

jakarta.servlet.ServletException

Since:

JViews 8.1

doGetSelectOneById

protected void doGetSelectOneById(jakarta.servlet.http.HttpServletRequest request,
                                  IlvSelectionSupport.IlvSelectionResponse response,
                                  String id)
                           throws IOException,
                                  jakarta.servlet.ServletException

Clears the current selections and attempts to select the object with the specified identifier. If a selectable object is found with the specified identifier, it is selected. The response updates the client-side selection accordingly.

Overrides:

doGetSelectOneById in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

id - The identifier of the object to select.

Throws:

IOException

jakarta.servlet.ServletException

Since:

JViews 8.1

doGetSelectOneMultipleById

protected void doGetSelectOneMultipleById(jakarta.servlet.http.HttpServletRequest request,
                                          IlvSelectionSupport.IlvSelectionResponse response,
                                          String id)
                                   throws IOException,
                                          jakarta.servlet.ServletException

Attempts to extend the selection with the object with the specified identifier, if any. The response updates the client-side selection accordingly. If a selectable object is found with the specified identifier, it is added or removed to the selection: an already selected object is deselected; an unselected object is selected. Otherwise (there was no selectable object), the selection is unchanged.

Overrides:

doGetSelectOneMultipleById in class IlvSelectionSupport

Parameters:

request - The HTTP request.

response - The response object.

id - The identifier of the object to select.

Throws:

IOException

jakarta.servlet.ServletException

Since:

JViews 8.1