ilog.views.faces.interactor

Class IlvInteractor

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.faces.interactor.IlvInteractor

All Implemented Interfaces:

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

Direct Known Subclasses:

IlvChartPickInteractor, IlvDragRectInteractor, IlvFacesAjaxInteractor, IlvFacesCursorChangeInteractor, IlvFacesDiagrammerLinkInteractor, IlvFacesDiagrammerResizeInteractor, IlvFacesHighlightInteractor, IlvFacesInteractorGroup, IlvFacesInterceptInteractor, IlvFacesMapInteractor, IlvFacesPanInteractor, IlvFacesResizeActivityInteractor, IlvFacesRowExpandCollapseInteractor, IlvFacesRowSelectInteractor, IlvFacesSelectInteractor, IlvFacesSheetScrollInteractor, IlvFacesTableScrollInteractor, IlvFacesTooltipInteractor

public class IlvInteractor
extends IlvFacesComponentBase
implements IlvFacesInteractor, IlvFacesConstants

The IlvInteractor is the base class for JViews Faces interactor components. An interactor is an object that is set on a JViews Faces view to make interactions on this view.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.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.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
IlvInteractor() Creates a new IlvInteractor instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component (its class name).
String	getCursor() Returns the mouse cursor to be displayed when using this interactor.
String	getFamily() Returns the identifier of the component family to which this component belongs.
String	getMenuModelId() Sets the model ID used in menu generation.
String	getMessage() Returns the message displayed by the message box attached to the view (if any) to which this interactor is attached.
void	restoreState(javax.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(javax.faces.context.FacesContext context) Returns the state of this component.
void	setCursor(String cursor) Sets the mouse cursor to be displayed when using this interactor.
void	setMenuModelId(String modelId) Returns the model ID used in menu generation.
void	setMessage(String message) Sets the message displayed when using this interactor.
void	updateModel(javax.faces.context.FacesContext ctx) Handles the "Update Model Values" phase of the JSF life cycle.

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

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

IlvInteractor

public IlvInteractor()

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

Specified by:

getFamily in class javax.faces.component.UIComponent

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component (its class name).

Returns:

The component type.

getCursor

public String getCursor()

Returns the mouse cursor to be displayed when using this interactor.

Specified by:

getCursor in interface IlvFacesInteractor

Returns:

The cursor of the interactor.

getMessage

public String getMessage()

Returns the message displayed by the message box attached to the view (if any) to which this interactor is attached.

Specified by:

getMessage in interface IlvFacesInteractor

Returns:

The message for this interactor.

setCursor

public void setCursor(String cursor)

Sets the mouse cursor to be displayed when using this interactor. The valid values are the ones supported by the target browsers.

Specified by:

setCursor in interface IlvFacesInteractor

Parameters:

cursor - The cursor to set.

setMessage

public void setMessage(String message)

Sets the message displayed when using this interactor. The message will be displayed in the message box attached to the view, if any.

Specified by:

setMessage in interface IlvFacesInteractor

Parameters:

message - The message displayed when using this interactor.

getMenuModelId

public String getMenuModelId()

Sets the model ID used in menu generation.

Specified by:

getMenuModelId in interface IlvFacesInteractor

Returns:

The model ID of this interactor.

Since:

JViews 7.5

setMenuModelId

public void setMenuModelId(String modelId)

Returns the model ID used in menu generation.

Specified by:

setMenuModelId in interface IlvFacesInteractor

Parameters:

modelId - The model ID of this interactor.

Since:

JViews 7.5

updateModel

public void updateModel(javax.faces.context.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 IlvFacesComponentBase

Parameters:

ctx - The current faces context.

saveState

public Object saveState(javax.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

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

Overrides:

restoreState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.