JBScalableIcon (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.ui.scale.UserScaleContextSupport
- - com.intellij.util.ui.JBScalableIcon

All Implemented Interfaces:

ScalableIcon, ScaleContextAware, javax.swing.Icon

Direct Known Subclasses:

JBUI.JBIcon
```
public abstract class JBScalableIcon
extends UserScaleContextSupport
implements ScalableIcon
```
A scalable icon, UserScaleContext aware, assuming vector-based painting (system scale independent).

Constructor Summary

Constructors
Modifier Constructor and Description

JBScalableIcon()

protected JBScalableIcon(JBScalableIcon icon)

Constructors
Modifier	Constructor and Description
	`JBScalableIcon()`
`protected`	`JBScalableIcon(JBScalableIcon icon)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getScale()`
`double`	`getScale(DerivedScaleType type)`
`double`	`getScale(ScaleType type)`
`T`	`getScaleContext()`
`protected boolean`	`isIconPreScaled()`
`javax.swing.Icon`	`scale(float scale)` Creates and returns a scaled instance of the icon.
`protected double`	`scaleVal(double value)` An equivalent of scaleVal(value, PIX_SCALE)
`protected double`	`scaleVal(double value, DerivedScaleType type)` Returns the value scaled according to the provided scale type
`protected double`	`scaleVal(double value, ScaleType type)` Returns the value scaled according to the provided scale type
`protected void`	`setAutoUpdateScaleContext(boolean autoUpdate)` Sets whether the scale context should be auto-updated by the `Scaler`.
`protected void`	`setIconPreScaled(boolean preScaled)`
`boolean`	`setScale(Scale scale)` Sets the new scale in the context
`java.lang.String`	`toString()`
`boolean`	`updateScaleContext(UserScaleContext ctx)` Updates the current context with the state of the provided context.
`JBScalableIcon`	`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.Icon
getIconHeight, getIconWidth, paintIcon

- Constructor Detail
  - JBScalableIcon
```
public JBScalableIcon()
```
  - JBScalableIcon
```
protected JBScalableIcon(JBScalableIcon icon)
```
- Method Detail
  - isIconPreScaled
```
protected boolean isIconPreScaled()
```
  - setIconPreScaled
```
protected void setIconPreScaled(boolean preScaled)
```
  - withIconPreScaled
```
public JBScalableIcon 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. 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.
    
    Parameters:
    
    preScaled - whether the icon is pre-scaled
    
    Returns:
    
    the icon in the provided pre-scaled state
    
    See Also:
    
    (JBScalableIcon)
  - setAutoUpdateScaleContext
```
protected void setAutoUpdateScaleContext(boolean autoUpdate)
```
    Sets whether the scale context should be auto-updated by the Scaler. This ensures that scaleVal(double) always uses up-to-date scale. This is useful when the icon doesn't need to recalculate its internal sizes on the scale context update and so it doesn't need the result of the update and/or it doesn't listen for updates. Otherwise, the value should be set to false and the scale context should be updated manually.
    By default the value is true.
  - getScale
```
public float getScale()
```
    Specified by:
    
    getScale in interface ScalableIcon
    
    Returns:
    
    the scale of the icon relative to its origin
  - scale
```
public javax.swing.Icon 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
    
    Parameters:
    
    scale - scale
    
    Returns:
    
    scaled icon instance
  - scaleVal
```
protected double scaleVal(double value)
```
    An equivalent of scaleVal(value, PIX_SCALE)
  - scaleVal
```
protected double scaleVal(double value,
                          ScaleType type)
```
    Returns the value scaled according to the provided scale type
  - scaleVal
```
protected double scaleVal(double value,
                          DerivedScaleType type)
```
    Returns the value scaled according to the provided scale type
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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

Class JBScalableIcon

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.Icon

Constructor Detail

JBScalableIcon

JBScalableIcon

Method Detail

isIconPreScaled

setIconPreScaled

withIconPreScaled

setAutoUpdateScaleContext

getScale

scale

scaleVal

scaleVal

scaleVal

toString

getScaleContext

updateScaleContext

getScale

getScale

setScale