com.sun.rave.web.ui.component
Class MessageBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.sun.rave.web.ui.component.MessageBase

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

Message

public abstract class MessageBase

extends javax.faces.component.UIComponentBase

Use the ui:message tag to display message associated with a component.

HTML Elements and Layout

A message consists of a summary and a detailed text.

Client Side Javascript Functions

none.

Examples

Example 1: An example showing how to display validation errors:

<ui:staticText text="Validator checks that the value is between 0-10 inclusive. />
<ui:message for="form1:textTest1"/>

<ui:field id="textTest1" label="Enter a number:" text="#{FieldTest.number}" validator="#{FieldTest.checkNumber}"/>


Auto-generated component class. Do NOT modify; all changes will be lost!

Constructor Summary

MessageBase()
Construct a new MessageBase.

Method Summary

java.lang.String	getAlt() Alternative text description used by screen reader tools
java.lang.String	getFamily() Return the family for this component.
java.lang.String	getFor() Identifier of the component this message is associated with.
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
int	getTabIndex() The position of this component in the tabbing order sequence
boolean	isShowDetail() Flag to determine whether to show the detail message.
boolean	isShowSummary() Flag to determine whether to show the summary message.
boolean	isVisible() Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.
void	setAlt(java.lang.String alt) Alternative text description used by screen reader tools
void	setFor(java.lang.String _for) Identifier of the component this message is associated with.
void	setShowDetail(boolean showDetail) Flag to determine whether to show the detail message.
void	setShowSummary(boolean showSummary) Flag to determine whether to show the summary message.
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setTabIndex(int tabIndex) The position of this component in the tabbing order sequence
void	setVisible(boolean visible) Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageBase

public MessageBase()

Construct a new MessageBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getAlt

public java.lang.String getAlt()

Alternative text description used by screen reader tools

setAlt

public void setAlt(java.lang.String alt)

Alternative text description used by screen reader tools

See Also:

getAlt()

getFor

public java.lang.String getFor()

Identifier of the component this message is associated with.

setFor

public void setFor(java.lang.String _for)

Identifier of the component this message is associated with.

See Also:

getFor()

isShowDetail

public boolean isShowDetail()

Flag to determine whether to show the detail message.

setShowDetail

public void setShowDetail(boolean showDetail)

Flag to determine whether to show the detail message.

See Also:

isShowDetail()

isShowSummary

public boolean isShowSummary()

Flag to determine whether to show the summary message.

setShowSummary

public void setShowSummary(boolean showSummary)

Flag to determine whether to show the summary message.

See Also:

isShowSummary()

getStyle

public java.lang.String getStyle()

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

setStyle

public void setStyle(java.lang.String style)

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

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getTabIndex

public int getTabIndex()

The position of this component in the tabbing order sequence

setTabIndex

public void setTabIndex(int tabIndex)

The position of this component in the tabbing order sequence

See Also:

getTabIndex()

isVisible

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

setVisible

public void setVisible(boolean visible)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

See Also:

isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.