ilog.tgo.resource.css

Interface IltAlarmSeverityCustomization

public interface IltAlarmSeverityCustomization

IltAlarmSeverityCustomization specifies the properties that can be customized for alarm severities using CSS. The following alarm severities can be configured:

• IltAlarm.Severity
• IltAlarm.ImpactSeverity
• IltTrap.Type

The following example illustrates how an alarm severity can be configured using CSS. The cascading style sheets are loaded using the method IltSettings.setStyleSheets(String[]).

  
 setting."ilog.tgo.model.IltAlarm.Severity"[name="Alarm.Raw.Informational"] {
   color: orange;
   darkColor: blue;
   brightColor: yellow;
   abbreviation: "i";
   description: "Informational";
   icon: '@|image("icon1.png")';
 }
 setting."ilog.tgo.model.IltAlarm.ImpactSeverity"[name="Alarm.Impact.InformationalLow"] {
   color: orange;
   darkColor: blue;
   brightColor: yellow;
   abbreviation: "IL";
   description: "InformationalLow";
   icon: '@|image("icon1.png")';
 }
 

The same configuration can be achieved using the method IltSettings.SetValue(Object, Object). This is illustrated below:

 IltSettings.SetValue("Alarm.Raw.Informational.Color", Color.orange);
 IltSettings.SetValue("Alarm.Raw.Informational.DarkColor", Color.blue);
 IltSettings.SetValue("Alarm.Raw.Informational.BrightColor", Color.yellow);
 IltSettings.SetValue("Alarm.Raw.Informational.Abbreviation", "i");
 IltSettings.SetValue("Alarm.Raw.Informational.Description", "Informational");
 IltSettings.SetValue("Alarm.Raw.Informational.Icon", icon);
 

Since:

JViews 7.5

Method Summary

Modifier and Type	Method and Description
String	getAbbreviation() Returns the alarm short description that is used to compose the alarm count of the business object.
Color	getBrightColor() Returns the alarm bright color that represents a certain alarm severity.
Color	getColor() Returns the alarm color that represents a certain alarm severity.
Color	getDarkColor() Returns the alarm dark color that represents a certain alarm severity.
String	getDescription() Returns the alarm long description that is used to compose the alarm balloon count.
Image	getIcon() Returns the icon that will be used as part of the alarm count representation.

Method Detail

getColor

Color getColor()

Returns the alarm color that represents a certain alarm severity.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    color: orange;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    color: orange;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    color: orange;
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    color: orange;
 }
 

Returns:

The alarm color.

getBrightColor

Color getBrightColor()

Returns the alarm bright color that represents a certain alarm severity. The dark color is used in the business object representation to give a relief effect.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    brightColor: yellow;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    brightColor: yellow;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    brightColor: yellow;
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    brightColor: yellow;
 }
 

Returns:

The bright color.

getDarkColor

Color getDarkColor()

Returns the alarm dark color that represents a certain alarm severity. The dark color is used in the business object representation to give a relief effect.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    darkColor: blue;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    darkColor: blue;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    darkColor: blue;
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    darkColor: blue;
 }
 

Returns:

The dark color.

getAbbreviation

String getAbbreviation()

Returns the alarm short description that is used to compose the alarm count of the business object.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    abbreviation: RC;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    abbreviation: ICL;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    abbreviation: LOC1;
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.NotReporting"] { 
    abbreviation: NR1;
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    abbreviation: TCS;
 }
 

Returns:

The alarm short description.

getDescription

String getDescription()

Returns the alarm long description that is used to compose the alarm balloon count. This is done when the business object uses the extended alarm balloon configuration, as well as the alarm severity. This configuration is also used to display the perceived severity label for alarms in the table component.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    description: "Raw Critical";
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    description: "Impact Critical Low";
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    description: "Loss of Connectivity";
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    description: "Trap ColdStart";
 }
 

Returns:

The alarm long description.

getIcon

Image getIcon()

Returns the icon that will be used as part of the alarm count representation.

CSS settings:

 setting."ilog.tgo.model.IltState"[name="Alarm.Raw.Critical"] {
    icon: '@|image("icon1.png")';
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.Impact.CriticalLow"] {
    icon: '@|image("icon1.png")';
 }
 setting."ilog.tgo.model.IltState"[name="Alarm.LossOfConnectivity"] { 
    icon: '@|image("icon1.png")';
 }
 setting."ilog.tgo.model.IltState"[name="Trap.Type.ColdStart"] {
    icon: '@|image("icon1.png")';
 }
 

 

Returns:

The alarm icon.