com.sun.webui.jsf.component
Class MessageGroup

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.MessageGroup
All Implemented Interfaces:
javax.faces.component.StateHolder

public class MessageGroup
extends javax.faces.component.UIComponentBase

The MessageGroup component is used to display a list of messages for the page and all its components.


Constructor Summary
MessageGroup()
          Default constructor.
 
Method Summary
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getStyle()
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getTitle()
          Sets the title of the message group.
 java.lang.String getToolTip()
          Sets the value of the title attribute for the HTML element.
 boolean isShowDetail()
          Set this attribute to true to display the detailed message.
 boolean isShowGlobalOnly()
          Use the showGlobalOnly attribute to display only those messages that are not associated with a component id.
 boolean isShowSummary()
          Set this attribute to true to display 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 setId(java.lang.String id)
          The component identifier for this component.
 void setRendered(boolean rendered)
          Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page.
 void setShowDetail(boolean showDetail)
          Set this attribute to true to display the detailed message.
 void setShowGlobalOnly(boolean showGlobalOnly)
          Use the showGlobalOnly attribute to display only those messages that are not associated with a component id.
 void setShowSummary(boolean showSummary)
          Set this attribute to true to display the summary message.
 void setStyle(java.lang.String style)
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 void setTitle(java.lang.String title)
          Sets the title of the message group.
 void setToolTip(java.lang.String toolTip)
          Sets the value of the title attribute for the HTML element.
 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
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageGroup

public MessageGroup()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public void setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

isShowDetail

public boolean isShowDetail()

Set this attribute to true to display the detailed message.


setShowDetail

public void setShowDetail(boolean showDetail)

Set this attribute to true to display the detailed message.

See Also:
isShowDetail()

isShowGlobalOnly

public boolean isShowGlobalOnly()

Use the showGlobalOnly attribute to display only those messages that are not associated with a component id. This attribute allows you to avoid showing a component error twice if you use webuijsf:message and webuijsf:messageGroup in the same page.


setShowGlobalOnly

public void setShowGlobalOnly(boolean showGlobalOnly)

Use the showGlobalOnly attribute to display only those messages that are not associated with a component id. This attribute allows you to avoid showing a component error twice if you use webuijsf:message and webuijsf:messageGroup in the same page.

See Also:
isShowGlobalOnly()

isShowSummary

public boolean isShowSummary()

Set this attribute to true to display the summary message.


setShowSummary

public void setShowSummary(boolean showSummary)

Set this attribute to true to display the summary message.

See Also:
isShowSummary()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getToolTip

public java.lang.String getToolTip()

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.


setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.

See Also:
getToolTip()

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()

getTitle

public java.lang.String getTitle()

Sets the title of the message group. If this attribute is not specified, the default title "System Messages" will be used.


setTitle

public void setTitle(java.lang.String title)

Sets the title of the message group. If this attribute is not specified, the default title "System Messages" will be used.

See Also:
getTitle()

restoreState

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

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

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

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.