Klasse 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
- Alle implementierten Schnittstellen:
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.ClientBehaviorHolder
Renders a text
UIComponent class, generated from template
component.stg
with class
OutTagDeclaration
.-
Feldübersicht
FelderVon Klasse geerbte Felder jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungAutomatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.Defines the position and the appearance of a help message on a component.getLabel()
A localized user presentable label for this component.Defines the position of the label relative to the field.Defines the position and the appearance of additional faces messages (like error message or help message) on a component.Should HTML content sanitized?getTip()
Text value to display as tooltip.boolean
Veraltet.boolean
Veraltet.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
Activates formatting of the value with the method {
Default:false
boolean
isPlain()
Use with caution: Only for special cases!void
restoreState
(jakarta.faces.context.FacesContext context, Object state) void
setAutoSpacing
(Boolean autoSpacing) void
setCompact
(boolean compact) Veraltet.void
setCreateSpan
(boolean createSpan) Veraltet.void
setCustomClass
(CustomClass customClass) void
setEscape
(boolean escape) void
setHelpPosition
(DecorationPosition helpPosition) void
setKeepLineBreaks
(boolean keepLineBreaks) void
void
setLabelLayout
(LabelLayout labelLayout) void
void
setMessageFormat
(boolean messageFormat) void
setMessagePosition
(DecorationPosition messagePosition) void
setPlain
(boolean plain) void
setSanitize
(SanitizeMode sanitize) void
Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUIOut
isNextToRenderIsLabel, setNextToRenderIsLabel
Von Klasse geerbte Methoden jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue
Von Klasse geerbte Methoden 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
Von Klasse geerbte Methoden 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
Von Klasse geerbte Methoden java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Von Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual
getRendererType
-
Felddetails
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- Siehe auch:
-
-
Konstruktordetails
-
UIOut
public UIOut()
-
-
Methodendetails
-
getFamily
- Setzt außer Kraft:
getFamily
in Klassejakarta.faces.component.UIOutput
-
getMarkup
-
setMarkup
-
isCompact
Veraltet.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
- Angegeben von:
isCompact
in KlasseAbstractUIOut
-
setCompact
Veraltet. -
isMessageFormat
public boolean isMessageFormat()Activates formatting of the value with the method {
Default:false
- Angegeben von:
isMessageFormat
in KlasseAbstractUIOut
-
setMessageFormat
public void setMessageFormat(boolean messageFormat) -
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).- Angegeben von:
getLabelLayout
in SchnittstelleSupportsLabelLayout
-
setLabelLayout
- Angegeben von:
setLabelLayout
in SchnittstelleSupportsLabelLayout
-
getMessagePosition
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.- Angegeben von:
getMessagePosition
in SchnittstelleSupportsDecorationPosition
-
setMessagePosition
-
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- Angegeben von:
getAutoSpacing
in SchnittstelleSupportsAutoSpacing
-
setAutoSpacing
-
getHelpPosition
Defines the position and the appearance of a help message on a component. The default is popoverRight.- Angegeben von:
getHelpPosition
in SchnittstelleSupportsDecorationPosition
-
setHelpPosition
-
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.- Angegeben von:
getCustomClass
in SchnittstelleVisual
-
setCustomClass
- Angegeben von:
setCustomClass
in SchnittstelleVisual
-
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
- Angegeben von:
isKeepLineBreaks
in KlasseAbstractUIOut
-
setKeepLineBreaks
public void setKeepLineBreaks(boolean keepLineBreaks) -
getTip
Text value to display as tooltip. -
setTip
-
isCreateSpan
Veraltet.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
- Angegeben von:
isCreateSpan
in KlasseAbstractUIOut
-
setCreateSpan
Veraltet. -
isEscape
public boolean isEscape()Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
Default:true
- Angegeben von:
isEscape
in KlasseAbstractUIOut
-
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
- Angegeben von:
getSanitize
in KlasseAbstractUIOut
-
setSanitize
-
restoreState
- Angegeben von:
restoreState
in Schnittstellejakarta.faces.component.StateHolder
- Setzt außer Kraft:
restoreState
in Klassejakarta.faces.component.UIOutput
-