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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

PageAlert

public abstract class PageAlertBase

extends javax.faces.component.UIComponentBase

Use the ui:pageAlert tag to display a full page alert. A page alert differs from the inline alert (see ui:alert) in that the content of the page that invokes the pageAlert is replaced by the alert page. An inline alert is a smaller alert that is inserted in the page that invokes the alert.

HTML Elements and Layout

A page alert consists of:

• an icon depicting the type of alert - question, information, warning, or error
• a page title next to the icon
• a summary message
• a detailed message
• one input component - (one text field, one text area, one checkbox, one set of radio buttons, one drop-down menu, or one scrolling list)
• a page separator line
  
• a set of page level buttons

The input field and the set of buttons are optional items, which must be specified with facets.

The following diagram shows the locations of each of the page alert areas, and the facets that are supported for specified areas.

Alert Icon (or optional pageAlertImage facet), Page Title Text (or optional pageAlertTitle facet)

Alert summary

Detailed message

Optional pageAlertInput facet

Page separator (or optional pageAlertSeparator facet)

Optional pageAlertButtons facet

Facets

The ui:pageAlert tag supports the following facets.

pageAlertTitle	Specifies a custom component to use to display the title of the alert.
pageAlertInput	Specifies a component to use in the body of the full page alert. This facet can be used to display an input component for the user to perform tasks related to the alert, for example.
pageAlertButtons	Specifies components to use for the buttons at the bottom of the alert page. This facet can be used to display a back button, for example. If you want to specify more than one button, you might find it helpful to enclose the button components in a ui:panelGroup component.
pageAlertSeparator	Specifies a component to use for the page separator that is displayed above the page buttons. The component included in this facet replaces the default page separator.
pageAlertImage	Specifies a component to use to display the alert icon. The component included in this facet replaces the default icon.

Client Side Javascript Functions

None.

Examples

Example 1: Simple example, with alert message and a back button.

	<ui:pageAlert id="pagealert" title="Error!" type="error"
            summary="Server Not Responding." 
            detail="The server jurassic is not responding. Verify that the power cable is connected.">
	  <f:facet name="pageAlertButtons">
              <ui:button text="Back" action="indexPage" />
	</ui:pageAlert>

Example 2: With input field and one page button.

	<ui:pageAlert id="pagealert" title="Password Expired!" type="warning"
            summary="Password expired." 
            detail="Your password has expired. Enter a new password">
	  <f:facet name="pageAlertButtons">
              <ui:button text="Go to Login Page" action="success" /> 
          </f:facet>
          <f:facet name="pageAlertInput">
            <ui:panelGroup id="pageAlertStuff">
              <ui:label text="New Password:" for="passwordField"/>
              <ui:field id="passwordField" type="password"/>
            </ui:panelGroup>
          </f:facet> 
	</ui:pageAlert>

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

Constructor Summary

PageAlertBase()
Construct a new PageAlertBase.

Method Summary

java.lang.String	getAlt() Alternative text description used by screen reader tools
java.lang.String	getDetail() Optional detailed message text for the alert.
java.lang.String	getFamily() Return the family for this component.
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.
java.lang.String	getSummary() Summary message text for the alert.
int	getTabIndex() The position of this component in the tabbing order sequence
java.lang.String	getTitle() The text to display as the page title
java.lang.String	getType() The type or category of alert.
boolean	isEscape() Flag indicating that the message text should be escaped so that it is not interpreted by the browser.
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	setDetail(java.lang.String detail) Optional detailed message text for the alert.
void	setEscape(boolean escape) Flag indicating that the message text should be escaped so that it is not interpreted by the browser.
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	setSummary(java.lang.String summary) Summary message text for the alert.
void	setTabIndex(int tabIndex) The position of this component in the tabbing order sequence
void	setTitle(java.lang.String title) The text to display as the page title
void	setType(java.lang.String type) The type or category of alert.
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

PageAlertBase

public PageAlertBase()

Construct a new PageAlertBase.

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

getDetail

public java.lang.String getDetail()

Optional detailed message text for the alert. This message might include more information about the alert and instructions for what to do about the alert.

setDetail

public void setDetail(java.lang.String detail)

Optional detailed message text for the alert. This message might include more information about the alert and instructions for what to do about the alert.

See Also:

getDetail()

isEscape

public boolean isEscape()

Flag indicating that the message text should be escaped so that it is not interpreted by the browser.

setEscape

public void setEscape(boolean escape)

Flag indicating that the message text should be escaped so that it is not interpreted by the browser.

See Also:

isEscape()

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

getSummary

public java.lang.String getSummary()

Summary message text for the alert. This brief message is displayed under the page alert title.

setSummary

public void setSummary(java.lang.String summary)

Summary message text for the alert. This brief message is displayed under the page alert title.

See Also:

getSummary()

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

getTitle

public java.lang.String getTitle()

The text to display as the page title

setTitle

public void setTitle(java.lang.String title)

The text to display as the page title

See Also:

getTitle()

getType

public java.lang.String getType()

The type or category of alert. The type attribute can be set to one of the following: "question", "information", "warning" or "error". The default type is error.

setType

public void setType(java.lang.String type)

The type or category of alert. The type attribute can be set to one of the following: "question", "information", "warning" or "error". The default type is error.

See Also:

getType()

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.