ilog.views.faces.component
Class IlvBasicViewHelper

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              ilog.views.faces.component.IlvBasicView
                  ilog.views.faces.component.IlvBasicViewHelper

All Implemented Interfaces:

IlvFacesComponent, IlvViewHelper, IlvFacesConstants, Serializable, StateHolder

Direct Known Subclasses:

IlvFacesDHTMLOverview, IlvFacesPanTool, IlvFacesZoomTool

public class IlvBasicViewHelper
extends IlvBasicView
implements IlvViewHelper

This class defines a basic JViews Faces view that is linked to another view.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.component.IlvBasicView

DEFAULT_OBJECT_FINDER

Fields inherited from class javax.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

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

IlvBasicViewHelper()
Creates a new IlvBasicViewHelper instance.

Method Summary

protected IlvViewHelper	createViewHelper() Creates the default IlvViewHelper used by this component.
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
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 stateObj) Restores the state of this component from the stateObj 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 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.component.IlvBasicView

clearDecodedPropertyMap, createFacesComponent, getAttributes, getData, getDefaultObjectFinder, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class javax.faces.component.UIGraphic

getUrl, getValue, getValueBinding, setUrl, setValue, setValueBinding

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvBasicViewHelper

public IlvBasicViewHelper()

Creates a new IlvBasicViewHelper instance.

Method Detail

createViewHelper

protected IlvViewHelper createViewHelper()

Creates the default IlvViewHelper used by this component. This default implementation returns an IlvViewHelperImpl

Returns:

The default IlvViewHelper implementation.

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.

This implementation returns the fully qualified class name.

Overrides:

getFamily in class IlvBasicView

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.

getView

public IlvBasicView getView()

Returns the view component associated with this component.

Specified by:

getView in interface IlvViewHelper

Returns:

The view component associated with this component.

getViewId

public String getViewId()

Returns the ID of the view linked to this component.

Specified by:

getViewId in interface IlvViewHelper

Returns:

The ID of the view linked to this component.

setView

public void setView(IlvBasicView view)

Sets the view component associated with this component.

Specified by:

setView in interface IlvViewHelper

Parameters:

view - The view component associated with this component.

setViewId

public void setViewId(String viewId)

Sets the ID of the view linked to this component.

Specified by:

setViewId in interface IlvViewHelper

Parameters:

viewId - The ID of the view.

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 IlvBasicView

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 IlvBasicView

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 stateObj parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface IlvViewHelper

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvBasicView

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.