ilog.views.chart.faces.dhtml.interactor

Class IlvChartSelectInteractor

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor

ilog.views.chart.faces.dhtml.interactor.IlvChartSelectInteractor

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, IlvViewHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, jakarta.faces.component.EditableValueHolder, 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 IlvChartSelectInteractor
extends IlvObjectSelectInteractor
implements IlvChartConstants

This class defines an interactor that contains the ilog.views.chart.data.IlvDataSetPoint selected by the user in its value property. It uses an IlvChartObjectSelectedFinder instance to retrieve the picked point.
The value change listener registered on this component can be called during the JSF lifecycle depending on the invocationContext value:

• In JSF_CONTEXT the interactor will submit the page and the action will be processed during the JSF lifecycle.
• In the IMAGE_SERVLET_CONTEXT the interactor will only query a new image from the server and the action is processed out of the JSF lifecycle. The IMAGE_SERVLET_CONTEXT implies some limitations and is designed to enable interaction only on the underlying graphic component (the component that generates the image).
  • Only the view component will be refreshed, so interactions on JSF components would not be effective.
  • The source of the value change event is an IlvChartFakeSelectInteractor designed to provide access to a fake JSF View component.
  • The JSF returned by the getView() method of the source component is an instance of IlvChartFakeDHTMLView. This component only accepts a call on its getChart() method.
  • valueChangeEvent.getOldValue() returns null
  • Any access to unauthorized API will result on a NotInJSFLifecycleException.

In both modes:

• To determine in the value change listener the invocation context, use the following code:

  IlvChartSelectInteractor source = (IlvChartSelectInteractor)valueChangeEvent.getSource();
  boolean inJSFLifecycle = source.getInvocationContext() == IlvDHTMLConstants.JSF_CONTEXT; 
  

• To access to the underlying graphic component, use the following code:

 IlvChart chart = ((IlvChartView)source.getView()).getChart();
 

Since:

JViews 7.5

See Also:

IlvChart, Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor

AUTO_SUBMIT_DEFAULT_VALUE, INVOCATION_CONTEXT_DEFAULT_VALUE, PARTIAL_SUBMIT_DEFAULT_VALUE

Fields inherited from class jakarta.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component.
protected IlvObjectSelectedFinder	getDefaultObjectSelectedFinder() Returns the default IlvObjectSelectedFinder instance if no specified instance is provided.
String	getFamily() Returns the family of this component.
String	getPickingMode() Returns the picking mode.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setPickingMode(String mode) Sets the picking mode.
void	updateModel(jakarta.faces.context.FacesContext context) 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.dhtml.interactor.IlvObjectSelectInteractor

broadcast, clearDecodedPropertyMap, getAttributes, getCursor, getInvocationContext, getMenuModelId, getMessage, getObjectSelectedFinder, getView, getViewId, isAutoSubmit, isDecodedProperty, isPartialSubmit, resetDecodedProperties, setAutoSubmit, setCursor, setDecodedProperty, setInvocationContext, setMenuModelId, setMessage, setObjectSelectedFinder, setPartialSubmit, setView, setViewId, validate

Methods inherited from class jakarta.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validateValue

Methods inherited from class jakarta.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class jakarta.faces.component.UIComponentBase

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

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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

getConverter, getLocalValue, setConverter

Constructor Detail

IlvChartSelectInteractor

public IlvChartSelectInteractor()

Creates a new IlvChartSelectInteractor instance.

Method Detail

getFamily

public String getFamily()

Returns the family of this component.

Overrides:

getFamily in class jakarta.faces.component.UIInput

Returns:

The family of this component.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getDefaultObjectSelectedFinder

protected IlvObjectSelectedFinder getDefaultObjectSelectedFinder()

Returns the default IlvObjectSelectedFinder instance if no specified instance is provided.

Specified by:

getDefaultObjectSelectedFinder in class IlvObjectSelectInteractor

Returns:

The default IlvObjectSelectedFinder instance.

getPickingMode

public String getPickingMode()

Returns the picking mode.

Returns:

The mode.

Since:

JViews 8.5

setPickingMode

public void setPickingMode(String mode)

Sets the picking mode.

Parameters:

mode - The mode to set.

Since:

JViews 8.5

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 IlvViewHelper

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvObjectSelectInteractor

Parameters:

context - The current faces context.

Returns:

The state of this component.

Since:

JViews 8.5

restoreState

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

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface IlvViewHelper

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvObjectSelectInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.

Since:

JViews 8.5

updateModel

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

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 IlvViewHelper

Overrides:

updateModel in class IlvObjectSelectInteractor

Parameters:

context - The current faces context.