ilog.views.faces.component

Class IlvFacesComponentImpl

java.lang.Object

ilog.views.faces.component.IlvFacesComponentImpl

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, Serializable

public class IlvFacesComponentImpl
extends Object
implements IlvFacesComponent

The IlvFacesComponentImpl, implements the IlvFacesComponent interface and specifically manages the decoded state of the properties and the rendering state of the component.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

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

Constructor and Description
IlvFacesComponentImpl() Creates a new IlvFacesComponentImpl instance.

Method Summary

Modifier and Type	Method and Description
void	clearDecodedPropertyMap() Empties the decoded properties maps.
Map	getAttributes(jakarta.faces.component.UIComponent component) Return a mutable Map representing the attributes (and properties, see below) associated with this UIComponent, keyed by attribute name (which must be a String).
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(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(jakarta.faces.context.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 lifecycle.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesComponentImpl

public IlvFacesComponentImpl()

Creates a new IlvFacesComponentImpl instance.

Method Detail

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.

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 lifecycle. 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 as 'decoded'.

resetDecodedProperties

public void resetDecodedProperties()

Resets the decoded properties of this component.

Specified by:

resetDecodedProperties in interface IlvFacesComponent

clearDecodedPropertyMap

public void clearDecodedPropertyMap()

Empties the decoded properties maps.

Specified by:

clearDecodedPropertyMap in interface IlvFacesComponent

getAttributes

public Map getAttributes(jakarta.faces.component.UIComponent component)

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.

Since:

JViews 8.1

saveState

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

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Parameters:

context - The current faces context.

Returns:

the state of this component.

restoreState

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

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvFacesComponent

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.