PrimeFacesWidgetBuilder (Metawidget API Documentation)

java.lang.Object
- org.metawidget.faces.component.html.widgetbuilder.HtmlWidgetBuilder
- - org.metawidget.faces.component.html.widgetbuilder.primefaces.PrimeFacesWidgetBuilder

All Implemented Interfaces:

Immutable, WidgetBuilder<javax.faces.component.UIComponent,UIMetawidget>
```
public class PrimeFacesWidgetBuilder
extends HtmlWidgetBuilder
```
WidgetBuilder for PrimeFaces environments.
Creates native PrimeFaces UIComponents, such as HtmlCalendar and HtmlInputNumberSlider, to suit the inspected fields.
As an implementation detail, PrimeFacesWidgetBuilder extends HtmlWidgetBuilder, which is a little unusual for a widget builder (they normally implement WidgetBuilder directly), but we want to reuse a lot of HtmlWidgetBuilder's secondary methods. Note that whilst we extend HtmlWidgetBuilder we only create PrimeFaces components, not any regular JSF components.

Author:

Richard Kennard, Marcel H

Field Summary
- Fields inherited from class org.metawidget.faces.component.html.widgetbuilder.HtmlWidgetBuilder
  DATATABLE_ROW_ACTION

Constructor Summary

Constructors
Constructor and Description

PrimeFacesWidgetBuilder()

PrimeFacesWidgetBuilder(PrimeFacesWidgetBuilderConfig config)

Constructors
Constructor and Description
`PrimeFacesWidgetBuilder()`
`PrimeFacesWidgetBuilder(PrimeFacesWidgetBuilderConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.faces.component.UIComponent`	`buildWidget(String elementName, Map<String,String> attributes, UIMetawidget metawidget)` Purely creates the widget.
`protected void`	`configureDataTableComponent(javax.faces.component.UIData uiData)`
`protected javax.faces.component.UIColumn`	`createColumnComponent()` Create a UIColumn component.
`protected javax.faces.component.html.HtmlCommandLink`	`createCommandLinkComponent()` Create a HtmlCommandLink component.
`protected javax.faces.component.UIData`	`createDataTableComponent()` Create a UIData component.
`protected int`	`getMaximumColumnsInDataTable()`
`protected void`	`setMaximumLength(javax.faces.component.UIComponent component, Map<String,String> attributes)`

Methods inherited from class org.metawidget.faces.component.html.widgetbuilder.HtmlWidgetBuilder
addColumnComponent, addColumnComponents, createDataTableComponent, initFacesSelect, initStaticSelect

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

- Constructor Detail
  - PrimeFacesWidgetBuilder
```
public PrimeFacesWidgetBuilder()
```
  - PrimeFacesWidgetBuilder
```
public PrimeFacesWidgetBuilder(PrimeFacesWidgetBuilderConfig config)
```
- Method Detail
  - buildWidget
```
public javax.faces.component.UIComponent buildWidget(String elementName,
                                            Map<String,String> attributes,
                                            UIMetawidget metawidget)
```
    Description copied from class: HtmlWidgetBuilder
    
    Purely creates the widget. Does not concern itself with the widget's id, value binding or preparing metadata for the renderer.
    
    Specified by:
    
    buildWidget in interface WidgetBuilder<javax.faces.component.UIComponent,UIMetawidget>
    
    Overrides:
    
    buildWidget in class HtmlWidgetBuilder
    
    Parameters:
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
    attributes - attributes of the business field to build a widget for. Never null. This Map is modifiable - changes will be passed to subsequent WidgetBuilders, WidgetProcessors and Layouts
    metawidget - the parent Metawidget. Never null
    
    Returns:
    the widget to use in non-read-only scenarios
  - setMaximumLength
```
protected void setMaximumLength(javax.faces.component.UIComponent component,
                    Map<String,String> attributes)
```
    Overrides:
    
    setMaximumLength in class HtmlWidgetBuilder
  - configureDataTableComponent
```
protected void configureDataTableComponent(javax.faces.component.UIData uiData)
```
    Overrides:
    
    configureDataTableComponent in class HtmlWidgetBuilder
  - createColumnComponent
```
protected javax.faces.component.UIColumn createColumnComponent()
```
    Description copied from class: HtmlWidgetBuilder
    
    Create a UIColumn component.
    
    Overrides:
    
    createColumnComponent in class HtmlWidgetBuilder
  - createDataTableComponent
```
protected javax.faces.component.UIData createDataTableComponent()
```
    Description copied from class: HtmlWidgetBuilder
    
    Create a UIData component.
    
    Overrides:
    
    createDataTableComponent in class HtmlWidgetBuilder
  - createCommandLinkComponent
```
protected javax.faces.component.html.HtmlCommandLink createCommandLinkComponent()
```
    Description copied from class: HtmlWidgetBuilder
    
    Create a HtmlCommandLink component.
    
    Overrides:
    
    createCommandLinkComponent in class HtmlWidgetBuilder
  - getMaximumColumnsInDataTable
```
protected int getMaximumColumnsInDataTable()
```
    Overrides:
    
    getMaximumColumnsInDataTable in class HtmlWidgetBuilder

Class PrimeFacesWidgetBuilder

Field Summary

Fields inherited from class org.metawidget.faces.component.html.widgetbuilder.HtmlWidgetBuilder

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.faces.component.html.widgetbuilder.HtmlWidgetBuilder

Methods inherited from class java.lang.Object

Constructor Detail

PrimeFacesWidgetBuilder

PrimeFacesWidgetBuilder

Method Detail

buildWidget

setMaximumLength

configureDataTableComponent

createColumnComponent

createDataTableComponent

createCommandLinkComponent

getMaximumColumnsInDataTable