ilog.tgo.faces.graph.dhtml.interactor

Class IltFacesClientSelectInteractor

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.faces.interactor.IlvInteractor

ilog.views.faces.dhtml.interactor.IlvFacesSelectInteractor

ilog.tgo.faces.graph.dhtml.interactor.IltFacesClientSelectInteractor

All Implemented Interfaces:

IltFacesJTGOConstants, IlvFacesComponent, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

public class IltFacesClientSelectInteractor
extends IlvFacesSelectInteractor
implements IltFacesJTGOConstants

The IltFacesClientSelectInteractor component implements an interactor that allows the selection and movement of objects in a network or equipment view.

This class is intended to minimize server-side image requests by dynamically displaying a rectangular selection border around the selected objects in the client-side.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

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 class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface ilog.tgo.faces.IltFacesJTGOConstants

CONTEXT, DATA_SOURCE, DATA_SOURCE_ID, DEFAULT_STYLE_SHEET, EQUIPMENT, NETWORK, OBJECT_ACTION_MB, PROPERTY_ACCESSOR, STYLE_SHEETS

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

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

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_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, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IltFacesClientSelectInteractor() Creates a new IltFacesClientSelectInteractor instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the component type identifier for this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
jakarta.faces.el.MethodBinding	getInfoProviderMethodBinding() Deprecated. since JViews 8.0. For alternatives see IltFacesGraphViewSelectionManager.getInfoProviderMethodBinding().
jakarta.faces.el.MethodBinding	getObjectActionMethodBinding() Accesses the objectActionMethodBinding property.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setInfoProviderMethodBinding(jakarta.faces.el.MethodBinding methodBinding) Deprecated. since JViews 8.0. For alternatives see IltFacesGraphViewSelectionManager.setInfoProviderMethodBinding(MethodBinding)().
void	setObjectActionMethodBinding(jakarta.faces.el.MethodBinding methodBinding) Sets the objectActionMethodBinding property.
void	updateModel(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

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 jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Constructor Detail

IltFacesClientSelectInteractor

public IltFacesClientSelectInteractor()

Creates a new IltFacesClientSelectInteractor 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 component type identifier for this component.

Returns:

The component type identifier for this component.

getInfoProviderMethodBinding

@Deprecated
public jakarta.faces.el.MethodBinding getInfoProviderMethodBinding()

Deprecated. since JViews 8.0. For alternatives see IltFacesGraphViewSelectionManager.getInfoProviderMethodBinding().

Accesses the infoProviderMethodBinding property. The returned method binding respects the signature:

 List method_name(IlpGraphView view, IlpRepresentationObject obj)
 

It returns a list of additional properties associated to the currently selected object. A valid item for this list is a String or a List itself.

Returns:

The binding to a method that will provide the additional information for the selected object.

Deprecated Since:

JViews 8.0

setInfoProviderMethodBinding

@Deprecated
public void setInfoProviderMethodBinding(jakarta.faces.el.MethodBinding methodBinding)

Deprecated. since JViews 8.0. For alternatives see IltFacesGraphViewSelectionManager.setInfoProviderMethodBinding(MethodBinding)().

Sets the infoProviderMethodBinding property. The given method binding respects the signature:

 List method_name(IlpGraphView view, IlpRepresentationObject obj)
 

It returns a list of additional properties associated to the currently selected object. A valid item for this list is a String or a List itself.

Parameters:

methodBinding - The binding to a method that will provide the additional information for the selected object.

Deprecated Since:

JViews 8.0

getObjectActionMethodBinding

public jakarta.faces.el.MethodBinding getObjectActionMethodBinding()

Accesses the objectActionMethodBinding property. The returned method binding respects the signature:

 boolean method_name(IlpGraphView view, int xPos, int yPos)
 

If the method returns true, no selection will be processed and a new image will be generated.

Returns:

The binding to a method that will perform object actions based on a given (x,y) coordinate.

setObjectActionMethodBinding

public void setObjectActionMethodBinding(jakarta.faces.el.MethodBinding methodBinding)

Sets the objectActionMethodBinding property. The given method binding should respect the following signature:

 boolean method_name(IlpGraphView view, int xPos, int yPos)
 

Parameters:

methodBinding - The binding to a method that will perform object actions based on a given (x,y) coordinate.

updateModel

public void updateModel(jakarta.faces.context.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(jakarta.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvFacesSelectInteractor

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.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 jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesSelectInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.