com.ibm.xsp.component.xp
Class XspOutputText

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by com.ibm.xsp.component.UIOutputEx
                  extended by com.ibm.xsp.component.UIOutputText
                      extended by com.ibm.xsp.component.xp.XspOutputText
All Implemented Interfaces:
FacesComponent, FacesOutputFiltering, ThemeControl, javax.faces.component.StateHolder, javax.faces.component.ValueHolder
Direct Known Subclasses:
UIViewColumnText

public class XspOutputText
extends UIOutputText

A control that displays a read-only field that outputs the result of an expression.

XPages Core Controls - Computed Field


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
XspOutputText()
           
 
Method Summary
 java.lang.String getContentType()
           Return the value of the contentType property.
 java.lang.String getDir()
           Return the value of the dir property.
 java.lang.String getHtmlFilter()
           Return the value of the htmlFilter property.
 java.lang.String getLang()
           Return the value of the lang property.
 java.lang.String getOuterStyleClass()
           Return the value of the outerStyleClass property.
 java.lang.String getRole()
           Return the value of the role property.
 java.lang.String getStyle()
           Return the value of the style property.
 java.lang.String getStyleClass()
           Return the value of the styleClass property.
 java.lang.String getTagName()
           Return the value of the tagName property.
 java.lang.String getTitle()
           Return the value of the title property.
 boolean isEscape()
           Return the value of the escape property.
 boolean isPreventBlank()
           Return the value of the preventBlank property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setContentType(java.lang.String contentType)
           Set the value of the contentType property.
 void setDir(java.lang.String dir)
           Set the value of the dir property.
 void setEscape(boolean escape)
           Set the value of the escape property.
 void setHtmlFilter(java.lang.String htmlFilter)
           Set the value of the htmlFilter property.
 void setLang(java.lang.String lang)
           Set the value of the lang property.
 void setOuterStyleClass(java.lang.String outerStyleClass)
           Set the value of the outerStyleClass property.
 void setPreventBlank(boolean preventBlank)
           Set the value of the preventBlank property.
 void setRole(java.lang.String role)
           Set the value of the role property.
 void setStyle(java.lang.String style)
           Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
           Set the value of the styleClass property.
 void setTagName(java.lang.String tagName)
           Set the value of the tagName property.
 void setTitle(java.lang.String title)
           Set the value of the title property.
 
Methods inherited from class com.ibm.xsp.component.UIOutputText
buildContents, getFor, getStyleKitFamily, initAfterContents, initBeforeContents, setFor
 
Methods inherited from class com.ibm.xsp.component.UIOutputEx
getDefaultHtmlFilter, getHtmlFilterName
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getFamily, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

XspOutputText

public XspOutputText()
Method Detail

getContentType

public java.lang.String getContentType()

Return the value of the contentType property. Contents:

Specifies the type of content to expect. HTML and Text are supported. Text is the default.


getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).


getHtmlFilter

public java.lang.String getHtmlFilter()

Return the value of the htmlFilter property. Contents:

Indicates which Active Content Filtering processor to use.

Overrides:
getHtmlFilter in class UIOutputEx

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.


getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.


getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.


getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.


getTagName

public java.lang.String getTagName()

Return the value of the tagName property. Contents:

Markup tag that should be generated by the control, instead of the default tag.


getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.


isEscape

public boolean isEscape()

Return the value of the escape property. Contents:

Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.


isPreventBlank

public boolean isPreventBlank()

Return the value of the preventBlank property. Contents:

Specifies if the rendered output is allowed to render nothing. If the value on this control is empty or null, it will insert a non-breaking space, which is useful for tables.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIOutputText

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIOutputText

setContentType

public void setContentType(java.lang.String contentType)

Set the value of the contentType property.


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


setEscape

public void setEscape(boolean escape)

Set the value of the escape property.


setHtmlFilter

public void setHtmlFilter(java.lang.String htmlFilter)

Set the value of the htmlFilter property.


setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.


setPreventBlank

public void setPreventBlank(boolean preventBlank)

Set the value of the preventBlank property.


setRole

public void setRole(java.lang.String role)

Set the value of the role property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


setTagName

public void setTagName(java.lang.String tagName)

Set the value of the tagName property.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.