ilog.views.faces.dhtml.component
Class IlvFacesSelectionManager

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

All Implemented Interfaces:

IlvFacesComponent, IlvDHTMLConstants, IlvFacesConstants, Serializable, StateHolder

Direct Known Subclasses:

IltFacesGraphViewSelectionManager, IlvFacesDiagrammerSelectionManager

public class IlvFacesSelectionManager
extends IlvFacesComponentBase
implements IlvDHTMLConstants, IlvFacesConstants

This is the base class for components in charge of managing the selection process on IlvBasicView implementations.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

static Boolean	FORCE_UPDATE_PROPERTIES_DEFAULT_VALUE Default value of forceUpdateProperties property.
static Boolean	IMAGE_MODE_DEFAULT_VALUE Default value of imageMode property.
static Integer	LINE_WIDTH_DEFAULT_VALUE Default value of lineWidth property.

Fields inherited from class javax.faces.component.UIComponent

bindings

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

IlvFacesSelectionManager()
Creates a new IlvFacesSelectionManager instance.

Method Summary

static String	getComponentType() Returns the type of this component.
String	getFamily()
Boolean	getFillOnDefaultValue() Returns the default value for the fillOn property.
Color	getLineColor() Returns the color of selection rectangles.
int	getLineWidth() Returns the width of selection rectangle lines.
String	getOnSelectionChanged() Returns a JavaScript handler called when the selection has changed.
boolean	isFillOn() Returns true when the selection rectangles are filled.
boolean	isForceUpdateProperties() Returns true to force an additional request in image mode to enable client-side selection listener, false otherwise.
boolean	isImageMode() Returns the image mode.
void	restoreState(FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext context) Gets the state of the instance as a Serializable Object.
void	setFillOn(boolean fillOn) Sets whether the selection rectangles are filled or not.
void	setFillOnDefaultValue(Boolean fillOn) Sets the default value for the fillOn property.
void	setForceUpdateProperties(boolean forceUpdateProperties) Sets this flag to make additional requests to query the current selection and additional properties in image mode to enable client-side selection listener.
void	setImageMode(boolean imageMode) Sets the image mode.
void	setLineColor(Color color) Sets the color of selection rectangles.
void	setLineWidth(int lineWidth) Sets the width of selection rectangle lines.
void	setOnSelectionChanged(String onSelectionChanged) Sets a JavaScript handler called when the selection has changed.
void	updateModel(FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

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, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processValidators, 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

Field Detail

LINE_WIDTH_DEFAULT_VALUE

public static final Integer LINE_WIDTH_DEFAULT_VALUE

Default value of lineWidth property.

IMAGE_MODE_DEFAULT_VALUE

public static final Boolean IMAGE_MODE_DEFAULT_VALUE

Default value of imageMode property.

FORCE_UPDATE_PROPERTIES_DEFAULT_VALUE

public static final Boolean FORCE_UPDATE_PROPERTIES_DEFAULT_VALUE

Default value of forceUpdateProperties property.

Constructor Detail

IlvFacesSelectionManager

public IlvFacesSelectionManager()

Creates a new IlvFacesSelectionManager instance.

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getLineColor

public Color getLineColor()

Returns the color of selection rectangles.

Returns:

The color.

setLineColor

public void setLineColor(Color color)

Sets the color of selection rectangles.

Parameters:

color - The color to set.

getLineWidth

public int getLineWidth()

Returns the width of selection rectangle lines.

Returns:

The line width.

setLineWidth

public void setLineWidth(int lineWidth)

Sets the width of selection rectangle lines.

Parameters:

lineWidth - The line width to set.

isImageMode

public boolean isImageMode()

Returns the image mode. In image mode the image is refreshed on each selection. In regular mode, only the selected object(s) bounding box is queried and rectangles are dynamically displayed on top of the view. Note that the client-side listeners on selection and additional information on selected objects are available in image mode if and only if the forceUpdateProperties property is set to true. In regular mode no special configuration is needed. The default value is true.

Returns:

Whether the selection manager is in image mode.

setImageMode

public void setImageMode(boolean imageMode)

Sets the image mode. In image mode the image is refreshed on each selection. In regular mode, only the selected object(s) bounding box is queried and rectangles are dynamically displayed on top of the view. Note that the client-side listeners on selection and additional information on selected objects are available in image mode if and only if the forceUpdateProperties property is set to true. In regular mode no special configuration is needed. The default value is true.

Parameters:

imageMode - The image mode to set.

isForceUpdateProperties

public boolean isForceUpdateProperties()

Returns true to force an additional request in image mode to enable client-side selection listener, false otherwise.

Returns:

The forceUpdateProperties.

setForceUpdateProperties

public void setForceUpdateProperties(boolean forceUpdateProperties)

Sets this flag to make additional requests to query the current selection and additional properties in image mode to enable client-side selection listener.

Parameters:

forceUpdateProperties - The forceUpdateProperties to set.

getOnSelectionChanged

public String getOnSelectionChanged()

Returns a JavaScript handler called when the selection has changed. The handler can use the predefined variable 'selection' which is the list of current IlvSelectionRectangle. To use this handler the IlvFacesSelectionManager must be in regular mode or the forceUpdateProperties must be set if in image mode. Refer to the user's documentation for further information.

Returns:

The onSelectionChanged.

See Also:

setForceUpdateProperties(boolean), setImageMode(boolean)

setOnSelectionChanged

public void setOnSelectionChanged(String onSelectionChanged)

Sets a JavaScript handler called when the selection has changed. The handler can use the predefined variable 'selection' which is the list of current selection objects implementing the JavaScript IlvSelectionRectangle prototype. To use this handler the IlvFacesSelectionManager must be in regular mode or the forceUpdateProperties must be set if in image mode. Refer to the user's documentation for further information.

Parameters:

onSelectionChanged - The JavaScript handler to set.

See Also:

setForceUpdateProperties(boolean), setImageMode(boolean)

isFillOn

public boolean isFillOn()

Returns true when the selection rectangles are filled.

Returns:

true when the selection rectangles are filled.

setFillOn

public void setFillOn(boolean fillOn)

Sets whether the selection rectangles are filled or not.

Parameters:

fillOn - true for filled selection rectangles.

setFillOnDefaultValue

public void setFillOnDefaultValue(Boolean fillOn)

Sets the default value for the fillOn property. This method should be invoked at construction time only -- invoking it later will lead to unpredictable behavior.

Parameters:

fillOn - The default value for the fillOn property.

getFillOnDefaultValue

public Boolean getFillOnDefaultValue()

Returns the default value for the fillOn property.

Returns:

The default value for the fillOn property.

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 IlvFacesComponentBase

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 IlvFacesComponentBase

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 IlvFacesComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.