Package net.miginfocom.swing
Class MigLayout
java.lang.Object
net.miginfocom.swing.MigLayout
- All Implemented Interfaces:
LayoutManager
,LayoutManager2
,Externalizable
,Serializable
A very flexible layout manager.
Read the documentation that came with this layout manager for information on usage.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor with no constraints.Constructor.Constructor.Constructor.Constructor.Constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addLayoutCallback
(LayoutCallback callback) Adds the callback function that will be called at different stages of the layout cylce.void
addLayoutComponent
(Component comp, Object constraints) void
addLayoutComponent
(String s, Component comp) static <E> E
Returns the column layout constraints either as aString
orAC
.Returns the component constraints as a String representation.Returns a shallow copy of the constraints map.float
getLayoutAlignmentX
(Container parent) float
getLayoutAlignmentY
(Container parent) Returns layout constraints either as aString
orLC
depending what was sent in to the constructor or set withsetLayoutConstraints(Object)
.Returns the row layout constraints either as aString
orAC
.void
invalidateLayout
(Container target) boolean
Returns if this layout manager is currently managing this component.void
layoutContainer
(Container parent) maximumLayoutSize
(Container parent) minimumLayoutSize
(Container parent) preferredLayoutSize
(Container parent) void
void
removeLayoutCallback
(LayoutCallback callback) Removes the callback if it exists.void
void
setColumnConstraints
(Object constr) Sets the column layout constraints for the layout manager instance as a String.void
setComponentConstraints
(Component comp, Object constr) Sets the component constraint for the component that already must be handled by this layout manager.void
setConstraintMap
(Map<Component, Object> map) Sets the constraints map.void
setLayoutConstraints
(Object constr) Sets the layout constraints for the layout manager instance as a String.void
setRowConstraints
(Object constr) Sets the row layout constraints for the layout manager instance as a String.void
-
Constructor Details
-
MigLayout
public MigLayout()Constructor with no constraints. -
MigLayout
Constructor.- Parameters:
layoutConstraints
- The constraints that concern the whole layout.null
will be treated as "".
-
MigLayout
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
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
Constructor.- Parameters:
layoutConstraints
- The constraints that concern the whole layout.null
will be treated as an empty constraint.
-
MigLayout
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
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
Returns layout constraints either as aString
orLC
depending what was sent in to the constructor or set withsetLayoutConstraints(Object)
.- Returns:
- The layout constraints either as a
String
orLC
depending what was sent in to the constructor or set withsetLayoutConstraints(Object)
. Nevernull
.
-
setLayoutConstraints
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 prLC
representation.null
is converted to""
for storage.- Throws:
RuntimeException
- if the constraint was not valid.
-
getColumnConstraints
Returns the column layout constraints either as aString
orAC
.- Returns:
- The column constraints either as a
String
orAC
depending what was sent in to the constructor or set withsetColumnConstraints(Object)
. Nevernull
.
-
setColumnConstraints
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 orAC
representation.null
is converted to""
for storage.- Throws:
RuntimeException
- if the constraint was not valid.
-
getRowConstraints
Returns the row layout constraints either as aString
orAC
.- Returns:
- The row constraints either as a
String
orAC
depending what was sent in to the constructor or set withsetRowConstraints(Object)
. Nevernull
.
-
setRowConstraints
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 orAC
representation.null
is converted to""
for storage.- Throws:
RuntimeException
- if the constraint was not valid.
-
getConstraintMap
Returns a shallow copy of the constraints map.- Returns:
- A shallow copy of the constraints map. Never
null
.
-
setConstraintMap
Sets the constraints map.- Parameters:
map
- The map. Will be copied.
-
getComponentConstraints
Returns the component constraints as a String representation. This string is the exact string as set withsetComponentConstraints(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 aCC
depending on what constraint was sent in when the component was added. May benull
.
-
setComponentConstraints
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 orCC
.null
is ok.- Throws:
RuntimeException
- if the constraint was not valid.IllegalArgumentException
- If the component is not handling the component.
-
isManagingComponent
Returns if this layout manager is currently managing this component.- Parameters:
c
- The component to check. Ifnull
thenfalse
will be returned.- Returns:
- If this layout manager is currently managing this component.
-
addLayoutCallback
Adds the callback function that will be called at different stages of the layout cylce.- Parameters:
callback
- The callback. Notnull
.
-
removeLayoutCallback
Removes the callback if it exists.- Parameters:
callback
- The callback. May benull
.
-
layoutContainer
- Specified by:
layoutContainer
in interfaceLayoutManager
-
findType
-
minimumLayoutSize
- Specified by:
minimumLayoutSize
in interfaceLayoutManager
-
preferredLayoutSize
- Specified by:
preferredLayoutSize
in interfaceLayoutManager
-
maximumLayoutSize
- Specified by:
maximumLayoutSize
in interfaceLayoutManager2
-
getLayoutAlignmentX
- Specified by:
getLayoutAlignmentX
in interfaceLayoutManager2
-
getLayoutAlignmentY
- Specified by:
getLayoutAlignmentY
in interfaceLayoutManager2
-
addLayoutComponent
- Specified by:
addLayoutComponent
in interfaceLayoutManager
-
addLayoutComponent
- Specified by:
addLayoutComponent
in interfaceLayoutManager2
-
removeLayoutComponent
- Specified by:
removeLayoutComponent
in interfaceLayoutManager
-
invalidateLayout
- Specified by:
invalidateLayout
in interfaceLayoutManager2
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-