| |||||||
FRAMES NO FRAMES |
Use the webuijsf:alarm
tag to display a theme-specific
alarm image in the rendered HTML page. The webuijsf:alarm
tag can be used anywhere that an image can be displayed. Alarm images
are useful in pages and tables that display the status of devices.
The rendered HTML page displays an XHTML compliant <img>
element with any applicable attributes. The attributes can be
specified through the <webuijsf:alarm>
tag
attributes.
webuijsf:alarm
tagUse the severity
attribute to specify the alarm
severity, which determines the theme-specific alarm icon to render.
The Alarm supports a set of Indicators which enables you to
define custom types and associated images in addition to default
types. Indicators also support the sorting attribute which enables sorting
among Indicators depending on the sortValue
value.
The text
attribute is used to specify the text to be displayed
next to the alarm icon, and the textPosition
attribute
specifies whether the text should be displayed to the left or right of
the icon.
The url
attribute can be used to override the
theme-specific alarm icon. The image that you specify with the url
attribute is always rendered, even if a severity is not specified. If
you specify a theme key with the icon
attribute, you must
also specify a standard severity. If you do not specify a severity, the
component will assume default severity. The icon is coupled with the
severity, while the url is not. If you specify an icon
attribute as well as a url
attribute, the image specified
by the url
takes precedence over the image specified by
the icon
attribute.
Other image-related attributes, such as border, height, and width,
can also be specified with the webuijsf:alarm
tag
attributes to override the image attributes of the icon.
The Theme provides the following alarm icon identifiers.
DOWN_ALARM_INDICATOR
CRITICAL_ALARM_INDICATOR
MAJOR_ALARM_INDICATOR
OK_ALARM_INDICATOR
ALARM_CRITICAL_SMALL
ALARM_CRITICAL_MEDIUM
ALARM_MAJOR_SMALL
ALARM_MAJOR_MEDIUM
ALARM_MINOR_SMALL
ALARM_MINOR_MEDIUM
ALARM_DOWN_SMALL
ALARM_DOWN_MEDIUM
ALARM_MASTHEAD_CRITICAL_MEDIUM
ALARM_MASTHEAD_DOWN_MEDIUM
ALARM_MASTHEAD_MAJOR_MEDIUM
ALARM_MASTHEAD_MINOR_MEDIUM
document.getElementById(id).setProps({text:
"New Alarm Text"})
.getProps() |
Use this function to get widget properties. See setProps()
function for a list of supported properties. |
refresh(execute) |
Use this function to
asynchronously refresh the component.
|
setProps(props) |
Use this function to change any of the following supported
properties:
|
When the component is manipulated client side, some functions might
publish event topics for custom Ajax implementations to listen for.
Using the Dojo event system, you can instruct Ajax to listen for the refresh event topic by using:
<webuijsf:script>
var processEvents =
{
update: function(props) {
//
Do something...
}
}
// Subscribe to refresh event.
dojo.subscribe(webui.suntheme.widget.alarm.event.<eventname>.endTopic,
processEvents, "update");
</webuijsf:script>
webui.suntheme.widget.alarm.event.refresh.beginTopic | Event topic published before asynchronously refreshing the
component. Supported properties include:
|
webui.suntheme.widget.alarm.event.refresh.endTopic | Event topic published after asynchronously refreshing the
component. Supported properties include: See setProps() function.
|
<webuijsf:alarm id="alarm1" severity="critical" />
<webuijsf:alarm id="alarm2"
severity="major"
url="../images/major.gif"
height="10"
width="10"
alt="Processor Alarm:Major" />
See the Examples section in the documentation for the webuijsf:tableColumn
component.
<webuijsf:alarm id="alarm1"
indicators="#{AlarmBean.customIndicator}" severity="mySeverity"
text="Custom severity" />
AlarmBackingBean.java
backing bean is used the
examples
above.AlarmBackingBean {The example above defines "mySeverity" as a custom define severity in addition to the default severities. An Indicator object can be constructed by calling any Indicator constructors.
...
public List getCustomIndicator() {
FacesContext context = FacesContext.getCurrentInstance();
UIComponent comp = context.getViewRoot().findComponent("form1:alarm1");
Alarm alarm = (Alarm) comp;
Indicator indicator = new Indicator("ALARM_CRITICAL_SMALL", "mySeverity", 600);
Listlst = Alarm.getDefaultIndicators();
lst.add(indicator);
return lst;
}
...
}
Indicator(String imageKey, String type, int sortValue)
or
Indicator(UIComponent imageComponent, String type, int sortValue)
<webuijsf:radioButton id="rb1" name="rb1" label="Toggle Alarm Visible" onClick="toggleVisible()"/><webuijsf:alarm id="alarm1" severity="
major
" text="#{MyBean.text}"
/>
<webuijsf:script>
function toggleVisible() {
var domNode = document.getElementById("form1:alarm1
"); // Get alarm
return domNode.setProps({visible: !domNode.getProps().visible}); // Toggle visible state
}
</webuijsf:script>
<webuijsf:radioButton id="rb1" name="rb1" label="Refresh Alarm" onClick="refreshAlarm()"/><webuijsf:alarm id="alarm1" severity="
major
" text="#{MyBean.text}"
/>
<webuijsf:script>
function refreshAlarm() {
var domNode =
document.getElementById("form1:alarm1"); // Get alarm
return domNode.refresh(); //
Asynchronously refresh alarm
}
</webuijsf:script>
Note that the refresh function can optionally take a list of
elements
to execute. Thus, a comma-separated list of ids can be provided to
update components server-side: refresh("form1:id1,form2:id2,..."). When
no parameter is given, the refresh function acts as a reset.
That is, the component will be redrawn only using values set
server-side.<webuijsf:alarm id="alarm1" severity="
major
" text="#{MyBean.text}"
/>
<webuijsf:textField id="field1" text="#{MyBean.text}
" label="Change Text"
onKeyPress="setTimeout('refreshAlarm();', 0);"/> // Field used to asynchronously update text.
<webuijsf:script>
function
refreshAlarm
() {
var domNode =
document.getElementById("form1:alarm1"); // Get alarm
return
domNode.refresh("form1:field1"); // Asynchronously refresh while
submitting field value
}
</webuijsf:script>
Tag Information | |
Tag Class | com.sun.webui.jsf.component.AlarmTag |
TagExtraInfo Class | None |
Body Content | JSP |
Display Name | None |
Attributes | ||||
Name | Required | Request-time | Type | Description |
binding | false | false | java.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. |
toolTip | false | false | java.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. |
onMouseDown | false | false | java.lang.String | Scripting code that is executed when the user presses a mouse button while the mouse pointer is on the component. |
onDblClick | false | false | java.lang.String | Scripting code that is executed when a mouse double click occurs over this component. |
onKeyPress | false | false | java.lang.String | Scripting code that is executed when the user presses and releases a key while the component has focus. |
severity | false | false | java.lang.String | Specifies the severity of the alarm. Valid values are:
|
indicators | false | false | java.lang.String | A developer define types of Alarm. This attribute can be set to an array of Indicators where Indicator holds the custom defined type and associated image. |
onMouseOut | false | false | java.lang.String | Scripting code that is executed when a mouse out movement occurs over this component. |
rendered | false | false | java.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. |
alt | false | false | java.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. |
id | false | true | java.lang.String | No Description |
onMouseOver | false | false | java.lang.String | Scripting code that is executed when the user moves the mouse pointer into the boundary of this component. |
htmlTemplate | false | false | java.lang.String | Alternative HTML template to be used by this component. |
onKeyUp | false | false | java.lang.String | Scripting code that is executed when the user releases a key while the component has focus. |
onMouseMove | false | false | java.lang.String | Scripting code that is executed when the user moves the mouse pointer while over the component. |
onMouseUp | false | false | java.lang.String | Scripting code that is executed when the user releases a mouse button while the mouse pointer is on the component. |
styleClass | false | false | java.lang.String | CSS style class or classes to be applied to the outermost HTML element when this component is rendered. |
text | false | false | java.lang.String | The text description of the alarm. |
visible | false | false | java.lang.String | Indicates 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, is true, so HTML for the component HTML is included and visible to the user. If the Alarm component is not visible, it can still be processed on subsequent form submissions because the HTML is present. |
style | false | false | java.lang.String | CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
onKeyDown | false | false | java.lang.String | Scripting code that is executed when the user presses down on a key while the component has focus. |
onClick | false | false | java.lang.String | Scripting code executed when a mouse click occurs over this component. |
textPosition | false | false | java.lang.String | Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left". By default, text is placed to the right of the image. |
width | false | false | java.lang.String | Image width override. When specified, the width and height attributes tell web browsers to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior. |
longDesc | false | false | java.lang.String | A verbose description of this image. |
height | false | false | java.lang.String | Image height override. When specified, the width and height attributes tell web browsers to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior. |
hspace | false | false | java.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. |
align | false | false | java.lang.String | Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right. |
icon | false | false | java.lang.String | The identifier of the desired theme image. |
vspace | false | false | java.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. |
url | false | false | java.lang.String | Absolute or relative URL to the image to be rendered. |
border | false | false | java.lang.String | Specifies the width of the img border in pixels. The default value for this attribute depends on the web browser. |
Variables | No Variables Defined. |
| |||||||
FRAMES NO FRAMES |