ilog.views.faces.dhtml.interactor
Class IlvFacesObjectSelectInteractor

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor
                      ilog.views.faces.dhtml.interactor.IlvFacesObjectSelectInteractor

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, Serializable, EditableValueHolder, StateHolder, ValueHolder

public class IlvFacesObjectSelectInteractor
extends IlvObjectSelectInteractor

The interactor allows you to select an IlvGraphic object on the view. This graphic object will be stored in the property value.
To change the default behavior of this interactor, a custom IlvObjectSelectedFinder can be set to this component.

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 only allows interaction 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 IlvFacesFakeObjectSelectInteractor designed to provide access to a fake JSF View component and the current client mode.
  • The JSF returned by the getView() method of the source component is an instance of IlvFacesDHTMLFakeView. This component only accepts a call on its getView() 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:

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

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

 IlvManagerView view = ((IlvFacesDHTMLView)source.getView()).getView();
 

Since:

JViews 6.5

See Also:

IlvFacesObjectSelectedFinder, Serialized Form

Field Summary

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

AUTO_SUBMIT_DEFAULT_VALUE, INVOCATION_CONTEXT_DEFAULT_VALUE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, 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, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

IlvFacesObjectSelectInteractor()
Creates a new IlvFacesObjectSelectInteractor instance.

Method Summary

static String	getComponentType() Returns the type of this component.
String	getFamily()

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

clearDecodedPropertyMap, getAttributes, getCursor, getInvocationContext, getMenuModelId, getMessage, getObjectSelectedFinder, getView, getViewId, isAutoSubmit, isDecodedProperty, resetDecodedProperties, restoreState, saveState, setAutoSubmit, setCursor, setDecodedProperty, setInvocationContext, setMenuModelId, setMessage, setObjectSelectedFinder, setView, setViewId, updateModel, validate

Methods inherited from class javax.faces.component.UIInput

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

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Constructor Detail

IlvFacesObjectSelectInteractor

public IlvFacesObjectSelectInteractor()

Creates a new IlvFacesObjectSelectInteractor instance.

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.