public class KPIStyleCallback extends LEDStyleCallback
SOURCE_IMAGE, SOURCE_PATH
Constructor and Description |
---|
KPIStyleCallback()
Constructor providing an indication of the method by which images will be loaded.
|
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. |
getBaseImageURI, getLEDCount, getLEDImage, getMethod, setLEDCount
public KPIStyleCallback()
method
- Integer; can be either SOURCE_IMAGE or SOURCE_PATHpublic java.awt.Image getLEDImage(int index)
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 getgetLEDImage
in class LEDStyleCallback
index
- Index of the threshold for which to load the imageImage
public java.lang.String getLEDImagePath(int index)
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.
getLEDImagePath
in class LEDStyleCallback
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 fileGauge
, DataSpecification