webuijsf
Tag notificationPhrase


Use the webuijsf:notificationPhrase tag to display notification information. This tag is typically specified as part of the webuijsf:masthead tag's statusArea facet. The webuijsf:notificationPhrase tag produces notification information identical to the webuijsf:masthead tag's notificationMsg attribute. See the webuijsf:masthead documentation for more information about the statusArea facet. This component should be marked as "immediate=true" so that it does not interfere with the masthead or any other component's JSF lifecycle.

The statusArea facet overrides the masthead's status area attributes. The webuijsf:notificationPhrase tag enables you to include notification messages in the status area, along with your custom components. The webuijsf:jobStatus, webuijsf:timeStamp, and webuijsf:alarmStatus tags enable you to include the other standard status area components as well.

Note that when you use the webuijsf:masthead attributes, spacing between the components is handled automatically. When you use the webuijsf:alarmStatus, webuijsf:jobStatus, webuijsf:timeStamp, and webuijsf:notificationPhrase tags in the statusArea facet, you may have to add code to handle the spacing between the components, as demonstrated in the example below.

Note that the notificationPhrase component is deprecated. Take a look at the examples section to see how to create an equivalent of the webuijsf:notificationPhrase.

HTML Elements and Layout

The rendered HTML page includes an <img> element for the information icon, adjacent to an <a> hyperlink containing the notification message.

Configuring the webuijsf:notificationPhrase tag

Specify the notification message with the text attribute. Use the icon attribute to specify a different theme identifier to use for the image, or imageURL to specify a non-theme image. Use other attibutes, such as url, action, or actionListenerExpression to provide detailed information about the notification message or take other action.

The immediate attribute should be set to true when this component is used in the masthead.

Theme Identifiers

The theme provides the following notification icon identifiers.

ALERT_INFO_LARGE
ALERT_INFO_MEDIUM
ALERT_INFO_SMALL

Client Side Javascript Functions

None.

Examples

Example 1: Display a notification phrase as part of the masthead statusArea facet

This example uses webuijsf:panelGroup to enclose the tags for the status items. The components are also enclosed in f:verbatim tags that specify <div> elements with a class selector that applies the correct spacing around the component in the masthead.

<webuijsf:masthead id="Masthead" productImageURL="../images/webconsole.png"
         productImageDescription="Java Web Console" userInfo="user_name" 
         serverInfo="server_name">
     <f:facet name="statusArea">
       <webuijsf:panelGroup id="statusPanel" separator="">
         <webuijsf:markup tag="div" styleClass="#{themeStyles.MASTHEAD_STATUS_DIV}">
         <webuijsf:notificationPhrase text="Important info goes here" />
         <webuijsf:image icon="DOT" border="0" width="20" height="1" />
         <webuijsf:jobStatus numJobs="1" />
         </webuijsf:markup>
         <webuijsf:markup tag="div" styleClass="#{themeStyles.MASTHEAD_TIME_DIV}">
         <webuijsf:timeStamp />
         </webuijsf:markup>
         <webuijsf:markup tag="div" styleClass="#{themeStyles.MASTHEAD_ALARM_DIV}">
         <webuijsf:alarmStatus numDownAlarms="0" numCriticalAlarms="1" numMajorAlarms="2" numMinorAlarms="3" />
         </webuijsf:markup>
       </webuijsf:panelGroup>
     </f:facet>
 </webuijsf:masthead>
 

Example 2: Create an equivalent of webuijsf:alarmStatus tag


<f:facet name="notificationInfo">
      <webuijsf:panelGroup id="notificationInfo">                             
          <webuijsf:image id="notificationImage" icon="ALERT_INFO_MEDIUM" align="middle"/>
          <f:verbatim>&nbsp; </f:verbatim>
          <webuijsf:hyperlink id="link1" url="#" styleClass="#{themeStyles.MASTHEAD_PROGRESS_LINK}">
          <webuijsf:staticText id="text1" styleClass="#{themeStyles.MASTHEAD_TEXT}"
         text="#{msgs.masthead_notificationText}"/>
          </webuijsf:hyperlink>
      </webuijsf:panelGroup>
  </f:facet>


Tag Information
Tag Classcom.sun.webui.jsf.component.NotificationPhraseTag
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 binding allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
onDblClickfalsefalsejava.lang.String Scripting code executed when a mouse double click occurs over this component.
imageURLfalsefalsejava.lang.String

Absolute or relative URL to the image to be rendered.

widthfalsefalsejava.lang.String

Image width override. When specified, the width and height attributes tell user agents to override the natural image or object size in favor of these values.

onKeyPressfalsefalsejava.lang.String

Scripting code executed when the user presses and releases a key while the component has focus.

targetfalsefalsejava.lang.String

The resource at the specified URL is displayed in the frame that is specified with the target attribute. Values such as "_blank" that are valid for the target attribute of a HTML anchor element are also valid for this attribute in this component

onFocusfalsefalsejava.lang.String

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

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.
urlLangfalsefalsejava.lang.String

The language code of the resource designated by this hyperlink.

idfalsetruejava.lang.StringNo Description
onKeyUpfalsefalsejava.lang.String

Scripting code executed when the user releases a key while the component has focus.

onMouseUpfalsefalsejava.lang.String

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

styleClassfalsefalsejava.lang.String

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

heightfalsefalsejava.lang.String

When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior.

actionListenerExpressionfalsefalsejava.lang.String Use the actionListenerExpression attribute to cause the component to fire an event. The value must be an EL expression and it must evaluate to the name of a public method that takes an ActionEvent parameter and returns void.
alignfalsefalsejava.lang.String

Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right.

iconfalsefalsejava.lang.String

The identifier of the desired theme image.

vspacefalsefalsejava.lang.String

Specifies the amount of white space in pixels to be inserted above and below the image. The default value is not specified but is generally a small, non-zero size.

stylefalsefalsejava.lang.String

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

borderfalsefalsejava.lang.String

Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser

urlfalsefalsejava.lang.String

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink. If the url attribute is specified, clicking this hyperlink sends the browser to the new location. If the action attribute is specified, the form is submitted. If both are specified, the url attribute takes precedence.

onClickfalsefalsejava.lang.String

Scripting code executed when a mouse click occurs over this component. If the component submits the form (by using the action attribute), the script that you use with the onClick attribute should not return from the function. When the action attribute is used, the component handles the return with a script that is appended to the anchor element's onclick property. When you supply an onClick attribute, this return script is appended after your script in the anchor's onclick. It is ok to return from your script to abort the submit process if necessary.

onBlurfalsefalsejava.lang.String

Scripting code executed when this element loses focus.

onMouseDownfalsefalsejava.lang.String

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

toolTipfalsefalsejava.lang.String

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.

typefalsefalsejava.lang.String

The MIME content type of the resource specified by this component.

actionExpressionfalsefalsejava.lang.String MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a either a String or a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application.
disabledfalsefalsejava.lang.String

Flag indicating that clicking of this component by the user is not currently permitted.

onMouseOutfalsefalsejava.lang.String

Scripting code executed when a mouse out movement occurs over this component.

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.

onMouseOverfalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

htmlTemplatefalsefalsejava.lang.String Alternative HTML template to be used by this component.
onMouseMovefalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer while over the component.

textfalsefalsejava.lang.String

The text to be displayed for the hyperlink.

immediatefalsefalsejava.lang.String Flag indicating that event handling for this component should be handled immediately (in Apply Request Values phase) rather than waiting until Invoke Application phase.
hspacefalsefalsejava.lang.String

Specifies the amount of white space in pixels to be inserted to the left and right of the image. The default value is not specified but is generally a small, non-zero size.

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.

onKeyDownfalsefalsejava.lang.String

Scripting code executed when the user presses down on a key while the component has focus.

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.

textPositionfalsefalsejava.lang.String

Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left".


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.