Package jmri.jmrit.etcs

Class ResourceUtil

java.lang.Object

jmri.jmrit.etcs.ResourceUtil

@API(status=EXPERIMENTAL)
public class ResourceUtil
extends Object

Class to locate ERTMS Graphical and Audio resources.

Method Summary

Modifier and Type	Method	Description
static BufferedImage	convertColorToTransparent(BufferedImage image)	Convert an image containing the DMI Background Colour to a transparent background.
static File	getImageFile(String fileName)	Get the File for an Image.
static ImageIcon	getImageIcon(String fileName)	Get the Image Icon for a given FileName.
static BufferedImage	getTransparentImage(String str)
static void	playDmiSound(int sound)	Play one of the DMI UI Sounds. 1 - S1_toofast.wav - 2 secs 2 - S2_warning.wav - 3 secs 3 - S_info.wav - 1 sec 4 - click.wav - 1 sec
static BufferedImage	readFile(File f)
static void	stopDmiSound(int sound)	Stop a DMI Sound from playing.

Methods inherited from class java.lang.Object

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

Method Details

getImageFile

@Nonnull
public static File getImageFile(String fileName)

Get the File for an Image. Note this File may not actually exist.

Parameters:

fileName - the Filename to search for.

Returns:

File with appropriate Directory.

getImageIcon

@CheckForNull
public static ImageIcon getImageIcon(String fileName)

Get the Image Icon for a given FileName.

Parameters:

fileName - the FileName to search for.

Returns:

ImageIcon, or null if image not located.

getTransparentImage

@CheckForNull
public static BufferedImage getTransparentImage(@Nonnull
 String str)

readFile

@CheckForNull
public static BufferedImage readFile(File f)

convertColorToTransparent

@CheckForNull
public static BufferedImage convertColorToTransparent(@CheckForNull
 BufferedImage image)

Convert an image containing the DMI Background Colour to a transparent background.

Parameters:

image - the Image to convert.

Returns:

converted image, or null.

playDmiSound

public static void playDmiSound(int sound)
                         throws IllegalArgumentException

Play one of the DMI UI Sounds. 1 - S1_toofast.wav - 2 secs 2 - S2_warning.wav - 3 secs 3 - S_info.wav - 1 sec 4 - click.wav - 1 sec

Parameters:

sound - which Sound, plays once.

Throws:

IllegalArgumentException - when needed

stopDmiSound

public static void stopDmiSound(int sound)

Stop a DMI Sound from playing.

Parameters:

sound - normally 2, the only sound which plays in a loop.