bibliothek.gui.dock.station.stack.tab.layouting

Class Size

java.lang.Object

bibliothek.gui.dock.station.stack.tab.layouting.Size

Direct Known Subclasses:

AbstractTabsLayoutBlock.TabsSize

public class Size
extends Object

A Size is used by a LayoutBlock to describe the layout that fits to some size.
There are two properties that describe how good a Size is. They are used in different cases:

• The type is a hard restraint, it is used to filter layouts. Layouts with an odd mix of preferred and minimum sizes are not legal and will never be applied. An example would: if the menu for overflowing Dockables has a minimum size, the list of tabs must have a minimum size as well.
• The getScore() is a soft restraint, it is used to order different layouts and to find the one layout that fits best.

Author:

Benjamin Sigg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Size.Type What type of size a Size describes.

Constructor Summary

Constructors

Constructor and Description
Size(Size.Type type, Dimension size, double score) Creates a new size
Size(Size.Type type, int width, int height, double score) Creates a new size.

Method Summary

Modifier and Type	Method and Description
int	getHeight() Gets the vertical amount of pixels.
double	getScore() Tells how much this size is liked, a value of 1.0 indicates that this is the best possible size, while a value of 0.0 indicates that this size is as good as unusable
Size.Type	getType() Gets the type of this size.
int	getWidth() Gets the horizontal amount of pixels.
boolean	isMinimum() Tells whether this Size describes the minimum size some component requires.
boolean	isPreferred() Tells whether this Size describes the preferred size some component requires.
Dimension	toDimension() Returns this size as Dimension.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Size

public Size(Size.Type type,
            int width,
            int height,
            double score)

Creates a new size.

Parameters:

type - what kind of size this describes

width - horizontal amount of pixels

height - vertical amount of pixels

score - how much this size is liked, a value of 1.0 indicates that this is the best possible size, while a value of 0.0 indicates that this size is as good as unusable

Size

public Size(Size.Type type,
            Dimension size,
            double score)

Creates a new size

Parameters:

type - what kind of size this describes

size - the amount of pixels

score - how much this size is liked, a value of 1.0 indicates that this is the best possible size, while a value of 0.0 indicates that this size is as good as unusable

Method Detail

isMinimum

public boolean isMinimum()

Tells whether this Size describes the minimum size some component requires.

Returns:

true if this is a minimum size

isPreferred

public boolean isPreferred()

Tells whether this Size describes the preferred size some component requires.

Returns:

true if this is a preferred size

getType

public Size.Type getType()

Gets the type of this size.

Returns:

the type, never null

getWidth

public int getWidth()

Gets the horizontal amount of pixels.

Returns:

the width

getHeight

public int getHeight()

Gets the vertical amount of pixels.

Returns:

the height

getScore

public double getScore()

Tells how much this size is liked, a value of 1.0 indicates that this is the best possible size, while a value of 0.0 indicates that this size is as good as unusable

Returns:

the score, a value between 0.0 and 1.0

toDimension

public Dimension toDimension()

Returns this size as Dimension.

Returns:

a new Dimension

toString

public String toString()

Overrides:

toString in class Object