webuijsf
Tag pageAlert


Use the webuijsf:pageAlert tag to display a full page alert. A page alert differs from the inline alert (see webuijsf: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:


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) Title text                                                                                                                
(Optional pageAlertTitle facet)
Detailed message
Optional pageAlertInput facet
Page separator (or optional pageAlertSeparator facet)
Optional pageAlertButtons facet

 

Facets

The webuijsf:pageAlert tag supports the following facets.

pageAlertTitle Specifies a custom component to use to display the title of the alert.  The title for a full page alert consists of both an alert icon image and the title text. The default image and the formatting of the title are designed to adhere to Sun UI guidelines.  Use the pageAlertTitle facet to replace the default alert icon and title with another component. This facet overrides the title and type attributes.  Note that you can define a different image by using the pageAlertImage facet. 
pageAlertImage
Specifies a component to use to display the alert icon. The component included in this facet replaces the default icon.
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 webuijsf: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.

Client Side Javascript Functions

None.

Examples

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

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

Example 2: With input field and one page button.

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


Tag Information
Tag Classcom.sun.webui.jsf.component.PageAlertTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String A ValueExpression that resolves to the UIComponent that corresponds to this tag. This attribute allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
summaryfalsefalsejava.lang.String Deprecated.
Use the title attribute to display the message summary in the page title.
styleClassfalsefalsejava.lang.String

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

typefalsefalsejava.lang.String

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.

titlefalsefalsejava.lang.String

The text to display as the page title

detailfalsefalsejava.lang.String

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

visiblefalsefalsejava.lang.String

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.

stylefalsefalsejava.lang.String

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

renderedfalsefalsejava.lang.String 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.
escapefalsefalsejava.lang.String

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

altfalsefalsejava.lang.String

Alternative textual description of the image rendered by this component. The alt text can be used by screen readers and in tool tips, and when image display is turned off in the web browser.

tabIndexfalsefalsejava.lang.String

Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.

idfalsetruejava.lang.StringNo Description

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.