com.jgoodies.forms.layout

Class ConstantSize

Implemented Interfaces:
Serializable, Size

public final class ConstantSize
extends Object
implements Size, Serializable

An implementation of the Size interface that represents constant sizes described by a value and unit, for example: 10 pixel, 15 point or 4 dialog units. You can get instances of ConstantSize using the factory methods and constants in the Sizes class. Logical constant sizes that vary with the current layout style are delivered by the LayoutStyle class.

This class supports different size units:

Unit   Abbreviation   Size
Millimetermm0.1 cm
Centimetercm10.0 mm
Inchin25.4 mm
DTP Pointpt1/72 in
Pixelpx1/(resolution in dpi) in
Dialog Unitdluhonors l&f, resolution, and dialog font size

Examples:

 Sizes.ZERO;
 Sizes.DLUX9;
 Sizes.dluX(42); 
 Sizes.pixel(99);
 
Version:
$Revision: 1.9 $
Author:
Karsten Lentzsch
See Also:
Size, Sizes

Nested Class Summary

static class
ConstantSize.Unit
An ordinal-based serializable typesafe enumeration for units as used in instances of ConstantSize.

Field Summary

static ConstantSize.Unit
CENTIMETER
static ConstantSize.Unit
CM
static ConstantSize.Unit
DIALOG_UNITS_X
static ConstantSize.Unit
DIALOG_UNITS_Y
static ConstantSize.Unit
DLUX
static ConstantSize.Unit
DLUY
static ConstantSize.Unit
IN
static ConstantSize.Unit
INCH
static ConstantSize.Unit
MILLIMETER
static ConstantSize.Unit
MM
static ConstantSize.Unit
PIXEL
static ConstantSize.Unit
POINT

Method Summary

boolean
equals(Object o)
Indicates whether some other ConstantSize is "equal to" this one.
int
getPixelSize(Component component)
Converts the size if necessary and returns the value in pixels.
int
hashCode()
Returns a hash code value for the object.
int
maximumSize(Container container, List components, com.jgoodies.forms.layout.FormLayout.Measure minMeasure, com.jgoodies.forms.layout.FormLayout.Measure prefMeasure, com.jgoodies.forms.layout.FormLayout.Measure defaultMeasure)
Returns this size as pixel size.
String
toString()
Returns a string representation of this size object.

Field Details

CENTIMETER

public static final ConstantSize.Unit CENTIMETER

CM

public static final ConstantSize.Unit CM

DIALOG_UNITS_X

public static final ConstantSize.Unit DIALOG_UNITS_X

DIALOG_UNITS_Y

public static final ConstantSize.Unit DIALOG_UNITS_Y

DLUX

public static final ConstantSize.Unit DLUX

DLUY

public static final ConstantSize.Unit DLUY

IN

public static final ConstantSize.Unit IN

INCH

public static final ConstantSize.Unit INCH

MILLIMETER

public static final ConstantSize.Unit MILLIMETER

MM

public static final ConstantSize.Unit MM

PIXEL

public static final ConstantSize.Unit PIXEL

POINT

public static final ConstantSize.Unit POINT

Method Details

equals

public boolean equals(Object o)
Indicates whether some other ConstantSize is "equal to" this one.
Parameters:
o - the Object with which to compare
Returns:
true if this object is the same as the obj argument; false otherwise.

getPixelSize

public int getPixelSize(Component component)
Converts the size if necessary and returns the value in pixels.
Parameters:
component - the associated component
Returns:
the size in pixels

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
Returns:
a hash code value for this object.

maximumSize

public int maximumSize(Container container,
                       List components,
                       com.jgoodies.forms.layout.FormLayout.Measure minMeasure,
                       com.jgoodies.forms.layout.FormLayout.Measure prefMeasure,
                       com.jgoodies.forms.layout.FormLayout.Measure defaultMeasure)
Specified by:
maximumSize in interface Size
Parameters:
container - the layout container
components - the list of components used to compute the size
minMeasure - the measure that determines the minimum sizes
prefMeasure - the measure that determines the preferred sizes
defaultMeasure - the measure that determines the default sizes
Returns:
the computed maximum size in pixel

toString

public String toString()
Returns a string representation of this size object. Note: The string representation may change at any time. It is strongly recommended to not use this string for parsing purposes.
Returns:
a string representation of the constant size

Copyright © 2002-2004 JGoodies Karsten Lentzsch. All Rights Reserved.