Package com.intellij.util.ui

Class JBCachingScalableIcon<T extends JBCachingScalableIcon>

java.lang.Object

com.intellij.ui.scale.UserScaleContextSupport

com.intellij.util.ui.JBScalableIcon

com.intellij.util.ui.JBUI.JBIcon

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

All Implemented Interfaces:

ScalableIcon, CopyableIcon, ScaleContextAware, javax.swing.Icon

Direct Known Subclasses:

DeferredIconImpl, EmptyIcon, SizedIcon

public abstract class JBCachingScalableIcon<T extends JBCachingScalableIcon>
extends JBUI.JBIcon
implements CopyableIcon

A JBScalableIcon providing an immutable caching implementation of the ScalableIcon.scale(float) method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JBCachingScalableIcon()
protected	JBCachingScalableIcon(JBCachingScalableIcon icon)

Method Summary

Modifier and Type	Method and Description
abstract T	copy() Returns a copy of this icon.
double	getScale(DerivedScaleType type)
double	getScale(ScaleType type)
T	getScaleContext()
T	scale(float scale) Creates and returns a scaled instance of the icon.
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.

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

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

Methods inherited from class java.lang.Object

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

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

deepCopy

Methods inherited from interface javax.swing.Icon

getIconHeight, getIconWidth, paintIcon

Constructor Detail

JBCachingScalableIcon

protected JBCachingScalableIcon()

JBCachingScalableIcon

protected JBCachingScalableIcon(JBCachingScalableIcon icon)

Method Detail

scale

public T scale(float scale)

Description copied from interface: ScalableIcon

Creates and returns a scaled instance of the icon. The icon is scaled relative to its origin, that is scale(1f) will return the icon in its original scale. To scale this instance by n times: scale(n * getScale()). Note that the methods Icon.getIconWidth() and Icon.getIconHeight() should return the scaled size of the icon.

Specified by:

scale in interface ScalableIcon

Overrides:

scale in class JBScalableIcon

Parameters:

scale - scale

Returns:

a new scaled copy of this icon, or the cached instance of the provided scale

copy

public abstract T 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

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