Module org.praxislive.gui
Package net.miginfocom.swing

Class MigLayout

java.lang.Object
net.miginfocom.swing.MigLayout
All Implemented Interfaces:
LayoutManager, LayoutManager2, Externalizable, Serializable
public final class MigLayout extends Object implements LayoutManager2, Externalizable
A very flexible layout manager.

Read the documentation that came with this layout manager for information on usage.

See Also:

  • Constructor Details

    • MigLayout

      public MigLayout()
      Constructor with no constraints.

    • MigLayout

      public MigLayout(String layoutConstraints)
      Constructor.
      Parameters:
      layoutConstraints - The constraints that concern the whole layout. null will be treated as "".

    • MigLayout

      public MigLayout(String layoutConstraints, String colConstraints)
      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)
      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)
      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)
      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)
      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 Details

    • getLayoutConstraints

      public Object getLayoutConstraints()
      Returns layout constraints either as a String or LC depending what was sent in to the constructor or set with setLayoutConstraints(Object).
      Returns:
      The layout constraints either as a String or LC depending what was sent in to the constructor or set with setLayoutConstraints(Object). Never null.

    • setLayoutConstraints

      public void setLayoutConstraints(Object constr)
      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 representation. null is converted to "" for storage.
      Throws:
      RuntimeException - if the constraint was not valid.

    • getColumnConstraints

      public Object getColumnConstraints()
      Returns the column layout constraints either as a String or AC.
      Returns:
      The column constraints either as a String or LC depending what was sent in to the constructor or set with setLayoutConstraints(Object). Never null.

    • setColumnConstraints

      public void setColumnConstraints(Object constr)
      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 representation. null is converted to "" for storage.
      Throws:
      RuntimeException - if the constraint was not valid.

    • getRowConstraints

      public Object getRowConstraints()
      Returns the row layout constraints as a String representation. This string is the exact string as set with setRowConstraints(Object) or sent into the constructor.

      See the class JavaDocs for information on how this string is formatted.

      Returns:
      The row layout constraints as a String representation. Never null.

    • setRowConstraints

      public void setRowConstraints(Object constr)
      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 representation. null is converted to "" for storage.
      Throws:
      RuntimeException - if the constraint was not valid.

    • getConstraintMap

      public Map<Component,Object> getConstraintMap()
      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)
      Sets the constraints map.
      Parameters:
      map - The map. Will be copied.

    • getComponentConstraints

      public Object getComponentConstraints(Component comp)
      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 CC depending on what constraint was sent in when the component was added. May be null.

    • setComponentConstraints

      public void setComponentConstraints(Component comp, Object constr)
      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:
      comp - The component to set the constraints for.
      constr - The component constraints as a String or CC. null is ok.
      Throws:
      RuntimeException - if the constraint was not valid.
      IllegalArgumentException - If the component is not handling the component.

    • isManagingComponent

      public boolean isManagingComponent(Component c)
      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)
      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)
      Removes the callback if it exists.
      Parameters:
      callback - The callback. May be null.

    • layoutContainer

      public void layoutContainer(Container parent)
      Specified by:
      layoutContainer in interface LayoutManager

    • minimumLayoutSize

      public Dimension minimumLayoutSize(Container parent)
      Specified by:
      minimumLayoutSize in interface LayoutManager

    • preferredLayoutSize

      public Dimension preferredLayoutSize(Container parent)
      Specified by:
      preferredLayoutSize in interface LayoutManager

    • maximumLayoutSize

      public Dimension maximumLayoutSize(Container parent)
      Specified by:
      maximumLayoutSize in interface LayoutManager2

    • getLayoutAlignmentX

      public float getLayoutAlignmentX(Container parent)
      Specified by:
      getLayoutAlignmentX in interface LayoutManager2

    • getLayoutAlignmentY

      public float getLayoutAlignmentY(Container parent)
      Specified by:
      getLayoutAlignmentY in interface LayoutManager2

    • addLayoutComponent

      public void addLayoutComponent(String s, Component comp)
      Specified by:
      addLayoutComponent in interface LayoutManager

    • addLayoutComponent

      public void addLayoutComponent(Component comp, Object constraints)
      Specified by:
      addLayoutComponent in interface LayoutManager2

    • removeLayoutComponent

      public void removeLayoutComponent(Component comp)
      Specified by:
      removeLayoutComponent in interface LayoutManager

    • invalidateLayout

      public void invalidateLayout(Container target)
      Specified by:
      invalidateLayout in interface LayoutManager2

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException