ilog.views.gantt.faces.dhtml.component

Class IlvFacesDHTMLGanttChartView

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.gantt.faces.component.IlvFacesHierarchyChartView

ilog.views.gantt.faces.component.IlvFacesGanttChartView

ilog.views.gantt.faces.dhtml.component.IlvFacesDHTMLGanttChartView

All Implemented Interfaces:

IlvFacesComponent, IlvDHTMLHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFacesDHTMLGanttSupport, IlvFacesDHTMLGanttConstants, IlvFacesGanttConstants, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

public class IlvFacesDHTMLGanttChartView
extends IlvFacesGanttChartView
implements IlvFacesDHTMLGanttConstants, IlvFacesDHTMLGanttSupport

This class defines the JViews Faces Gantt Chart component that has the properties needed for a DHTML rendering.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.gantt.faces.component.IlvFacesHierarchyChartView

DIVIDER_LOCATION_DEFAULT_VALUE, SHEET_H_SCROLL_BACKGROUND_CLICK_EXTENT_DEFAULT_VALUE, ZOOM_FACTOR_DEFAULT_VALUE

Fields inherited from class ilog.views.faces.component.IlvBasicView

DEFAULT_OBJECT_FINDER

Fields inherited from class jakarta.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

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
IlvFacesDHTMLGanttChartView() Creates a new IlvFacesDHTMLGanttChartView instance.

Method Summary

Modifier and Type	Method and Description
String	getBeforeSessionExpirationHandler() Returns the JavaScript code that will be called when the session is about to expire.
IlvHierarchyChart	getChart() Returns the wrapped instance of IlvHierarchyChart.
String	getColumnResizeMessage() Returns the message displayed by the view message box during the resizing of a column.
static String	getComponentType() Returns the type of this component.
String	getControllerURL() Returns the URL of the controller servlet.
String	getErrorMessage() Returns the error message displayed by the view when an error occurred during image loading.
String	getFamily() Returns the identifier of the component family to which this component belongs.
String	getHotkeys() Returns the hotkeys for this view.
String	getImageFormat() Returns the desired format of the image generated by the servlet.
String	getServlet() Returns the servlet that will generate the image displayed by the view.
String	getServletClass()
String	getServletURL()
int	getUpdateInterval() Returns the automatic update interval (in seconds) of the Gantt.
String	getWaitingImage() Returns the path to the image displayed when the view loads the image.
boolean	isAccessible() Returns whether the view is accessible or not.
boolean	isAutoUpdateCapabilities() Returns whether the automatic update will also update the capabilities.
boolean	isResizable() Returns whether the view is resizable.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the stateObj parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setAccessible(boolean accessible) Sets whether the view is accessible or not.
void	setAutoUpdateCapabilities(boolean autoUpdateCapabilities) Sets whether the automatic update will also update the capabilities.
void	setBeforeSessionExpirationHandler(String handler) Sets the JavaScript code that will be called when the session is about to expire.
void	setColumnResizeMessage(String columnResizeMessage) Sets the message displayed by the view message box during the resizing of a column.
void	setErrorMessage(String errorMessage) Sets the error message displayed by the view when an error occurred during image loading.
void	setHotkeys(String hotkeys) Sets the hotkeys for this view.
void	setImageFormat(String imageFormat) Sets the desired format of the image generated by the servlet.
void	setResizable(boolean resizable) Sets whether the view is resizable.
void	setServlet(String servlet) Sets the servlet that will generate the image displayed by the view.
void	setServletClass(String servletClass)
void	setServletURL(String servletURL)
void	setUpdateInterval(int updateInterval) Sets the automatic update interval (in seconds) of the Gantt.
void	setValue(Object value) Sets the value of this component.
void	setWaitingImage(String waitingImage) Sets the path of the image displayed when the view loads the image.
void	updateModel(jakarta.faces.context.FacesContext ctx) This method updates the referenced values with the local values of the component if these values were updated from the client.

Methods inherited from class ilog.views.gantt.faces.component.IlvFacesGanttChartView

createHierarchyChart

Methods inherited from class ilog.views.gantt.faces.component.IlvFacesHierarchyChartView

getConverter, getDataSource, getDataSourceId, getDefaultObjectFinder, getDividerLocation, getEndVisibleInterval, getLocalValue, getProject, getSheetHScrollBackgroundClickExtent, getSheetInteractor, getSheetInteractorId, getSplitterArrowsVisible, getStartVisibleInterval, getStyleSheet, getStyleSheets, getTableInteractor, getTableInteractorId, getZoomFactor, isEditable, isSheetHScrollable, isSheetVScrollable, setChart, setConverter, setDataSource, setDataSourceId, setDividerLocation, setEditable, setEndVisibleInterval, setProject, setSheetHScrollable, setSheetHScrollBackgroundClickExtent, setSheetInteractor, setSheetInteractorId, setSheetVScrollable, setSplitterArrowsVisible, setStartVisibleInterval, setStyleSheet, setStyleSheets, setTableInteractor, setTableInteractorId, setZoomFactor

Methods inherited from class ilog.views.faces.component.IlvBasicView

clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class jakarta.faces.component.UIGraphic

getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValueBinding, setValueExpression

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.faces.component.ValueHolder

getValue

Constructor Detail

IlvFacesDHTMLGanttChartView

public IlvFacesDHTMLGanttChartView()

Creates a new IlvFacesDHTMLGanttChartView instance.

Method Detail

getFamily

public String getFamily()

Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

This implementation returns the fully qualified class name.

Overrides:

getFamily in class IlvFacesGanttChartView

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getControllerURL

public String getControllerURL()
                        throws Exception

Returns the URL of the controller servlet.

Returns:

The URL of the controller servlet.

Throws:

IllegalStateException - If the type of the request is not handled.

Exception

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the error message displayed by the view when an error occurred during image loading.

Specified by:

setErrorMessage in interface IlvFacesDHTMLGanttSupport

Parameters:

errorMessage - The error message to set.

getErrorMessage

public String getErrorMessage()

Returns the error message displayed by the view when an error occurred during image loading.

Specified by:

getErrorMessage in interface IlvFacesDHTMLGanttSupport

Returns:

The error message.

setImageFormat

public void setImageFormat(String imageFormat)

Sets the desired format of the image generated by the servlet. Valid values are "JPEG" and "PNG"'.

Specified by:

setImageFormat in interface IlvDHTMLHelper

Parameters:

imageFormat - The desired image format of the image displayed by the view.

getImageFormat

public String getImageFormat()

Returns the desired format of the image generated by the servlet.

Specified by:

getImageFormat in interface IlvDHTMLHelper

Returns:

The desired format of the image generated by the servlet.

setServlet

public void setServlet(String servlet)

Sets the servlet that will generate the image displayed by the view. This method is an alias for setValue. The servlet parameter could be a URL to the servlet or a fully qualified servlet class that will be instantiated to generate the image.

Specified by:

setServlet in interface IlvDHTMLHelper

Parameters:

servlet - The image generating servlet.

getServlet

public String getServlet()

Returns the servlet that will generate the image displayed by the view. The returned value could be a URL or a fully qualified class.

Specified by:

getServlet in interface IlvDHTMLHelper

Returns:

The image generating servlet.

setServletClass

public void setServletClass(String servletClass)

Specified by:

setServletClass in interface IlvDHTMLHelper

getServletClass

public String getServletClass()

Specified by:

getServletClass in interface IlvDHTMLHelper

setServletURL

public void setServletURL(String servletURL)

Specified by:

setServletURL in interface IlvDHTMLHelper

getServletURL

public String getServletURL()

Specified by:

getServletURL in interface IlvDHTMLHelper

setUpdateInterval

public void setUpdateInterval(int updateInterval)

Sets the automatic update interval (in seconds) of the Gantt. An interval of zero means no automatic update.

Specified by:

setUpdateInterval in interface IlvFacesDHTMLGanttSupport

Parameters:

updateInterval - The update interval to set.

getUpdateInterval

public int getUpdateInterval()

Returns the automatic update interval (in seconds) of the Gantt. An interval of zero means no automatic update.

Specified by:

getUpdateInterval in interface IlvFacesDHTMLGanttSupport

Returns:

The update interval.

setWaitingImage

public void setWaitingImage(String waitingImage)

Sets the path of the image displayed when the view loads the image.

Specified by:

setWaitingImage in interface IlvDHTMLHelper

Parameters:

waitingImage - The path of the image displayed when the view loads the image.

getWaitingImage

public String getWaitingImage()

Returns the path to the image displayed when the view loads the image.

Specified by:

getWaitingImage in interface IlvDHTMLHelper

Returns:

The path to the image displayed when the view loads the image.

setAutoUpdateCapabilities

public void setAutoUpdateCapabilities(boolean autoUpdateCapabilities)

Sets whether the automatic update will also update the capabilities.

Specified by:

setAutoUpdateCapabilities in interface IlvFacesDHTMLGanttSupport

Parameters:

autoUpdateCapabilities - The automatic update capabilities to set.

isAutoUpdateCapabilities

public boolean isAutoUpdateCapabilities()

Returns whether the automatic update will also update the capabilities.

Specified by:

isAutoUpdateCapabilities in interface IlvFacesDHTMLGanttSupport

Returns:

The automatic update capabilities.

getColumnResizeMessage

public String getColumnResizeMessage()

Returns the message displayed by the view message box during the resizing of a column.

Specified by:

getColumnResizeMessage in interface IlvFacesDHTMLGanttSupport

Returns:

The message.

setColumnResizeMessage

public void setColumnResizeMessage(String columnResizeMessage)

Sets the message displayed by the view message box during the resizing of a column.

Specified by:

setColumnResizeMessage in interface IlvFacesDHTMLGanttSupport

Parameters:

columnResizeMessage - The message to set.

isResizable

public boolean isResizable()

Returns whether the view is resizable.

Specified by:

isResizable in interface IlvFacesDHTMLGanttSupport

Returns:

The resizable flag.

setResizable

public void setResizable(boolean resizable)

Sets whether the view is resizable.

Specified by:

setResizable in interface IlvFacesDHTMLGanttSupport

Parameters:

resizable - The resizable to set.

isAccessible

public boolean isAccessible()

Returns whether the view is accessible or not.

Since:

JViews 8.8

setAccessible

public void setAccessible(boolean accessible)

Sets whether the view is accessible or not.

Since:

JViews 8.8

getHotkeys

public String getHotkeys()

Returns the hotkeys for this view.

Since:

JViews 8.8

setHotkeys

public void setHotkeys(String hotkeys)

Sets the hotkeys for this view.

Since:

JViews 8.8

setValue

public void setValue(Object value)

Sets the value of this component.

Specified by:

setValue in interface IlvDHTMLHelper

Specified by:

setValue in interface jakarta.faces.component.ValueHolder

Overrides:

setValue in class jakarta.faces.component.UIGraphic

Parameters:

value - The new value.

getChart

public IlvHierarchyChart getChart()

Returns the wrapped instance of IlvHierarchyChart.

Specified by:

getChart in interface IlvFacesDHTMLGanttSupport

Overrides:

getChart in class IlvFacesHierarchyChartView

Returns:

The chart.

getBeforeSessionExpirationHandler

public String getBeforeSessionExpirationHandler()

Returns the JavaScript code that will be called when the session is about to expire.

Specified by:

getBeforeSessionExpirationHandler in interface IlvFacesDHTMLGanttSupport

Returns:

The JavasScript code to execute when the session is about to expire.

Since:

JViews 8.1

setBeforeSessionExpirationHandler

public void setBeforeSessionExpirationHandler(String handler)

Sets the JavaScript code that will be called when the session is about to expire.

This code can use the view implicit variable that represents the JavaScript proxy of this component.

Specified by:

setBeforeSessionExpirationHandler in interface IlvFacesDHTMLGanttSupport

Parameters:

handler - The JavasScript code.

Since:

JViews 8.1

updateModel

public void updateModel(jakarta.faces.context.FacesContext ctx)

This method updates the referenced values with the local values of the component if these values were updated from the client.

Specified by:

updateModel in interface IlvDHTMLHelper

Overrides:

updateModel in class IlvFacesHierarchyChartView

Parameters:

ctx - The current faces context.

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface IlvDHTMLHelper

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvFacesHierarchyChartView

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Restores the state of this component from the stateObj parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface IlvDHTMLHelper

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesHierarchyChartView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.