MigLayout (Codename One API)

java.lang.Object
- com.codename1.ui.layouts.Layout
- - com.codename1.ui.layouts.mig.MigLayout

Deprecated.
this is currently an experimental integration and has known bugs do not rely on this layout for production
```
public final class MigLayout
extends Layout
```
A very flexible layout manager.
Read the documentation that came with this layout manager for information on usage.

Constructor Summary

Constructors
Constructor and Description
`MigLayout()` Deprecated. Constructor with no constraints.
`MigLayout(LC layoutConstraints)` Deprecated. Constructor.
`MigLayout(LC layoutConstraints, AC colConstraints)` Deprecated. Constructor.
`MigLayout(LC layoutConstraints, AC colConstraints, AC rowConstraints)` Deprecated. Constructor.
`MigLayout(String layoutConstraints)` Deprecated. Constructor.
`MigLayout(String layoutConstraints, String colConstraints)` Deprecated. Constructor.
`MigLayout(String layoutConstraints, String colConstraints, String rowConstraints)` Deprecated. Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLayoutCallback(LayoutCallback callback)` Deprecated. Adds the callback function that will be called at different stages of the layout cylce.
`void`	`addLayoutComponent(Component comp, Object constraints)` Deprecated.
`void`	`addLayoutComponent(Object value, Component comp, Container c)` Deprecated. Some layouts can optionally track the addition of elements with meta-data that allows the user to "hint" on object positioning.
`static <E> E`	`findType(Class<E> clazz, Component comp)` Deprecated.
`Object`	`getColumnConstraints()` Deprecated. Returns the column layout constraints either as a `String` or `net.miginfocom.layout.AC`.
`Object`	`getComponentConstraint(Component comp)` Deprecated. Returns the optional component constraint
`Object`	`getComponentConstraints(Component comp)` Deprecated. Returns the component constraints as a String representation.
`Map<Component,Object>`	`getConstraintMap()` Deprecated. Returns a shallow copy of the constraints map.
`float`	`getLayoutAlignmentX(Container parent)` Deprecated.
`float`	`getLayoutAlignmentY(Container parent)` Deprecated.
`Object`	`getLayoutConstraints()` Deprecated. Returns layout constraints either as a `String` or `net.miginfocom.layout.LC` depending what was sent in to the constructor or set with `setLayoutConstraints(Object)`.
`Dimension`	`getPreferredSize(Container parent)` Deprecated. Returns the container preferred size
`Object`	`getRowConstraints()` Deprecated. Returns the row layout constraints either as a `String` or `net.miginfocom.layout.AC`.
`void`	`invalidateLayout(Container target)` Deprecated.
`boolean`	`isConstraintTracking()` Deprecated. If this method returns true, the addLayoutComponent method will be called when replacing a layout for every component within the container
`boolean`	`isManagingComponent(Component c)` Deprecated. Returns if this layout manager is currently managing this component.
`void`	`layoutContainer(Container parent)` Deprecated. Layout the given parent container children
`Dimension`	`maximumLayoutSize(Container parent)` Deprecated.
`Dimension`	`minimumLayoutSize(Container parent)` Deprecated.
`Dimension`	`preferredLayoutSize(Container parent)` Deprecated.
`void`	`removeLayoutCallback(LayoutCallback callback)` Deprecated. Removes the callback if it exists.
`void`	`removeLayoutComponent(Component comp)` Deprecated. Removes the component from the layout this operation is only useful if the layout maintains references to components within it
`void`	`setColumnConstraints(Object constr)` Deprecated. Sets the column layout constraints for the layout manager instance as a String.
`void`	`setComponentConstraints(Component comp, Object constr)` Deprecated. Sets the component constraint for the component that already must be handled by this layout manager.
`void`	`setConstraintMap(Map<Component,Object> map)` Deprecated. Sets the constraints map.
`void`	`setLayoutConstraints(Object constr)` Deprecated. Sets the layout constraints for the layout manager instance as a String.
`void`	`setRowConstraints(Object constr)` Deprecated. Sets the row layout constraints for the layout manager instance as a String.

Methods inherited from class com.codename1.ui.layouts.Layout
cloneConstraint, equals, getChildrenInTraversalOrder, hashCode, isOverlapSupported, obscuresPotential, overridesTabIndices, updateTabIndices

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MigLayout
```
public MigLayout()
```
    Deprecated.
    
    Constructor with no constraints.
  - MigLayout
```
public MigLayout(String layoutConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as "".
  - MigLayout
```
public MigLayout(String layoutConstraints,
                 String colConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as "".
    
    colConstraints - The constraints for the columns in the grid. null will be treated as "".
  - MigLayout
```
public MigLayout(String layoutConstraints,
                 String colConstraints,
                 String rowConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as "".
    
    colConstraints - The constraints for the columns in the grid. null will be treated as "".
    
    rowConstraints - The constraints for the rows in the grid. null will be treated as "".
  - MigLayout
```
public MigLayout(LC layoutConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as an empty constraint.
  - MigLayout
```
public MigLayout(LC layoutConstraints,
                 AC colConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as an empty constraint.
    
    colConstraints - The constraints for the columns in the grid. null will be treated as an empty constraint.
  - MigLayout
```
public MigLayout(LC layoutConstraints,
                 AC colConstraints,
                 AC rowConstraints)
```
    Deprecated.
    
    Constructor.
    
    Parameters:
    
    layoutConstraints - The constraints that concern the whole layout. null will be treated as an empty constraint.
    
    colConstraints - The constraints for the columns in the grid. null will be treated as an empty constraint.
    
    rowConstraints - The constraints for the rows in the grid. null will be treated as an empty constraint.
- Method Detail
  - getLayoutConstraints
```
public Object getLayoutConstraints()
```
    Deprecated.
    
    Returns layout constraints either as a String or net.miginfocom.layout.LC depending what was sent in to the constructor or set with setLayoutConstraints(Object).
    
    Returns:
    
    The layout constraints either as a String or net.miginfocom.layout.LC depending what was sent in to the constructor or set with setLayoutConstraints(Object). Never null.
  - setLayoutConstraints
```
public void setLayoutConstraints(Object constr)
```
    Deprecated.
    
    Sets the layout constraints for the layout manager instance as a String.
    See the class JavaDocs for information on how this string is formatted.
    
    Parameters:
    
    constr - The layout constraints as a String pr net.miginfocom.layout.LC representation. null is converted to "" for storage.
    
    Throws:
    
    RuntimeException - if the constraint was not valid.
  - getColumnConstraints
```
public Object getColumnConstraints()
```
    Deprecated.
    
    Returns the column layout constraints either as a String or net.miginfocom.layout.AC.
    
    Returns:
    
    The column constraints either as a String or net.miginfocom.layout.AC depending what was sent in to the constructor or set with setColumnConstraints(Object). Never null.
  - setColumnConstraints
```
public void setColumnConstraints(Object constr)
```
    Deprecated.
    
    Sets the column layout constraints for the layout manager instance as a String.
    See the class JavaDocs for information on how this string is formatted.
    
    Parameters:
    
    constr - The column layout constraints as a String or net.miginfocom.layout.AC representation. null is converted to "" for storage.
    
    Throws:
    
    RuntimeException - if the constraint was not valid.
  - getRowConstraints
```
public Object getRowConstraints()
```
    Deprecated.
    
    Returns the row layout constraints either as a String or net.miginfocom.layout.AC.
    
    Returns:
    
    The row constraints either as a String or net.miginfocom.layout.AC depending what was sent in to the constructor or set with setRowConstraints(Object). Never null.
  - setRowConstraints
```
public void setRowConstraints(Object constr)
```
    Deprecated.
    
    Sets the row layout constraints for the layout manager instance as a String.
    See the class JavaDocs for information on how this string is formatted.
    
    Parameters:
    
    constr - The row layout constraints as a String or net.miginfocom.layout.AC representation. null is converted to "" for storage.
    
    Throws:
    
    RuntimeException - if the constraint was not valid.
  - getConstraintMap
```
public Map<Component,Object> getConstraintMap()
```
    Deprecated.
    
    Returns a shallow copy of the constraints map.
    
    Returns:
    
    A shallow copy of the constraints map. Never null.
  - setConstraintMap
```
public void setConstraintMap(Map<Component,Object> map)
```
    Deprecated.
    
    Sets the constraints map.
    
    Parameters:
    
    map - The map. Will be copied.
  - getComponentConstraints
```
public Object getComponentConstraints(Component comp)
```
    Deprecated.
    
    Returns the component constraints as a String representation. This string is the exact string as set with #setComponentConstraints(java.awt.Component, Object) or set when adding the component to the parent component.
    See the class JavaDocs for information on how this string is formatted.
    
    Parameters:
    
    comp - The component to return the constraints for.
    
    Returns:
    
    The component constraints as a String representation or null if the component is not registered with this layout manager. The returned values is either a String or a net.miginfocom.layout.CC depending on what constraint was sent in when the component was added. May be null.
  - setComponentConstraints
```
public void setComponentConstraints(Component comp,
                                    Object constr)
```
    Deprecated.
    
    Sets the component constraint for the component that already must be handled by this layout manager.
    See the class JavaDocs for information on how this string is formatted.
    
    Parameters:
    
    constr - The component constraints as a String or net.miginfocom.layout.CC. null is ok.
    
    comp - The component to set the constraints for.
    
    Throws:
    
    RuntimeException - if the constraint was not valid.
    
    IllegalArgumentException - If the component is not handling the component.
  - isManagingComponent
```
public boolean isManagingComponent(Component c)
```
    Deprecated.
    
    Returns if this layout manager is currently managing this component.
    
    Parameters:
    
    c - The component to check. If null then false will be returned.
    
    Returns:
    
    If this layout manager is currently managing this component.
  - addLayoutCallback
```
public void addLayoutCallback(LayoutCallback callback)
```
    Deprecated.
    
    Adds the callback function that will be called at different stages of the layout cylce.
    
    Parameters:
    
    callback - The callback. Not null.
  - removeLayoutCallback
```
public void removeLayoutCallback(LayoutCallback callback)
```
    Deprecated.
    
    Removes the callback if it exists.
    
    Parameters:
    
    callback - The callback. May be null.
  - layoutContainer
```
public void layoutContainer(Container parent)
```
    Deprecated.
    
    Description copied from class: Layout
    
    Layout the given parent container children
    
    Specified by:
    
    layoutContainer in class Layout
    
    Parameters:
    
    parent - the given parent container
  - findType
```
public static <E> E findType(Class<E> clazz,
                             Component comp)
```
    Deprecated.
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container parent)
```
    Deprecated.
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container parent)
```
    Deprecated.
  - maximumLayoutSize
```
public Dimension maximumLayoutSize(Container parent)
```
    Deprecated.
  - getLayoutAlignmentX
```
public float getLayoutAlignmentX(Container parent)
```
    Deprecated.
  - getLayoutAlignmentY
```
public float getLayoutAlignmentY(Container parent)
```
    Deprecated.
  - addLayoutComponent
```
public void addLayoutComponent(Object value,
                               Component comp,
                               Container c)
```
    Deprecated.
    
    Description copied from class: Layout
    
    Some layouts can optionally track the addition of elements with meta-data that allows the user to "hint" on object positioning.
    
    Overrides:
    
    addLayoutComponent in class Layout
    
    Parameters:
    
    value - optional meta data information, like alignment orientation
    
    comp - the added component to the layout
    
    c - the parent container
  - addLayoutComponent
```
public void addLayoutComponent(Component comp,
                               Object constraints)
```
    Deprecated.
  - isConstraintTracking
```
public boolean isConstraintTracking()
```
    Deprecated.
    
    Description copied from class: Layout
    
    If this method returns true, the addLayoutComponent method will be called when replacing a layout for every component within the container
    
    Overrides:
    
    isConstraintTracking in class Layout
    
    Returns:
    
    false by default
  - getComponentConstraint
```
public Object getComponentConstraint(Component comp)
```
    Deprecated.
    
    Description copied from class: Layout
    
    Returns the optional component constraint
    
    Overrides:
    
    getComponentConstraint in class Layout
    
    Parameters:
    
    comp - the component whose constraint should be returned
    
    Returns:
    
    the optional component constraint
  - removeLayoutComponent
```
public void removeLayoutComponent(Component comp)
```
    Deprecated.
    
    Description copied from class: Layout
    
    Removes the component from the layout this operation is only useful if the layout maintains references to components within it
    
    Overrides:
    
    removeLayoutComponent in class Layout
    
    Parameters:
    
    comp - the removed component from layout
  - invalidateLayout
```
public void invalidateLayout(Container target)
```
    Deprecated.
  - getPreferredSize
```
public Dimension getPreferredSize(Container parent)
```
    Deprecated.
    
    Description copied from class: Layout
    
    Returns the container preferred size
    
    Specified by:
    
    getPreferredSize in class Layout
    
    Parameters:
    
    parent - the parent container
    
    Returns:
    
    the container preferred size

Class MigLayout

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.layouts.Layout

Methods inherited from class java.lang.Object

Constructor Detail

MigLayout

MigLayout

MigLayout

MigLayout

MigLayout

MigLayout

MigLayout

Method Detail

getLayoutConstraints

setLayoutConstraints

getColumnConstraints

setColumnConstraints

getRowConstraints

setRowConstraints

getConstraintMap

setConstraintMap

getComponentConstraints

setComponentConstraints

isManagingComponent

addLayoutCallback

removeLayoutCallback

layoutContainer

findType

minimumLayoutSize

preferredLayoutSize

maximumLayoutSize

getLayoutAlignmentX

getLayoutAlignmentY

addLayoutComponent

addLayoutComponent

isConstraintTracking

getComponentConstraint

removeLayoutComponent

invalidateLayout

getPreferredSize