|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1) E12063-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.gauge.LEDStyleCallback
public abstract class LEDStyleCallback
This abstract class should be implemented by Gauge bean consumers to provide customized LED image support. It is responsible for loading the images (if loading is required from image paths) and maintaining a single copy of the list of those images. The Gauge bean should control only a single instance of this implementation to optimize image loading and performance. Loading of images is deferred until the Gauge needs to render the gauges.
Field Summary | |
---|---|
static int |
SOURCE_IMAGE Constant to indicate images should be loaded from Image objects. |
static int |
SOURCE_PATH Constant to indicate images should be loaded from image paths. |
Constructor Summary | |
---|---|
LEDStyleCallback(int method) Constructor providing an indication of the method by which images will be loaded. |
Method Summary | |
---|---|
java.lang.String |
getBaseImageURI() Gets the base image URI from which image paths are loaded. |
int |
getLEDCount() Gets the number of LED images this implementation should plan on loading. |
abstract 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.awt.Image |
getLEDImage(int index, ErrorHandler handler) |
abstract 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. |
int |
getMethod() Gets the method by which images should be loaded. |
void |
setLEDCount(int count) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static int SOURCE_PATH
public static int SOURCE_IMAGE
Constructor Detail |
---|
public LEDStyleCallback(int method)
method
- Integer; can be either SOURCE_IMAGE or SOURCE_PATHMethod Detail |
---|
public int getMethod()
public abstract 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 getindex
- Index of the threshold for which to load the imageImage
public abstract java.lang.String getLEDImagePath(int index)
Gauge
and this callback instance has been initialized to require Image objects. Image paths are stored in a list 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.
index
- The threshold index, which is always one greater than the number of thresholds determined by the DataSpecification
object.Gauge
, DataSpecification
public java.lang.String getBaseImageURI()
String
representing the base image URIpublic int getLEDCount()
Gauge
public void setLEDCount(int count)
public java.awt.Image getLEDImage(int index, ErrorHandler handler)
index
- Index of LED image to get.handler
- Instance of ErrorHandler
List
containing loaded images.List
.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1) E12063-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |