UserScaleContext (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.ui.scale.UserScaleContext

Direct Known Subclasses:

JBUI.BaseScaleContext
```
public class UserScaleContext
extends java.lang.Object
```
Represents a snapshot of the user space scale factors: ScaleType.USR_SCALE and ScaleType.OBJ_SCALE). The context can be associated with a UI object (see ScaleContextAware) to define its HiDPI behaviour. Unlike ScaleContext, UserScaleContext is device scale independent and is thus used for vector-based painting.

See Also:

ScaleContextAware, ScaleContext

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserScaleContext.Cache<D,S extends UserScaleContext>` A cache for the last usage of a data object matching a scale context.
`static interface`	`UserScaleContext.UpdateListener` A context update listener.

Field Summary

Fields
Modifier and Type Field and Description

protected Scale objScale

protected double pixScale

protected Scale usrScale

Fields
Modifier and Type	Field and Description
`protected Scale`	`objScale`
`protected double`	`pixScale`
`protected Scale`	`usrScale`

Constructor Summary

Constructors
Modifier Constructor and Description

protected UserScaleContext()

Constructors
Modifier	Constructor and Description
`protected`	`UserScaleContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUpdateListener(UserScaleContext.UpdateListener l)`
`double`	`apply(double value, DerivedScaleType type)` Applies the scale of the provided type to `value` and returns the result.
`double`	`apply(double value, ScaleType type)` Applies the scale of the provided type to `value` and returns the result.
`<T extends UserScaleContext> T`	`copy()`
`static UserScaleContext`	`create()` Creates a default context with the current user scale
`static UserScaleContext`	`create(Scale... scales)` Creates a context with the provided scale factors (system scale is ignored)
`static UserScaleContext`	`create(UserScaleContext ctx)` Creates a context from the provided `ctx`.
`static UserScaleContext`	`createIdentity()` Creates a context with all scale factors set to 1.
`protected double`	`derivePixScale()`
`void`	`dispose()` Clears the links.
`boolean`	`equals(java.lang.Object obj)`
`double`	`getScale(DerivedScaleType type)`
`double`	`getScale(ScaleType type)`
`int`	`hashCode()`
`protected boolean`	`isScaleOverridden(Scale scale)`
`protected void`	`notifyUpdateListeners()`
`protected boolean`	`onUpdated(boolean updated)`
`boolean`	`overrideScale(Scale scale)` Permanently overrides the provided scale (the scale won't be changed on subsequent `update()`).
`void`	`removeUpdateListener(UserScaleContext.UpdateListener l)`
`boolean`	`setScale(Scale scale)` Sets the new scale (system scale is ignored).
`java.lang.String`	`toString()`
`boolean`	`update()` Updates the user scale with the current global user scale if necessary.
`boolean`	`update(UserScaleContext ctx)` Updates the context with the state of the provided one.
`protected <T extends UserScaleContext> boolean`	`updateAll(T ctx)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - usrScale
```
protected Scale usrScale
```
  - objScale
```
protected Scale objScale
```
  - pixScale
```
protected double pixScale
```
- Constructor Detail
  - UserScaleContext
```
protected UserScaleContext()
```
- Method Detail
  - createIdentity
```
public static UserScaleContext createIdentity()
```
    Creates a context with all scale factors set to 1.
  - create
```
public static UserScaleContext create(Scale... scales)
```
    Creates a context with the provided scale factors (system scale is ignored)
  - create
```
public static UserScaleContext create()
```
    Creates a default context with the current user scale
  - create
```
public static UserScaleContext create(UserScaleContext ctx)
```
    Creates a context from the provided ctx.
  - derivePixScale
```
protected double derivePixScale()
```
  - overrideScale
```
public boolean overrideScale(Scale scale)
```
    Permanently overrides the provided scale (the scale won't be changed on subsequent update()). Can be used to make a UI object user scale independent:
    ((ScaleContextAware)uiObject).getScaleContext().overrideScale(USR_SCALE.of(1.0));
    
    Parameters:
    
    scale - the new scale to override
    
    Returns:
    
    whether the new scale updated the current value
    
    See Also:
    
    ScaleType.of(double)
  - isScaleOverridden
```
protected boolean isScaleOverridden(Scale scale)
```
  - setScale
```
public boolean setScale(Scale scale)
```
    Sets the new scale (system scale is ignored). Use ScaleType.of(double) to provide the new scale. Note, the new scale value can be change on subsequent update(). Use overrideScale(Scale) to set a scale permanently.
    
    Parameters:
    
    scale - the new scale to set
    
    Returns:
    
    whether the new scale updated the current value
    
    See Also:
    
    ScaleType.of(double)
  - getScale
```
public double getScale(ScaleType type)
```
    Returns:
    
    the context scale factor of the provided type (1d for system scale)
  - getScale
```
public double getScale(DerivedScaleType type)
```
  - apply
```
public double apply(double value,
                    DerivedScaleType type)
```
    Applies the scale of the provided type to value and returns the result.
  - apply
```
public double apply(double value,
                    ScaleType type)
```
    Applies the scale of the provided type to value and returns the result.
  - onUpdated
```
protected boolean onUpdated(boolean updated)
```
  - update
```
public boolean update()
```
    Updates the user scale with the current global user scale if necessary.
    
    Returns:
    
    whether any of the scale factors has been updated
  - update
```
public boolean update(UserScaleContext ctx)
```
    Updates the context with the state of the provided one.
    
    Parameters:
    
    ctx - the new context
    
    Returns:
    
    whether any of the scale factors has been updated
  - updateAll
```
protected <T extends UserScaleContext> boolean updateAll(T ctx)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - dispose
```
public void dispose()
```
    Clears the links.
  - addUpdateListener
```
public void addUpdateListener(UserScaleContext.UpdateListener l)
```
  - removeUpdateListener
```
public void removeUpdateListener(UserScaleContext.UpdateListener l)
```
  - notifyUpdateListeners
```
protected void notifyUpdateListeners()
```
  - copy
```
public <T extends UserScaleContext> T copy()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class UserScaleContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

usrScale

objScale

pixScale

Constructor Detail

UserScaleContext

Method Detail

createIdentity

create

create

create

derivePixScale

overrideScale

isScaleOverridden

setScale

getScale

getScale

apply

apply

onUpdated

update

update

updateAll

equals

hashCode

dispose

addUpdateListener

removeUpdateListener

notifyUpdateListeners

copy

toString