Package com.luciad.drawing

Class ImageIcon

java.lang.Object

com.luciad.drawing.ImageIcon

public final class ImageIcon
extends Object

Helper class for loading JPEG or PNG files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImageIcon.Builder	Builder which takes images as input to create an IIcon.

Method Summary

Modifier and Type	Method	Description
static IIcon	create(String filePath)	Create an IIcon from a PNG or JPEG file.
static ImageIcon.Builder	newBuilder()	Creates a Builder which allows to construct an IIcon based on 1 or more images.
static IIcon	toIcon(Image image)	Converts an Image to an Icon.

Methods inherited from class java.lang.Object

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

Method Details

create

@NotNull
public static IIcon create(@NotNull
 String filePath)
                    throws RuntimeException

Create an IIcon from a PNG or JPEG file.

Will throw a RuntimeError if the file does not contain any valid data or if the file format could not be recognized.

It accepts icon files with following naming convention.

• The base icon at display scale 1 is named <name>.<ext> where <ext> is PNG or JPEG.
• The icon at display scale f is named <name>@<f>x.<ext>. f is typically a value like 2 or 4. See the article on high DPI for additional information.

Parameters:

filePath - a file path

Returns:

an IIcon from a PNG or JPEG file

Throws:

RuntimeException - if the file does not contain any valid data or if the file format could not be recognized.

toIcon

@NotNull
public static IIcon toIcon(@NotNull
 Image image)
                    throws NullPointerException

Converts an Image to an Icon.

The used display scale is 1. The anchor point of the icon is at the center of the image.

Parameters:

image - the Image to convert.

Returns:

the IIcon.

Throws:

NullPointerException - when passing a null value.

Since:

2023.1

newBuilder

@NotNull
public static ImageIcon.Builder newBuilder()

Creates a Builder which allows to construct an IIcon based on 1 or more images.

Returns:

the builder.

Since:

2023.1