JavaFX 24 · javafx.css.Size · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final SizeUnits	units
private final double	value

Access	Constructor and Description
public	Size(double value of the size value, SizeUnits unit of the size units) Constructs a `Size` object.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public SizeUnits	Returns: the units getUnits() Return the units.
public double	Returns: the value getValue() Returns the value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: true if it is absolute, otherwise false isAbsolute() Returns whether or not this `Size` is an absolute value or a relative value.
public double	Returns: the size in pixels pixels(double The multiplier for PERCENTAGE sizes multiplier, Font The font for EM sizes font) Converts this size into pixels.
public double	Returns: the size of pixels pixels(Font the font font) If size is not an absolute size, return the product of font size in pixels and value.
pack-priv double	pixels(double multiplier) If size is not an absolute size, return the product of multiplier and value.
public double	Returns: the size in pixels pixels() A convenience method for calling `pixels(1)`
pack-priv double	points(Font font) Converts this size into Points units, a Point is 1/72 of a inch
pack-priv double	points(double The multiplier for PERCENTAGE sizes multiplier, Font The font for EM sizes font) Converts this size into points.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

units	back to summary
private final SizeUnits units

value	back to summary
private final double value

Size	back to summary
public Size(double value, SizeUnits units) Constructs a `Size` object. Parameters value:double value of the size units:SizeUnits unit of the size

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getUnits	back to summary
public SizeUnits getUnits() Return the units. Returns:SizeUnits the units

getUnits

back to summary

public SizeUnits getUnits()

Return the units.

Returns:SizeUnits: the units

getValue	back to summary
public double getValue() Returns the value. Returns:double the value

getValue

back to summary

public double getValue()

Returns the value.

Returns:double: the value

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isAbsolute back to summary

isAbsolute	back to summary
public boolean isAbsolute() Returns whether or not this `Size` is an absolute value or a relative value. Returns:boolean true if it is absolute, otherwise false

public boolean isAbsolute()

Returns whether or not this Size is an absolute value or a relative value.

Returns:boolean: true if it is absolute, otherwise false

pixels	back to summary
public double pixels(double multiplier, Font font) Converts this size into pixels. Parameters multiplier:double The multiplier for PERCENTAGE sizes font:Font The font for EM sizes Returns:double the size in pixels

pixels

back to summary

public double pixels(double multiplier, Font font)

Converts this size into pixels.

Parameters

multiplier:double: The multiplier for PERCENTAGE sizes
font:Font: The font for EM sizes

Returns:double

the size in pixels

pixels	back to summary
public double pixels(Font font) If size is not an absolute size, return the product of font size in pixels and value. Otherwise, return the absolute value. Parameters font:Font the font Returns:double the size of pixels

pixels

back to summary

public double pixels(Font font)

If size is not an absolute size, return the product of font size in pixels and value. Otherwise, return the absolute value.

Parameters

font:Font: the font

Returns:double

the size of pixels

pixels	back to summary
pack-priv double pixels(double multiplier) If size is not an absolute size, return the product of multiplier and value. Otherwise, return the absolute value.

pixels back to summary

pixels	back to summary
public double pixels() A convenience method for calling `pixels(1)` Returns:double the size in pixels

public double pixels()

A convenience method for calling pixels(1)

Returns:double: the size in pixels

points	back to summary
pack-priv double points(Font font) Converts this size into Points units, a Point is 1/72 of a inch

points	back to summary
pack-priv double points(double multiplier, Font font) Converts this size into points. Parameters multiplier:double The multiplier for PERCENTAGE sizes font:Font The font for EM sizes

points

back to summary

pack-priv double points(double multiplier, Font font)

Converts this size into points.

Parameters

multiplier:double: The multiplier for PERCENTAGE sizes
font:Font: The font for EM sizes

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class Size

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail