ilog.tgo.resource
Class IltSettings

java.lang.Object
  ilog.tgo.resource.IltSettings

All Implemented Interfaces:

IlvStylable

public class IltSettings
extends Object
implements IlvStylable

This is the JTGO top-level global settings class. It contains the default configuration for the ILOG JTGO look and feel. It also applies user-defined global settings defined in a CSS file.

The ILOG JTGO look and feel stores information about how object attributes, states and alarm information are mapped to decorations in order to create the graphic representation.

Each property is identified by a name, and can be retrieved or set through the methods GetValue and SetValue. Properties can also be set by first defining the settings within a CSS file and applying the settings using the setStylesheet methods. For settings details within CSS files please refer to classes in the ilog.tgo.resource.css.handlers package.

The ILOG JTGO look and feel characteristics can be customized as follows:

• Link media icons: modify the IltLink.Media representation. The property name is defined by the prefix Link.Media., the media name and the Icon suffix. For example:

   IltSettings.SetValue("Link.Media.Fiber.Icon", image)
   

• Link technology icons and colors: modify the IltLink.Technology representation. The property name is defined by the prefix Link.Technology., the technology name and the Icon (or Color) suffix. For example:

   IltSettings.SetValue("Link.Technology.WirelessEdge.Icon", image)
   IltSettings.SetValue("Link.Technology.WirelessEdge.Color", color)
   

• Network element function icons: modify the IltNetworkElement.Function representation. The property name is defined by the prefix NetworkElement.Function., the function name and the Icon suffix. For example:

   IltSettings.SetValue("NetworkElement.Function.ADM.Icon", image)
   

• Object type labels: for the objects that contain a type attribute, such as IltNetworkElement, IltShelf, IltPort and IltLed, the type label is retrieved automatically from the ILOG JTGO resource bundle. However, it is also possible to customize the textual representation of the type so that it is appropriately displayed in a table component. To customize the label representation, configure the label value as illustrated in the example below:

   IltSettings.SetValue("Led.Type.Circular.Label", "Circular")
   IltSettings.SetValue("Port.Type.IEEE_1394_4f.Label", "IEEE 1394")
   IltSettings.SetValue("NetworkElement.Type.NE.Label", "Network Element");
   

• Network element family labels: by default, the IltNetworkElement.Family representation is a label retrieved automatically from the ILOG JTGO resource bundle. As you create new families, register the appropriate entries in the resource bundle. However, it is also possible to set the family label here, using the following setting name: NetworkElement.Family.YOUR FAMILY NAME.Label, as illustrated below:

   IltSettings.SetValue("NetworkElement.Family.FCOT.Label", "FCOT")
   

• Network element function icon position: according to the network element type, this specifies whether the function icon is placed at the center of the network element base or at the bottom left position. To configure the icon position, modify the IltNetworkElement.Type representation. The property name is defined by the prefix NetworkElement.Type., the type name and CenterFunctionIcon. The example below illustrates this configuration:

   IltSettings.SetValue("NetworkElement.Type.NE.CenterFunctionIcon", Boolean.FALSE);
   

• Network element type base renderers: modify the IltNetworkElement.Type base representation. The property name is defined by the prefix NetworkElement.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltNEBaseRenderer instances. For example:

   IltSettings.SetValue("NetworkElement.Type.NE.Renderer", new IltNEImageBaseRendererFactory(...))
   

• Card type base renderers: modify the IltCard.Type base representation. The property name is defined by the prefix Card.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltCardBaseRenderer instances. For example:

   IltSettings.SetValue("Card.Type.Standard.Renderer", new IltCardImageBaseRendererFactory(...))
   

• Card carrier type base renderers: modify the IltCardCarrier.Type base representation. The property name is defined by the prefix CardCarrier.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltCardCarrierBaseRenderer instances. For example:

   IltBaseRendererFactory yourCardCarrierBaseRendererFactory = ...;
   IltSettings.SetValue("CardCarrier.Type.Standard.Renderer", yourCardCarrierBaseRendererFactory)
   

• Port type base renderers: modify the IltPort.Type base representation. The property name is defined by the prefix Port.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltPortBaseRenderer instances. For example:

   IltSettings.SetValue("Port.Type.IEEE_1394_4f.Renderer", new IltPortImageBaseRendererFactory(...))
   

• Led type base renderers: modify the IltLed.Type base representation. The property name is defined by the prefix Led.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltLedBaseRenderer instances. For example:

   IltSettings.SetValue("Port.Type.Circular.Renderer", new IltLedImageBaseRendererFactory(...))
   

• Off-page connector type base renderers: modify the IltOffPageConnector.Type base representation. The property name is defined by the prefix OffPageConnector.Type., the type name and the Renderer suffix. The property value should be an IltBaseRendererFactory that creates IltOPCBaseRenderer instances. For example:

   IltSettings.SetValue("OffPageConnector.Type.Standard.Renderer", new IltOPCImageBaseRendererFactory(...))
   

General settings: modify the icons used to represent the information window, system window and subnetwork status. The following property names can be set:

• InformationWindow.Icon: the icon used to display the information window when its contents have not yet been displayed.
• InformationWindow.Acknowledged.Icon: the icon used to display the information window when its contents have already been displayed.
• SystemWindow.Icon: the icon used to display the system window when its contents have not yet been displayed.
• SystemWindow.Acknowledged.Icon: the icon used to display the system window when its contents have already been displayed.
• Subnetwork.Collapse.Icon: the icon used to collapse subnetworks
• Subnetwork.Expand.Icon: the icon used to expand subnetworks
• Subnetwork.Empty.Icon: the icon used to represent a subnetwork that has no children objects

Miscellaneous states: modify the IltMisc.SecState representation. Property names are defined by the state name and the Icon suffix, for example:

 
 IltSettings.SetValue("Misc.SecState.DoorAjar.Icon", image)
 

Performance, SAN and SNMP states: modify IltPerformance.SecState, IltSAN.SecState and IltSNMP state representation, so that the state can be represented as a gauge, a chart or a counter. Property names are defined by the state name, and a suffix that determines the type of configuration that is applied. This suffix can be:

• Type: to indicate the type of decoration that is used to represent the state. The default configuration is IltDecorationType.Gauge.
• Gauge: to indicate the mapping used to create a gauge representation. See IltGaugeMapping.
• Chart: to indicate the mapping used to create a chart representation. See IltChartMapping.
• Counter: to indicate the mapping used to create a counter representation. See IltCounterMapping.

The following example illustrates how to customize the representation of the state IltPerformance.SecState.Input.

 IltSettings.SetValue("Performance.SecState.Input.Type", IltDecorationType.Chart);
 IltSettings.SetValue("Performance.SecState.Input.Chart", new IltChartMapping(chart1, chart2));
 

SONET protections: modify the IltSONET.Protection representation. The property name is defined by the prefix SONET.Protection., the protection name and the Icon suffix. For example:

 
 IltSettings.SetValue("SONET.Protection.Exercisor.Icon", image)
 

OSI primary states: modify the icons displayed according to the primary states set in the object. The following properties can be customized:

• OSI.State.Usage.Busy.Icon
• OSI.State.Administrative.Locked.Icon
• OSI.State.Administrative.ShuttingDown.Icon

Bellcore secondary state and OSI status: modify IltBellcore.SecState, IltOSI.Availability, IltOSI.Control, IltOSI.Repair, IltOSI.Procedural and IltOSI.Standby state representation. Property names are defined by the state name, and a suffix that determines the object condition according to its primary state. This suffix can be:

• OOS: when the primary state information defines that the object is out of service.
• NT: when the primary state information defines that the object is carrying no traffic.
• CT: when the primary state information defines that the object is carrying traffic.

The following example illustrates how to customize the representation of the state IltBellcore.SecState.Blocked.

 IltSettings.SetValue("Bellcore.SecState.Blocked.OOS.Icon", blockedOOS);
 IltSettings.SetValue("Bellcore.SecState.Blocked.NT.Icon", blockedNT);
 IltSettings.SetValue("Bellcore.SecState.Blocked.CT.Icon", blockedCT);
 

Alarm Severities: modify the alarm severity configuration. The following properties can be customized:

• Alarm.Raw.Severity.Icon: this property is used to specify the icon that represents raw alarms in the table and tree components. To compute the alarm representation, this icon will be automatically colored according to the color that corresponds to the severity of the alarm instance.
• Alarm.Impact.Severity.Icon: this property is used to specify the icon that represents impact alarm in the table and tree components. To compute the alarm representation this icon will be automatically colored according to the color that corresponds to the severity of the alarm instance.
• Alarm.Raw.Icon: this property is used to specify the icon that indicates that the object has raw alarms. This icon is added as a secondary state icon in the business object representation.
• Alarm.Impact.Icon: this property is used to specify the icon that indicates that the object has impact alarms. This icon is added as a secondary state icon in the business object representation.

The following properties can be used to customize the representation of raw alarms in the business objects:

• Alarm.Raw.Severity.Color: corresponds to the alarm color that represents the given alarm severity.
• Alarm.Raw.Severity.BrightColor: corresponds to the alarm bright color that represents the given alarm severity. The bright color is used in the business object representation to give the relief effect.
• Alarm.Raw.Severity.DarkColor: corresponds to the alarm dark color that represents the given alarm severity. The dark color is used in the business object representation to give the relief effect.
• Alarm.Raw.Severity.Abbreviation: corresponds to the alarm short description that is used to compose the alarm count of the business object.
• Alarm.Raw.Severity.Description: corresponds to the alarm long description that is used to compose the alarm balloon count 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.
• Alarm.Raw.Severity.Icon: corresponds to the icon that will be used as part of the alarm count representation.

For instance Alarm.Raw.Critical.Color.

The following properties can be used to customize the representation of impact alarms in the business objects:

• Alarm.Impact.Severity.Color: corresponds to the alarm color that represents the given alarm severity.
• Alarm.Impact.Severity.BrightColor: corresponds to the alarm bright color that represents the given alarm severity. The bright color is used in the business object representation to give the relief effect.
• Alarm.Impact.Severity.DarkColor: corresponds to the alarm dark color that represents the given alarm severity. The dark color is used in the business object representation to give the relief effect.
• Alarm.Impact.Severity.Abbreviation: corresponds to the alarm short description that is used to compose the alarm count of the business object.
• Alarm.Impact.Severity.Description: corresponds to the alarm long description that is used to compose the alarm balloon count 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.
• Alarm.Impact.Severity.Icon: corresponds to the icon that will be used as part of the alarm count representation.

For instance Alarm.Impact.CriticalHigh.Color.

The following properties can be used to customize the representation of traps in the business objects:

• Trap.Type.Type.Color: corresponds to the trap color that represents the given trap type.
• Trap.Type.Type.BrightColor: corresponds to the trap bright color that represents the given trap type. The bright color is used in the business object representation to give the relief effect.
• Trap.Type.Type.DarkColor: corresponds to the trap dark color that represents the given trap type. The dark color is used in the business object representation to give the relief effect.
• Trap.Type.Type.Abbreviation: corresponds to the trap short description that is used to compose the alarm count of the business object
• Trap.Type.Type.Description: corresponds to the trap long description that is used to compose the alarm balloon count when the business object uses the extended alarm balloon configuration.
• Trap.Type.Type.Icon: corresponds to the icon that will be used as part of the trap count representation.

For instance: Trap.Type.LinkFailure.Color.

The following properties can be used to toggle the offscreen buffered image optimizations (enabled by default). Complex graphic objects are expensive to render and update, taking extra resources every time they are computed. The offscreen buffered image technique renders such complex graphics into a buffered image kept in memory. This takes advantage of the fact that in memory, buffered images are quickly rendered. This process consumes extra memory due to the number of cached resources, therefore it can be disabled when memory footprint is critical.

• ilog.tgo.polygon.offscreenCache: this property enables or disables the use of offscreen buffered image technique with polygons such as IltPolyGroup and IltLinearGroup.
• ilog.tgo.bts.offscreenCache: this property enables or disables the use of offscreen buffered image technique with BTS Antennas such as IltBTSAntenna.

To disable the offscreen performance improvements for polygons, do the following:

 
 IltSettings.SetValue("OffscreenCache.Polygon", Boolean.FALSE);
 

Similarly, to enable the performance improvements for BTS antennas, do the following:

 IltSettings.SetValue("OffscreenCache.BTS", Boolean.TRUE);
 

Since:

JTGO 4.0

See Also:

IltAlarmRenderer, IltBellcoreRenderer, IltMiscRenderer, IltOSIRenderer, IltPerformanceRenderer, IltSANRenderer, IltSNMPRenderer, IltSONETRenderer, IltInfoWindowRenderer, IltSystemWindowRenderer, IltSubnetworkRenderer, IltCardRenderer, IltCardCarrierRenderer, IltLedRenderer, IltLinkRenderer, IltNetworkElementRenderer, IltOffPageConnectorRenderer, IltObjectRenderer, IltPortRenderer, IltShelfRenderer

Field Summary

Fields inherited from interface ilog.views.util.styling.IlvStylable

APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK

Constructor Summary

IltSettings()
Creates an instance of IltSettings with a default context.

IltSettings(IlpContext context)
Creates an instance of IltSettings with the given context.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property modification listener.
IlpContext	getContext() Retrieves current application context.
static Image	GetImage(Object key) Returns an image property value.
static IltLookAndFeel	getLookAndFeel() Returns the current look and feel.
int	getStyleSheetDebugMask() Returns the current debug level.
String[]	getStyleSheets() Returns the cascaded style sheets.
String	getStyleSheets(int index) Returns one of the cascaded style sheets.
static Object	GetValue(Object key) Returns the value of a property.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property modification listener.
static void	setLookAndFeel(IltLookAndFeel lf) Sets a new Look and Feel.
void	setStyleSheetDebugMask(int mask) Sets the debug level while parsing the style sheets.
void	setStyleSheets(int index, String css) Changes one of the cascading style sheets.
void	setStyleSheets(String[] css) Sets the cascading style sheets.
static Object	SetValue(Object key, Object value) Sets the value of a property in the current configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IltSettings

public IltSettings()

Creates an instance of IltSettings with a default context.

Since:

JViews 7.5

IltSettings

public IltSettings(IlpContext context)

Creates an instance of IltSettings with the given context.

Parameters:

context - The used context.

Since:

JViews 7.5

Method Detail

getLookAndFeel

public static IltLookAndFeel getLookAndFeel()

Returns the current look and feel.

Returns:

The current look and feel.

Since:

JViews 7.5

setLookAndFeel

public static void setLookAndFeel(IltLookAndFeel lf)

Sets a new Look and Feel.

This method sets new configuration values to the global settings.

This new configuration is not immediately applied to the objects that are already being displayed in graphic views. These objects will be updated once needed, that is:

• When the attribute values have change.
• If a new style sheet is applied.
• On request. See IlpGraphicView.invalidateGraphics() for more information.

Parameters:

lf - The new look and feel.

Since:

JViews 7.5

GetValue

public static Object GetValue(Object key)

Returns the value of a property.

Parameters:

key - The property identifier.

SetValue

public static Object SetValue(Object key,
                              Object value)

Sets the value of a property in the current configuration.

Parameters:

key - The property identifier.

value - The property value.

GetImage

public static Image GetImage(Object key)

Returns an image property value.

Parameters:

key - The property identifier.

Returns:

The Image that is defined for key.

setStyleSheets

public void setStyleSheets(String[] css)
                    throws IlvStylingException

Description copied from interface: IlvStylable

Sets the cascading style sheets. Each element can be a URL, a filename, or the style sheet string directly. The order is by priority (the last CSS takes over).

This is a bound property. It means the implementation should fire a PropertyChange event to all registered PropertyChangeListeners after setting the new value.

Specified by:

setStyleSheets in interface IlvStylable

Parameters:

css - An array of strings representing the CSS document (usually with a file or URL with .css suffix).

Throws:

IlvStylingException

Since:

JViews 7.5

setStyleSheets

public void setStyleSheets(int index,
                           String css)
                    throws IlvStylingException

Description copied from interface: IlvStylable

Changes one of the cascading style sheets. A style sheet can be a URL, a filename, or the style sheet string directly. This method is an alternative to IlvStylable.setStyleSheets(java.lang.String[]). It lets you change one particular style sheet file, instead of setting the whole style sheet array.

This is a bound property. It means the implementation should fire a PropertyChange event to all registered PropertyChangeListeners after setting the new value. The old and new value arguments of the event represent the whole array.

Specified by:

setStyleSheets in interface IlvStylable

Parameters:

index - The index of the style sheet to replace.

css - A String representing the CSS document (usually with a file or URL with .css suffix).

Throws:

IlvStylingException

Since:

JViews 7.5

See Also:

IlvStylable.setStyleSheets(java.lang.String[])

getStyleSheets

public String[] getStyleSheets()

Description copied from interface: IlvStylable

Returns the cascaded style sheets.

Specified by:

getStyleSheets in interface IlvStylable

Returns:

An array containing the URLs or file names of the style sheets.

Since:

JViews 7.5

getStyleSheets

public String getStyleSheets(int index)

Description copied from interface: IlvStylable

Returns one of the cascaded style sheets.

Specified by:

getStyleSheets in interface IlvStylable

Parameters:

index - The position of the cascading style sheet to return.

Returns:

The URL or file name of the ith index style sheet.

Since:

JViews 7.5

setStyleSheetDebugMask

public void setStyleSheetDebugMask(int mask)

Description copied from interface: IlvStylable

Sets the debug level while parsing the style sheets. Set this property before calling IlvStylable.setStyleSheets(java.lang.String[]) to debug problems during configuration. This is a bound property. It means the implementation should fire a PropertyChange event to all registered PropertyChangeListeners after setting the new value.

Specified by:

setStyleSheetDebugMask in interface IlvStylable

Parameters:

mask - The debug mask, expressed as an OR combination of the predefined flags.

Since:

JViews 7.5

See Also:

IlvStylable.setStyleSheets(java.lang.String[]), IlvStylable.getStyleSheetDebugMask(), IlvStylable.APPLIED_RULE_MASK, IlvStylable.BAD_CLASS_MASK, IlvStylable.BAD_PROP_MASK, IlvStylable.BAD_PROP_WITH_STACK_MASK, IlvStylable.CREATED_MASK, IlvStylable.DECL_MASK, IlvStylable.DECL_VALUE_MASK, IlvStylable.FAILED_CONVERSIONS_MASK, IlvStylable.TIME_REPORT_MASK, IlvStylable.WARNING_PROP_MASK

getStyleSheetDebugMask

public int getStyleSheetDebugMask()

Description copied from interface: IlvStylable

Returns the current debug level.

Specified by:

getStyleSheetDebugMask in interface IlvStylable

Since:

JViews 7.5

See Also:

IlvStylable.setStyleSheetDebugMask(int)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property modification listener.

Specified by:

addPropertyChangeListener in interface IlvStylable

Parameters:

listener - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property modification listener.

Specified by:

removePropertyChangeListener in interface IlvStylable

Parameters:

listener - The listener to remove.

getContext

public IlpContext getContext()

Retrieves current application context.

Returns:

The current application context.

Since:

JViews 7.5