| com.sun.rave.web.ui.component.PageAlertBase
All known Subclasses: com.sun.rave.web.ui.component.PageAlert,
| PageAlertBase | | abstract public class PageAlertBase extends javax.faces.component.UIComponentBase (Code) | | 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!
|
| PageAlertBase | | public PageAlertBase()(Code) | | Construct a new PageAlertBase.
|
| getAlt | | public String getAlt()(Code) | | Alternative text description used by screen reader tools
|
| getDetail | | public String getDetail()(Code) | | 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.
|
| getFamily | | public String getFamily()(Code) | | Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate
Renderer for this component instance.
|
| getStyle | | public String getStyle()(Code) | | CSS style(s) to be applied when this component is rendered.
|
| getStyleClass | | public String getStyleClass()(Code) | | CSS style class(es) to be applied when this component is rendered.
|
| getSummary | | public String getSummary()(Code) | | Summary message text for the alert. This brief message is displayed under the page alert title.
|
| getTabIndex | | public int getTabIndex()(Code) | | The position of this component in the tabbing order sequence
|
| getTitle | | public String getTitle()(Code) | | The text to display as the page title
|
| getType | | public String getType()(Code) | | 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.
|
| isEscape | | public boolean isEscape()(Code) | | Flag indicating that the message text should be escaped so that it is
not interpreted by the browser.
|
| isVisible | | public boolean isVisible()(Code) | | 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.
|
| restoreState | | public void restoreState(FacesContext _context, Object _state)(Code) | | Restore the state of this component.
|
| saveState | | public Object saveState(FacesContext _context)(Code) | | Save the state of this component.
|
| setDetail | | public void setDetail(String detail)(Code) | | 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: PageAlertBase.getDetail() |
| setEscape | | public void setEscape(boolean escape)(Code) | | Flag indicating that the message text should be escaped so that it is
not interpreted by the browser.
See Also: PageAlertBase.isEscape() |
| setType | | public void setType(String type)(Code) | | 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: PageAlertBase.getType() |
| setVisible | | public void setVisible(boolean visible)(Code) | | 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: PageAlertBase.isVisible() |
|
|