com.icesoft.faces.component.ext

Class HtmlMessages

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIMessages

javax.faces.component.html.HtmlMessages

com.icesoft.faces.component.ext.HtmlMessages

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class HtmlMessages
extends javax.faces.component.html.HtmlMessages

This is an extension of javax.faces.component.html.HtmlMessages, 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.HtmlMessages

javax.faces.component.html.HtmlMessages.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.UIMessages

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

Constructor Summary

Constructors

Constructor and Description
HtmlMessages()

Method Summary

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	getErrorClass() Return the value of the errorClass property.
boolean	getEscape() Return the value of the escape property.
java.lang.String	getFatalClass() Return the value of the fataClass property.
java.lang.String	getInfoClass() Return the value of the infoClass property.
java.lang.String	getLang() Return the value of the lang 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.
java.lang.String	getWarnClass() Return the value of the warnClass 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	setErrorClass(java.lang.String errorClass) Set the value of the errorClass property.
void	setEscape(boolean escape) Set the value of the escape property.
void	setFatalClass(java.lang.String fatalClass) Set the value of the fataClass property.
void	setInfoClass(java.lang.String infoClass) Set the value of the infoClass property.
void	setLang(java.lang.String lang) Set the value of the lang 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.
void	setWarnClass(java.lang.String warnClass) Set the value of the warnClass property.

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

getErrorStyle, getFatalStyle, getInfoStyle, getLayout, getStyle, getTitle, getWarnStyle, isTooltip, setErrorStyle, setFatalStyle, setInfoStyle, setLayout, setStyle, setTitle, setTooltip, setWarnStyle

Methods inherited from class javax.faces.component.UIMessages

getFamily, getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, 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, markInitialState, 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

HtmlMessages

public HtmlMessages()

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.

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

getEscape

public boolean getEscape()

Return the value of the escape 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.

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.UIComponentBase

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.UIComponentBase

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Overrides:

setStyleClass in class javax.faces.component.html.HtmlMessages

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Overrides:

getStyleClass in class javax.faces.component.html.HtmlMessages

setErrorClass

public void setErrorClass(java.lang.String errorClass)

Set the value of the errorClass property.

Overrides:

setErrorClass in class javax.faces.component.html.HtmlMessages

getErrorClass

public java.lang.String getErrorClass()

Return the value of the errorClass property.

Overrides:

getErrorClass in class javax.faces.component.html.HtmlMessages

setFatalClass

public void setFatalClass(java.lang.String fatalClass)

Set the value of the fataClass property.

Overrides:

setFatalClass in class javax.faces.component.html.HtmlMessages

getFatalClass

public java.lang.String getFatalClass()

Return the value of the fataClass property.

Overrides:

getFatalClass in class javax.faces.component.html.HtmlMessages

setInfoClass

public void setInfoClass(java.lang.String infoClass)

Set the value of the infoClass property.

Overrides:

setInfoClass in class javax.faces.component.html.HtmlMessages

getInfoClass

public java.lang.String getInfoClass()

Return the value of the infoClass property.

Overrides:

getInfoClass in class javax.faces.component.html.HtmlMessages

setWarnClass

public void setWarnClass(java.lang.String warnClass)

Set the value of the warnClass property.

Overrides:

setWarnClass in class javax.faces.component.html.HtmlMessages

getWarnClass

public java.lang.String getWarnClass()

Return the value of the warnClass property.

Overrides:

getWarnClass in class javax.faces.component.html.HtmlMessages

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.HtmlMessages

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

Overrides:

setDir in class javax.faces.component.html.HtmlMessages

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.HtmlMessages

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

Overrides:

setLang in class javax.faces.component.html.HtmlMessages