IlvDHTMLDecoder (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.faces.dhtml.renderkit.IlvDHTMLDecoder

All Implemented Interfaces:

IlvFacesConstants
```
public class IlvDHTMLDecoder
extends Object
implements IlvFacesConstants
```
The IlvDHTMLDecoder class is a utility class used to update the JViews Faces components with the update data extracted from the request.
Each decodeXXXProperty looks for an available update for the specified property.
If any, the component property is updated and the property is marked "updated" to update a bound bean property, if any, during the update model phase of the life cycle.

Since:

JViews 6.5

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IlvDHTMLDecoder.ObjectDecoder` This simple interface defines a decoder that converts a String value that comes from the request to the correct property type.

Field Summary

Fields
Modifier and Type Field and Description

javax.faces.component.UIComponent component
The component which is being decoded.
- 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

Fields
Modifier and Type	Field and Description
`javax.faces.component.UIComponent`	`component` The component which is being decoded.

Constructor Summary

Constructors
Constructor and Description

IlvDHTMLDecoder(HashMap parameterMap, javax.faces.component.UIComponent component)
Builds a new IlvDecoder object.

Constructors
Constructor and Description
`IlvDHTMLDecoder(HashMap parameterMap, javax.faces.component.UIComponent component)` Builds a new `IlvDecoder` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decodeBooleanProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeByteProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeCharProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeClassNameOrValueBindingRef(String refPropertyId, String classPropertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeColorProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeDependencyProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeDoubleArrayProperty(String propertyId)` Decodes a property of type array that contains doubles.
`void`	`decodeDoubleProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeGenericProperty(String propertyId, IlvDHTMLDecoder.ObjectDecoder decoder)` Decodes the update data from the request URL for a specified property.
`void`	`decodeIntegerProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeLongProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeMethodBindingProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeShortProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeStringArrayProperty(String propertyId)` Decodes a property of type array that contains strings.
`void`	`decodeStringMapProperty(String propertyId)` Decodes a property of type map for which keys and values are `String`.
`void`	`decodeStringProperty(String propertyId)` Decodes the update data from the request URL for a specified property.
`void`	`decodeValueBindingRef(String propertyId)` Decodes the update data from the request URL for a specified property.
`String`	`getUpdateData(String propertyId)` Returns the property update data for this component property from the client request without any processing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - component
```
public javax.faces.component.UIComponent component
```
    The component which is being decoded.
- Constructor Detail
  - IlvDHTMLDecoder
```
public IlvDHTMLDecoder(HashMap parameterMap,
                       javax.faces.component.UIComponent component)
```
    Builds a new IlvDecoder object.
    
    Parameters:
    
    parameterMap - The parameter map of the decoded properties of the current component. Can be obtained by getParameterMap(context, component) in the decode method of the renderer.
    
    component - The component to update with the update data extracted from the request.
- Method Detail
  - getUpdateData
```
public String getUpdateData(String propertyId)
```
    Returns the property update data for this component property from the client request without any processing.
    
    Parameters:
    
    propertyId - The ID of the property.
    
    Returns:
    
    The update data received from the client for this property.
  - decodeProperty
```
public void decodeProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeGenericProperty
```
public void decodeGenericProperty(String propertyId,
                                  IlvDHTMLDecoder.ObjectDecoder decoder)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any. This method use the ObjectDecoder instance to decode the update data.
    
    Parameters:
    
    propertyId - The ID of the property.
    
    decoder - The object decoder that converts the update data to the new property value.
  - decodeStringArrayProperty
```
public void decodeStringArrayProperty(String propertyId)
```
    Decodes a property of type array that contains strings.
    
    Parameters:
    
    propertyId - The ID of the property to decode.
    
    Since:
    
    JViews 8.0
  - decodeStringMapProperty
```
public void decodeStringMapProperty(String propertyId)
```
    Decodes a property of type map for which keys and values are String.
    
    Parameters:
    
    propertyId - The ID of the property to decode.
    
    Since:
    
    JViews 8.0
  - decodeStringProperty
```
public void decodeStringProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeDoubleArrayProperty
```
public void decodeDoubleArrayProperty(String propertyId)
```
    Decodes a property of type array that contains doubles.
    
    Parameters:
    
    propertyId - The ID of the property to decode.
    
    Since:
    
    JViews 8.0
  - decodeDoubleProperty
```
public void decodeDoubleProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeIntegerProperty
```
public void decodeIntegerProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeBooleanProperty
```
public void decodeBooleanProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeLongProperty
```
public void decodeLongProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeShortProperty
```
public void decodeShortProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeByteProperty
```
public void decodeByteProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeCharProperty
```
public void decodeCharProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeDependencyProperty
```
public void decodeDependencyProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeColorProperty
```
public void decodeColorProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property. If there's some update data for this property, the property is marked "decoded" to update a bound bean property, if any.
    
    Parameters:
    
    propertyId - The ID of the property.
  - decodeMethodBindingProperty
```
public void decodeMethodBindingProperty(String propertyId)
```
    Decodes the update data from the request URL for a specified property.
    The decoded data is expected to be a method binding. If this is the case, a method binding is registered on the property.
    
    Parameters:
    
    propertyId - The ID of the property to decode.
    
    Since:
    
    JViews 7.5
  - decodeClassNameOrValueBindingRef
```
public void decodeClassNameOrValueBindingRef(String refPropertyId,
                                             String classPropertyId)
```
    Decodes the update data from the request URL for a specified property.
    If the decoded data is a value binding expression, a value binding object will create from this expression a set to the refPropertyId property.
    Otherwise the decode value will be set to the classPropertyId property.
    
    Parameters:
    
    refPropertyId - The ID of the reference property.
    
    classPropertyId - The ID of the class name property.
    
    Since:
    
    JViews 7.5
  - decodeValueBindingRef
```
public void decodeValueBindingRef(String propertyId)
```
    Decodes the update data from the request URL for a specified property.
    If the decoded data is a value binding expression, a value binding object will create from this expression a set to the refPropertyId property.
    Otherwise the decode value will be set to the classPropertyId property.
    
    Parameters:
    
    propertyId - The ID of the property to decode.
    
    Since:
    
    JViews 7.5

Class IlvDHTMLDecoder

Nested Class Summary

Field Summary

Fields inherited from interface ilog.views.faces.IlvFacesConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

component

Constructor Detail

IlvDHTMLDecoder

Method Detail

getUpdateData

decodeProperty

decodeGenericProperty

decodeStringArrayProperty

decodeStringMapProperty

decodeStringProperty

decodeDoubleArrayProperty

decodeDoubleProperty

decodeIntegerProperty

decodeBooleanProperty

decodeLongProperty

decodeShortProperty

decodeByteProperty

decodeCharProperty

decodeDependencyProperty

decodeColorProperty

decodeMethodBindingProperty

decodeClassNameOrValueBindingRef

decodeValueBindingRef