The graphic representation of a shelf is based on the information that is available in the business model. Although states and alarms may be associated with a shelf, you cannot display them in the shelf graphic representation. After all, a shelf is only a container for the cards themselves.

This section contains information on:

Customizing Shelf Representations

This section provides details about the CSS properties that you can use to customize the representation of shelves. Some properties are mapped, which means that they are computed on the basis of the state and alarm information set in the object (column Set).

A shelf also displays an outline around the slots and an alarm border in case of alarms. This representation can be customized through the following additional property:

Customizing Shelf Names

In the network and equipment components, shelves do not display their names. Instead of the shelf name, you see the slot labels, which are customized by using the property XSlotLabels, or by setting the attribute xSlotIndex. The following properties can be used to customize slot labels:

How to Customize Shelf Slot Labels

object."ilog.tgo.model.IltShelf" {
  labelVisible: true;
  labelForeground: blue;
  XSlotNumbersOffset: 3;
}

Customizing Shelf States and Alarms

Although states and alarms can be associated with a shelf, they cannot be displayed in the shelf graphic representation in the network and equipment components. After all, a shelf is only a container for the cards themselves.

However, in the case of alarms, an alarm border is displayed around the shelf to indicate the presence of outstanding alarms (but no alarm balloon or alarm count), as illustrated below.

The following CSS properties are available to customize this representation:

How to Customize Shelf States and Alarms

The following CSS extract shows how you can customize a shelf object to not display alarm information.

object."ilog.tgo.model.IltShelf" {
  alarmBorderVisible: false;
  alarmColorVisible: false;
}

The resources that apply to shelf types are identified as:

You can edit the values directly in the JViews TGO resource bundle file.

When you create new shelf types, the label and tooltip information will also be retrieved from this resource bundle to be displayed, for example, in a table cell. As you declare new shelf types, register the corresponding entries into the resource bundle file, as follows:

Considering that you have created the following new shelf type:

IltShelf.Type MyType = new IltShelf.Type("MyType"); 

You should declare the following properties in the JTGOMessages.properties file:

Customizing Shelf Types

In JViews TGO, the shelf type defines how the object base will be represented. Each shelf type is associated with a specific base renderer that is in charge of drawing the object according to its type and state information.

How to Create and Register a Shelf Type (using the API)

IltShelf.Type MyType = new IltShelf.Type("MyType");
 
IltSettings.SetValue("Shelf.Type.MyType.Renderer", 
                     new IltBaseRendererFactory() {
                       public IltBaseRenderer createValue() {
                         return new MyTypeBaseRenderer();
                       }
                     });

How to Create and Register a Shelf Type (using CSS)

setting."ilog.tgo.model.IltShelf"{
   types[0]: @+shelfType0;
}
Subobject#shelfType0 {
  class: 'ilog.tgo.model.IltShelf.Type'; 
  name: "MyType";
}

Likewise, you can customize the renderer using global CSS settings. To do so, you need to specify the full path to the object to be customized, as well as the value of its name attribute in order to match the right type of object in the system. The CSS property to customize here is renderer. In the example below, the name of the renderer factory class that is included in the search path is MyShelfRendererFactory.

setting."ilog.tgo.model.IltShelf.Type"[name="MyType"] {
   renderer: @+shelfRendererFactory;
}
Subobject#shelfRendererFactory {
   class: 'MyShelfRendererFactory';
}

Customizing Shelf Tiny Types

Besides the graphic representation in the network and equipment components, the shelf object can be represented as tiny objects in the tree and table components.

How to Modify a Shelf Tiny Representation (using the API)

IltShelf.Type MyType = new IltShelf.Type("MyType");
 
IltSettings.SetValue("Shelf.TinyType.MyType.Renderer", 
                     new IltTinyImageBaseRendererFactory(YOUR_IMAGE, YOUR_IMAGE_PARAMETERS));

How to Modify a Shelf Tiny Representation (using CSS)

You can customize the renderer using global CSS settings. The CSS property to customize here is tinyRenderer. In the example below, the name of the renderer factory class that is included in the search path is MyShelfTinyRendererFactory.

setting."ilog.tgo.model.IltShelf.Type"[name="MyType"] {
   tinyRenderer: @+shelfTinyRendererFactory0;
}
Subobject#shelfTinyRendererFactory0 {
   class: 'MyShelfTinyRendererFactory';
}