ilog.views.faces.dhtml.interactor
Class IlvObjectSelectRectInteractor

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor
                      extended by ilog.views.faces.dhtml.interactor.IlvObjectSelectRectInteractor
All Implemented Interfaces:
IlvFacesComponent, IlvViewHelper, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, Serializable, EditableValueHolder, StateHolder, ValueHolder
Direct Known Subclasses:
IlvFacesNodeOrLinkSelectRectInteractor, IlvFacesObjectSelectRectInteractor

public class IlvObjectSelectRectInteractor
extends IlvObjectSelectInteractor

This class defines an interactor that allows you to select a set model objects from a view.
Each subclass must register an objectSelectedFinder that will set the value from the JViews Faces View and the parameters passed from the renderer.

Since:
JViews 6.5
See Also:
Serialized Form

Field Summary
static Integer LINE_WIDTH_DEFAULT_VALUE
          Default value of lineWidth property
 
Fields inherited from class ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor
AUTO_SUBMIT_DEFAULT_VALUE, INVOCATION_CONTEXT_DEFAULT_VALUE
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID
 
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
 
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
IlvObjectSelectRectInteractor()
          Creates a new IlvObjectSelectRectInteractor instance.
 
Method Summary
 Color getLineColor()
          Returns a string representing the HTML color of the dragged rectangle.
 int getLineWidth()
          Returns the line width of the dragged rectangle.
 void restoreState(FacesContext context, Object state)
          Restores the state of this component from the state parameter.
 Object saveState(FacesContext context)
          Returns the state of this component.
 void setLineColor(Color lineColor)
          Sets the line color of the dragged rectangle.
 void setLineWidth(int lineWidth)
          Sets the line width of the dragged rectangle.
 void updateModel(FacesContext ctx)
          This method updates the referenced values with the local values of the component if these values were updated from the client.
 
Methods inherited from class ilog.views.faces.dhtml.interactor.IlvObjectSelectInteractor
clearDecodedPropertyMap, getAttributes, getCursor, getInvocationContext, getMenuModelId, getMessage, getObjectSelectedFinder, getView, getViewId, isAutoSubmit, isDecodedProperty, resetDecodedProperties, setAutoSubmit, setCursor, setDecodedProperty, setInvocationContext, setMenuModelId, setMessage, setObjectSelectedFinder, setView, setViewId, validate
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getFamily, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, 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
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter
 

Field Detail

LINE_WIDTH_DEFAULT_VALUE

public static final Integer LINE_WIDTH_DEFAULT_VALUE
Default value of lineWidth property

Constructor Detail

IlvObjectSelectRectInteractor

public IlvObjectSelectRectInteractor()
Creates a new IlvObjectSelectRectInteractor instance.

Method Detail

getLineWidth

public int getLineWidth()
Returns the line width of the dragged rectangle.

Returns:
The line width of the dragged rectangle.

setLineWidth

public void setLineWidth(int lineWidth)
Sets the line width of the dragged rectangle.

Parameters:
lineWidth - The line width of the dragged rectangle.

getLineColor

public Color getLineColor()
Returns a string representing the HTML color of the dragged rectangle.

Returns:
The color of the dragged rectangle.

setLineColor

public void setLineColor(Color lineColor)
Sets the line color of the dragged rectangle.

Parameters:
lineColor - The color of the dragged rectangle. This is an HTML color.

updateModel

public void updateModel(FacesContext ctx)
This method updates the referenced values with the local values of the component if these values were updated from the client.

Specified by:
updateModel in interface IlvViewHelper
Overrides:
updateModel in class IlvObjectSelectInteractor
Parameters:
ctx - 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 IlvViewHelper
Specified by:
saveState in interface StateHolder
Overrides:
saveState in class IlvObjectSelectInteractor
Parameters:
context - The current faces context.
Returns:
The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object state)
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 IlvObjectSelectInteractor
Parameters:
context - The current faces context.
state - The previously saved state of this component.


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.