javax.faces.component.html: public class: HtmlOutputFormat

javax.faces.component.html
public class: HtmlOutputFormat [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIOutput
            javax.faces.component.html.HtmlOutputFormat

All Implemented Interfaces:
ValueHolder, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

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.

Nested Class Summary:
protected enum class	HtmlOutputFormat.PropertyKeys

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.

Fields inherited from javax.faces.component.UIOutput:
COMPONENT_TYPE, COMPONENT_FAMILY

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public HtmlOutputFormat() { super(); setRendererType("javax.faces.Format"); }

Method from javax.faces.component.html.HtmlOutputFormat Summary:
getDir, getLang, getStyle, getStyleClass, getTitle, isEscape, setDir, setEscape, setLang, setStyle, setStyleClass, setTitle

Methods from javax.faces.component.UIOutput:
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

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

Method from javax.faces.component.html.HtmlOutputFormat Detail:
public String getDir() { return (java.lang.String) getStateHelper().eval(PropertyKeys.dir); } 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).
public String getLang() { return (java.lang.String) getStateHelper().eval(PropertyKeys.lang); } Return the value of the `lang` property. Contents: Code describing the language used in the generated markup for this component.
public String getStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.style); } Return the value of the `style` property. Contents: CSS style(s) to be applied when this component is rendered.
public String getStyleClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass); } 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.
public String getTitle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.title); } Return the value of the `title` property. Contents: Advisory title information about markup elements generated for this component.
public boolean isEscape() { return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.escape, true); } 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.
public void setDir(String dir) { getStateHelper().put(PropertyKeys.dir, dir); handleAttribute("dir", dir); } Set the value of the `dir` property.
public void setEscape(boolean escape) { getStateHelper().put(PropertyKeys.escape, escape); } Set the value of the `escape` property.
public void setLang(String lang) { getStateHelper().put(PropertyKeys.lang, lang); handleAttribute("lang", lang); } Set the value of the `lang` property.
public void setStyle(String style) { getStateHelper().put(PropertyKeys.style, style); handleAttribute("style", style); } Set the value of the `style` property.
public void setStyleClass(String styleClass) { getStateHelper().put(PropertyKeys.styleClass, styleClass); } Set the value of the `styleClass` property.
public void setTitle(String title) { getStateHelper().put(PropertyKeys.title, title); handleAttribute("title", title); } Set the value of the `title` property.

Method from javax.faces.component.html.HtmlOutputFormat Detail:

 public String getDir() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.dir);
}

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

 public String getLang() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.lang);
}

Return the value of the lang property.

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

 public String getStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.style);
}

Return the value of the style property.

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

 public String getStyleClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass);
}

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.

 public String getTitle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.title);
}

Return the value of the title property.

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

 public boolean isEscape() {
        return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.escape, true);
}

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.

 public  void setDir(String dir) {
        getStateHelper().put(PropertyKeys.dir, dir);
        handleAttribute("dir", dir);
}

Set the value of the dir property.

 public  void setEscape(boolean escape) {
        getStateHelper().put(PropertyKeys.escape, escape);
}

Set the value of the escape property.

 public  void setLang(String lang) {
        getStateHelper().put(PropertyKeys.lang, lang);
        handleAttribute("lang", lang);
}

Set the value of the lang property.

 public  void setStyle(String style) {
        getStateHelper().put(PropertyKeys.style, style);
        handleAttribute("style", style);
}

Set the value of the style property.

 public  void setStyleClass(String styleClass) {
        getStateHelper().put(PropertyKeys.styleClass, styleClass);
}

Set the value of the styleClass property.

 public  void setTitle(String title) {
        getStateHelper().put(PropertyKeys.title, title);
        handleAttribute("title", title);
}

Set the value of the title property.