Class UIOut
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
org.apache.myfaces.tobago.internal.component.AbstractUIOut
org.apache.myfaces.tobago.component.UIOut
- All Implemented Interfaces:
EventListener
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.TransientStateHolder
,javax.faces.component.ValueHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,SupportsAutoSpacing
,SupportsLabelLayout
,Visual
@Generated("component.stg")
public class UIOut
extends AbstractUIOut
implements javax.faces.component.behavior.ClientBehaviorHolder
Renders a text
UIComponent class, generated from template
component.stg
with class
OutTagDeclaration
.-
Field Summary
FieldsFields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAutomatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.getLabel()
A localized user presentable label for this component.Defines the position of the label relative to the field.Should HTML content sanitized?getTip()
Text value to display as tooltip.boolean
Deprecated.boolean
Deprecated.boolean
isEscape()
Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.boolean
Flag indicating that new-line characters will be converted to HTML <br>.boolean
isPlain()
Use with caution: Only for special cases!void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setAutoSpacing
(Boolean autoSpacing) void
setCompact
(boolean compact) Deprecated.void
setCreateSpan
(boolean createSpan) Deprecated.void
setCustomClass
(CustomClass customClass) void
setEscape
(boolean escape) void
setKeepLineBreaks
(boolean keepLineBreaks) void
void
setLabelLayout
(LabelLayout labelLayout) void
void
setPlain
(boolean plain) void
setSanitize
(SanitizeMode sanitize) void
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIOut
isNextToRenderIsLabel, setNextToRenderIsLabel
Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIOut
public UIOut()
-
-
Method Details
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UIOutput
-
getMarkup
-
setMarkup
-
isCompact
Deprecated.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.
Default:false
- Specified by:
isCompact
in classAbstractUIOut
-
setCompact
Deprecated. -
getLabelLayout
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).- Specified by:
getLabelLayout
in interfaceSupportsLabelLayout
-
setLabelLayout
- Specified by:
setLabelLayout
in interfaceSupportsLabelLayout
-
getLabel
A localized user presentable label for this component. -
setLabel
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet- Specified by:
getAutoSpacing
in interfaceSupportsAutoSpacing
-
setAutoSpacing
-
isPlain
public boolean isPlain()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.
Default:false
-
setPlain
public void setPlain(boolean plain) -
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>
One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Specified by:
getCustomClass
in interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
isKeepLineBreaks
public boolean isKeepLineBreaks()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".
Default:true
- Specified by:
isKeepLineBreaks
in classAbstractUIOut
-
setKeepLineBreaks
public void setKeepLineBreaks(boolean keepLineBreaks) -
getTip
Text value to display as tooltip. -
setTip
-
isCreateSpan
Deprecated.Indicates that the renderer should create an element in the output language (e. g. an span or div tag around the output text). Use true, if you enable the possibility to apply styles to the output. Use false, if you want to keep the code small (especially inside of sheets).
Default:true
- Specified by:
isCreateSpan
in classAbstractUIOut
-
setCreateSpan
Deprecated. -
isEscape
public boolean isEscape()Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
Default:true
- Specified by:
isEscape
in classAbstractUIOut
-
setEscape
public void setEscape(boolean escape) -
getSanitize
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,
Default:auto
Allowed Values:auto,never
- Specified by:
getSanitize
in classAbstractUIOut
-
setSanitize
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIOutput
-