@Generated(value="component.stg") public class UIOut extends AbstractUIOut implements javax.faces.component.behavior.ClientBehaviorHolder
component.stg with class
OutTagDeclaration.| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
| Constructor and Description |
|---|
UIOut() |
| Modifier and Type | Method and Description |
|---|---|
CustomClass |
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.
|
String |
getFamily() |
String |
getLabel()
A localized user presentable label for this component.
|
LabelLayout |
getLabelLayout()
Defines the position of the label relative to the field.
|
Markup |
getMarkup() |
SanitizeMode |
getSanitize()
Should HTML content sanitized?
|
String |
getTip()
Text value to display as tooltip.
|
boolean |
isCompact()
Deprecated.
|
boolean |
isCreateSpan()
Deprecated.
|
boolean |
isEscape()
Flag indicating that characters that are
sensitive in HTML and XML markup must be escaped.
|
boolean |
isKeepLineBreaks()
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 |
setCompact(boolean compact)
Deprecated.
|
void |
setCreateSpan(boolean createSpan)
Deprecated.
|
void |
setCustomClass(CustomClass customClass) |
void |
setEscape(boolean escape) |
void |
setKeepLineBreaks(boolean keepLineBreaks) |
void |
setLabel(String label) |
void |
setLabelLayout(LabelLayout labelLayout) |
void |
setMarkup(Markup markup) |
void |
setPlain(boolean plain) |
void |
setSanitize(SanitizeMode sanitize) |
void |
setTip(String tip) |
isLabelLayoutSkipclearInitialState, getConverter, getLocalValue, getValue, markInitialState, saveState, setConverter, setValueaddClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreegetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesgetRendererTypepublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UIOutput@Deprecated public boolean isCompact()
falseisCompact in class AbstractUIOut@Deprecated public void setCompact(boolean compact)
public LabelLayout getLabelLayout()
getLabelLayout in interface SupportsLabelLayoutpublic void setLabelLayout(LabelLayout labelLayout)
setLabelLayout in interface SupportsLabelLayoutpublic String getLabel()
public void setLabel(String label)
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.
falsepublic void setPlain(boolean plain)
public CustomClass getCustomClass()
<tc:in>
<tc:style customClass="my-emphasized"/>
</tc:in>
One capability is, to used external CSS libs.
getCustomClass in interface Visualpublic void setCustomClass(CustomClass customClass)
setCustomClass in interface Visualpublic boolean isKeepLineBreaks()
trueisKeepLineBreaks in class AbstractUIOutpublic void setKeepLineBreaks(boolean keepLineBreaks)
public String getTip()
public void setTip(String tip)
@Deprecated public boolean isCreateSpan()
trueisCreateSpan in class AbstractUIOut@Deprecated public void setCreateSpan(boolean createSpan)
public boolean isEscape()
trueisEscape in class AbstractUIOutpublic void setEscape(boolean escape)
public SanitizeMode getSanitize()
autoauto,nevergetSanitize in class AbstractUIOutpublic void setSanitize(SanitizeMode sanitize)
public void restoreState(javax.faces.context.FacesContext context,
Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIOutputCopyright © 2002–2022 The Apache Software Foundation. All rights reserved.