public abstract class IlvFacesComponentBase extends javax.faces.component.UIComponentBase implements IlvFacesComponent
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.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
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
Modifier | Constructor and Description |
---|---|
protected |
IlvFacesComponentBase()
Creates a new
IlvFacesComponentBase instance. |
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(javax.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(javax.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(javax.faces.context.FacesContext context,
Object stateObj)
Perform any processing required to restore the state from the
entries in the state Object.
|
Object |
saveState(javax.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(javax.faces.context.FacesContext facesContext)
Handles the "Update Model Values" phase of the JSF life cycle.
|
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
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
protected IlvFacesComponentBase()
IlvFacesComponentBase
instance.protected IlvFacesComponent createFacesComponent()
IlvFacesComponent
implementation. By default, it returns an instance
of IlvFacesComponentImpl
.IlvFacesComponent
implementation.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:
Map
implementation must implement
the java.io.Serializable
interface.null
key or value must
throw a NullPointerException
.ClassCastException
.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
.getAttributes
in class javax.faces.component.UIComponentBase
public boolean isDecodedProperty(String property)
true
if the specified property was decoded during the "Apply
Request Value" phase of the JSF lifecycle, false
otherwise.isDecodedProperty
in interface IlvFacesComponent
property
- The property to test.true
if the property was decoded, false
otherwise.public void resetDecodedProperties()
resetDecodedProperties
in interface IlvFacesComponent
public void setDecodedProperty(String property)
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.setDecodedProperty
in interface IlvFacesComponent
property
- The property to set to decoded
.public void clearDecodedPropertyMap()
clearDecodedPropertyMap
in interface IlvFacesComponent
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIComponentBase
public void updateModel(javax.faces.context.FacesContext facesContext)
facesContext
- The current faces context.public Object saveState(javax.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(javax.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
saveState
in interface IlvFacesComponent
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
context
- The current faces context.NullPointerException
- if context
is nullpublic void restoreState(javax.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(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface IlvFacesComponent
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
context
- The current faces context.stateObj
- The previously saved state of this component.NullPointerException
- if either context
or
state
are null
public String getClientId(javax.faces.context.FacesContext context)
getClientId
in class javax.faces.component.UIComponentBase
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.