ilog.views.chart.faces.component

Class IlvChartView

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

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, 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:

IlvChartDHTMLViewComponent

public class IlvChartView
extends IlvBasicView
implements IlvChartConstants

This class is the base chart view component class.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

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.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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getClientState()
static String	getComponentType() Returns the type of this component.
IlvFacesDataSource	getDataSource() Returns the data source to be displayed by the chart linked to this chart view.
String	getDataSourceId() Returns the ID of the data source displayed by this chart.
IlvObjectSelectedFinder	getDefaultObjectFinder() Returns the default finder of this view.
String	getFamily() Returns the identifier of the component family to which this component belongs.
IlvFacesInteractor	getInteractor() Returns the interactor instance set to this view.
String	getInteractorId() Returns the ID of the data source to be displayed by the chart of this chart view component.
String	getProject() Returns a chart designer project URL.
String	getType() Returns the type of the chart.
double	getXZoomFactor() Returns the factor used when calling the JavaScript zoomIn and zoomOut methods.
double	getYZoomFactor() Returns the factor used when calling the JavaScript zoomIn and zoomOut methods.
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	setClientState(String state)
void	setDataSource(IlvFacesDataSource dataSource) Sets the data source to be displayed by the chart linked to this chart view.
void	setDataSourceId(String dataSourceId) Sets the ID of the data source displayed by this chart.
void	setInteractor(IlvFacesInteractor interactor) Sets the interactor instance of this chart view.
void	setInteractorId(String id) Sets the id of the data source to be displayed by the chart of this chart view component.
void	setProject(String project) The URL to a chart designer project.
void	setType(String type) Sets the type of the chart.
void	setXZoomFactor(double xZoomFactor) Changes the factor used when calling the JavaScript zoomIn and zoomOut methods.
void	setYZoomFactor(double yZoomFactor) Changes the factor used when calling the JavaScript zoomIn and zoomOut methods.
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.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, setValue, 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

Constructor Detail

IlvChartView

public IlvChartView()

Creates a new IlvChartView 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 IlvBasicView

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.

setInteractorId

public void setInteractorId(String id)

Sets the id of the data source to be displayed by the chart of this chart view component.

Parameters:

id - The id of the data source.

getInteractorId

public String getInteractorId()

Returns the ID of the data source to be displayed by the chart of this chart view component.

Returns:

The ID of the data source.

setInteractor

public void setInteractor(IlvFacesInteractor interactor)

Sets the interactor instance of this chart view.

Parameters:

interactor - The interactor to set to this view.

Since:

JViews 7.5

getInteractor

public IlvFacesInteractor getInteractor()

Returns the interactor instance set to this view. This method can return null if this property is not yet resolved or if there is no interactor set on this view.

Returns:

The interactor set on this view or null if no interactor is set or if this property is not yet resolved.

Since:

JViews 7.5

setDataSource

public void setDataSource(IlvFacesDataSource dataSource)

Sets the data source to be displayed by the chart linked to this chart view.

Parameters:

dataSource - The data source to be displayed by the chart linked to this chart view.

getDataSource

public IlvFacesDataSource getDataSource()

Returns the data source to be displayed by the chart linked to this chart view. This method could return null if the property is not set or if this property is not yet resolved.

Returns:

The data source to be displayed by the chart linked to this chart view or null if not defined.

setType

public void setType(String type)

Sets the type of the chart. Valid types are "Cartesian", "polar", "radar" or "pie".

Parameters:

type - The type of the chart.

getType

public String getType()

Returns the type of the chart.

Returns:

The type of the chart. Either "Cartesian", "polar", "radar" or "pie".

getXZoomFactor

public double getXZoomFactor()

Returns the factor used when calling the JavaScript zoomIn and zoomOut methods.

Returns:

The x zoom factor.

getYZoomFactor

public double getYZoomFactor()

Returns the factor used when calling the JavaScript zoomIn and zoomOut methods.

Returns:

The y zoom factor.

setXZoomFactor

public void setXZoomFactor(double xZoomFactor)

Changes the factor used when calling the JavaScript zoomIn and zoomOut methods. The default value is 2.

Parameters:

xZoomFactor - The x zoom factor.

setYZoomFactor

public void setYZoomFactor(double yZoomFactor)

Changes the factor used when calling the JavaScript zoomIn and zoomOut methods. The default value is 2.

Parameters:

yZoomFactor - The y zoom factor.

getDataSourceId

public String getDataSourceId()

Returns the ID of the data source displayed by this chart.

Returns:

The ID of the data source displayed by this chart.

setDataSourceId

public void setDataSourceId(String dataSourceId)

Sets the ID of the data source displayed by this chart.

Parameters:

dataSourceId - The ID of the data source

getClientState

public String getClientState()

Internal: do not use!

setClientState

public void setClientState(String state)

Internal: do not use!

getProject

public String getProject()

Returns a chart designer project URL.

Returns:

The project.

Since:

JViews 6.5

setProject

public void setProject(String project)

The URL to a chart designer project.

Parameters:

project - The project to set.

Since:

JViews 6.5

getDefaultObjectFinder

public IlvObjectSelectedFinder getDefaultObjectFinder()

Returns the default finder of this view.

Overrides:

getDefaultObjectFinder in class IlvBasicView

Returns:

The default finder if any, null otherwise.

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.

Overrides:

updateModel in class IlvBasicView

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 jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvBasicView

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 jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvBasicView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.