HtmlMetawidget (Metawidget API Documentation)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UIOutput
    - - javax.faces.component.UIInput
      - org.metawidget.faces.component.UIMetawidget
        
        org.metawidget.faces.component.html.HtmlMetawidget

All Implemented Interfaces:

EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
```
public class HtmlMetawidget
extends UIMetawidget
```
Metawidget for Java Server Faces environments.

Author:

Richard Kennard

Nested Class Summary
- Nested classes/interfaces inherited from class org.metawidget.faces.component.UIMetawidget
  UIMetawidget.Pipeline

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_TYPE
- Fields inherited from class org.metawidget.faces.component.UIMetawidget
  COMPONENT_ATTRIBUTE_METADATA, COMPONENT_ATTRIBUTE_NOT_RECREATABLE, COMPONENT_ATTRIBUTE_SECTION_DECORATOR
- Fields inherited from class javax.faces.component.UIInput
  CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
- Fields inherited from class javax.faces.component.UIComponent
  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

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

HtmlMetawidget()

Constructors
Constructor and Description
`HtmlMetawidget()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getComponentType()` Get the component type used to create this Metawidget.
`protected String`	`getDefaultConfiguration()`
`String`	`getStyle()`
`String`	`getStyleClass()`
`void`	`initNestedMetawidget(UIMetawidget metawidget, Map<String,String> attributes)` Overridden to carry CSS style attributes into the nested Metawidget.
`void`	`restoreState(javax.faces.context.FacesContext context, Object state)`
`Object`	`saveState(javax.faces.context.FacesContext context)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`

Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

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

Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter

- Field Detail
  - COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HtmlMetawidget
```
public HtmlMetawidget()
```
- Method Detail
  - getStyle
```
public String getStyle()
```
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getComponentType
```
public String getComponentType()
```
    Description copied from class: UIMetawidget
    
    Get the component type used to create this Metawidget.
    Usually, clients will want to create a nested-Metawidget using the same subclass as themselves. To be 'proper' in JSF, though, we should go via application.createComponent. Unfortunately by default a UIComponent does not know its own component type, so subclasses must override this method.
    This method is public for use by NestedLayoutDecorators.
    
    Specified by:
    
    getComponentType in class UIMetawidget
  - saveState
```
public Object saveState(javax.faces.context.FacesContext context)
```
    Specified by:
    
    saveState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    saveState in class UIMetawidget
  - restoreState
```
public void restoreState(javax.faces.context.FacesContext context,
                Object state)
```
    Specified by:
    
    restoreState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    restoreState in class UIMetawidget
  - getDefaultConfiguration
```
protected String getDefaultConfiguration()
```
    Specified by:
    
    getDefaultConfiguration in class UIMetawidget
  - initNestedMetawidget
```
public void initNestedMetawidget(UIMetawidget metawidget,
                        Map<String,String> attributes)
```
    Overridden to carry CSS style attributes into the nested Metawidget.
    
    Overrides:
    
    initNestedMetawidget in class UIMetawidget

Class HtmlMetawidget

Nested Class Summary

Nested classes/interfaces inherited from class org.metawidget.faces.component.UIMetawidget

Field Summary

Fields inherited from class org.metawidget.faces.component.UIMetawidget

Fields inherited from class javax.faces.component.UIInput

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.faces.component.UIMetawidget

Methods inherited from class javax.faces.component.UIInput

Methods inherited from class javax.faces.component.UIOutput

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.ValueHolder

Field Detail

COMPONENT_TYPE

Constructor Detail

HtmlMetawidget

Method Detail

getStyle

setStyle

getStyleClass

setStyleClass

getComponentType

saveState

restoreState

getDefaultConfiguration

initNestedMetawidget