WriteComponent (Struts 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 WriteComponent

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

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

    public class WriteComponent

extends javax.faces.component.UIOutput

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

Field Summary

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

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

Method Summary
`String` | `getFamily()` Return the component family to which this component belongs.
`String` | `getStyle()` Return the CSS style(s) to be rendered for this component.
`String` | `getStyleClass()` Return the CSS style class(es) to be rendered for this component.
`boolean` | `isFilter()` Return a flag indicating whether filtering should take place.
`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` | `setFilter(boolean filter)` Set the flag indicating that the output value should be filtered.
`void` | `setStyle(String style)` Set the CSS style(s) to be rendered for this component.
`void` | `setStyleClass(String styleClass)` Set the CSS style class(es) to be rendered for this component.

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

### WriteComponent

    public WriteComponent()

  Create a new `WriteComponent` 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`

### isFilter

    public boolean isFilter()

  Return a flag indicating whether filtering should take place.

### setFilter

    public void setFilter(boolean filter)

  Set the flag indicating that the output value should be filtered.

  Parameters:
    `filter` - The new filter flag

### getStyle

    public String getStyle()

  Return the CSS style(s) to be rendered for this component.

### setStyle

    public void setStyle(String style)

  Set the CSS style(s) to be rendered for this component.

  Parameters:
    `style` - The new CSS style(s)

### getStyleClass

    public String getStyleClass()

  Return the CSS style class(es) to be rendered for this component.

### setStyleClass

    public void setStyleClass(String styleClass)

  Set the CSS style class(es) to be rendered for this component.

  Parameters:
    `styleClass` - The new CSS style class(es)

### 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.