HtmlOutputText (ICEfaces-EE ICE Components Java API Documentation)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UIOutput
    - - javax.faces.component.html.HtmlOutputText
      - com.icesoft.faces.component.ext.HtmlOutputText

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
```
public class HtmlOutputText
extends javax.faces.component.html.HtmlOutputText
```
This is an extension of javax.faces.component.html.HtmlOutputText, which provides some additional behavior to this component such as:
- changes the component's rendered state based on the authentication
- adds effects to the component

Nested Class Summary
- Nested classes/interfaces inherited from class javax.faces.component.html.HtmlOutputText
  javax.faces.component.html.HtmlOutputText.PropertyKeys

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COMPONENT_TYPE

static java.lang.String RENDERER_TYPE
- Fields inherited from class javax.faces.component.UIOutput
  COMPONENT_FAMILY
- Fields inherited from class javax.faces.component.UIComponent
  ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT_TYPE`
`static java.lang.String`	`RENDERER_TYPE`

Constructor Summary

Constructors
Constructor and Description

HtmlOutputText()

Constructors
Constructor and Description
`HtmlOutputText()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.icesoft.faces.context.effects.CurrentStyle`	`getCurrentStyle()` Return the value of the `currentStyle` property.
`java.lang.String`	`getDir()` Return the value of the `dir` property.
`com.icesoft.faces.context.effects.Effect`	`getEffect()` Return the value of the `effect` property.
`java.lang.String`	`getLang()` Return the value of the `lang` property.
`boolean`	`getNospan()` Return the value of the `nospan` property.
`com.icesoft.faces.context.effects.Effect`	`getOnchangeeffect()` Return the value of the `onchangeeffect` property.
`java.lang.String`	`getOnclick()` Return the value of the `onclick` property.
`com.icesoft.faces.context.effects.Effect`	`getOnclickeffect()` Return the value of the `onclickeffect` property.
`java.lang.String`	`getOndblclick()` Return the value of the `ondblclick` property.
`com.icesoft.faces.context.effects.Effect`	`getOndblclickeffect()` Return the value of the `ondblclickeffect` property.
`java.lang.String`	`getOnkeydown()` Return the value of the `onkeydown` property.
`com.icesoft.faces.context.effects.Effect`	`getOnkeydowneffect()` Return the value of the `onkeydowneffect` property.
`java.lang.String`	`getOnkeypress()` Return the value of the `onkeypress` property.
`com.icesoft.faces.context.effects.Effect`	`getOnkeypresseffect()` Return the value of the `onkeypresseffect` property.
`java.lang.String`	`getOnkeyup()` Return the value of the `onkeyup` property.
`com.icesoft.faces.context.effects.Effect`	`getOnkeyupeffect()` Return the value of the `onkeyupeffect` property.
`java.lang.String`	`getOnmousedown()` Return the value of the `onmousedown` property.
`com.icesoft.faces.context.effects.Effect`	`getOnmousedowneffect()` Return the value of the `onmousedowneffect` property.
`java.lang.String`	`getOnmousemove()` Return the value of the `onmousemove` property.
`com.icesoft.faces.context.effects.Effect`	`getOnmousemoveeffect()` Return the value of the `onmousemoveeffect` property.
`java.lang.String`	`getOnmouseout()` Return the value of the `onmouseout` property.
`com.icesoft.faces.context.effects.Effect`	`getOnmouseouteffect()` Return the value of the `onmouseouteffect` property.
`java.lang.String`	`getOnmouseover()` Return the value of the `onmouseover` property.
`com.icesoft.faces.context.effects.Effect`	`getOnmouseovereffect()` Return the value of the `onmouseovereffect` property.
`java.lang.String`	`getOnmouseup()` Return the value of the `onmouseup` property.
`com.icesoft.faces.context.effects.Effect`	`getOnmouseupeffect()` Return the value of the `onmouseupeffect` property.
`java.lang.String`	`getRenderedOnUserRole()` Return the value of the `renderedOnUserRole` property.
`java.lang.String`	`getStyleClass()` Return the value of the `styleClass` property.
`boolean`	`getVisible()` Return the value of the `visible` property.
`boolean`	`isRendered()` Return the value of the `rendered` property.
`void`	`restoreState(javax.faces.context.FacesContext context, java.lang.Object state)` Perform any processing required to restore the state from the entries in the state Object.
`java.lang.Object`	`saveState(javax.faces.context.FacesContext context)` Gets the state of the instance as a `Serializable` Object.
`void`	`setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle)` Set the value of the `currentStyle` property.
`void`	`setDir(java.lang.String dir)` Set the value of the `dir` property.
`void`	`setEffect(com.icesoft.faces.context.effects.Effect effect)` Set the value of the `effect` property.
`void`	`setLang(java.lang.String lang)` Set the value of the `lang` property.
`void`	`setNospan(boolean nospan)` Set the value of the `nospan` property.
`void`	`setOnchangeeffect(com.icesoft.faces.context.effects.Effect onchangeeffect)` Set the value of the `onchangeeffect` property.
`void`	`setOnclick(java.lang.String onclick)` Set the value of the `onclick` property.
`void`	`setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect)` Set the value of the `onclickeffect` property.
`void`	`setOndblclick(java.lang.String ondblclick)` Set the value of the `ondblclick` property.
`void`	`setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect)` Set the value of the `ondblclickeffect` property.
`void`	`setOnkeydown(java.lang.String onkeydown)` Set the value of the `onkeydown` property.
`void`	`setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect)` Set the value of the `onkeydowneffect` property.
`void`	`setOnkeypress(java.lang.String onkeypress)` Set the value of the `onkeypress` property.
`void`	`setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect)` Set the value of the `onkeypresseffect` property.
`void`	`setOnkeyup(java.lang.String onkeyup)` Set the value of the `onkeyup` property.
`void`	`setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect)` Set the value of the `onkeyupeffect` property.
`void`	`setOnmousedown(java.lang.String onmousedown)` Set the value of the `onmousedown` property.
`void`	`setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect)` Set the value of the `onmousedowneffect` property.
`void`	`setOnmousemove(java.lang.String onmousemove)` Set the value of the `onmousemove` property.
`void`	`setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect)` Set the value of the `onmousemoveeffect` property.
`void`	`setOnmouseout(java.lang.String onmouseout)` Set the value of the `onmouseout` property.
`void`	`setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect)` Set the value of the `onmouseouteffect` property.
`void`	`setOnmouseover(java.lang.String onmouseover)` Set the value of the `onmouseover` property.
`void`	`setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect)` Set the value of the `onmouseovereffect` property.
`void`	`setOnmouseup(java.lang.String onmouseup)` Set the value of the `onmouseup` property.
`void`	`setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect)` Set the value of the `onmouseupeffect` property.
`void`	`setRenderedOnUserRole(java.lang.String renderedOnUserRole)` Set the value of the `renderedOnUserRole` property.
`void`	`setStyleClass(java.lang.String styleClass)` Set the value of the `styleClass` property.
`void`	`setValueBinding(java.lang.String s, javax.faces.el.ValueBinding vb)`
`void`	`setVisible(boolean visible)` Set the value of the `visible` property.

Methods inherited from class javax.faces.component.html.HtmlOutputText
getStyle, getTitle, isEscape, setEscape, setStyle, setTitle

Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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
  - RENDERER_TYPE
```
public static final java.lang.String RENDERER_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HtmlOutputText
```
public HtmlOutputText()
```
- Method Detail
  - setValueBinding
```
public void setValueBinding(java.lang.String s,
                            javax.faces.el.ValueBinding vb)
```
    Overrides:
    
    setValueBinding in class javax.faces.component.UIComponentBase
  - setEffect
```
public void setEffect(com.icesoft.faces.context.effects.Effect effect)
```
    Set the value of the effect property.
  - getEffect
```
public com.icesoft.faces.context.effects.Effect getEffect()
```
    Return the value of the effect property.
  - setVisible
```
public void setVisible(boolean visible)
```
    Set the value of the visible property.
  - getVisible
```
public boolean getVisible()
```
    Return the value of the visible property.
  - setNospan
```
public void setNospan(boolean nospan)
```
    Set the value of the nospan property.
  - getNospan
```
public boolean getNospan()
```
    Return the value of the nospan property.
  - setRenderedOnUserRole
```
public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)
```
    Set the value of the renderedOnUserRole property.
  - getRenderedOnUserRole
```
public java.lang.String getRenderedOnUserRole()
```
    Return the value of the renderedOnUserRole property.
  - setStyleClass
```
public void setStyleClass(java.lang.String styleClass)
```
    Set the value of the styleClass property.
    
    Overrides:
    
    setStyleClass in class javax.faces.component.html.HtmlOutputText
  - getStyleClass
```
public java.lang.String getStyleClass()
```
    Return the value of the styleClass property.
    
    Overrides:
    
    getStyleClass in class javax.faces.component.html.HtmlOutputText
  - getOnclickeffect
```
public com.icesoft.faces.context.effects.Effect getOnclickeffect()
```
    Return the value of the onclickeffect property.
  - setOnclickeffect
```
public void setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect)
```
    Set the value of the onclickeffect property.
  - getOndblclickeffect
```
public com.icesoft.faces.context.effects.Effect getOndblclickeffect()
```
    Return the value of the ondblclickeffect property.
  - setOndblclickeffect
```
public void setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect)
```
    Set the value of the ondblclickeffect property.
  - getOnmousedowneffect
```
public com.icesoft.faces.context.effects.Effect getOnmousedowneffect()
```
    Return the value of the onmousedowneffect property.
  - setOnmousedowneffect
```
public void setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect)
```
    Set the value of the onmousedowneffect property.
  - getOnmouseupeffect
```
public com.icesoft.faces.context.effects.Effect getOnmouseupeffect()
```
    Return the value of the onmouseupeffect property.
  - setOnmouseupeffect
```
public void setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect)
```
    Set the value of the onmouseupeffect property.
  - getOnmousemoveeffect
```
public com.icesoft.faces.context.effects.Effect getOnmousemoveeffect()
```
    Return the value of the onmousemoveeffect property.
  - setOnmousemoveeffect
```
public void setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect)
```
    Set the value of the onmousemoveeffect property.
  - getOnmouseovereffect
```
public com.icesoft.faces.context.effects.Effect getOnmouseovereffect()
```
    Return the value of the onmouseovereffect property.
  - setOnmouseovereffect
```
public void setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect)
```
    Set the value of the onmouseovereffect property.
  - getOnmouseouteffect
```
public com.icesoft.faces.context.effects.Effect getOnmouseouteffect()
```
    Return the value of the onmouseouteffect property.
  - setOnmouseouteffect
```
public void setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect)
```
    Set the value of the onmouseouteffect property.
  - getOnchangeeffect
```
public com.icesoft.faces.context.effects.Effect getOnchangeeffect()
```
    Return the value of the onchangeeffect property.
  - setOnchangeeffect
```
public void setOnchangeeffect(com.icesoft.faces.context.effects.Effect onchangeeffect)
```
    Set the value of the onchangeeffect property.
  - getOnkeypresseffect
```
public com.icesoft.faces.context.effects.Effect getOnkeypresseffect()
```
    Return the value of the onkeypresseffect property.
  - setOnkeypresseffect
```
public void setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect)
```
    Set the value of the onkeypresseffect property.
  - getOnkeydowneffect
```
public com.icesoft.faces.context.effects.Effect getOnkeydowneffect()
```
    Return the value of the onkeydowneffect property.
  - setOnkeydowneffect
```
public void setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect)
```
    Set the value of the onkeydowneffect property.
  - getOnkeyupeffect
```
public com.icesoft.faces.context.effects.Effect getOnkeyupeffect()
```
    Return the value of the onkeyupeffect property.
  - setOnkeyupeffect
```
public void setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect)
```
    Set the value of the onkeyupeffect property.
  - getOnclick
```
public java.lang.String getOnclick()
```
    Return the value of the onclick property.
  - setOnclick
```
public void setOnclick(java.lang.String onclick)
```
    Set the value of the onclick property.
  - getOndblclick
```
public java.lang.String getOndblclick()
```
    Return the value of the ondblclick property.
  - setOndblclick
```
public void setOndblclick(java.lang.String ondblclick)
```
    Set the value of the ondblclick property.
  - getOnmousedown
```
public java.lang.String getOnmousedown()
```
    Return the value of the onmousedown property.
  - setOnmousedown
```
public void setOnmousedown(java.lang.String onmousedown)
```
    Set the value of the onmousedown property.
  - getOnmouseup
```
public java.lang.String getOnmouseup()
```
    Return the value of the onmouseup property.
  - setOnmouseup
```
public void setOnmouseup(java.lang.String onmouseup)
```
    Set the value of the onmouseup property.
  - getOnmousemove
```
public java.lang.String getOnmousemove()
```
    Return the value of the onmousemove property.
  - setOnmousemove
```
public void setOnmousemove(java.lang.String onmousemove)
```
    Set the value of the onmousemove property.
  - getOnmouseover
```
public java.lang.String getOnmouseover()
```
    Return the value of the onmouseover property.
  - setOnmouseover
```
public void setOnmouseover(java.lang.String onmouseover)
```
    Set the value of the onmouseover property.
  - getOnmouseout
```
public java.lang.String getOnmouseout()
```
    Return the value of the onmouseout property.
  - setOnmouseout
```
public void setOnmouseout(java.lang.String onmouseout)
```
    Set the value of the onmouseout property.
  - getOnkeypress
```
public java.lang.String getOnkeypress()
```
    Return the value of the onkeypress property.
  - setOnkeypress
```
public void setOnkeypress(java.lang.String onkeypress)
```
    Set the value of the onkeypress property.
  - getOnkeydown
```
public java.lang.String getOnkeydown()
```
    Return the value of the onkeydown property.
  - setOnkeydown
```
public void setOnkeydown(java.lang.String onkeydown)
```
    Set the value of the onkeydown property.
  - getOnkeyup
```
public java.lang.String getOnkeyup()
```
    Return the value of the onkeyup property.
  - setOnkeyup
```
public void setOnkeyup(java.lang.String onkeyup)
```
    Set the value of the onkeyup property.
  - isRendered
```
public boolean isRendered()
```
    Return the value of the rendered property.
    
    Overrides:
    
    isRendered in class javax.faces.component.UIComponentBase
  - getCurrentStyle
```
public com.icesoft.faces.context.effects.CurrentStyle getCurrentStyle()
```
    Return the value of the currentStyle property.
  - setCurrentStyle
```
public void setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle)
```
    Set the value of the currentStyle property.
  - saveState
```
public java.lang.Object saveState(javax.faces.context.FacesContext context)
```
    Gets the state of the instance as a Serializable Object.
    
    Specified by:
    
    saveState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    saveState in class javax.faces.component.UIOutput
  - restoreState
```
public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
```
    Perform any processing required to restore the state from the entries in the state Object.
    
    Specified by:
    
    restoreState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    restoreState in class javax.faces.component.UIOutput
  - getDir
```
public java.lang.String getDir()
```
    Return the value of the dir property. Contents:
    Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
    
    Overrides:
    
    getDir in class javax.faces.component.html.HtmlOutputText
  - setDir
```
public void setDir(java.lang.String dir)
```
    Set the value of the dir property.
    
    Overrides:
    
    setDir in class javax.faces.component.html.HtmlOutputText
  - getLang
```
public java.lang.String getLang()
```
    Return the value of the lang property. Contents:
    Code describing the language used in the generated markup for this component.
    
    Overrides:
    
    getLang in class javax.faces.component.html.HtmlOutputText
  - setLang
```
public void setLang(java.lang.String lang)
```
    Set the value of the lang property.
    
    Overrides:
    
    setLang in class javax.faces.component.html.HtmlOutputText

Class HtmlOutputText

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlOutputText

Field Summary

Fields inherited from class javax.faces.component.UIOutput

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.html.HtmlOutputText

Methods inherited from class javax.faces.component.UIOutput

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_TYPE

RENDERER_TYPE

Constructor Detail

HtmlOutputText

Method Detail

setValueBinding

setEffect

getEffect

setVisible

getVisible

setNospan

getNospan

setRenderedOnUserRole

getRenderedOnUserRole

setStyleClass

getStyleClass

getOnclickeffect

setOnclickeffect

getOndblclickeffect

setOndblclickeffect

getOnmousedowneffect

setOnmousedowneffect

getOnmouseupeffect

setOnmouseupeffect

getOnmousemoveeffect

setOnmousemoveeffect

getOnmouseovereffect

setOnmouseovereffect

getOnmouseouteffect

setOnmouseouteffect

getOnchangeeffect

setOnchangeeffect

getOnkeypresseffect

setOnkeypresseffect

getOnkeydowneffect

setOnkeydowneffect

getOnkeyupeffect

setOnkeyupeffect

getOnclick

setOnclick

getOndblclick

setOndblclick

getOnmousedown

setOnmousedown

getOnmouseup

setOnmouseup

getOnmousemove

setOnmousemove

getOnmouseover

setOnmouseover

getOnmouseout

setOnmouseout

getOnkeypress

setOnkeypress

getOnkeydown

setOnkeydown

getOnkeyup

setOnkeyup

isRendered

getCurrentStyle

setCurrentStyle

saveState

restoreState

getDir

setDir

getLang