oracle.dss.gauge

Class KPIStyleCallback

java.lang.Object

oracle.dss.gauge.LEDStyleCallback

oracle.dss.gauge.KPIStyleCallback

public class KPIStyleCallback
extends LEDStyleCallback

Since:

11.0

For internal use only. Application developers should not use this

Provides a mechanism to include KPI images for LED gauges which require a KPI look and feel.

Field Summary

Fields inherited from class oracle.dss.gauge.LEDStyleCallback

SOURCE_IMAGE, SOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
KPIStyleCallback() Constructor providing an indication of the method by which images will be loaded.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Image	getLEDImage(int index) Called when an instance of java.awt.Image is needed by a Gauge and this callback instance has been initialized to require Image objects.
java.lang.String	getLEDImagePath(int index) Called when a relative path to an LED image is needed by a Gauge and this callback instance has been initialized to require Image objects.

Methods inherited from class oracle.dss.gauge.LEDStyleCallback

getBaseImageURI, getLEDCount, getLEDImage, getMethod, setLEDCount

Methods inherited from class java.lang.Object

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

Constructor Detail

KPIStyleCallback

public KPIStyleCallback()

Constructor providing an indication of the method by which images will be loaded.

Parameters:

method - Integer; can be either SOURCE_IMAGE or SOURCE_PATH

Method Detail

getLEDImage

public java.awt.Image getLEDImage(int index)

Called when an instance of java.awt.Image is needed by a Gauge and this callback instance has been initialized to require Image objects. The number of threshold LEDs required by the gauge for which this implementation runs can be retrieved with the get

Specified by:

getLEDImage in class LEDStyleCallback

Parameters:

index - Index of the threshold for which to load the image

Returns:

Instance of Image

getLEDImagePath

public java.lang.String getLEDImagePath(int index)

Called when a relative path to an LED image is needed by a Gauge and this callback instance has been initialized to require Image objects. Image paths are stored in a vector of strings.

The relative path returned from this method is appended to the BaseImageURI to construct the full path to the image. The full path may specify a URL or a resource on the classpath.

For example, the relative path to an image may be "images/myImage.gif". If no BaseImageURI is set, then this method attempts to load the image from the classpath, on the specified path relative to the Gauge class, which would be "/oracle/dss/gauge/images/myImage.gif".

If BaseImageURI is "/myPackage/myComponent/", then this method attempts to load the image from the classpath on the specified absolute path, "/myPackage/myComponent/images/myImage.gif".

If BaseImageURI is "http://my.server.com/", then this method attempts to load the image at the given URL, "http://my.server.com/images/myImage.gif".

If an image cannot be loaded, a special "not loaded" image will be used instead.

Specified by:

getLEDImagePath in class LEDStyleCallback

Parameters:

index - The threshold index, which is always one greater than the number of thresholds determined by the DataSpecification object.

path - The relative path to an image file

See Also:

Gauge, DataSpecification