Class UIOut
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
-
- org.apache.myfaces.tobago.internal.component.AbstractUIOut
-
- org.apache.myfaces.tobago.component.UIOut
-
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder,jakarta.faces.component.PartialStateHolder,jakarta.faces.component.StateHolder,jakarta.faces.component.TransientStateHolder,jakarta.faces.component.ValueHolder,jakarta.faces.event.ComponentSystemEventListener,jakarta.faces.event.FacesListener,jakarta.faces.event.SystemEventListenerHolder,EventListener,SupportsAutoSpacing,SupportsDecorationPosition,SupportsLabelLayout,Visual
@Generated("component.stg") public class UIOut extends AbstractUIOut implements jakarta.faces.component.behavior.ClientBehaviorHolderRenders a text UIComponent class, generated from templatecomponent.stgwith classOutTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIOut()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BooleangetAutoSpacing()Automatically add spacing (margins/paddings) to the component for better positioning.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()DecorationPositiongetHelpPosition()Defines the position and the appearance of a help message on a component.StringgetLabel()A localized user presentable label for this component.LabelLayoutgetLabelLayout()Defines the position of the label relative to the field.MarkupgetMarkup()DecorationPositiongetMessagePosition()Defines the position and the appearance of additional faces messages (like error message or help message) on a component.SanitizeModegetSanitize()Should HTML content sanitized?StringgetTip()Text value to display as tooltip.booleanisCompact()Deprecated.booleanisCreateSpan()Deprecated.booleanisEscape()Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.booleanisKeepLineBreaks()Flag indicating that new-line characters will be converted to HTML <br>.booleanisMessageFormat()Activates formatting of the value with the method {
Default:falsebooleanisPlain()Use with caution: Only for special cases!voidrestoreState(jakarta.faces.context.FacesContext context, Object state)voidsetAutoSpacing(Boolean autoSpacing)voidsetCompact(boolean compact)Deprecated.voidsetCreateSpan(boolean createSpan)Deprecated.voidsetCustomClass(CustomClass customClass)voidsetEscape(boolean escape)voidsetHelpPosition(DecorationPosition helpPosition)voidsetKeepLineBreaks(boolean keepLineBreaks)voidsetLabel(String label)voidsetLabelLayout(LabelLayout labelLayout)voidsetMarkup(Markup markup)voidsetMessageFormat(boolean messageFormat)voidsetMessagePosition(DecorationPosition messagePosition)voidsetPlain(boolean plain)voidsetSanitize(SanitizeMode sanitize)voidsetTip(String tip)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIOut
isNextToRenderIsLabel, setNextToRenderIsLabel
-
Methods inherited from class jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue
-
Methods inherited from class jakarta.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, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
-
Methods inherited from class jakarta.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 jakarta.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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjakarta.faces.component.UIOutput
-
isCompact
@Deprecated public boolean 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:
isCompactin classAbstractUIOut
-
setCompact
@Deprecated public void setCompact(boolean compact)
Deprecated.
-
isMessageFormat
public boolean isMessageFormat()
Activates formatting of the value with the method {
Default:false- Specified by:
isMessageFormatin classAbstractUIOut
-
setMessageFormat
public void setMessageFormat(boolean messageFormat)
-
getLabelLayout
public LabelLayout 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:
getLabelLayoutin interfaceSupportsLabelLayout
-
setLabelLayout
public void setLabelLayout(LabelLayout labelLayout)
- Specified by:
setLabelLayoutin interfaceSupportsLabelLayout
-
getMessagePosition
public DecorationPosition getMessagePosition()
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.- Specified by:
getMessagePositionin interfaceSupportsDecorationPosition
-
setMessagePosition
public void setMessagePosition(DecorationPosition messagePosition)
-
getLabel
public String getLabel()
A localized user presentable label for this component.
-
setLabel
public void setLabel(String label)
-
getAutoSpacing
public Boolean 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:
getAutoSpacingin interfaceSupportsAutoSpacing
-
setAutoSpacing
public void setAutoSpacing(Boolean autoSpacing)
-
getHelpPosition
public DecorationPosition getHelpPosition()
Defines the position and the appearance of a help message on a component. The default is popoverRight.- Specified by:
getHelpPositionin interfaceSupportsDecorationPosition
-
setHelpPosition
public void setHelpPosition(DecorationPosition helpPosition)
-
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
public CustomClass 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:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin 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:
isKeepLineBreaksin classAbstractUIOut
-
setKeepLineBreaks
public void setKeepLineBreaks(boolean keepLineBreaks)
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
isCreateSpan
@Deprecated public boolean 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:
isCreateSpanin classAbstractUIOut
-
setCreateSpan
@Deprecated public void setCreateSpan(boolean createSpan)
Deprecated.
-
isEscape
public boolean isEscape()
Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
Default:true- Specified by:
isEscapein classAbstractUIOut
-
setEscape
public void setEscape(boolean escape)
-
getSanitize
public SanitizeMode 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:popover when escape="false" or
- tc:textarea when attribute data-html-editor is set,
Default:auto
Allowed Values:auto,never- Specified by:
getSanitizein classAbstractUIOut
-
setSanitize
public void setSanitize(SanitizeMode sanitize)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIOutput
-
-