ilog.views.gantt.faces.dhtml.servlet

Class IlvFacesGanttServletSupport

java.lang.Object

ilog.views.util.servlet.IlvServletSupport

ilog.views.gantt.servlet.IlvGanttServletSupport

ilog.views.gantt.faces.dhtml.servlet.IlvFacesGanttServletSupport

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, IlvFacesDHTMLGanttConstants, IlvFacesGanttConstants

public class IlvFacesGanttServletSupport
extends IlvGanttServletSupport
implements IlvFacesDHTMLGanttConstants

This IlvFacesGanttServletSupport is the implementation of IlvGanttServletSupport for the JViews Gantt Faces package.

Since:

JViews 6.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_DATASOURCE The request parameter name of a data source ID.
static String	PARAM_PROJECT The request parameter name of a Gantt Designer project URL.
static String	PARAM_STYLESHEETS The request parameter name of a style sheet URL.

Fields inherited from class ilog.views.gantt.servlet.IlvGanttServletSupport

ACTION_PARAM, CAP_FORMAT_PARAM, CAPABILITIES_REQUEST, CHART_COMPONENT, COMPONENT_PARAM, END_TIME_PARAM, HEIGHT, HITMAP_REQUEST, HORZ_POSITION_PARAM, HTML_CAP_FORMAT, IMAGE_FORMAT_PARAM, IMAGE_REQUEST, JPEG_IMAGE_FORMAT, JSON_CAP_FORMAT, OCTET_CAP_FORMAT, PNG_IMAGE_FORMAT, REQUEST_PARAM, SHEET_COMPONENT, START_TIME_PARAM, TABLE_COMPONENT, VALID_CAP_FORMATS, VALID_COMPONENTS, VERBOSE_PARAM, VERT_POSITION_PARAM, WIDTH

Fields inherited from interface ilog.views.gantt.faces.dhtml.IlvFacesDHTMLGanttConstants

AUTO_UPDATE_CAPABILITIES, COLUMN_RESIZE_MESSAGE, FILENAME, PARAM_COMPID, SESSION_ID_PREFIX, UPDATE_INTERVAL

Fields inherited from interface ilog.views.gantt.faces.IlvFacesGanttConstants

DATA_SOURCE, DATA_SOURCE_ID, DIVIDER_LOCATION, EDITABLE, END_VISIBLE_INTERVAL, H_SHEET_SCROLLABLE, HIERARCHY_CHART, MESSAGEBOX, MESSAGEBOX_ID, PROPERTY_ACCESSOR, REFRESH_DATA, RESIZE_ACTIVITY, RESIZE_HEADER_ACTION_NAME, ROW_EXPAND_COLLAPSE_ACTION_NAME, ROW_SELECT_ACTION_NAME, SHEET_H_SCROLL_BACKGROUND_CLICK_EXTENT, SHEET_INTERACTOR, SHEET_INTERACTOR_ID, SPLITTER_ARROWS_VISIBLE, START_VISIBLE_INTERVAL, STYLE_SHEET, STYLE_SHEETS, TABLE_INTERACTOR, TABLE_INTERACTOR_ID, V_SHEET_SCROLLABLE, ZOOM_FACTOR

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesGanttServletSupport(jakarta.servlet.ServletContext context) Creates a new IlvFacesGanttServletSupport.

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultActions() Adds the default row expand/collapse, row select and resize header default actions.
protected IlvPopupMenuServletSupport	createPopupMenuSupport() Creates a new instance of pop-up menu servlet support.
protected IlvSelectionSupport	createSelectionSupport() Creates a new instance of selection servlet support.
protected Map	getAdditionalCapabilities(IlvHierarchyChart chart, IlvServletRequestParameters params) Allows you to put additional capabilities to the capability request.
protected IlvHierarchyChart	getChart(jakarta.servlet.http.HttpServletRequest request, IlvServletRequestParameters params) Returns the chart used for the specified request.
IlvServerAction	getDefaultJSFSelectAction() Returns the default row select action.
IlvServerAction	getDefaultResizeActivityAction() Gets the default resize activity action.
IlvServerAction	getDefaultResizeHeaderAction() Returns the default resize header action.
IlvServerAction	getDefaultRowExpandCollapseAction() Returns the default row expand/collapse action.
IlvServerAction	getDefaultRowSelectAction() Returns the default row select action.
protected jakarta.faces.context.FacesContext	getFacesContext(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean forceCreation) Returns a dummy faces context to retrieve value bindings.
protected Object	getLock(jakarta.servlet.http.HttpServletRequest request) Returns a lock object to synchronize the request processing.
protected IlvMenuFactory	getMenuFactory(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Retrieves or creates the menu factory used in this pop-up menu request.
boolean	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) This method is the main entry point for handling HTTP requests.
protected void	removeDefaultActions() Removes the default server actions added by the addDefaultActions method.
protected void	setDataSource(jakarta.servlet.http.HttpServletRequest request, String dataSourceId) Sets the Gantt data model identified by the dataSourceId parameter in the session to the current hierarchy chart.
void	setDefaultJSFSelectAction(IlvServerAction defaultRowSelectAction) Sets the default row select action.
void	setDefaultResizeActivityAction(IlvServerAction defaultResizeActivityAction) Sets the default resize activity action.
void	setDefaultResizeHeaderAction(IlvServerAction defaultResizeHeaderAction) Sets the default resize header action.
void	setDefaultRowExpandCollapseAction(IlvServerAction defaultRowExpandCollapseAction) Sets the default row expand/collapse action.
void	setDefaultRowSelectAction(IlvServerAction defaultRowSelectAction) Sets the default row select action.
protected void	setProject(jakarta.servlet.http.HttpServletRequest request, String projectURL) Sets the project URL to the current hierarchy chart.
protected void	setStyleSheets(jakarta.servlet.http.HttpServletRequest request, String styleSheets) Sets the comma separated Cascading Style Sheet list to the current hierarchy chart.

Methods inherited from class ilog.views.gantt.servlet.IlvGanttServletSupport

additionalBinaryCapabilities, additionalTextCapabilities, addServerAction, generateImage, getConfigParameters, getContext, getDataInterval, getHitmapSupport, getImageEncoder, getObjectAt, getPopupMenuSupport, getSelectionSupport, getServletContext, getTimestamp, isPopupEnabled, isSelectionEnabled, isVerbose, prepareChart, removeServerAction, setConfigParameters, setImageEncoder, setPopupEnabled, setSelectionEnabled, setServletContext

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

doGetScriptMessage, getParameterValidationListener, getScriptMessageSupport, setParameterValidationListener

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_DATASOURCE

public static final String PARAM_DATASOURCE

The request parameter name of a data source ID.

See Also:

Constant Field Values

PARAM_PROJECT

public static final String PARAM_PROJECT

The request parameter name of a Gantt Designer project URL.

See Also:

Constant Field Values

PARAM_STYLESHEETS

public static final String PARAM_STYLESHEETS

The request parameter name of a style sheet URL.

See Also:

Constant Field Values

Constructor Detail

IlvFacesGanttServletSupport

public IlvFacesGanttServletSupport(jakarta.servlet.ServletContext context)

Creates a new IlvFacesGanttServletSupport.

Parameters:

context - The servlet context.

Method Detail

getFacesContext

protected jakarta.faces.context.FacesContext getFacesContext(jakarta.servlet.http.HttpServletRequest request,
                                                             jakarta.servlet.http.HttpServletResponse response,
                                                             boolean forceCreation)

Returns a dummy faces context to retrieve value bindings.

Parameters:

request - The HTTP request.

response - The HTTP response.

forceCreation - Force creation of faces context even if FacesContext.getCurrentInstance() doesn't return null.

Returns:

A faces context instance or null.

Since:

JViews 7.5

createPopupMenuSupport

protected IlvPopupMenuServletSupport createPopupMenuSupport()

Creates a new instance of pop-up menu servlet support.

Overrides:

createPopupMenuSupport in class IlvGanttServletSupport

Returns:

A new pop-up menu support.

createSelectionSupport

protected IlvSelectionSupport createSelectionSupport()

Creates a new instance of selection servlet support.

Overrides:

createSelectionSupport in class IlvGanttServletSupport

Returns:

A selection servlet support.

addDefaultActions

protected void addDefaultActions()

Adds the default row expand/collapse, row select and resize header default actions. These actions could be removed by the removeDefaultActions method. Each subclass can override this method to register its specific default server actions or can override the getters of the default row expand/collapse, row select, header resize actions.

See Also:

getDefaultRowExpandCollapseAction(), getDefaultResizeHeaderAction(), getDefaultRowSelectAction(), getDefaultJSFSelectAction()

removeDefaultActions

protected void removeDefaultActions()

Removes the default server actions added by the addDefaultActions method.

getChart

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

Returns the chart used for the specified request. You can always return the same chart, or you can return a chart for each request session if the chart contents is session-specific.

Specified by:

getChart in class IlvGanttServletSupport

Parameters:

request - The current HTTP request.

params - The parameters parsed from the request.

Throws:

jakarta.servlet.ServletException

getLock

protected Object getLock(jakarta.servlet.http.HttpServletRequest request)

Returns a lock object to synchronize the request processing. This implementation locks on the session.

Parameters:

request - The HTTP request.

Returns:

A lock object to synchronize the request processing.

getMenuFactory

protected IlvMenuFactory getMenuFactory(jakarta.servlet.http.HttpServletRequest request,
                                        jakarta.servlet.http.HttpServletResponse response)
                                 throws jakarta.servlet.ServletException

Retrieves or creates the menu factory used in this pop-up menu request.

Parameters:

request - The HTTP request.

response - The HTTP response.

Returns:

The factory used to generate pop-up menus.

Throws:

jakarta.servlet.ServletException

Since:

JViews 7.5

handleRequest

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

This method is the main entry point for handling HTTP requests.

You can override this method to provide a new request type like this:

 public boolean handleRequest(HttpServletRequest request,
                              HttpServletResponse response)
   throws IOException, ServletException
   {
     if (super.handleRequest(request, response))
       return true;
     IlvServletRequestParameters params = new IlvServletRequestParameters(request);
     String requestType = params.getString(REQUEST_PARAM, null);
     if ("somethingImportant".equals(requestType)) {
       doSomethingImportant(request, response, params);
       return true;
     }
     return false;
   }
 

Overrides:

handleRequest in class IlvGanttServletSupport

Parameters:

request - The current HTTP request.

response - The HTTP response.

Returns:

true if a recognized request was handled successfully, or false if the request type was not recognized. If a recognized request is not handled successfully, an exception will be thrown.

Throws:

IOException - if an input or output error is detected when the servlet handles the request.

jakarta.servlet.ServletException - if the request could not be handled.

setProject

protected void setProject(jakarta.servlet.http.HttpServletRequest request,
                          String projectURL)
                   throws jakarta.servlet.ServletException

Sets the project URL to the current hierarchy chart.

Parameters:

request - The request processed by this servlet.

projectURL - The URL of the project to set.

Throws:

jakarta.servlet.ServletException

setStyleSheets

protected void setStyleSheets(jakarta.servlet.http.HttpServletRequest request,
                              String styleSheets)
                       throws jakarta.servlet.ServletException

Sets the comma separated Cascading Style Sheet list to the current hierarchy chart.

Parameters:

request - The request processed by this servlet.

styleSheets - The style sheet list.

Throws:

jakarta.servlet.ServletException

setDataSource

protected void setDataSource(jakarta.servlet.http.HttpServletRequest request,
                             String dataSourceId)
                      throws jakarta.servlet.ServletException

Sets the Gantt data model identified by the dataSourceId parameter in the session to the current hierarchy chart.

Parameters:

request - The request processed by this servlet.

dataSourceId - The identifier of the Gantt data model in the session.

Throws:

jakarta.servlet.ServletException

getAdditionalCapabilities

protected Map getAdditionalCapabilities(IlvHierarchyChart chart,
                                        IlvServletRequestParameters params)
                                 throws jakarta.servlet.ServletException

Allows you to put additional capabilities to the capability request. The Map should contains pairs of propertyName and propertyValue for each additional capability.

Overrides:

getAdditionalCapabilities in class IlvGanttServletSupport

Parameters:

chart - The chart returned by getChart.

params - The parameters parsed from the current HTTP request.

Returns:

the additional properties (null if none).

Throws:

jakarta.servlet.ServletException

getDefaultResizeHeaderAction

public IlvServerAction getDefaultResizeHeaderAction()

Returns the default resize header action. This action handles the resize of columns of the table view.

This implementation returns an IlvTableHeaderResizeAction instance.

This method is called by the addDefaultAction method.

Returns:

The default resize header server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

setDefaultResizeHeaderAction

public void setDefaultResizeHeaderAction(IlvServerAction defaultResizeHeaderAction)

Sets the default resize header action. This action handles the resize of columns of the table view.

Parameters:

defaultResizeHeaderAction - The new default resize header default server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

getDefaultRowExpandCollapseAction

public IlvServerAction getDefaultRowExpandCollapseAction()

Returns the default row expand/collapse action.

This implementation returns an IlvRowExpandCollapseAction instance.

This method is called by the addDefaultAction method.

Returns:

The default row expand and collapse server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

setDefaultRowExpandCollapseAction

public void setDefaultRowExpandCollapseAction(IlvServerAction defaultRowExpandCollapseAction)

Sets the default row expand/collapse action.

Parameters:

defaultRowExpandCollapseAction - The new default row expand and collapse server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

getDefaultJSFSelectAction

public IlvServerAction getDefaultJSFSelectAction()

Returns the default row select action. This action translates a server action event into a value change event and invoke the attached value change listener.

This implementation returns an IlvFacesGanttSelectAction instance.

This method is called by the addDefaultAction method.

Returns:

The JSF select server action.

Since:

JViews 7.5

See Also:

addDefaultActions()

setDefaultJSFSelectAction

public void setDefaultJSFSelectAction(IlvServerAction defaultRowSelectAction)

Sets the default row select action. This action selects a hierarchy node.

Parameters:

defaultRowSelectAction - The default row select server action.

Since:

JViews 7.5

See Also:

addDefaultActions()

getDefaultRowSelectAction

public IlvServerAction getDefaultRowSelectAction()

Returns the default row select action. This action selects a hierarchy node.

This implementation returns an IlvRowSelectAction instance.

This method is called by the addDefaultAction method.

Returns:

The default row select server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

setDefaultRowSelectAction

public void setDefaultRowSelectAction(IlvServerAction defaultRowSelectAction)

Sets the default row select action. This action selects a hierarchy node.

Parameters:

defaultRowSelectAction - The default row select server action.

Since:

JViews 6.5

See Also:

addDefaultActions()

setDefaultResizeActivityAction

public void setDefaultResizeActivityAction(IlvServerAction defaultResizeActivityAction)

Sets the default resize activity action.

Parameters:

defaultResizeActivityAction - the default resize activity action.

Since:

JViews 8.7

getDefaultResizeActivityAction

public IlvServerAction getDefaultResizeActivityAction()

Gets the default resize activity action.

Returns:

the default resize activity action, it's an instance of IlvServerAction.

Since:

JViews 8.7