Package com.intellij.ui.scale

Class ScaleContext

java.lang.Object

com.intellij.ui.scale.UserScaleContext

com.intellij.util.ui.JBUI.BaseScaleContext

com.intellij.ui.scale.ScaleContext

Direct Known Subclasses:

JBUI.ScaleContext

public class ScaleContext
extends JBUI.BaseScaleContext

Extends UserScaleContext with the system scale, and is thus used for raster-based painting. The context is created via a context provider. If the provider is Component, the context's system scale can be updated via a call to update(), reflecting the current component's system scale (which may change as the component moves b/w devices).

See Also:

ScaleContextAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScaleContext.Cache<D>

Nested classes/interfaces inherited from class com.intellij.ui.scale.UserScaleContext

UserScaleContext.UpdateListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.ref.WeakReference<java.awt.Component>	compRef
protected Scale	sysScale

Fields inherited from class com.intellij.ui.scale.UserScaleContext

objScale, pixScale, usrScale

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScaleContext()
protected	ScaleContext(Scale scale)

Method Summary

Modifier and Type	Method and Description
<T extends UserScaleContext> T	copy()
static ScaleContext	create() Creates a default context with the default screen scale and the current user scale
static ScaleContext	create(java.awt.Component comp) Creates a context based on the comp's system scale and sticks to it via the update() method.
static ScaleContext	create(java.awt.Graphics2D g) Creates a context based on the g's system scale
static ScaleContext	create(java.awt.GraphicsConfiguration gc) Creates a context based on the gc's system scale
static ScaleContext	create(Scale... scales) Creates a context with the provided scale factors
static ScaleContext	create(Scale scale) Creates a context with the provided scale
static ScaleContext	create(UserScaleContext ctx) Creates a context from the provided ctx.
static ScaleContext	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()
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.
protected <T extends UserScaleContext> boolean	updateAll(T ctx)

Methods inherited from class com.intellij.util.ui.JBUI.BaseScaleContext

getScale, update, update

Methods inherited from class com.intellij.ui.scale.UserScaleContext

addUpdateListener, apply, apply, isScaleOverridden, notifyUpdateListeners, onUpdated, overrideScale, removeUpdateListener, update

Methods inherited from class java.lang.Object

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

Field Detail

sysScale

protected Scale sysScale

compRef

protected java.lang.ref.WeakReference<java.awt.Component> compRef

Constructor Detail

ScaleContext

protected ScaleContext()

ScaleContext

protected ScaleContext(Scale scale)

Method Detail

createIdentity

public static ScaleContext createIdentity()

Creates a context with all scale factors set to 1.

create

public static ScaleContext create(UserScaleContext ctx)

Creates a context from the provided ctx.

create

public static ScaleContext create(java.awt.Component comp)

Creates a context based on the comp's system scale and sticks to it via the update() method.

create

public static ScaleContext create(java.awt.GraphicsConfiguration gc)

Creates a context based on the gc's system scale

create

public static ScaleContext create(java.awt.Graphics2D g)

Creates a context based on the g's system scale

create

public static ScaleContext create(Scale scale)

Creates a context with the provided scale

create

public static ScaleContext create(Scale... scales)

Creates a context with the provided scale factors

create

public static ScaleContext create()

Creates a default context with the default screen scale and the current user scale

derivePixScale

protected double derivePixScale()

Overrides:

derivePixScale in class UserScaleContext

getScale

public double getScale(ScaleType type)

Overrides:

getScale in class UserScaleContext

Returns:

the context scale factor of the provided type (1d for system scale)

getScale

public double getScale(DerivedScaleType type)

Overrides:

getScale in class UserScaleContext

update

public boolean update()

Updates the user scale with the current global user scale if necessary. Also updates the system scale (if the context was created from Component) if necessary.

Overrides:

update in class UserScaleContext

Returns:

whether any of the scale factors has been updated

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 UserScaleContext.update(). Use UserScaleContext.overrideScale(Scale) to set a scale permanently. Also includes the system scale.

Overrides:

setScale in class UserScaleContext

Parameters:

scale - the new scale to set

Returns:

whether the new scale updated the current value

See Also:

ScaleType.of(double)

updateAll

protected <T extends UserScaleContext> boolean updateAll(T ctx)

Overrides:

updateAll in class UserScaleContext

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class UserScaleContext

hashCode

public int hashCode()

Overrides:

hashCode in class UserScaleContext

dispose

public void dispose()

Description copied from class: UserScaleContext

Clears the links.

Overrides:

dispose in class UserScaleContext

copy

public <T extends UserScaleContext> T copy()

Overrides:

copy in class UserScaleContext

toString

public java.lang.String toString()

Overrides:

toString in class UserScaleContext