Package com.intellij.openapi.util

Class IconLoader

java.lang.Object

com.intellij.openapi.util.IconLoader

public final class IconLoader
extends java.lang.Object

Provides access to icons used in the UI.

Please see Working with Icons and Images about supported formats, organization, and accessing icons in plugins.

See Also:

IconUtil

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IconLoader.CachedImageIcon
static class	IconLoader.LazyIcon Consider using #createLazy).

Method Summary

Modifier and Type	Method and Description
static void	activate()
static void	clearCache()
static javax.swing.Icon	copy(javax.swing.Icon icon, java.awt.Component ancestor, boolean deepCopy)
static javax.swing.Icon	createLazy(java.util.function.Supplier<javax.swing.Icon> producer)
static void	deactivate()
static void	detachClassLoader(java.lang.ClassLoader classLoader)
static javax.swing.Icon	filterIcon(javax.swing.Icon icon, java.util.function.Supplier<? extends java.awt.image.RGBImageFilter> filterSupplier, java.awt.Component ancestor) Creates new icon with the filter applied.
static javax.swing.Icon	findIcon(java.lang.String path) Might return null if icon was not found.
static javax.swing.Icon	findIcon(java.lang.String path, boolean strict)
static javax.swing.Icon	findIcon(java.lang.String path, java.lang.Class<?> aClass) Might return null if icon was not found.
static javax.swing.Icon	findIcon(java.lang.String path, java.lang.Class<?> aClass, boolean computeNow)
static javax.swing.Icon	findIcon(java.lang.String path, java.lang.Class<?> aClass, boolean computeNow, boolean strict)
static javax.swing.Icon	findIcon(java.lang.String path, java.lang.ClassLoader classLoader)
static javax.swing.Icon	findIcon(java.net.URL url)
static javax.swing.Icon	findIcon(java.net.URL url, boolean useCache)
static javax.swing.Icon	findLafIcon(java.lang.String key, java.lang.Class<?> aClass, boolean strict)
static javax.swing.Icon	getDarkIcon(javax.swing.Icon icon, boolean dark) Returns a copy of the provided icon with darkness set to dark.
static javax.swing.Icon	getDisabledIcon(javax.swing.Icon icon) Gets (creates if necessary) disabled icon based on the passed one.
static javax.swing.Icon	getIcon(java.awt.Image image) Deprecated. use JBImageIcon
static javax.swing.Icon	getIcon(java.lang.String path)
static javax.swing.Icon	getIcon(java.lang.String path, java.lang.Class aClass)
static javax.swing.Icon	getIconSnapshot(javax.swing.Icon icon) Gets a snapshot of the icon, immune to changes made by these calls: setFilter(ImageFilter), setUseDarkIcons(boolean)
static javax.swing.Icon	getMenuBarIcon(javax.swing.Icon icon, boolean dark) For internal usage.
static javax.swing.Icon	getReflectiveIcon(java.lang.String path, java.lang.ClassLoader classLoader)
static javax.swing.Icon	getTransparentIcon(javax.swing.Icon icon)
static javax.swing.Icon	getTransparentIcon(javax.swing.Icon icon, float alpha)
static void	installPathPatcher(IconPathPatcher patcher)
static boolean	isGoodSize(javax.swing.Icon icon)
static <T,E extends java.lang.Throwable> T	performStrictly(ThrowableComputable<T,E> computable)
static void	removePathPatcher(IconPathPatcher patcher)
static void	setFilter(java.awt.image.ImageFilter filter)
static void	setStrictGlobally(boolean strict)
static void	setUseDarkIcons(boolean useDarkIcons)
static java.awt.Image	toImage(javax.swing.Icon icon)
static java.awt.Image	toImage(javax.swing.Icon icon, ScaleContext ctx)

Methods inherited from class java.lang.Object

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

Method Detail

performStrictly

public static <T,E extends java.lang.Throwable> T performStrictly(ThrowableComputable<T,E> computable)
                                                           throws E extends java.lang.Throwable

Throws:

E extends java.lang.Throwable

setStrictGlobally

public static void setStrictGlobally(boolean strict)

installPathPatcher

public static void installPathPatcher(IconPathPatcher patcher)

removePathPatcher

public static void removePathPatcher(IconPathPatcher patcher)

getIcon

@Deprecated
public static javax.swing.Icon getIcon(java.awt.Image image)

Deprecated. use JBImageIcon

setUseDarkIcons

public static void setUseDarkIcons(boolean useDarkIcons)

setFilter

public static void setFilter(java.awt.image.ImageFilter filter)

clearCache

public static void clearCache()

getIcon

public static javax.swing.Icon getIcon(java.lang.String path)

getReflectiveIcon

public static javax.swing.Icon getReflectiveIcon(java.lang.String path,
                                                 java.lang.ClassLoader classLoader)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path)

Might return null if icon was not found. Use only if you expected null return value, otherwise see getIcon(String)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path,
                                        boolean strict)

getIcon

public static javax.swing.Icon getIcon(java.lang.String path,
                                       java.lang.Class aClass)

activate

public static void activate()

deactivate

public static void deactivate()

findLafIcon

public static javax.swing.Icon findLafIcon(java.lang.String key,
                                           java.lang.Class<?> aClass,
                                           boolean strict)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path,
                                        java.lang.Class<?> aClass)

Might return null if icon was not found. Use only if you expected null return value, otherwise see getIcon(String, Class)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path,
                                        java.lang.Class<?> aClass,
                                        boolean computeNow)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path,
                                        java.lang.Class<?> aClass,
                                        boolean computeNow,
                                        boolean strict)

findIcon

public static javax.swing.Icon findIcon(java.net.URL url)

findIcon

public static javax.swing.Icon findIcon(java.net.URL url,
                                        boolean useCache)

findIcon

public static javax.swing.Icon findIcon(java.lang.String path,
                                        java.lang.ClassLoader classLoader)

toImage

public static java.awt.Image toImage(javax.swing.Icon icon)

toImage

public static java.awt.Image toImage(javax.swing.Icon icon,
                                     ScaleContext ctx)

copy

public static javax.swing.Icon copy(javax.swing.Icon icon,
                                    java.awt.Component ancestor,
                                    boolean deepCopy)

isGoodSize

public static boolean isGoodSize(javax.swing.Icon icon)

getDisabledIcon

public static javax.swing.Icon getDisabledIcon(javax.swing.Icon icon)

Gets (creates if necessary) disabled icon based on the passed one.

Returns:

ImageIcon constructed from disabled image of passed icon.

filterIcon

public static javax.swing.Icon filterIcon(javax.swing.Icon icon,
                                          java.util.function.Supplier<? extends java.awt.image.RGBImageFilter> filterSupplier,
                                          java.awt.Component ancestor)

Creates new icon with the filter applied.

getTransparentIcon

public static javax.swing.Icon getTransparentIcon(javax.swing.Icon icon)

getTransparentIcon

public static javax.swing.Icon getTransparentIcon(javax.swing.Icon icon,
                                                  float alpha)

getIconSnapshot

public static javax.swing.Icon getIconSnapshot(javax.swing.Icon icon)

Gets a snapshot of the icon, immune to changes made by these calls: setFilter(ImageFilter), setUseDarkIcons(boolean)

Parameters:

icon - the source icon

Returns:

the icon snapshot

getMenuBarIcon

public static javax.swing.Icon getMenuBarIcon(javax.swing.Icon icon,
                                              boolean dark)

For internal usage. Converts the icon to 1x scale when applicable.

getDarkIcon

public static javax.swing.Icon getDarkIcon(javax.swing.Icon icon,
                                           boolean dark)

Returns a copy of the provided icon with darkness set to dark. The method takes effect on a IconLoader.CachedImageIcon (or its wrapper) only.

detachClassLoader

public static void detachClassLoader(java.lang.ClassLoader classLoader)

createLazy

public static javax.swing.Icon createLazy(java.util.function.Supplier<javax.swing.Icon> producer)