Package com.jgoodies.forms.layout
Class ConstantSize
- java.lang.Object
-
- com.jgoodies.forms.layout.ConstantSize
-
- All Implemented Interfaces:
Size,java.io.Serializable
public final class ConstantSize extends java.lang.Object implements Size, java.io.Serializable
An implementation of theSizeinterface that represents constant sizes described by a value and unit, for example: 10 pixel, 15 point or 4 dialog units. You can get instances ofConstantSizeusing the factory methods and constants in theSizesclass. Logical constant sizes that vary with the current layout style are delivered by theLayoutStyleclass.This class supports different size units:
Unit Abbreviation Size Millimeter mm 0.1 cm Centimeter cm 10.0 mm Inch in 25.4 mm DTP Point pt 1/72 in Pixel px 1/(resolution in dpi) in Dialog Unit dlu honors l&f, resolution, and dialog font size Examples:
Sizes.ZERO; Sizes.DLUX9; Sizes.dluX(42); Sizes.pixel(99);
- Version:
- $Revision: 1.18 $
- Author:
- Karsten Lentzsch
- See Also:
Size,Sizes, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConstantSize.UnitAn ordinal-based serializable typesafe enumeration for units as used in instances ofConstantSize.
-
Field Summary
Fields Modifier and Type Field Description static ConstantSize.UnitCENTIMETERstatic ConstantSize.UnitCMstatic ConstantSize.UnitDIALOG_UNITS_Xstatic ConstantSize.UnitDIALOG_UNITS_Ystatic ConstantSize.UnitDLUXstatic ConstantSize.UnitDLUYstatic ConstantSize.UnitINstatic ConstantSize.UnitINCHstatic ConstantSize.UnitMILLIMETERstatic ConstantSize.UnitMMstatic ConstantSize.UnitPIXELstatic ConstantSize.UnitPOINTstatic ConstantSize.UnitPTstatic ConstantSize.UnitPX
-
Constructor Summary
Constructors Constructor Description ConstantSize(double value, ConstantSize.Unit unit)Constructs a ConstantSize for the given size and unit.ConstantSize(int value, ConstantSize.Unit unit)Constructs a ConstantSize for the given size and unit.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancompressible()Describes if this Size can be compressed, if container space gets scarce.java.lang.Stringencode()Returns a parseable string representation of this constant size.booleanequals(java.lang.Object o)Indicates whether some other ConstantSize is "equal to" this one.intgetPixelSize(java.awt.Component component)Converts the size if necessary and returns the value in pixels.ConstantSize.UnitgetUnit()Returns this size's unit.doublegetValue()Returns this size's value.inthashCode()Returns a hash code value for the object.intmaximumSize(java.awt.Container container, java.util.List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)Returns this size as pixel size.java.lang.StringtoString()Returns a string representation of this size object.
-
-
-
Field Detail
-
PIXEL
public static final ConstantSize.Unit PIXEL
-
POINT
public static final ConstantSize.Unit POINT
-
DIALOG_UNITS_X
public static final ConstantSize.Unit DIALOG_UNITS_X
-
DIALOG_UNITS_Y
public static final ConstantSize.Unit DIALOG_UNITS_Y
-
MILLIMETER
public static final ConstantSize.Unit MILLIMETER
-
CENTIMETER
public static final ConstantSize.Unit CENTIMETER
-
INCH
public static final ConstantSize.Unit INCH
-
PX
public static final ConstantSize.Unit PX
-
PT
public static final ConstantSize.Unit PT
-
DLUX
public static final ConstantSize.Unit DLUX
-
DLUY
public static final ConstantSize.Unit DLUY
-
MM
public static final ConstantSize.Unit MM
-
CM
public static final ConstantSize.Unit CM
-
IN
public static final ConstantSize.Unit IN
-
-
Constructor Detail
-
ConstantSize
public ConstantSize(int value, ConstantSize.Unit unit)Constructs a ConstantSize for the given size and unit.- Parameters:
value- the size value interpreted in the given unitsunit- the size's unit- Since:
- 1.1
-
ConstantSize
public ConstantSize(double value, ConstantSize.Unit unit)Constructs a ConstantSize for the given size and unit.- Parameters:
value- the size value interpreted in the given unitsunit- the size's unit- Since:
- 1.1
-
-
Method Detail
-
getValue
public double getValue()
Returns this size's value.- Returns:
- the size value
- Since:
- 1.1
-
getUnit
public ConstantSize.Unit getUnit()
Returns this size's unit.- Returns:
- the size unit
- Since:
- 1.1
-
getPixelSize
public int getPixelSize(java.awt.Component component)
Converts the size if necessary and returns the value in pixels.- Parameters:
component- the associated component- Returns:
- the size in pixels
-
maximumSize
public int maximumSize(java.awt.Container container, java.util.List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)Returns this size as pixel size. Neither requires the component list nor the specified measures.Invoked by
FormSpecto determine the size of a column or row.- Specified by:
maximumSizein interfaceSize- Parameters:
container- the layout containercomponents- the list of components used to compute the sizeminMeasure- the measure that determines the minimum sizesprefMeasure- the measure that determines the preferred sizesdefaultMeasure- the measure that determines the default sizes- Returns:
- the computed maximum size in pixel
-
compressible
public boolean compressible()
Describes if this Size can be compressed, if container space gets scarce. Used by the FormLayout size computations in#compressedSizesto check whether a column or row can be compressed or not.ConstantSizes are incompressible.
- Specified by:
compressiblein interfaceSize- Returns:
false- Since:
- 1.1
-
equals
public boolean equals(java.lang.Object o)
Indicates whether some other ConstantSize is "equal to" this one.- Overrides:
equalsin classjava.lang.Object- Parameters:
o- the Object with which to compare- Returns:
trueif this object is the same as the obj argument;falseotherwise.- See Also:
Object.hashCode(),Hashtable
-
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 byjava.util.Hashtable.- Overrides:
hashCodein classjava.lang.Object- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object),Hashtable
-
toString
public java.lang.String toString()
Returns a string representation of this size object. Note: This string representation may change at any time. It is intended for debugging purposes. For parsing, useencode()instead.- Overrides:
toStringin classjava.lang.Object- Returns:
- a string representation of the constant size
-
-