Package org.gnome.adw

Enum Class LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

org.gnome.adw.LengthUnit

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LengthUnit>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum LengthUnit
extends Enum<LengthUnit>
implements Enumeration

Describes length units.

| Unit | Regular Text | Large Text | | ---- | ------------ | ---------- | | 1px | 1px | 1px | | 1pt | 1.333333px | 1.666667px | | 1sp | 1px | 1.25px |

New values may be added to this enumeration over time.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PT	points, changes with text scale factor
PX	pixels
SP	scale independent pixels, changes with text scale factor

Method Summary

Modifier and Type	Method	Description
double	fromPx(double value, @Nullable Settings settings)	Converts value from pixels to this LengthUnit.
static Type	getType()	Get the GType of the LengthUnit class
int	getValue()	Get the numeric value of this enum
static LengthUnit	of(int value)	Create a new LengthUnit for the provided value
double	toPx(double value, @Nullable Settings settings)	Converts value from this LengthUnit to pixels.
static LengthUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LengthUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PX

public static final LengthUnit PX

pixels

PT

public static final LengthUnit PT

points, changes with text scale factor

SP

public static final LengthUnit SP

scale independent pixels, changes with text scale factor

Method Details

values

public static LengthUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LengthUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static LengthUnit of(int value)

Create a new LengthUnit for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the LengthUnit class

Returns:

the GType

fromPx

public double fromPx(double value,
 @Nullable
 @Nullable Settings settings)

Converts value from pixels to this LengthUnit.

Parameters:

value - a value in pixels

settings - settings to use, or NULL for default settings

Returns:

the length in this LengthUnit

toPx

public double toPx(double value,
 @Nullable
 @Nullable Settings settings)

Converts value from this LengthUnit to pixels.

Parameters:

value - a value in this LengthUnit

settings - settings to use, or NULL for default settings

Returns:

the length in pixels