ilog.views.faces.interactor
Class IlvFacesMapRectInteractor

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          ilog.views.faces.component.IlvFacesComponentBase
              ilog.views.faces.interactor.IlvInteractor
                  ilog.views.faces.interactor.IlvDragRectInteractor
                      ilog.views.faces.interactor.IlvFacesMapRectInteractor

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, IlvFrameworkConstants, IlvFacesInteractor, Serializable, StateHolder

public class IlvFacesMapRectInteractor
extends IlvDragRectInteractor
implements IlvFrameworkConstants

The Map Rectangle interactor allows you to launch a server action outside of the JavaServer Faces lifecycle by dragging a rectangle.
The default action name is "mapRect" and the parameters of this action are the coordinates (in the manager coordinates system) of the dragged rectangle on the view and the corner from which the rectangle was dragged (upper-left=0, lower-left=1, lower-right=2, upper-right=3).
To handle an action event, a listener must registered through IlvManagerServletSupport.addServerActionListener.

Since:

Jviews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.interactor.IlvDragRectInteractor

LINE_WIDTH_DEFAULT_VALUE

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

Constructor Summary

IlvFacesMapRectInteractor()
Creates a new IlvFacesMapRectInteractor instance.

Method Summary

String	getActionName() Returns the action name.
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.
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	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.interactor.IlvDragRectInteractor

getLineColor, getLineWidth, setLineColor, setLineWidth

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

Constructor Detail

IlvFacesMapRectInteractor

public IlvFacesMapRectInteractor()

Creates a new IlvFacesMapRectInteractor 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 IlvDragRectInteractor

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.

getActionName

public String getActionName()

Returns the action name. When the interactor is used, an action event will be triggered with this name.
The default action name is "mapRect".

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 "mapRect".

Parameters:

actionName - The name of the action.

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 IlvDragRectInteractor

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 IlvDragRectInteractor

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 IlvDragRectInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.