Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class SVGUnit

java.lang.Object

java.lang.Enum<SVGUnit>

org.freedesktop.cairo.SVGUnit

All Implemented Interfaces:

Serializable, Comparable<SVGUnit>, Constable

public enum SVGUnit
extends Enum<SVGUnit>

SVGUnit is used to describe the units valid for coordinates and lengths in the SVG specification.

See also:

• https://www.w3.org/TR/SVG/coords.html#Units
• https://www.w3.org/TR/SVG/types.html#InterfaceSVGLength
• https://www.w3.org/TR/css-values-3/#lengths

Since:

1.16

See Also:

• Surface

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
CM	Centimeters (1cm = 96px/2.54).
EM	The size of the element's font.
EX	The x-height of the element’s font.
IN	Inches (1in = 2.54cm = 96px).
MM	Millimeters (1mm = 1/10th of 1cm).
PC	Picas (1pc = 1/6th of 1in).
PERCENT	Percent, a value that is some fraction of another reference value.
PT	Points (1pt = 1/72th of 1in).
PX	Pixels (1px = 1/96th of 1in).
USER	User unit, a value in the current coordinate system.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static SVGUnit	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static SVGUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SVGUnit[]	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

USER

public static final SVGUnit USER

User unit, a value in the current coordinate system. If used in the root element for the initial coordinate systems it corresponds to pixels.

Since:

1.16

EM

public static final SVGUnit EM

The size of the element's font.

Since:

1.16

EX

public static final SVGUnit EX

The x-height of the element’s font.

Since:

1.16

PX

public static final SVGUnit PX

Pixels (1px = 1/96th of 1in).

Since:

1.16

IN

public static final SVGUnit IN

Inches (1in = 2.54cm = 96px).

Since:

1.16

CM

public static final SVGUnit CM

Centimeters (1cm = 96px/2.54).

Since:

1.16

MM

public static final SVGUnit MM

Millimeters (1mm = 1/10th of 1cm).

Since:

1.16

PT

public static final SVGUnit PT

Points (1pt = 1/72th of 1in).

Since:

1.16

PC

public static final SVGUnit PC

Picas (1pc = 1/6th of 1in).

Since:

1.16

PERCENT

public static final SVGUnit PERCENT

Percent, a value that is some fraction of another reference value.

Since:

1.16

Method Details

values

public static SVGUnit[] 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 SVGUnit 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

getValue

public int getValue()

Return the value of this enum

Returns:

the value

of

public static SVGUnit of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal