HtmlComponent (Struts Faces 1.3.10 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.faces.component
Class HtmlComponent

    java.lang.Object
      javax.faces.component.UIComponent
          javax.faces.component.UIComponentBase
              javax.faces.component.UIOutput
                  org.apache.struts.faces.component.HtmlComponent

All Implemented Interfaces:
  javax.faces.component.StateHolder, javax.faces.component.ValueHolder

    public class HtmlComponent

extends javax.faces.component.UIOutput

Custom component that replaces the Struts `<html:html>` tag.

Field Summary

Fields inherited from class javax.faces.component.UIOutput
`COMPONENT_FAMILY, COMPONENT_TYPE`

Constructor Summary
`HtmlComponent()` Create a new `HtmlComponent` with default properties.

Method Summary
`String` | `getFamily()` Return the component family to which this component belongs.
`boolean` | `isLocale()` Return a flag indicating whether a locale should be created.
`boolean` | `isXhtml()` Return a flag indicating whether xhtml should be created.
`void` | `restoreState(javax.faces.context.FacesContext context, Object state)` Restore the state of this component.
`Object` | `saveState(javax.faces.context.FacesContext context)` Save the state of this component.
`void` | `setLocale(boolean locale)` Set the flag indicating whether a locale should be created.
`void` | `setXhtml(boolean xhtml)` Set the flag indicating whether xhtml should be created.

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

Methods inherited from class javax.faces.component.UIComponentBase
`addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding`

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

Constructor Detail

### HtmlComponent

    public HtmlComponent()

  Create a new `HtmlComponent` with default properties.

Method Detail

### getFamily

    public String getFamily()

  Return the component family to which this component belongs.

  Overrides:
    `getFamily` in class `javax.faces.component.UIOutput`

### isLocale

    public boolean isLocale()

  Return a flag indicating whether a locale should be created.

### setLocale

    public void setLocale(boolean locale)

  Set the flag indicating whether a locale should be created.

  Parameters:
    `locale` - The new flag

### isXhtml

    public boolean isXhtml()

  Return a flag indicating whether xhtml should be created.

### setXhtml

    public void setXhtml(boolean xhtml)

  Set the flag indicating whether xhtml should be created.

  Parameters:
    `xhtml` - The new flag

### restoreState

    public void restoreState(javax.faces.context.FacesContext context,
                             Object state)

  Restore the state of this component.

  Specified by:
    `restoreState` in interface `javax.faces.component.StateHolder`
  Overrides:
    `restoreState` in class `javax.faces.component.UIOutput`
  Parameters:
    `context` - `FacesContext` for the current request
    `state` - State object from which to restore our state

### saveState

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

  Save the state of this component.

  Specified by:
    `saveState` in interface `javax.faces.component.StateHolder`
  Overrides:
    `saveState` in class `javax.faces.component.UIOutput`
  Parameters:
    `context` - `FacesContext` for the current request

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.