Package com.intellij.ui.scale

Enum ScaleType

java.lang.Object

java.lang.Enum<ScaleType>

com.intellij.ui.scale.ScaleType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScaleType>

public enum ScaleType
extends java.lang.Enum<ScaleType>

The IDE supports two different HiDPI modes:

1) IDE-managed HiDPI mode.

Supported for backward compatibility until complete transition to the JRE-managed HiDPI mode happens. In this mode there's a single coordinate space and the whole UI is scaled by the IDE guided by the user scale factor (USR_SCALE).

2) JRE-managed HiDPI mode.

In this mode the JRE scales graphics prior to drawing it on the device. So, there're two coordinate spaces: the user space and the device space. The system scale factor (SYS_SCALE) defines the transform b/w the spaces. The UI size metrics (windows, controls, fonts height) are in the user coordinate space. Though, the raster images should be aware of the device scale in order to meet HiDPI. (For instance, JRE on a Mac Retina monitor device works in the JRE-managed HiDPI mode, transforming graphics to the double-scaled device coordinate space)

The IDE operates the scale factors of the following types:

• 1) The user scale factor: USR_SCALE
• 2) The system (monitor device) scale factor: SYS_SCALE
• 3) The object (UI instance specific) scale factor: OBJ_SCALE

See Also:

JreHiDpiUtil.isJreHiDPIEnabled(), UIUtil.isJreHiDPI(), JreHiDpiUtil.isJreHiDPI(GraphicsConfiguration), JreHiDpiUtil.isJreHiDPI(Graphics2D), JBUIScale.isUsrHiDPI(), UIUtil.drawImage(Graphics, Image, Rectangle, Rectangle, ImageObserver), ImageUtil.createImage(GraphicsConfiguration, int, int, int), ImageUtil.createImage(int, int, int), ScaleContext

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBJ_SCALE An extra scale factor of a particular UI object, which doesn't affect any other UI object, as opposed to the user scale and the system scale factors.
SYS_SCALE The system scale factor is defined by the device DPI and/or the system settings.
USR_SCALE The user scale factor is set and managed by the IDE.

Method Summary

Modifier and Type	Method and Description
Scale	of(double value)
static ScaleType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScaleType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USR_SCALE

public static final ScaleType USR_SCALE

The user scale factor is set and managed by the IDE. Currently it's derived from the UI font size, specified in the IDE Settings.

The user scale value depends on which HiDPI mode is enabled. In the IDE-managed HiDPI mode the user scale "includes" the default system scale and simply equals it with the default UI font size. In the JRE-managed HiDPI mode the user scale is independent of the system scale and equals 1.0 with the default UI font size. In case the default UI font size changes, the user scale changes proportionally in both the HiDPI modes.

In the IDE-managed HiDPI mode the user scale completely defines the UI scale. In the JRE-managed HiDPI mode the user scale can be considered a supplementary scale taking effect in cases like the IDE Presentation Mode and when the default UI scale is changed by the user.

See Also:

JBUIScale.setUserScaleFactor(float), JBUIScale.scale(float), JBUIScale.scale(int)

SYS_SCALE

public static final ScaleType SYS_SCALE

The system scale factor is defined by the device DPI and/or the system settings. For instance, Mac Retina monitor device has the system scale 2.0 by default. As there can be multiple devices (multi-monitor configuration) there can be multiple system scale factors, appropriately. However, there's always a single default system scale factor corresponding to the default device. And it's the only system scale available in the IDE-managed HiDPI mode.

In the JRE-managed HiDPI mode, the system scale defines the scale of the transform b/w the user and the device coordinate spaces performed by the JRE.

See Also:

JBUIScale.sysScale(), JBUIScale.sysScale(GraphicsConfiguration), JBUIScale.sysScale(Graphics2D), JBUIScale.sysScale(Component)

OBJ_SCALE

public static final ScaleType OBJ_SCALE

An extra scale factor of a particular UI object, which doesn't affect any other UI object, as opposed to the user scale and the system scale factors. This scale factor affects the user space size of the object and doesn't depend on the HiDPI mode. By default it is set to 1.0.

Method Detail

values

public static ScaleType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScaleType c : ScaleType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScaleType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

of

public Scale of(double value)