ilog.views.faces.component
Interface IlvViewHelper

All Superinterfaces:

IlvFacesConstants, Serializable

All Known Implementing Classes:

IlvBasicViewHelper, IlvFacesDHTMLOverview, IlvFacesLayerVisibilityTool, IlvFacesNodeOrLinkSelectInteractor, IlvFacesNodeOrLinkSelectRectInteractor, IlvFacesObjectSelectInteractor, IlvFacesObjectSelectRectInteractor, IlvFacesPanTool, IlvFacesZoomTool, IlvObjectSelectInteractor, IlvObjectSelectRectInteractor, IlvViewHelperImpl

public interface IlvViewHelper
extends IlvFacesConstants, Serializable

The IlvViewHelper interface defines a component that is linked to a view. This view is identified by an identifier (ID) that must be resolved during the rendering phase. The state must contain the ID of the view but not the view itself.

Since:

JViews 6.0

Field Summary

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

Method Summary

IlvBasicView	getView() Returns the view component associated with this component.
String	getViewId() Returns the ID of the view linked to this component.
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	setView(IlvBasicView view) Sets the view component associated with this component.
void	setViewId(String viewId) Sets the ID of the view linked to this component.
void	updateModel(FacesContext context) This method updates the referenced values by the local values of the component if these values were updated from the client.

Method Detail

getViewId

String getViewId()

Returns the ID of the view linked to this component.

Returns:

The ID of the view linked to this component.

setViewId

void setViewId(String viewId)

Sets the ID of the view linked to this component.

Parameters:

viewId - The ID of the view.

getView

IlvBasicView getView()

Returns the view component associated with this component.

Returns:

The view component associated with this component.

setView

void setView(IlvBasicView view)

Sets the view component associated with this component.

Parameters:

view - The view component associated with this component.

updateModel

void updateModel(FacesContext context)

This method updates the referenced values by the local values of the component if these values were updated from the client.

Parameters:

context - The current faces context.

saveState

Object saveState(FacesContext context)

Returns the state of this component.

Parameters:

context - The current faces context

Returns:

The state of this component.

restoreState

void restoreState(FacesContext context,
                  Object state)

Restores the state of this component from the state parameter.

Parameters:

context - The current faces context.

state - The previously saved state of this component.