org.drombler.commons.fx.scene.layout

Enum RegionDimension

java.lang.Object

java.lang.Enum<RegionDimension>

org.drombler.commons.fx.scene.layout.RegionDimension

All Implemented Interfaces:

Serializable, Comparable<RegionDimension>

public enum RegionDimension
extends Enum<RegionDimension>

A {@link Region] dimension.

Author:

puce

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEIGHT The height of a Region.
WIDTH The width of a Region.

Method Summary

Modifier and Type	Method and Description
abstract double	getMaxSize(Region region) Gets the maximal size of a region dimension.
abstract double	getMinSize(Region region) Gets the minimum size of a region dimension.
abstract double	getPrefSize(Region region) Gets the preferred size of a region dimension.
abstract double	getSize(Region region) Gets the size of a region dimension.
abstract void	setMaxSize(Region region, double maxSize) Sets the maximal size of a region dimension.
abstract void	setMinSize(Region region, double minSize) Sets the minimum size of a region dimension.
abstract void	setPrefSize(Region region, double prefSize) Sets the preferred size of a region dimension.
static RegionDimension	valueOf(String name) Returns the enum constant of this type with the specified name.
static RegionDimension[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WIDTH

public static final RegionDimension WIDTH

The width of a Region.

HEIGHT

public static final RegionDimension HEIGHT

The height of a Region.

Method Detail

values

public static RegionDimension[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RegionDimension c : RegionDimension.values())
    System.out.println(c);

Returns:

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

valueOf

public static RegionDimension valueOf(String name)

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

NullPointerException - if the argument is null

getSize

public abstract double getSize(Region region)

Gets the size of a region dimension.

Parameters:

region - the region

Returns:

the size of a region dimension

getPrefSize

public abstract double getPrefSize(Region region)

Gets the preferred size of a region dimension.

Parameters:

region - the region

Returns:

the preferred size of a region dimension

setPrefSize

public abstract void setPrefSize(Region region,
                                 double prefSize)

Sets the preferred size of a region dimension.

Parameters:

region - the region

prefSize - the preferred size of a region dimension

getMinSize

public abstract double getMinSize(Region region)

Gets the minimum size of a region dimension.

Parameters:

region - the region

Returns:

the minimum size of a region dimension

setMinSize

public abstract void setMinSize(Region region,
                                double minSize)

Sets the minimum size of a region dimension.

Parameters:

region - the region

minSize - the minimum size of a region dimension

getMaxSize

public abstract double getMaxSize(Region region)

Gets the maximal size of a region dimension.

Parameters:

region - the region

Returns:

the maximal size of a region dimension

setMaxSize

public abstract void setMaxSize(Region region,
                                double maxSize)

Sets the maximal size of a region dimension.

Parameters:

region - the region

maxSize - the maximal size of a region dimension