ilog.views.gantt.faces.dhtml.component

Class IlvFacesDHTMLGanttSupportImpl

java.lang.Object

ilog.views.faces.dhtml.component.IlvDHTMLHelperImpl

ilog.views.gantt.faces.dhtml.component.IlvFacesDHTMLGanttSupportImpl

All Implemented Interfaces:

IlvDHTMLHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFacesDHTMLGanttSupport, IlvFacesDHTMLGanttConstants, IlvFacesGanttConstants, Serializable

public class IlvFacesDHTMLGanttSupportImpl
extends IlvDHTMLHelperImpl
implements IlvFacesDHTMLGanttSupport, IlvFacesDHTMLGanttConstants

This class is the default implementation of the IlvFacesDHTMLGanttSupport interface.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	ACCESSIBLE_DEFAULT_VALUE Default value of the accessible property.
static Boolean	AUTO_UPDATE_CAPABILITIES_DEFAULT_VALUE Default value of autoUpdateCapabilities property.
static Boolean	RESIZABLE_DEFAULT_VALUE Default value of the resizable property.
static Integer	UPDATE_INTERVAL_DEFAULT_VALUE Default value of updateInterval property.

Fields inherited from class ilog.views.faces.dhtml.component.IlvDHTMLHelperImpl

helped

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_COMPID, 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

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

Constructor Summary

Constructors

Constructor and Description
IlvFacesDHTMLGanttSupportImpl(IlvBasicView helped) Creates a new IlvFacesDHTMLGanttSupportImpl 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.
IlvHierarchyChart	getChart(IlvHierarchyChart superChart) Gets an instance of the hierarchy chart that will be wrapped.
String	getColumnResizeMessage() Returns the message displayed by the view message box during the resizing of a column.
String	getErrorMessage() Returns the error message displayed by the view when an error occurred during image loading.
String	getHotkeys() Returns the hotkeys for this view.
int	getUpdateInterval() Returns the automatic update interval (in seconds) of the Gantt.
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(FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(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	setResizable(boolean resizable) Sets whether the view is resizable.
void	setUpdateInterval(int updateInterval) Sets the automatic update interval (in seconds) of the Gantt.
void	updateModel(FacesContext context) 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.faces.dhtml.component.IlvDHTMLHelperImpl

getHelped, getImageFormat, getServlet, getServletClass, getServletURL, getWaitingImage, setHelped, setImageFormat, setServlet, setServletClass, setServletURL, setValue, setWaitingImage

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.faces.dhtml.component.IlvDHTMLHelper

getImageFormat, getServlet, getServletClass, getServletURL, getWaitingImage, setImageFormat, setServlet, setServletClass, setServletURL, setValue, setWaitingImage

Field Detail

UPDATE_INTERVAL_DEFAULT_VALUE

public static final Integer UPDATE_INTERVAL_DEFAULT_VALUE

Default value of updateInterval property.

AUTO_UPDATE_CAPABILITIES_DEFAULT_VALUE

public static final Boolean AUTO_UPDATE_CAPABILITIES_DEFAULT_VALUE

Default value of autoUpdateCapabilities property.

RESIZABLE_DEFAULT_VALUE

public static final Boolean RESIZABLE_DEFAULT_VALUE

Default value of the resizable property.

ACCESSIBLE_DEFAULT_VALUE

public static final Boolean ACCESSIBLE_DEFAULT_VALUE

Default value of the accessible property.

Since:

JViews 8.8

Constructor Detail

IlvFacesDHTMLGanttSupportImpl

public IlvFacesDHTMLGanttSupportImpl(IlvBasicView helped)

Creates a new IlvFacesDHTMLGanttSupportImpl instance.

Parameters:

helped - The component class that is helped by this class.

Method Detail

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.

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.

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.

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.

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.

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.

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.

Returns:

The hotkeys.

Since:

JViews 8.8

setHotkeys

public void setHotkeys(String hotkeys)

Sets the hotkeys for this view.

Parameters:

hotkeys - The hotkeys to set.

Since:

JViews 8.8

getChart

public IlvHierarchyChart getChart(IlvHierarchyChart superChart)

Gets an instance of the hierarchy chart that will be wrapped. The algorithm does the following:

• Looks for the local HIERARCHY_CHART property.
• Looks for a value binding on the HIERARCHY_CHART property.
• Checks if the chart is not already in the session.
• Creates a new instance through the IlvFacesHierarchyChartView.createHierarchyChart()

Parameters:

superChart - The super.getChart() call of the helped class.

Returns:

The hierarchy chart to be displayed by the view.

getChart

public IlvHierarchyChart getChart()

Returns the wrapped instance of IlvHierarchyChart.

Specified by:

getChart in interface IlvFacesDHTMLGanttSupport

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(FacesContext context)

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 IlvDHTMLHelperImpl

Parameters:

context - The current faces context.

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvDHTMLHelper

Overrides:

saveState in class IlvDHTMLHelperImpl

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object stateObj)

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvDHTMLHelper

Overrides:

restoreState in class IlvDHTMLHelperImpl

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.