out (Tobago Core VDL Documentation)

All Tags

Description:
Renders a text
UIComponentClass: org.apache.myfaces.tobago.component.UIOut
RendererType:
- Out (default)
- OutInsideBoxLabel
- OutInsideIn
- OutInsideSectionLabel

Component Information
Info	Value
Component Type	`org.apache.myfaces.tobago.Out`
Handler Class	`org.apache.myfaces.tobago.facelets.TobagoComponentHandler`
Renderer Type	`Out`
Description	None

Attributes
Name	Required	Type	Description
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean. For Facelets, the component is the outer UIPanel, not the input control. Type: `javax.faces.component.UIComponent`
`compact`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	** @deprecated. Will be removed in a future version ** since 4.3.0. Use attribute 'plain' instead. This attribute is useful if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output. Type: `boolean` Default: `false`
`converter`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`)	An expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression. Type: `javax.faces.convert.Converter`
`escape`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Type: `boolean` Default: `true`
`id`	`false`	`java.lang.String`	The component identifier for this component. This value must be unique within the closest parent component that is a naming container. Type: `java.lang.String`
`keepLineBreaks`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that new-line characters will be converted to HTML <br>. This is useful for pre-formatted plain text. This has only an effect, with escape="true". Type: `boolean` Default: `true`
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized user presentable label for this component. Type: `java.lang.String`
`labelLayout`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.component.LabelLayout`)	Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags). Type: `org.apache.myfaces.tobago.component.LabelLayout`
`markup`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.context.Markup`)	Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer. Type: `org.apache.myfaces.tobago.context.Markup`
`plain`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Use with caution: Only for special cases! This attribute is useful for tc:out if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output. For tc:form there will no div tag be rendered. So, the content can be used freely from layout managers. But, no AJAX is possible for components with "plain" set, because there is no client element with an "id" in the DOM. Type: `boolean` Default: `false`
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. Type: `boolean` Default: `true`
`sanitize`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.sanitizer.SanitizeMode`)	Should HTML content sanitized? The effect of sanitizing depends on the configuration. The value "auto" means, that sanitizing take place for tc:out when escape="false" or tc:textarea when attribute data-html-editor is set, because that are the critical parts. Type: `org.apache.myfaces.tobago.sanitizer.SanitizeMode` Default: `auto` Allowed Values: `[auto, never]`
`tip`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text value to display as tooltip. Type: `java.lang.String`
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The current value of this component. Type: `java.lang.Object`

All Tags

Output generated by Vdldoc View Declaration Language Documentation Generator.