ilog.views.faces.component

Class IlvFacesComponentBase

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

All Implemented Interfaces:

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

Direct Known Subclasses:

IltFacesDataSource, IlvFacesDataSource, IlvFacesDiagrammerDataSource, IlvFacesGanttDataSource, IlvFacesJDBCMapping, IlvFacesLayerVisibilityTool, IlvFacesSelectionManager, IlvInteractor

public abstract class IlvFacesComponentBase
extends jakarta.faces.component.UIComponentBase
implements IlvFacesComponent

This class is a base class for a JViews Faces component. It extends UIComponentBase. If you want to extend from another JavaServer Faces base class, you have to implement the IlvFacesComponent interface. An IlvFacesComponentImpl utility class implements the methods defined by this interface.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.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

Modifier	Constructor and Description
protected	IlvFacesComponentBase() Creates a new IlvFacesComponentBase instance.

Method Summary

Modifier and Type	Method and Description
void	clearDecodedPropertyMap() Clears the decoded properties.
protected IlvFacesComponent	createFacesComponent() Creates the IlvFacesComponent implementation.
Map	getAttributes() Return a mutable Map representing the attributes (and properties, see below) associated with this UIComponent, keyed by attribute name (which must be a String).
String	getClientId(jakarta.faces.context.FacesContext context)
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	processUpdates(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.
void	resetDecodedProperties() Resets the decoded properties of this component.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(jakarta.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
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.
void	updateModel(jakarta.faces.context.FacesContext facesContext) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class jakarta.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 jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFamily, 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

IlvFacesComponentBase

protected IlvFacesComponentBase()

Creates a new IlvFacesComponentBase instance.

Method Detail

createFacesComponent

protected IlvFacesComponent createFacesComponent()

Creates the IlvFacesComponent implementation. By default, it returns an instance of IlvFacesComponentImpl.

Returns:

The IlvFacesComponent implementation.

getAttributes

public Map getAttributes()

Return a mutable Map representing the attributes (and properties, see below) associated with this UIComponent, keyed by attribute name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements:

• The Map implementation must implement the java.io.Serializable interface.
• Any attempt to add a null key or value must throw a NullPointerException.
• Any attempt to add a key that is not a String must throw a ClassCastException.
• If the attribute name specified as a key matches a property of this UIComponent's implementation class, the following methods will have special behavior:
  • containsKey - Return false.
  • get() - If the property is readable, call the getter method and return the returned value (wrapping primitive values in their corresponding wrapper classes); otherwise throw IllegalArgumentException.
  • put() - If the property is writable, call the setter method to set the corresponding value (unwrapping primitive values in their corresponding wrapper classes). If the property is not writeable, or an attempt is made to set a property of primitive type to null, throw IllegalArgumentException.
  • remove - Throw IllegalArgumentException.

Overrides:

getAttributes in class jakarta.faces.component.UIComponentBase

Since:

JViews 8.1

isDecodedProperty

public boolean isDecodedProperty(String property)

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

Specified by:

isDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to test.

Returns:

true if the property was decoded, false otherwise.

resetDecodedProperties

public void resetDecodedProperties()

Resets the decoded properties of this component.

Specified by:

resetDecodedProperties in interface IlvFacesComponent

setDecodedProperty

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

Specified by:

setDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to set to decoded.

clearDecodedPropertyMap

public void clearDecodedPropertyMap()

Clears the decoded properties.

Specified by:

clearDecodedPropertyMap in interface IlvFacesComponent

processUpdates

public void processUpdates(jakarta.faces.context.FacesContext context)

Handles the "Update Model Values" phase of the JSF life cycle.

Overrides:

processUpdates in class jakarta.faces.component.UIComponentBase

updateModel

public void updateModel(jakarta.faces.context.FacesContext facesContext)

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.

Parameters:

facesContext - The current faces context.

saveState

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

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets.

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class jakarta.faces.component.UIComponentBase

Parameters:

context - The current faces context.

Returns:

The state of this component.

Throws:

NullPointerException - if context is null

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class jakarta.faces.component.UIComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.

Throws:

NullPointerException - if either context or state are null

getClientId

public String getClientId(jakarta.faces.context.FacesContext context)

Overrides:

getClientId in class jakarta.faces.component.UIComponentBase