ilog.views.faces.interactor
Class IlvDragRectInteractor

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

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, IlvFacesInteractor, Serializable, StateHolder

Direct Known Subclasses:

IlvFacesMapRectInteractor, IlvFacesZoomInteractor

public class IlvDragRectInteractor
extends IlvInteractor

The IlvDragRectInteractor is the base component class of interactor components that allow a rectangle to be dragged.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

static Integer

LINE_WIDTH_DEFAULT_VALUE Default value of lineWidth property.

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

IlvDragRectInteractor()
Creates a new IlvDragRectInteractor instance.

Method Summary

static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
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) 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.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

Field Detail

LINE_WIDTH_DEFAULT_VALUE

public static final Integer LINE_WIDTH_DEFAULT_VALUE

Default value of lineWidth property.

Since:

JViews 6.5

Constructor Detail

IlvDragRectInteractor

public IlvDragRectInteractor()

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

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.

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)

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 IlvInteractor

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 StateHolder

Overrides:

saveState in class IlvInteractor

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 StateHolder

Overrides:

restoreState in class IlvInteractor

Parameters:

context - The current faces context.

state - The previously saved state of this component.