javax.faces.component.html
Class HtmlOutputFormat

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.html.HtmlOutputFormat
All Implemented Interfaces:
StateHolder, ValueHolder

public class HtmlOutputFormat
extends UIOutput

Represents a component that looks up a localized message in a resource bundle, optionally uses it as a MessageFormat pattern string and substitutes in parameter values from nested UIParameter components, and renders the result. If the "dir" or "lang" attributes are present, render a span element and pass them through as attributes on the span.

By default, the rendererType property must be set to "javax.faces.Format". This value can be changed by calling the setRendererType() method.


Field Summary
static java.lang.String COMPONENT_TYPE
          The standard component type for this component.
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Constructor Summary
HtmlOutputFormat()
           
 
Method Summary
 java.lang.String getDir()
          Return the value of the dir property.
 java.lang.String getLang()
          Return the value of the lang property.
 java.lang.String getStyle()
          Return the value of the style property.
 java.lang.String getStyleClass()
          Return the value of the styleClass property.
 java.lang.String getTitle()
          Return the value of the title property.
 boolean isEscape()
          Return the value of the escape property.
 void restoreState(FacesContext _context, java.lang.Object _state)
           Perform any processing required to restore the state from the entries in the state Object.
 java.lang.Object saveState(FacesContext _context)
           Gets the state of the instance as a Serializable Object.
 void setDir(java.lang.String dir)
          Set the value of the dir property.
 void setEscape(boolean escape)
          Set the value of the escape property.
 void setLang(java.lang.String lang)
          Set the value of the lang property.
 void setStyle(java.lang.String style)
          Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
          Set the value of the styleClass property.
 void setTitle(java.lang.String title)
          Set the value of the title property.
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getFamily, 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, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:
Constant Field Values
Constructor Detail

HtmlOutputFormat

public HtmlOutputFormat()
Method Detail

getDir

public java.lang.String getDir()

Return the value of the dir property.

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


isEscape

public boolean isEscape()

Return the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.


setEscape

public void setEscape(boolean escape)

Set the value of the escape property.


getLang

public java.lang.String getLang()

Return the value of the lang property.

Contents: Code describing the language used in the generated markup for this component.


setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: CSS style(s) to be applied when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


getTitle

public java.lang.String getTitle()

Return the value of the title property.

Contents: Advisory title information about markup elements generated for this component.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.


saveState

public java.lang.Object saveState(FacesContext _context)
Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIOutput

restoreState

public void restoreState(FacesContext _context,
                         java.lang.Object _state)
Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIOutput


Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved.