HtmlOutputFormat (Java EE 5)

表示查找资源包中已本地化消息的组件，可选择将其用作 MessageFormat 模式字符串，并用来自嵌入 UIParameter 组件的参数值替换，然后呈现结果。如果存在 "dir" 或 "lang" 属性，则呈现 span 元素，并将其作为 span 中的属性传递。

默认情况下，rendererType 属性必须设置为 "javax.faces.Format"。可以调用 setRendererType() 方法更改此值。

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.

英文文档：

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

public HtmlOutputFormat()

英文文档：

HtmlOutputFormat

public HtmlOutputFormat()

public String getDir()

返回 dir 属性的值。

内容：未继承方向性的文本的方向指示。有效值有 "LTR"（left-to-right，从左到右）和 "RTL"（right-to-left，从右到左）。

英文文档：

getDir

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

public void setDir(String dir)

设置 dir 属性的值。

英文文档：

setDir

public void setDir(String dir)

Set the value of the dir property.

public boolean isEscape()

返回 escape 属性的值。

内容：指示在 HTML 和 XML 标记中敏感的字符必须被转义的标志。默认情况下此标志设置为 "true"。

英文文档：

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.

public void setEscape(boolean escape)

设置 escape 属性的值。

英文文档：

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

public String getLang()

返回 lang 属性的值。

内容：描述为此组件生成的标记中所用语言的代码。

英文文档：

getLang

public String getLang()

Return the value of the lang property.

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

public void setLang(String lang)

设置 lang 属性的值。

英文文档：

setLang

public void setLang(String lang)

Set the value of the lang property.

public String getStyle()

返回 style 属性的值。

内容：呈现此组件时应用的 CSS 样式。

英文文档：

getStyle

public String getStyle()

Return the value of the style property.

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

public void setStyle(String style)

设置 style 属性的值。

英文文档：

setStyle

public void setStyle(String style)

Set the value of the style property.

public String getStyleClass()

返回 styleClass 属性的值。

内容：呈现此元素时应用的以空格分隔的 CSS 样式类列表。此值必须作为生成标记上的 "class" 属性传递。

英文文档：

getStyleClass

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

public void setStyleClass(String styleClass)

设置 styleClass 属性的值。

英文文档：

setStyleClass

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

public String getTitle()

返回 title 属性的值。

内容：关于为此组件生成的标记元素的建议性标题信息。

英文文档：

getTitle

public String getTitle()

Return the value of the title property.

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

public void setTitle(String title)

设置 title 属性的值。

英文文档：

setTitle

public void setTitle(String title)

Set the value of the title property.

public Object saveState(FacesContext _context)

英文文档：

saveState

public 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

public void restoreState(FacesContext _context,
                         Object _state)