net.sf.mmm.client.ui.api.common

Enum Filling

java.lang.Object

java.lang.Enum<Filling>

net.sf.mmm.client.ui.api.common.Filling

All Implemented Interfaces:

Serializable, Comparable<Filling>

public enum Filling
extends Enum<Filling>

This enum contains the available values for the filling of an object. The filling determines if the size of the object will be expanded horizontally and/or vertically if there is more space available.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Both width and height of the object will be expanded.
HORIZONTAL The width of the object will be expanded while the height is kept.
NONE The object will keep its size.
VERTICAL The height of the object will be expanded while the width is kept.

Method Summary

Modifier and Type	Method and Description
Filling	getMirrored() This method returns the mirrored filling.
Filling	getPart(Orientation orientation) This method extracts the horizontal or vertical part of this filling.
static Filling	valueOf(String name) Returns the enum constant of this type with the specified name.
static Filling[]	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

NONE

public static final Filling NONE

The object will keep its size.

HORIZONTAL

public static final Filling HORIZONTAL

The width of the object will be expanded while the height is kept.

VERTICAL

public static final Filling VERTICAL

The height of the object will be expanded while the width is kept.

BOTH

public static final Filling BOTH

Both width and height of the object will be expanded.

Method Detail

values

public static Filling[] 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 (Filling c : Filling.values())
    System.out.println(c);

Returns:

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

valueOf

public static Filling 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

getMirrored

public Filling getMirrored()

This method returns the mirrored filling.
(NONE.mirror == NONE (HORIZONTAL.mirror == VERTICAL (VERTICAL.mirror == HORIZONTAL (BOTH.mirror == BOTH

Returns:

the mirrored filling.

getPart

public Filling getPart(Orientation orientation)

This method extracts the horizontal or vertical part of this filling.

Parameters:

orientation - is the orientation of the requested part.

Returns:

NONE if this filling is NONE or orthogonal to the given orientation. The filling parallel to the orientation, otherwise.