| com.sun.rave.web.ui.component.AlertBase
All known Subclasses: com.sun.rave.web.ui.component.Alert,
| AlertBase | | abstract public class AlertBase extends javax.faces.component.UIOutput (Code) | | Use the ui:alert
tag to display an inline alert
message at the top of the rendered HTML page. Inline alert messages
permit users to correct problems or proceed with their work without
having to dismiss a window and navigate to a new location.
There 2 facets associated with an alert tag:
alertImage - allows the developer to put
in their own image and/or text
alertLink - allows the developer to put
in their own formatted link or extra text.
HTML Elements and Layout
An alert message consists of an icon depicting the type of alert -
information, success, warning, or error - along with a summary
message and an optional detail
message.
Client Side Javascript
Functions
none.
Examples
Example 1: An example showing
an informational alert:
<ui:alert id="msg1"
type="information" summary="Patch Installed Successfully" detail="Patch
9997-01 was successfully installed on host alpha, beta and zed."
/>
Example 2: An example showing
an error alert with an alert link:
<ui:alert id="msg2"
type="error" summary="Patch Installation Failed!"
detail="Patch 9997-01 was not installed on host alpha, beta and zed."
linkText="View Log" linkURL="/log/patch-log.txt" linkTarget="_blank"
linkToolTip="Open Window Containing Error Log"/>
Example
3: An example showing the use of an alertImage facet:
<ui:alert id="msg2"
type="error" summary="Patch Installation Failed!"
detail="Patch 9997-01 was not installed on host alpha, beta and
zed.">
<f:facet name="alertImage">
<ui:image
id="foo" url="../images/foo.gif"
/>
</f:facet>
</ui:alert>
Auto-generated component class.
Do NOT modify; all changes
will be lost!
|
| AlertBase | | public AlertBase()(Code) | | Construct a new AlertBase.
|
| 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.
|
| getLinkAction | | public javax.faces.el.MethodBinding getLinkAction()(Code) | | Method binding representing a method that receives action from the
embedded hyperlink component.
|
| getLinkTarget | | public String getLinkTarget()(Code) | | The window (target) in which to load the link that is specified with linkText.
|
| getLinkText | | public String getLinkText()(Code) | | The text for an optional link that is appended to the detail message.
|
| getLinkToolTip | | public String getLinkToolTip()(Code) | | 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 link that is specified
with linkText.
|
| getLinkURL | | public String getLinkURL()(Code) | | Absolute, relative, or context relative (starting with "/") URL to the resource to navigate
to when the link that is specified with linkText is selected.
|
| 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 prominently
displayed next to the icon.
|
| getTabIndex | | public int getTabIndex()(Code) | | The position of this component in the tabbing order sequence
|
| getType | | public String getType()(Code) | | The type or category of alert. This type can be set to either "information", "success", "warning" or "error".
|
| 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: AlertBase.getDetail() |
| setLinkAction | | public void setLinkAction(javax.faces.el.MethodBinding linkAction)(Code) | | Method binding representing a method that receives action from the
embedded hyperlink component.
See Also: AlertBase.getLinkAction() |
| setLinkToolTip | | public void setLinkToolTip(String linkToolTip)(Code) | | 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 link that is specified
with linkText.
See Also: AlertBase.getLinkToolTip() |
| setLinkURL | | public void setLinkURL(String linkURL)(Code) | | Absolute, relative, or context relative (starting with "/") URL to the resource to navigate
to when the link that is specified with linkText is selected.
See Also: AlertBase.getLinkURL() |
| setSummary | | public void setSummary(String summary)(Code) | | Summary message text for the alert. This brief message is prominently
displayed next to the icon.
See Also: AlertBase.getSummary() |
| setTabIndex | | public void setTabIndex(int tabIndex)(Code) | | The position of this component in the tabbing order sequence
See Also: AlertBase.getTabIndex() |
| setType | | public void setType(String type)(Code) | | The type or category of alert. This type can be set to either "information", "success", "warning" or "error".
See Also: AlertBase.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: AlertBase.isVisible() |
|
|