ilog.views.gantt.servlet

Class IlvGanttSelectionSupport

java.lang.Object

ilog.views.util.servlet.IlvSelectionSupport

ilog.views.gantt.servlet.IlvGanttSelectionSupport

Direct Known Subclasses:

IlvFacesGanttSelectionSupport

public class IlvGanttSelectionSupport
extends IlvSelectionSupport

This class is the IlvSelectionSupport implementation dedicated to Gantt charts.

Since:

JViews 8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvGanttSelectionSupport.DefaultIdentifierFactory Default implementation of IdentifierFactory.
static interface	IlvGanttSelectionSupport.IdentifierFactory Defines a factory of identifiers for Gantt model objects.

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

IlvSelectionSupport.IlvSelectionResponse

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITY_OBJECT_TYPE Identifier for the Gantt model object type Activity.
static String	CONSTRAINT_OBJECT_TYPE Identifier for the Gantt model object type Constraint.
static String	RESERVATION_OBJECT_TYPE Identifier for the Gantt model object type Reservation.
static String	RESOURCE_OBJECT_TYPE Identifier for the Gantt model object type Resource.

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

REQUEST_TYPE

Constructor Summary

Constructors

Constructor and Description
IlvGanttSelectionSupport(IlvGanttServletSupport support) Creates an IlvGanttSelectionSupport instance.

Method Summary

Modifier and Type	Method and Description
protected void	cacheObjectId(IlvGanttModel model, Object object, String id) Caches the association of an identifier to a Gantt model object.
protected IlvGanttSheetSelectionSupport	createGanttSheetSelectionSupport() Creates the selection support for the Gantt sheet component.
protected IlvGanttTableSelectionSupport	createGanttTableSelectionSupport() Creates the selection support for the Gantt table component.
protected IlvServerAction	createImageModeAction() Creates the server action that handles changing the representation mode for the selection.
protected IlvServerAction	createMoveSelectionAction() Creates the server action that handles moving the selected objects.
protected IlvServerAction	createResizeActivityAction() Creates the server action that handles resizing the selected activities.
protected IlvServerAction	createSelectObjectAction() Creates the server action that handles selecting 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	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	doGetUpdateAll(jakarta.servlet.http.HttpServletRequest request, IlvSelectionSupport.IlvSelectionResponse response) Resynchronizes the selection on the client from the server-side state of selection.
protected List	getAdditionalProperties(IlvSelectionSupport.IlvSelectionResponse response, Object object) Returns additional information about a selected object.
IlvGanttComponentSelectionSupport	getDelegate(jakarta.servlet.http.HttpServletRequest request) Returns the selection support suitable for a type of component.
String	getIdentifier(Object object) Returns the identifier associated to a Gantt model object.
IlvGanttSelectionSupport.IdentifierFactory	getIdentifierFactory() Returns the factory of identifiers for Gantt model objects.
protected Object	getObject(IlvGanttModel model, String id) Returns the Gantt model object corresponding to an identifier, provided that the object identifier was previously cached using cacheObjectId.
protected Object	getObject(IlvGanttModel model, String id, String type) Returns the Gantt model object corresponding to an identifier and a type.
IlvGanttServletSupport	getSupport() Returns the IlvGanttServletSupport instance attached to this support.
boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Handles a selection request.
void	installListeners() Installs the server action listeners to properly handle selection actions.
void	removeListeners() Removes the server action previously installed with installListeners.
void	setIdentifierFactory(IlvGanttSelectionSupport.IdentifierFactory factory) Sets the factory of identifier for Gantt model objects.

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

doGetDeselectAll, doGetSelectAll, doGetSelectOneById, doGetSelectOneMultipleById, doGetUpdatedCapabilities, doPostSetProperties, getLastSelectedObject, initializeResponseProperties, isResizable, setAdditionalProperties, setLastSelectedObject

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVITY_OBJECT_TYPE

public static final String ACTIVITY_OBJECT_TYPE

Identifier for the Gantt model object type Activity.

Since:

JViews 8.1

See Also:

Constant Field Values

RESOURCE_OBJECT_TYPE

public static final String RESOURCE_OBJECT_TYPE

Identifier for the Gantt model object type Resource.

Since:

JViews 8.1

See Also:

Constant Field Values

CONSTRAINT_OBJECT_TYPE

public static final String CONSTRAINT_OBJECT_TYPE

Identifier for the Gantt model object type Constraint.

Since:

JViews 8.1

See Also:

Constant Field Values

RESERVATION_OBJECT_TYPE

public static final String RESERVATION_OBJECT_TYPE

Identifier for the Gantt model object type Reservation.

Since:

JViews 8.1

See Also:

Constant Field Values

Constructor Detail

IlvGanttSelectionSupport

public IlvGanttSelectionSupport(IlvGanttServletSupport support)

Creates an IlvGanttSelectionSupport instance.

Parameters:

support - The image servlet support.

Method Detail

getSupport

public IlvGanttServletSupport getSupport()

Returns the IlvGanttServletSupport instance attached to this support.

Returns:

The image servlet support.

getDelegate

public IlvGanttComponentSelectionSupport getDelegate(jakarta.servlet.http.HttpServletRequest request)

Returns the selection support suitable for a type of component.

Parameters:

request - The HTTP request.

Returns:

The selection support corresponding to the comp request parameter.

createGanttSheetSelectionSupport

protected IlvGanttSheetSelectionSupport createGanttSheetSelectionSupport()

Creates the selection support for the Gantt sheet component.

createGanttTableSelectionSupport

protected IlvGanttTableSelectionSupport createGanttTableSelectionSupport()

Creates the selection support for the Gantt table component.

installListeners

public void installListeners()

Installs the server action listeners to properly handle selection actions.

Specified by:

installListeners in class IlvSelectionSupport

removeListeners

public void removeListeners()

Removes the server action previously installed with installListeners.

Specified by:

removeListeners in class IlvSelectionSupport

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

handleRequest

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

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

createImageModeAction

protected IlvServerAction createImageModeAction()

Creates the server action that handles changing the representation mode for the selection.

Internal: do not use!

createSelectObjectAction

protected IlvServerAction createSelectObjectAction()

Creates the server action that handles selecting objects.

Internal: do not use!

createMoveSelectionAction

protected IlvServerAction createMoveSelectionAction()

Creates the server action that handles moving the selected objects.

Internal: do not use!

createResizeActivityAction

protected IlvServerAction createResizeActivityAction()

Creates the server action that handles resizing the selected activities.

Internal: do not use!

getIdentifierFactory

public IlvGanttSelectionSupport.IdentifierFactory getIdentifierFactory()

Returns the factory of identifiers for Gantt model objects.

Returns:

The factory of identifiers for Gantt model objects.

setIdentifierFactory

public void setIdentifierFactory(IlvGanttSelectionSupport.IdentifierFactory factory)

Sets the factory of identifier for Gantt model objects. Note that setting an identifier factory must be done before the first usage of the factory -- otherwise it is not taken into account. The best place to set it would be in IlvGanttServletSupport.createSelectionSupport().

Parameters:

factory - The factory to be set.

getIdentifier

public String getIdentifier(Object object)

Returns the identifier associated to a Gantt model object.

Parameters:

object - A Gantt model object.

Returns:

The identifier associated to a Gantt model object.

getObject

protected Object getObject(IlvGanttModel model,
                           String id)

Returns the Gantt model object corresponding to an identifier, provided that the object identifier was previously cached using cacheObjectId.

Parameters:

model - The model that contains the object to be returned.

id - The identifier of the object to be returned.

cacheObjectId

protected void cacheObjectId(IlvGanttModel model,
                             Object object,
                             String id)

Caches the association of an identifier to a Gantt model object.

Parameters:

model - The Gantt model containing the object.

object - The object.

id - The identifier of the object.

getObject

protected Object getObject(IlvGanttModel model,
                           String id,
                           String type)

Returns the Gantt model object corresponding to an identifier and a type. The object is first looked up in the cache then into the complete Gantt model.

Parameters:

model - The model that contains the object to be returned.

id - The identifier of the object to be returned.

type - The type of object. One of:

• ACTIVITY_OBJECT_TYPE
• RESOURCE_OBJECT_TYPE
• CONSTRAINT_OBJECT_TYPE
• RESERVATION_OBJECT_TYPE

Returns:

The corresponding Gantt model object or null if none is found for the given type and identifier.

Since:

JViews 8.1

See Also:

cacheObjectId(IlvGanttModel, Object, String)