org.apache.myfaces.tobago.component

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.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportsLabelLayout, Visual

public class UIOut
extends AbstractUIOut
implements Visual

Renders a text UIComponent class, generated from template component.stg with class OutTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UIOut()

Method Summary

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?
Style	getStyle() For internal use.
String	getTip() Text value to display as tooltip.
boolean	isCreateSpan() Indicates that the renderer should create an element in the output language (e. g. an span or div tag around the output text).
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>.
void	setCreateSpan(boolean createSpan)
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	setSanitize(SanitizeMode sanitize)
void	setStyle(Style style)
void	setTip(String tip)

Methods inherited from class javax.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, 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, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 org.apache.myfaces.tobago.component.Visual

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIOut

public UIOut()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

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.

Specified by:

getLabelLayout in interface SupportsLabelLayout

setLabelLayout

public void setLabelLayout(LabelLayout labelLayout)

Specified by:

setLabelLayout in interface SupportsLabelLayout

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:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

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 class AbstractUIOut

setKeepLineBreaks

public void setKeepLineBreaks(boolean keepLineBreaks)

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

isCreateSpan

public boolean isCreateSpan()

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 class AbstractUIOut

setCreateSpan

public void setCreateSpan(boolean createSpan)

getLabel

public String getLabel()

A localized user presentable label for this component.

setLabel

public void setLabel(String label)

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 class AbstractUIOut

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:textarea when attribute data-html-editor is set,

because that are the critical parts.
Default: auto
Allowed Values: auto,never

Specified by:

getSanitize in class AbstractUIOut

setSanitize

public void setSanitize(SanitizeMode sanitize)