ilog.views.chart.faces.dhtml.component

Class IlvChartDHTMLViewComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.chart.faces.component.IlvChartView

ilog.views.chart.faces.dhtml.component.IlvChartDHTMLViewComponent

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, IlvDHTMLHelper, IlvDHTMLConstants, IlvFacesConstants, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

Direct Known Subclasses:

IlvChartDHTMLLegend, IlvChartDHTMLView

public abstract class IlvChartDHTMLViewComponent
extends IlvChartView
implements IlvDHTMLHelper

This class defines a base class for DHTML component that displays a chart or a part of a chart.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	ACCESSIBLE_DEFAULT_VALUE Default value of accessible property
static Boolean	RESIZABLE_DEFAULT_VALUE Default value of resizable property

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.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.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

Constructor Summary

Constructors

Constructor and Description
IlvChartDHTMLViewComponent() Creates a new IlvChartDHTMLViewComponent instance.

Method Summary

Modifier and Type	Method and Description
protected IlvDHTMLHelper	createDHTMLHelper() Creates the default IlvDHTMLViewHelper implementation which is a IlvDHTMLHelperImpl.
Color	getBackgroundColor() Returns the background color of the generated image.
String	getErrorMessage() Returns the error message displayed when an error occurs during the loading of the image.
String	getHotkeys() Returns the hotkeys for this view.
String	getImageFormat() Returns the desired format of the image generated by the servlet.
IlvFacesChartImageMapGenerator	getImageMapGenerator() Returns the image map generator.
String	getImageMapGeneratorClass() Returns the class name of the image map generator.
String	getOnCapabilitiesLoaded() Returns the custom onCapababilitiesLoaded JavaScript handler.
String	getOnImageLoaded() Returns the custom onImageLoaded JavaScript handler.
String	getServlet() Returns the servlet that will generate the image displayed by the view.
String	getServletClass()
String	getServletURL()
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	isGenerateImageMap() Returns the image map of this chart view that should be generated.
boolean	isImageMapVisible() Returns true if the image map, once generated, should be visible.
boolean	isResizable() Returns whether the view is resizable or not.
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	setBackgroundColor(Color background) Sets the background color of the generated image.
void	setErrorMessage(String errorMessage) Sets the error message displayed when an error occurs during the loading of the image.
void	setGenerateImageMap(boolean imap) Sets whether the image map of this chart view should be generated.
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	setImageMapGenerator(IlvFacesChartImageMapGenerator imageMapGenerator) Returns the image map generator.
void	setImageMapGeneratorClass(String imageMapGeneratorClass) Sets the class name of the image map generator.
void	setImageMapVisible(boolean visible) Sets whether the image map should be visible, if generated.
void	setOnCapabilitiesLoaded(String onCapabilitiesLoaded) Sets the custom onCapababilitiesLoaded JavaScript handler.
void	setOnImageLoaded(String onImageLoaded) Sets the custom onImageLoaded JavaScript handler.
void	setResizable(boolean resizable) Sets whether the view is resizable or not.
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	setValue(Object value) Sets the servlet that will generate the image displayed by the view.
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.chart.faces.component.IlvChartView

getClientState, getComponentType, getDataSource, getDataSourceId, getDefaultObjectFinder, getFamily, getInteractor, getInteractorId, getProject, getType, getXZoomFactor, getYZoomFactor, setClientState, setDataSource, setDataSourceId, setInteractor, setInteractorId, setProject, setType, setXZoomFactor, setYZoomFactor

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

Field Detail

RESIZABLE_DEFAULT_VALUE

public static final Boolean RESIZABLE_DEFAULT_VALUE

Default value of resizable property

Since:

JViews 6.5

ACCESSIBLE_DEFAULT_VALUE

public static final Boolean ACCESSIBLE_DEFAULT_VALUE

Default value of accessible property

Since:

JViews 8.8

Constructor Detail

IlvChartDHTMLViewComponent

public IlvChartDHTMLViewComponent()

Creates a new IlvChartDHTMLViewComponent instance.

Method Detail

createDHTMLHelper

protected IlvDHTMLHelper createDHTMLHelper()

Creates the default IlvDHTMLViewHelper implementation which is a IlvDHTMLHelperImpl.

Returns:

The default IlvDHTMLViewHelper implementation.

setGenerateImageMap

public void setGenerateImageMap(boolean imap)

Sets whether the image map of this chart view should be generated. The image map must be defined in the image generating servlet.

Parameters:

imap - The image map generation flag.

isGenerateImageMap

public boolean isGenerateImageMap()

Returns the image map of this chart view that should be generated.

Returns:

The image map generation flag.

setBackgroundColor

public void setBackgroundColor(Color background)

Sets the background color of the generated image. The HTML format must be used (#RRGGBB)

Parameters:

background - The background color of the generated image.

getBackgroundColor

public Color getBackgroundColor()

Returns the background color of the generated image.

Returns:

The background color of the generated image.

isImageMapVisible

public boolean isImageMapVisible()

Returns true if the image map, once generated, should be visible.

Returns:

The image map visibility flag.

setImageMapVisible

public void setImageMapVisible(boolean visible)

Sets whether the image map should be visible, if generated.

Parameters:

visible - The image map visibility flag.

getImageMapGenerator

public IlvFacesChartImageMapGenerator getImageMapGenerator()

Returns the image map generator.

If the generateImageMap property is true, this generator will be invoked to dynamically create the image map.

Returns:

The image map generator.

Since:

JViews 7.5

setImageMapGenerator

public void setImageMapGenerator(IlvFacesChartImageMapGenerator imageMapGenerator)

Returns the image map generator.

If the generateImageMap property is true, this generator will be invoked to dynamically create the image map.

Parameters:

imageMapGenerator - The image map generator instance.

Since:

JViews 7.5

getImageMapGeneratorClass

public String getImageMapGeneratorClass()

Returns the class name of the image map generator.

If the generateImageMap property is true, and the imageMapgenerator property is not set, an instance of this generator will be created and this generator will be invoked to dynamically create the image map.

Returns:

The image map generator class name.

Since:

JViews 7.5

setImageMapGeneratorClass

public void setImageMapGeneratorClass(String imageMapGeneratorClass)

Sets the class name of the image map generator.

If the generateImageMap property is true, and the imageMapgenerator property is not set, an instance of this generator will be created and this generator will be invoked to dynamically create the image map.

Parameters:

imageMapGeneratorClass - The image map generator class name.

Since:

JViews 7.5

getOnCapabilitiesLoaded

public String getOnCapabilitiesLoaded()

Returns the custom onCapababilitiesLoaded JavaScript handler. This handler is called when the chart has loaded its capabilities, that is, the information on data and visible ranges.

Returns:

The custom onCapababilitiesLoaded JavaScript handler.

getOnImageLoaded

public String getOnImageLoaded()

Returns the custom onImageLoaded JavaScript handler. This handler is called when the image displayed by the chart is loaded.

Returns:

The custom onImageLoaded JavaScript handler.

setOnCapabilitiesLoaded

public void setOnCapabilitiesLoaded(String onCapabilitiesLoaded)

Sets the custom onCapababilitiesLoaded JavaScript handler. This handler is called when the chart has loaded its capabilities, that is, the information on data and visible ranges.

Parameters:

onCapabilitiesLoaded - The custom onCapababilitiesLoaded JavaScript handler.

setOnImageLoaded

public void setOnImageLoaded(String onImageLoaded)

Sets the custom onImageLoaded JavaScript handler. This handler is called when the image displayed by the chart is loaded.

Parameters:

onImageLoaded - The custom onImageLoaded JavaScript handler.

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.

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.

getServletClass

public String getServletClass()

Specified by:

getServletClass in interface IlvDHTMLHelper

getServletURL

public String getServletURL()

Specified by:

getServletURL in interface IlvDHTMLHelper

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.

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.

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.

setServletClass

public void setServletClass(String servletClass)

Specified by:

setServletClass in interface IlvDHTMLHelper

setServletURL

public void setServletURL(String servletURL)

Specified by:

setServletURL in interface IlvDHTMLHelper

setValue

public void setValue(Object value)

Sets the servlet that will generate the image displayed by the view. 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:

setValue in interface IlvDHTMLHelper

Overrides:

setValue in class jakarta.faces.component.UIGraphic

Parameters:

value - The image generating servlet.

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.

getErrorMessage

public String getErrorMessage()

Returns the error message displayed when an error occurs during the loading of the image.

Returns:

The error message displayed when an error occurs during the loading of the image.

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the error message displayed when an error occurs during the loading of the image.

Parameters:

errorMessage - The error message displayed when an error occurs during the loading of the image.

isResizable

public boolean isResizable()

Returns whether the view is resizable or not.

Returns:

The resizable state.

Since:

JViews 6.5

setResizable

public void setResizable(boolean resizable)

Sets whether the view is resizable or not.

Parameters:

resizable - The resizable state to set.

Since:

JViews 6.5

isAccessible

public boolean isAccessible()

Returns whether the view is accessible or not.

Returns:

The accessible state.

Since:

JViews 8.8

setAccessible

public void setAccessible(boolean accessible)

Sets whether the view is accessible or not.

Parameters:

accessible - The accessible state to set.

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

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 IlvChartView

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 IlvChartView

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 IlvChartView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.