fr.cnes.genius.lowLevel

Class GIcon

java.lang.Object

javax.swing.ImageIcon

fr.cnes.genius.lowLevel.GIcon

All Implemented Interfaces:

Serializable, Accessible, Icon

public class GIcon
extends ImageIcon

The class GIcon defines the commonly used icons based on choice among icons of GENIUS resources, and the associated icon type name among : OPEN, SAVE, EXIT, START, STOP, WARNING, ERROR, INFO, DELETE, PRINT, EXPAND, COLLAPSE, CLEAR, COPY, PASTE, IMPORT, EXPORT.

Author:

JF Goester

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GIcon.Type Types of icons.

Nested classes/interfaces inherited from class javax.swing.ImageIcon

ImageIcon.AccessibleImageIcon

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GENIUS_ICON_FILE Default GENIUS application frame icon file name

Fields inherited from class javax.swing.ImageIcon

component, tracker

Constructor Summary

Constructors

Constructor and Description
GIcon(GIcon.Type type, int size) Constructor with the type of the icon end its size.

Method Summary

Modifier and Type	Method and Description
static GIcon	createGIconFromURL(URL url, int size) Gets an icon from the provided URL and scales it to the requested size.
static GIcon	createIconFromFile(String iconpath) Create a GIcon from an image file
static ImageIcon	createIconFromURL(URL url, int size) Gets an icon from the provided URL and scales it to the requested size.
static Image	createImageFromURL(URL url, int size) Gets an image from the provided URL and scales it to the requested size.
static URL	getIconURL(String imageName) Get the URL of an icon, prepending the prefix "/fr/cnes/genius/icons/" to imageName.
static URL	getIconURLFromPath(String imagePath) Get the URL of an icon, prepending the prefix "/fr/cnes/genius/icons/" to imageName.

Methods inherited from class javax.swing.ImageIcon

getAccessibleContext, getDescription, getIconHeight, getIconWidth, getImage, getImageLoadStatus, getImageObserver, loadImage, paintIcon, setDescription, setImage, setImageObserver, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GENIUS_ICON_FILE

public static final String DEFAULT_GENIUS_ICON_FILE

Default GENIUS application frame icon file name

See Also:

Constant Field Values

Constructor Detail

GIcon

public GIcon(GIcon.Type type,
             int size)

Constructor with the type of the icon end its size.

Parameters:

type - type of icon available in the following list : OPEN, SAVE, EXIT, START, STOP, WARNING, ERROR, INFO, DELETE, PRINT

size - size in pixels of this icon.

Method Detail

getIconURL

public static URL getIconURL(String imageName)
                      throws GException

Get the URL of an icon, prepending the prefix "/fr/cnes/genius/icons/" to imageName.

Parameters:

imageName - name of the image file that will be prefixed by "/fr/cnes/genius/icons/".

Returns:

the URL of the image if found or null otherwise.

Throws:

GException - in case the icon can not be found.

getIconURLFromPath

public static URL getIconURLFromPath(String imagePath)
                              throws GException

Get the URL of an icon, prepending the prefix "/fr/cnes/genius/icons/" to imageName.

Parameters:

imagePath - resource path of the image file that will not be prefixed by "/fr/cnes/genius/icons/".

Returns:

the URL of the image if found or null otherwise.

Throws:

GException - in case the icon can not be found.

createGIconFromURL

public static GIcon createGIconFromURL(URL url,
                                       int size)
                                throws IOException

Gets an icon from the provided URL and scales it to the requested size.

Parameters:

url - of the icon.

size - of the result icon.

Returns:

the requested image if found or null otherwise.

Throws:

IOException - In case the icon can not be read.

createIconFromURL

public static ImageIcon createIconFromURL(URL url,
                                          int size)
                                   throws IOException

Gets an icon from the provided URL and scales it to the requested size.

Parameters:

url - of the icon.

size - of the result icon.

Returns:

the requested image if found or null otherwise.

Throws:

IOException - In case the icon can not be read.

createImageFromURL

public static Image createImageFromURL(URL url,
                                       int size)
                                throws IOException

Gets an image from the provided URL and scales it to the requested size.

Parameters:

url - of the image.

size - of the result image.

Returns:

the requested image if found or null otherwise.

Throws:

IOException - In case the image can not be read.

createIconFromFile

public static GIcon createIconFromFile(String iconpath)

Create a GIcon from an image file

Parameters:

iconpath - the full path of the image file

Returns:

a GIcon object