net.miginfocom.layout

Class LayoutUtil

public final class LayoutUtil extends Object

A utility class that has only static helper methods.
Field Summary
static intMAX
static intMIN
static intPREF
Method Summary
static intgetDesignTimeEmptySize()
The size of an empty row or columns in a grid during design time.
static intgetGlobalDebugMillis()
If global debug should be on or off.
static ObjectgetSerializedObject(Object caller)
Returns the serialized object that are associated with caller.
static intgetSizeSafe(int[] sizes, int sizeType)
static StringgetVersion()
Returns the current version of MiG Layout.
static booleanisDesignTime(ContainerWrapper cw)
Returns if design time is turned on for a Container in ContainerWrapper.
static booleanisLeftToRight(LC lc, ContainerWrapper container)
Returns if left-to-right orientation is used.
static ObjectreadAsXML(ObjectInput in)
Reads an object from in using the
static voidsetDesignTime(ContainerWrapper cw, boolean b)
Sets if design time is turned on for a Container in ContainerWrapper.
static voidsetDesignTimeEmptySize(int pixels)
The size of an empty row or columns in a grid during design time.
static voidsetGlobalDebugMillis(int millis)
If global debug should be on or off.
static voidsetSerializedObject(Object caller, Object o)
Sets the serialized object and associates it with caller.
static voidwriteAsXML(ObjectOutput out, Object o)
Writes an object to XML.

Field Detail

MAX

public static final int MAX

MIN

public static final int MIN

PREF

public static final int PREF

Method Detail

getDesignTimeEmptySize

public static int getDesignTimeEmptySize()
The size of an empty row or columns in a grid during design time.

Returns: The number of pixels. Default is 15.

getGlobalDebugMillis

public static int getGlobalDebugMillis()
If global debug should be on or off. If > 0 then debug is turned on for all MigLayout instances.

Returns: The current debug milliseconds.

See Also: LC

getSerializedObject

public static Object getSerializedObject(Object caller)
Returns the serialized object that are associated with caller. It also removes it from the list.

Parameters: caller The original creator of the object.

Returns: The object.

getSizeSafe

public static int getSizeSafe(int[] sizes, int sizeType)

getVersion

public static String getVersion()
Returns the current version of MiG Layout.

Returns: The current version of MiG Layout. E.g. "3.6.3" or "4.0"

isDesignTime

public static boolean isDesignTime(ContainerWrapper cw)
Returns if design time is turned on for a Container in ContainerWrapper.

Parameters: cw The container to set design time for. null is legal will return true if there is at least one ContainerWrapper (or null) that have design time turned on.

Returns: If design time is set for cw.

isLeftToRight

public static final boolean isLeftToRight(LC lc, ContainerWrapper container)
Returns if left-to-right orientation is used. If not set explicitly in the layout constraints the Locale of the parent is used.

Parameters: lc The constraint if there is one. Can be null. container The parent that may be used to get the left-to-right if ffc does not specify this.

Returns: If left-to-right orientation is currently used.

readAsXML

public static Object readAsXML(ObjectInput in)
Reads an object from in using the

Parameters: in The object input to read from.

Returns: The object. Never null.

Throws: IOException If there was a problem saving as XML

setDesignTime

public static void setDesignTime(ContainerWrapper cw, boolean b)
Sets if design time is turned on for a Container in ContainerWrapper.

Parameters: cw The container to set design time for. null is legal and can be used as a key to turn on/off design time "in general". Note though that design time "in general" is always on as long as there is at least one ContainerWrapper with design time.

If this method has not ever been called it will default to what Beans.isDesignTime() returns. This means that if you call this method you indicate that you will take responsibility for the design time value. b true means design time on.

setDesignTimeEmptySize

public static void setDesignTimeEmptySize(int pixels)
The size of an empty row or columns in a grid during design time.

Parameters: pixels The number of pixels. Default is 0 (it was 15 prior to v3.7.2, but since that meant different behaviour under design time by default it was changed to be 0, same as non-design time). IDE vendors can still set it to 15 to get the old behaviour.

setGlobalDebugMillis

public static void setGlobalDebugMillis(int millis)
If global debug should be on or off. If > 0 then debug is turned on for all MigLayout instances.

Note! This is a passive value and will be read by panels when the needed, which is normally when they repaint/layout.

Parameters: millis The new debug milliseconds. 0 turns of global debug and leaves debug up to every individual panel.

See Also: LC

setSerializedObject

public static void setSerializedObject(Object caller, Object o)
Sets the serialized object and associates it with caller.

Parameters: caller The object created o o The just serialized object.

writeAsXML

public static void writeAsXML(ObjectOutput out, Object o)
Writes an object to XML.

Parameters: out The boject out to write to. Will not be closed. o The object to write.