ilog.views.diagrammer.faces.dhtml.interactor
Class IlvFacesDiagrammerSelectInteractor

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          ilog.views.faces.component.IlvFacesComponentBase
              ilog.views.faces.interactor.IlvInteractor
                  ilog.views.faces.dhtml.interactor.IlvFacesSelectInteractor
                      ilog.views.diagrammer.faces.dhtml.interactor.IlvFacesDiagrammerSelectInteractor

All Implemented Interfaces:

IlvFacesComponent, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, Serializable, StateHolder

public class IlvFacesDiagrammerSelectInteractor
extends IlvFacesSelectInteractor

IlvFacesDiagrammerSelectInteractor is a Diagrammer specific implementation of the IlvFacesSelectInteractor class.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

static Boolean

DELETION_ALLOWED_DEFAULT_VALUE The default value of the deletionAllowed property.

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

FORCE_UPDATE_DEFAULT_VALUE, IMAGE_MODE_DEFAULT_VALUE, internalState, LINE_WIDTH_DEFAULT_VALUE, MOVE_ALLOWED_DEFAULT_VALUE

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

Constructor Summary

IlvFacesDiagrammerSelectInteractor()
Creates a new IlvFacesDiagrammerSelectInteractor instance.

Method Summary

static String	getComponentType() Returns the type of this component.
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.
MethodBinding	getInfoProviderMethodBinding() Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManager.getInfoProviderMethodBinding() method instead.
boolean	isDeletionAllowed() Returns if the user is allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.
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	setDeletionAllowed(boolean deletionAllowed) Sets if the user is allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.
void	setInfoProviderMethodBinding(MethodBinding infoProviderMethodBinding) Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManager.setInfoProviderMethodBinding(MethodBinding) method instead.
void	updateModel(FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

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

getLineColor, getLineWidth, getOnSelectionChanged, isForceUpdateProperties, isImageMode, isMoveAllowed, setForceUpdateProperties, setImageMode, setLineColor, setLineWidth, setMoveAllowed, setOnSelectionChanged

Methods inherited from class ilog.views.faces.interactor.IlvInteractor

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class java.lang.Object

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

Field Detail

DELETION_ALLOWED_DEFAULT_VALUE

public static final Boolean DELETION_ALLOWED_DEFAULT_VALUE

The default value of the deletionAllowed property.

Since:

JViews 8.0

See Also:

setDeletionAllowed(boolean)

Constructor Detail

IlvFacesDiagrammerSelectInteractor

public IlvFacesDiagrammerSelectInteractor()

Creates a new IlvFacesDiagrammerSelectInteractor 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.

Overrides:

getFamily in class IlvFacesSelectInteractor

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.

getInfoProviderMethodBinding

public MethodBinding getInfoProviderMethodBinding()

Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManager.getInfoProviderMethodBinding() method instead.

Returns an expression to that's respecting the signature ArrayList methodName(IlvDiagrammer, Object) or ArrayList methodName(IlvDiagrammer, IlvSDMNode).

The returned value of this method is a list of additional properties to associate to the selected object.

A valid item of this list is a String or a list itself.

Returns:

A binding to the method that will provide the additional information on the selected objects.

setInfoProviderMethodBinding

public void setInfoProviderMethodBinding(MethodBinding infoProviderMethodBinding)

Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManager.setInfoProviderMethodBinding(MethodBinding) method instead.

Sets a method binding that's respecting the signature ArrayList methodName(IlvDiagrammer, Object) or ArrayList methodName(IlvDiagrammer, IlvSDMNode).

The returned value of this method is a list of additional properties to associate to the selected object.

A valid item of this list is a String or a list itself.

Parameters:

infoProviderMethodBinding - The binding to the method that will provide the additional information on the selected objects.

isDeletionAllowed

public boolean isDeletionAllowed()

Returns if the user is allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view. This flag is set to false by default.

Returns:

If deletion using the delete key is allowed.

Since:

JViews 8.0

setDeletionAllowed

public void setDeletionAllowed(boolean deletionAllowed)

Sets if the user is allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view. This flag is set to false by default.

Parameters:

deletionAllowed - Set to true to allow deletion.

Since:

JViews 8.0

updateModel

public void updateModel(FacesContext context)

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Overrides:

updateModel in class IlvFacesSelectInteractor

Parameters:

context - The current faces context.

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvFacesSelectInteractor

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 IlvFacesComponent

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvFacesSelectInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.