Package com.intellij.util.ui

Class EmptyIcon

java.lang.Object

com.intellij.ui.scale.UserScaleContextSupport

com.intellij.util.ui.JBScalableIcon

com.intellij.util.ui.JBUI.JBIcon

com.intellij.util.ui.JBCachingScalableIcon<EmptyIcon>

com.intellij.util.ui.EmptyIcon

All Implemented Interfaces:

ScalableIcon, CopyableIcon, ScaleContextAware, javax.swing.Icon

Direct Known Subclasses:

ColorIcon, ColorIcon, ColorIconCache.ColorIcon, EmptyIcon.EmptyIconUIResource

public class EmptyIcon
extends JBCachingScalableIcon<EmptyIcon>

See Also:

ColorIcon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmptyIcon.EmptyIconUIResource

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height
static javax.swing.Icon	ICON_0
static javax.swing.Icon	ICON_13
static javax.swing.Icon	ICON_16
static javax.swing.Icon	ICON_18
static javax.swing.Icon	ICON_8
protected int	width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmptyIcon(EmptyIcon icon)
	EmptyIcon(int size) Deprecated. use create(int) for caching.
	EmptyIcon(int width, int height) Deprecated. use create(int, int) for caching.

Method Summary

Modifier and Type	Method and Description
EmptyIcon.EmptyIconUIResource	asUIResource()
EmptyIcon	copy() Returns a copy of this icon.
static EmptyIcon	create(javax.swing.Icon base) Creates an icon of the size of the provided icon base.
static EmptyIcon	create(int size) Creates an icon of the provided size.
static EmptyIcon	create(int width, int height) Creates an icon of the provided size.
boolean	equals(java.lang.Object o)
int	getIconHeight()
int	getIconWidth()
double	getScale(DerivedScaleType type)
double	getScale(ScaleType type)
T	getScaleContext()
int	hashCode()
void	paintIcon(java.awt.Component component, java.awt.Graphics g, int i, int j)
boolean	setScale(Scale scale) Sets the new scale in the context
boolean	updateScaleContext(UserScaleContext ctx) Updates the current context with the state of the provided context.
EmptyIcon	withIconPreScaled(boolean preScaled) The pre-scaled state of the icon indicates whether the initial size of the icon is pre-scaled (by the global user scale) or not.

Methods inherited from class com.intellij.util.ui.JBCachingScalableIcon

scale

Methods inherited from class com.intellij.util.ui.JBScalableIcon

getScale, isIconPreScaled, scaleVal, scaleVal, scaleVal, setAutoUpdateScaleContext, setIconPreScaled, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.ui.icons.CopyableIcon

deepCopy

Field Detail

ICON_18

public static final javax.swing.Icon ICON_18

ICON_16

public static final javax.swing.Icon ICON_16

ICON_13

public static final javax.swing.Icon ICON_13

ICON_8

public static final javax.swing.Icon ICON_8

ICON_0

public static final javax.swing.Icon ICON_0

width

protected final int width

height

protected final int height

Constructor Detail

EmptyIcon

@Deprecated
public EmptyIcon(int size)

Deprecated. use create(int) for caching.

EmptyIcon

@Deprecated
public EmptyIcon(int width,
                 int height)

Deprecated. use create(int, int) for caching.

EmptyIcon

protected EmptyIcon(EmptyIcon icon)

Method Detail

create

public static EmptyIcon create(int size)

Creates an icon of the provided size. Use JBUIScale.scaleIcon(JBScalableIcon) (JBScalableIcon)} to meet HiDPI.

create

public static EmptyIcon create(int width,
                               int height)

Creates an icon of the provided size. Use JBUIScale.scaleIcon(JBScalableIcon) (JBScalableIcon)} to meet HiDPI.

create

public static EmptyIcon create(javax.swing.Icon base)

Creates an icon of the size of the provided icon base.

copy

public EmptyIcon copy()

Description copied from interface: CopyableIcon

Returns a copy of this icon.

The copy should be a new instance, it should preserve the original size and should paint equal to the original bitmap. The subtype of the new icon is up to an implementor. It may or may not be equal the original subtype.

Specified by:

copy in interface CopyableIcon

Specified by:

copy in class JBCachingScalableIcon<EmptyIcon>

withIconPreScaled

public EmptyIcon withIconPreScaled(boolean preScaled)

Description copied from class: JBScalableIcon

The pre-scaled state of the icon indicates whether the initial size of the icon is pre-scaled (by the global user scale) or not. If the size is not pre-scaled, then there're two approaches to deal with it: 1) scale its initial size right away and store; 2) scale its initial size every time it's requested. The 2nd approach is preferable because of the the following. Scaling of the icon may involve not only USR_SCALE but OBJ_SCALE as well. In which case applying all the scale factors and then rounding (the size is integer, the scale factors are not) gives more accurate result than rounding and then scaling.

For example, say we have an icon of 15x15 initial size, USR_SCALE is 1.5f, OBJ_SCALE is 1,5f. Math.round(Math.round(15 * USR_SCALE) * OBJ_SCALE) = 35 Math.round(15 * USR_SCALE * OBJ_SCALE) = 34

Thus, JBUI.scale(MyIcon.create(w, h)) is preferable to MyIcon.create(JBUI.scale(w), JBUI.scale(h)). Here [w, h] is "raw" unscaled size.

Overrides:

withIconPreScaled in class JBScalableIcon

Parameters:

preScaled - whether the icon is pre-scaled

Returns:

the icon in the provided pre-scaled state

See Also:

(JBScalableIcon)

getIconWidth

public int getIconWidth()

getIconHeight

public int getIconHeight()

paintIcon

public void paintIcon(java.awt.Component component,
                      java.awt.Graphics g,
                      int i,
                      int j)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

asUIResource

public EmptyIcon.EmptyIconUIResource asUIResource()

getScaleContext

public T getScaleContext()

Specified by:

getScaleContext in interface ScaleContextAware

Returns:

the scale context

updateScaleContext

public boolean updateScaleContext(UserScaleContext ctx)

Description copied from interface: ScaleContextAware

Updates the current context with the state of the provided context. If ctx is null, then updates the current context via ScaleContext.update() and returns the result.

Specified by:

updateScaleContext in interface ScaleContextAware

Parameters:

ctx - the new scale context

Returns:

whether any of the scale factors has been updated

getScale

public double getScale(ScaleType type)

Specified by:

getScale in interface ScaleContextAware

Returns:

the scale of the provided type from the context

getScale

public double getScale(DerivedScaleType type)

Specified by:

getScale in interface ScaleContextAware

Returns:

the scale of the provided type from the context

setScale

public boolean setScale(Scale scale)

Description copied from interface: ScaleContextAware

Sets the new scale in the context

Specified by:

setScale in interface ScaleContextAware

Returns:

whether the provided scale updated the current value