ReadableIdProcessor (Metawidget API Documentation)

java.lang.Object
- org.metawidget.faces.component.widgetprocessor.ReadableIdProcessor

All Implemented Interfaces:

Immutable, AdvancedWidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>, WidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>
```
public class ReadableIdProcessor
extends Object
implements AdvancedWidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>
```
WidgetProcessor to set 'human readable' ids on a UIComponent.
Unlike UIViewRoot.createUniqueId, tries to make the id human readable, both for debugging purposes and for when running unit tests (using, say, WebTest). Because the ids are based off the value binding (or method binding) of the UIComponent, this WidgetProcessor must come after StandardBindingProcessor (or equivalent).
Clients can plug in a different WidgetProcessor to use UIViewRoot.createUniqueId if preferred. They can even plug in assigning a changing, random id to a component each time it is generated. This is a great way to fox hackers who are trying to POST back pre-generated payloads of HTTP fields (ie. CSRF attacks).

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

ReadableIdProcessor()

Constructors
Constructor and Description
`ReadableIdProcessor()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`onEndBuild(UIMetawidget metawidget)` Event called at the end of widget building, after all widgets have been built and added to the `Layout`.
`void`	`onStartBuild(UIMetawidget metawidget)` Event called at the start of the widget building process, before the `WidgetBuilder` is called.
`javax.faces.component.UIComponent`	`processWidget(javax.faces.component.UIComponent component, String elementName, Map<String,String> attributes, UIMetawidget metawidget)` Process the given widget.
`protected void`	`setUniqueId(String id, javax.faces.component.UIComponent component, UIMetawidget metawidget)`
`protected void`	`setUniqueId(javax.faces.component.UIComponent component, String expressionString, UIMetawidget metawidget)`

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

- Constructor Detail
  - ReadableIdProcessor
```
public ReadableIdProcessor()
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(UIMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the start of the widget building process, before the WidgetBuilder is called. WidgetProcessors may wish to act on this event to initialize themselves ready for processing. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onStartBuild in interface AdvancedWidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - processWidget
```
public javax.faces.component.UIComponent processWidget(javax.faces.component.UIComponent component,
                                              String elementName,
                                              Map<String,String> attributes,
                                              UIMetawidget metawidget)
```
    Description copied from interface: WidgetProcessor
    
    Process the given widget. Called after a widget has been built by the WidgetBuilder, and before it is added to the Layout.
    
    Specified by:
    
    processWidget in interface WidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>
    
    Parameters:
    component - the widget to process. Never null
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
    attributes - attributes of the widget to process. Never null. This Map is modifiable - changes will be passed to subsequent WidgetProcessors and Layouts
    metawidget - the parent Metawidget. Never null
    
    Returns:
    generally the original widget (as passed in to the first argument). Can be a different widget if the WidgetProcessor wishes to substitute the original widget for another. Can be null if the WidgetProcessor wishes to cancel all further processing of this widget (including laying out)
  - onEndBuild
```
public void onEndBuild(UIMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the end of widget building, after all widgets have been built and added to the Layout. WidgetProcessors may wish to act on this event to clean themselves up after processing. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onEndBuild in interface AdvancedWidgetProcessor<javax.faces.component.UIComponent,UIMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - setUniqueId
```
protected void setUniqueId(javax.faces.component.UIComponent component,
               String expressionString,
               UIMetawidget metawidget)
```
  - setUniqueId
```
protected void setUniqueId(String id,
               javax.faces.component.UIComponent component,
               UIMetawidget metawidget)
```

Class ReadableIdProcessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadableIdProcessor

Method Detail

onStartBuild

processWidget

onEndBuild

setUniqueId

setUniqueId