ilog.views.diagrammer.faces.dhtml.component
Class IlvFacesDiagrammerSelectionManager

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          ilog.views.faces.component.IlvFacesComponentBase
              ilog.views.faces.dhtml.component.IlvFacesSelectionManager
                  ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerSelectionManager

All Implemented Interfaces:

IlvFacesComponent, IlvDHTMLConstants, IlvFacesConstants, Serializable, StateHolder

public class IlvFacesDiagrammerSelectionManager
extends IlvFacesSelectionManager

IlvFacesDiagrammerSelectionManager is a facet of IlvFacesDHTMLDiagrammerView that allows you to configure the selection management in the view.

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.dhtml.component.IlvFacesSelectionManager

FORCE_UPDATE_PROPERTIES_DEFAULT_VALUE, IMAGE_MODE_DEFAULT_VALUE, LINE_WIDTH_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

IlvFacesDiagrammerSelectionManager()
Creates a new IlvFacesDiagrammerSelectionManager instance.

Method Summary

static String	getComponentType() Returns the type of this component.
String	getFamily()
MethodBinding	getInfoProviderMethodBinding() Deprecated. Beginning with JViews 8.0 it is recommended to use getPropertyAccessor() instead.
IlvFacesDiagrammerPropertyAccessor	getPropertyAccessor() Returns a reference to an IlvFacesDiagrammerPropertyAccessor instance that will be used to access the properties of the selected objects.
void	restoreState(FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object. If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.
Object	saveState(FacesContext context) Gets the state of the instance as a Serializable Object. If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. This method must not alter the state of the implementing object. In other words, after executing this code: Object state = component.saveState(facesContext); component should be the same as before executing it. The return from this method must be Serializable
void	setInfoProviderMethodBinding(MethodBinding infoProviderMethodBinding) Deprecated. Beginning with JViews 8.0 it is recommended to use setPropertyAccessor(IlvFacesDiagrammerPropertyAccessor) instead.
void	setPropertyAccessor(IlvFacesDiagrammerPropertyAccessor propertyAccessor) Sets a reference to a IlvFacesDiagrammerPropertyAccessor instance that will be used to access the properties of the selected objects.
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.component.IlvFacesSelectionManager

getFillOnDefaultValue, getLineColor, getLineWidth, getOnSelectionChanged, isFillOn, isForceUpdateProperties, isImageMode, setFillOn, setFillOnDefaultValue, setForceUpdateProperties, setImageMode, setLineColor, setLineWidth, setOnSelectionChanged

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

Constructor Detail

IlvFacesDiagrammerSelectionManager

public IlvFacesDiagrammerSelectionManager()

Creates a new IlvFacesDiagrammerSelectionManager instance.

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class IlvFacesSelectionManager

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 it is recommended to use getPropertyAccessor() instead.

Returns an expression to that respects the signature of ArrayList methodName(IlvDiagrammer, Object) or ArrayList methodName(IlvDiagrammer, IlvSDMNode).

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

A valid item in this list is a String or a list.

Returns:

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

setInfoProviderMethodBinding

public void setInfoProviderMethodBinding(MethodBinding infoProviderMethodBinding)

Deprecated. Beginning with JViews 8.0 it is recommended to use setPropertyAccessor(IlvFacesDiagrammerPropertyAccessor) 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.

getPropertyAccessor

public IlvFacesDiagrammerPropertyAccessor getPropertyAccessor()

Returns a reference to an IlvFacesDiagrammerPropertyAccessor instance that will be used to access the properties of the selected objects.

Returns:

A reference to the property accessor.

See Also:

setPropertyAccessor(IlvFacesDiagrammerPropertyAccessor)

setPropertyAccessor

public void setPropertyAccessor(IlvFacesDiagrammerPropertyAccessor propertyAccessor)

Sets a reference to a IlvFacesDiagrammerPropertyAccessor instance that will be used to access the properties of the selected objects. To enable the ability to set properties, the editable property of the parent IlvFacesDiagrammerView object must be set to true.

Parameters:

propertyAccessor - The property accessor.

See Also:

IlvFacesDiagrammerView.setEditable(boolean)

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 IlvFacesSelectionManager

Parameters:

context - The current faces context.

saveState

public Object saveState(FacesContext context)

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets.

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvFacesSelectionManager

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object stateObj)

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvFacesSelectionManager

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.