ilog.tgo.faces.graph.dhtml.interactor
Class IltFacesGraphInteractor

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              ilog.tgo.faces.graph.dhtml.interactor.IltFacesGraphInteractor

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFrameworkConstants, IlvFacesInteractor, Serializable, ActionSource, ActionSource2, StateHolder

public class IltFacesGraphInteractor
extends UICommand
implements IlvFacesComponent, IlvFacesInteractor, IlvViewHelper, IlvFrameworkConstants, IlvDHTMLConstants

The IltFacesGraphInteractor faces component implements an interactor that converts client-side interactions into server-side mouse events.

The value change listener registered with this component can be called from inside or outside the JSF life cycle depending on the invocationContext value. Possible values are:

• JSF_CONTEXT: the interactor will submit the page and the action will be processed during the JSF life cycle.
• IMAGE_SERVLET_CONTEXT: the interactor will only query a new image from the server, and the action is processed out of the JSF life cycle. The IMAGE_SERVLET_CONTEXT value implies some limitations and is designed to only allow interactions on the underlying graphic component, that is, the IlpGraphView view component.
  • Only the view component will be refreshed, so other related faces components will not be updated.
  • The source of the value change event is an IltFacesFakeGraphInteractor object designed to provide access to a fake faces view component.
  • The fake faces view component is either a IltFacesDHTMLFakeNetworkView object or an IltFacesDHTMLFakeEquipmentView object and only allows access to the underlying graphic component (IlpGraphView).
  • The valueChangeEvent.getOldValue() method returns null.
  • Any access to an unauthorized API will result in a NotInJSFLifecycleException being thrown.

In both modes:

• The invocation context uses the following code to determine the value change listener:

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

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

         IlpNetwork network = ((IltFacesDHTMLNetworkView)source.getView()).getNetwork();
       

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

static Boolean	AUTO_SUBMIT_DEFAULT_VALUE The default value for the autoSubmit property.
static Integer	INVOCATION_CONTEXT_DEFAULT_VALUE The default value of the invocationContext property.
static Integer	LINE_WIDTH_DEFAULT_VALUE The default value for the lineWidth property.

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

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

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

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

Constructor Summary

IltFacesGraphInteractor()
Creates a new IltFacesGraphInteractor instance.

Method Summary

void	clearDecodedPropertyMap() Clears the decoded properties.
String	getActionName() Returns the action name.
Map	getAttributes() Returns a mutable Map instance representing the attributes and properties associated with this UIComponent object keyed by attribute name.
static String	getComponentType() Returns the component type identifier of this component.
String	getCursor() Returns the cursor property, that is, the mouse cursor to be displayed when using this interactor.
String	getFamily()
int	getInvocationContext() Returns the invocationContext property.
Color	getLineColor() Returns the lineColor property.
int	getLineWidth() Returns the lineWidth property.
String	getMenuModelId() Returns the menuModelId property, that is, the model identifier used in menu operations.
String	getMessage() Returns the message property, that is, the text displayed by the message box attached to the view if there is one.
IlvBasicView	getView() Returns the view component associated with this component.
String	getViewId() Returns the ID of the view linked to this component.
boolean	isAutoSubmit() Returns the autoSubmit property.
boolean	isDecodedProperty(String property) Returns true if the specified property was decoded during the "Apply Request Value" phase of the JSF lifecycle, false otherwise.
void	resetDecodedProperties() Resets the decoded properties of this component.
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	setActionName(String actionName) Sets the action name of the event that will be triggered when this interactor is used.
void	setAutoSubmit(boolean autoSubmit) Sets the autoSubmit property.
void	setCursor(String cursor) Sets the cursor property.
void	setDecodedProperty(String property) Sets the property to decoded, which means that the property value was updated from the request during the "Apply Request Value" phase of the JSF life cycle.
void	setInvocationContext(int invocationContext) Sets the invocationContext property.
void	setLineColor(Color lineColor) Sets the lineColor property.
void	setLineWidth(int lineWidth) Sets the lineWidth property.
void	setMenuModelId(String modelId) Sets the menuModelId property.
void	setMessage(String message) Sets the message property.
void	setView(IlvBasicView view) Sets the view component associated with this component.
void	setViewId(String viewId) Sets the ID of the view linked to this component.
void	updateModel(FacesContext context) This method updates the referenced values by the local values of the component if these values were updated from the client.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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

The default value for the lineWidth property.

AUTO_SUBMIT_DEFAULT_VALUE

public static final Boolean AUTO_SUBMIT_DEFAULT_VALUE

The default value for the autoSubmit property.

INVOCATION_CONTEXT_DEFAULT_VALUE

public static final Integer INVOCATION_CONTEXT_DEFAULT_VALUE

The default value of the invocationContext property.

Constructor Detail

IltFacesGraphInteractor

public IltFacesGraphInteractor()

Creates a new IltFacesGraphInteractor instance.

Method Detail

getLineWidth

public int getLineWidth()

Returns the lineWidth property.

Returns:

The line width of the dragged rectangle.

setLineWidth

public void setLineWidth(int lineWidth)

Sets the lineWidth property.

Parameters:

lineWidth - The line width of the dragged rectangle.

getLineColor

public Color getLineColor()

Returns the lineColor property. This is an HTML color.

Returns:

The color of the dragged rectangle.

setLineColor

public void setLineColor(Color lineColor)

Sets the lineColor property. This is an HTML color.

Parameters:

lineColor - The color of the dragged rectangle.

isAutoSubmit

public boolean isAutoSubmit()

Returns the autoSubmit property.

Returns:

The auto submit mode.

setAutoSubmit

public void setAutoSubmit(boolean autoSubmit)

Sets the autoSubmit property.

Parameters:

autoSubmit - The auto submit mode to set.

getInvocationContext

public int getInvocationContext()

Returns the invocationContext property.

Returns:

Either JSF_CONTEXT or IMAGE_SERVLET_CONTEXT.

setInvocationContext

public void setInvocationContext(int invocationContext)

Sets the invocationContext property. Valid values are IlvDHTMLConstants.JSF_CONTEXT and IlvDHTMLConstants.IMAGE_SERVLET_CONTEXT.

Parameters:

invocationContext - The invocation context to be set.

getActionName

public String getActionName()

Returns the action name. An action event will be triggered with this name when the interactor is used.

The default action name is "jtgointeractor".

Returns:

The action name.

setActionName

public void setActionName(String actionName)

Sets the action name of the event that will be triggered when this interactor is used.

The default action name is "jtgointeractor".

Parameters:

actionName - The name of the action.

getComponentType

public static String getComponentType()

Returns the component type identifier of this component.

Returns:

The component type identifier of this component.

getCursor

public String getCursor()

Returns the cursor property, that is, the mouse cursor to be displayed when using this interactor.

Specified by:

getCursor in interface IlvFacesInteractor

Returns:

The mouse cursor of the interactor.

setCursor

public void setCursor(String cursor)

Sets the cursor property. Valid values are the values supported by the target browsers.

Specified by:

setCursor in interface IlvFacesInteractor

Parameters:

cursor - The mouse cursor to be set.

getMessage

public String getMessage()

Returns the message property, that is, the text displayed by the message box attached to the view if there is one.

Specified by:

getMessage in interface IlvFacesInteractor

Returns:

The message text for this interactor.

setMessage

public void setMessage(String message)

Sets the message property.

Specified by:

setMessage in interface IlvFacesInteractor

Parameters:

message - The message text displayed when using this interactor.

getMenuModelId

public String getMenuModelId()

Returns the menuModelId property, that is, the model identifier used in menu operations.

Specified by:

getMenuModelId in interface IlvFacesInteractor

Returns:

The menu model identifier for this interactor.

setMenuModelId

public void setMenuModelId(String modelId)

Sets the menuModelId property.

Specified by:

setMenuModelId in interface IlvFacesInteractor

Parameters:

modelId - The menu model identifier for this interactor.

isDecodedProperty

public boolean isDecodedProperty(String property)

Returns true if the specified property was decoded during the "Apply Request Value" phase of the JSF lifecycle, false otherwise.

Specified by:

isDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to test.

Returns:

true if the property was decoded, false otherwise.

setDecodedProperty

public void setDecodedProperty(String property)

Sets the property to decoded, which means that the property value was updated from the request during the "Apply Request Value" phase of the JSF life cycle. This method must be called by renderers only during the execution of their decode method.

Specified by:

setDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to set to decoded.

resetDecodedProperties

public void resetDecodedProperties()

Resets the decoded properties of this component.

Specified by:

resetDecodedProperties in interface IlvFacesComponent

clearDecodedPropertyMap

public void clearDecodedPropertyMap()

Clears the decoded properties.

Specified by:

clearDecodedPropertyMap in interface IlvFacesComponent

getViewId

public String getViewId()

Returns the ID of the view linked to this component.

Specified by:

getViewId in interface IlvViewHelper

Returns:

The ID of the view linked to this component.

setViewId

public void setViewId(String viewId)

Sets the ID of the view linked to this component.

Specified by:

setViewId in interface IlvViewHelper

Parameters:

viewId - The ID of the view.

getView

public IlvBasicView getView()

Returns the view component associated with this component.

Specified by:

getView in interface IlvViewHelper

Returns:

The view component associated with this component.

setView

public void setView(IlvBasicView view)

Sets the view component associated with this component.

Specified by:

setView in interface IlvViewHelper

Parameters:

view - The view component associated with this component.

updateModel

public void updateModel(FacesContext context)

This method updates the referenced values by the local values of the component if these values were updated from the client.

Specified by:

updateModel in interface IlvViewHelper

Parameters:

context - The current faces context.

getFamily

public String getFamily()

Overrides:

getFamily in class UICommand

getAttributes

public Map getAttributes()

Returns a mutable Map instance representing the attributes and properties associated with this UIComponent object keyed by attribute name. The attribute name must be a String. The implementation returned must support all of the standard and optional Map methods, plus support the following additional requirements:

• The Map implementation must implement the java.io.Serializable interface.
• Any attempt to add a null key or value must throw a NullPointerException.
• Any attempt to add a key that is not a String object must throw a ClassCastException.
• If the attribute name specified as a key matches a property of the implementation class of this UIComponent object, the methods listed below will have the following behavior:
  • containsKey: returns false.
  • get(): if the property is readable, call the getter method to retrieve the returned value. Primitive values are wrapped in their corresponding wrapper classes. Otherwise throw IllegalArgumentException.
  • put(): if the property is writable, call the setter method to set the corresponding value. Primitive values are unwrapped in their corresponding wrapper classes. If the property is not writable, or an attempt is made to set a property of primitive type to null, throw IllegalArgumentException.
  • remove: throws IllegalArgumentException.

Overrides:

getAttributes in class UIComponentBase

Since:

JViews 8.1

saveState

public Object saveState(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 StateHolder

Overrides:

saveState in class UICommand

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 IlvViewHelper

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UICommand

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.