ilog.views.faces.component
Interface IlvFacesComponent

All Superinterfaces:
IlvFacesConstants, Serializable
All Known Implementing Classes:
IlvBasicView, IlvBasicViewHelper, IlvButtonGroup, IlvDHTMLImageButton, IlvDragRectInteractor, IlvFacesComponentBase, IlvFacesComponentImpl, IlvFacesContextualMenu, IlvFacesDashboardView, IlvFacesDHTMLDashboardView, IlvFacesDHTMLDiagrammerView, IlvFacesDHTMLMapView, IlvFacesDHTMLOverview, IlvFacesDHTMLView, IlvFacesDiagrammerDataSource, IlvFacesDiagrammerSelectInteractor, IlvFacesDiagrammerSelectionManager, IlvFacesDiagrammerView, IlvFacesDiagrammerXMLDataSource, IlvFacesLayerVisibilityTool, IlvFacesMapInteractor, IlvFacesMapRectInteractor, IlvFacesMenu, IlvFacesNodeOrLinkSelectInteractor, IlvFacesNodeOrLinkSelectRectInteractor, IlvFacesObjectSelectInteractor, IlvFacesObjectSelectRectInteractor, IlvFacesPanInteractor, IlvFacesPanTool, IlvFacesSelectInteractor, IlvFacesSelectionManager, IlvFacesView, IlvFacesZoomInteractor, IlvFacesZoomTool, IlvImageButton, IlvInteractor, IlvMessageBox, IlvObjectSelectInteractor, IlvObjectSelectRectInteractor

public interface IlvFacesComponent
extends Serializable, IlvFacesConstants

This is the base interface of the JViews Faces components.

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
 void clearDecodedPropertyMap()
          Clears the decoded properties.
 boolean isDecodedProperty(String property)
          Returns true if the specified property was decoded during the "Apply Request Value" phase of the JSF lifecycle, false otherwise.
 void resetDecodedProperties()
          Resets the decoded properties of this component.
 void restoreState(FacesContext context, Object stateObj)
          Restores the state of this component from the state parameter.
 Object saveState(FacesContext context)
          Returns the state of this component.
 void setDecodedProperty(String property)
          Sets the property to decoded, which means that the property value was updated from the request during the "Apply Request Value" phase of the JSF life cycle.
 

Method Detail

isDecodedProperty

boolean isDecodedProperty(String property)
Returns true if the specified property was decoded during the "Apply Request Value" phase of the JSF lifecycle, false otherwise.

Parameters:
property - The property to test.
Returns:
true if the property was decoded, false otherwise.

setDecodedProperty

void setDecodedProperty(String property)
Sets the property to decoded, which means that the property value was updated from the request during the "Apply Request Value" phase of the JSF life cycle. This method must be called by renderers only during the execution of their decode method.

Parameters:
property - The property to set to decoded.

resetDecodedProperties

void resetDecodedProperties()
Resets the decoded properties of this component.


clearDecodedPropertyMap

void clearDecodedPropertyMap()
Clears the decoded properties.


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 stateObj)
Restores the state of this component from the state parameter.

Parameters:
context - The current faces context.
stateObj - The previously saved state of this component.


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