Class CC
- java.lang.Object
-
- net.miginfocom.layout.CC
-
- All Implemented Interfaces:
Externalizable
,Serializable
public final class CC extends Object implements Externalizable
A simple value holder for one component's constraint.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CC()
Empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CC
alignX(String align)
Same functionality asgetHorizontal().setAlign(ConstraintParser.parseUnitValue(unitValue, true))
only this method returnsthis
for chaining multiple calls.CC
alignY(String align)
Same functionality asgetVertical().setAlign(ConstraintParser.parseUnitValue(unitValue, true))
only this method returnsthis
for chaining multiple calls.CC
cell(int... colRowWidthHeight)
Set the cell(s) that the component should occupy in the grid.CC
dockEast()
Same functionality as callingsetDockSide(int)
with3
only this method returnsthis
for chaining multiple calls.CC
dockNorth()
Same functionality as callingsetDockSide(int)
with0
only this method returnsthis
for chaining multiple calls.CC
dockSouth()
Same functionality as callingsetDockSide(int)
with2
only this method returnsthis
for chaining multiple calls.CC
dockWest()
Same functionality as callingsetDockSide(int)
with1
only this method returnsthis
for chaining multiple calls.CC
endGroup(String... xy)
The end group(s) that this component should be placed in.CC
endGroupX(String s)
Specifies that the component should be put in the end groups
and will thus share the same ending coordinate as them within the group.CC
endGroupY(String s)
The end group that this component should be placed in.CC
external()
Same functionality as callingsetExternal(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.CC
flowX()
Same functionality as callingsetFlowX(Boolean)
withBoolean.TRUE
only this method returnsthis
for chaining multiple calls.CC
flowY()
Same functionality as callingsetFlowX(Boolean)
withBoolean.FALSE
only this method returnsthis
for chaining multiple calls.CC
gap(String... args)
Corresponds exactly to the "gap left right top bottom" keyword.CC
gapAfter(String boundsSize)
Sets the horizontal gap after the component.CC
gapBefore(String boundsSize)
Sets the horizontal gap before the component.CC
gapBottom(String boundsSize)
Sets the gap below the component.CC
gapLeft(String boundsSize)
Sets the gap to the left the component.CC
gapRight(String boundsSize)
Sets the gap to the right of the component.CC
gapTop(String boundsSize)
Sets the gap above the component.CC
gapX(String before, String after)
The horizontal gap before and/or after the component.CC
gapY(String before, String after)
The vertical gap before (normally above) and/or after (normally below) the component.AnimSpec
getAnimSpec()
Returns the animation spec.int
getCellX()
Returns the absolute cell position in the grid or-1
if cell positioning is not used.int
getCellY()
Returns the absolute cell position in the grid or-1
if cell positioning is not used.DimConstraint
getDimConstraint(boolean isHor)
Returns the vertical or horizontal dim constraint.int
getDockSide()
Sets the docking side.Boolean
getFlowX()
Returns if the flow in the cell is in the horizontal dimension.int
getHideMode()
Sets how a component that is hidden (not visible) should be treated by default.DimConstraint
getHorizontal()
Returns the horizontal dimension constraint for this component constraint.String
getId()
Returns the id used to reference this component in some constraints.BoundSize
getNewlineGapSize()
Returns the newline size if it is a custom size.UnitValue[]
getPadding()
Returns the absolute resizing in the last stage of the layout cycle.UnitValue[]
getPos()
Returns the absolute positioning of one or more of the edges.Float
getPushX()
"pushx" indicates that the column that this component is in (this first if the component spans) should default to growing.Float
getPushY()
"pushx" indicates that the row that this component is in (this first if the component spans) should default to growing.int
getSkip()
Returns how many cells in the grid that should be skipped before the component that this constraint belongs to.int
getSpanX()
Returns the number of cells the cell that this constraint's component will span in the indicated dimension.int
getSpanY()
Returns the number of cells the cell that this constraint's component will span in the indicated dimension.int
getSplit()
Returns in how many parts the current cell (that this constraint's component will be in) should be split in.String
getTag()
Tags the component with metadata.DimConstraint
getVertical()
Returns the vertical dimension constraint for this component constraint.UnitValue[]
getVisualPadding()
Returns the visual padding used when laying out this Component.BoundSize
getWrapGapSize()
Returns the wrap size if it is a custom size.CC
grow()
CC
grow(float... widthHeight)
grow weight for the component horizontally and optionally vertically.CC
growPrio(int... widthHeight)
Grow priority for the component horizontally and optionally vertically.CC
growPrioX(int p)
The grow priority compared to other components in the same cell.CC
growPrioY(int p)
The grow priority compared to other components in the same cell.CC
growX()
Grow weight for the component horizontally.CC
growX(float w)
Grow weight for the component horizontally.CC
growY()
Grow weight for the component vertically.CC
growY(float w)
Grow weight for the component vertically.CC
growY(Float w)
Deprecated.CC
height(String size)
The size for the component as a min and/or preferred and/or maximum size.CC
hideMode(int mode)
How this component, if hidden (not visible), should be treated.CC
id(String s)
The id used to reference this component in some constraints.boolean
isBoundsInGrid()
Returns if the absolutepos
value should be corrections to the component that is in a normal cell.boolean
isExternal()
Returns if this component should have its bounds handled by an external source and not this layout manager.boolean
isNewline()
Returns if the flow should wrap to the next line/column before the component that this constraint belongs to.boolean
isWrap()
Returns if the flow should wrap to the next line/column after the component that this constraint belongs to.CC
maxHeight(String size)
The maximum size for the component.CC
maxWidth(String size)
The maximum size for the component.CC
minHeight(String size)
The minimum size for the component.CC
minWidth(String size)
The minimum size for the component.CC
newline()
Same functionality as callingsetNewline(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.CC
newline(String gapSize)
Same functionality assetNewlineGapSize(BoundSize)
only this method returnsthis
for chaining multiple calls.CC
pad(int top, int left, int bottom, int right)
Same functionality assetPadding(UnitValue[])
but the unit values as absolute pixels.CC
pad(String pad)
Same functionality assetPadding(ConstraintParser.parseInsets(pad, false))}
only this method returnsthis
for chaining multiple calls.CC
pos(String x, String y)
Same functionality asx(String x)
andy(String y)
together.CC
pos(String x, String y, String x2, String y2)
CC
push()
Same functionality aspushX().pushY()
which means this cell will push in both x and y dimensions.CC
push(Float weightX, Float weightY)
Same functionality aspushX(weightX).pushY(weightY)
which means this cell will push in both x and y dimensions.CC
pushX()
Same functionality assetPushX(Float)
which means this cell will push the rest of the row.CC
pushX(Float weight)
Same functionality assetPushX(Float weight)
only this method returnsthis
for chaining multiple calls.CC
pushY()
Same functionality assetPushY(Float)
which means this cell will push the rest of the column.CC
pushY(Float weight)
Same functionality assetPushY(Float weight)
only this method returnsthis
for chaining multiple calls.void
readExternal(ObjectInput in)
void
setBoundsInGrid(boolean b)
Sets if the absolutepos
value should be corrections to the component that is in a normal cell.void
setCellX(int x)
Set an absolute cell x-position in the grid.void
setCellY(int y)
Set an absolute cell x-position in the grid.void
setDockSide(int side)
Sets the docking side.void
setExternal(boolean b)
If this boolean is true this component is not handled in any way by the layout manager and the component can have its bounds set by an external handler which is normally by the use of somecomponent.setBounds(x, y, width, height)
directly (for Swing).void
setFlowX(Boolean b)
Sets if the flow in the cell is in the horizontal dimension.void
setHideMode(int mode)
Sets how a component that is hidden (not visible) should be treated by default.void
setHorizontal(DimConstraint h)
Sets the horizontal dimension constraint for this component constraint.void
setId(String id)
Sets the id used to reference this component in some constraints.void
setNewline(boolean b)
Sets if the flow should wrap to the next line/column before the component that this constraint belongs to.void
setNewlineGapSize(BoundSize s)
Set the newline size and turns newline on if!= null
.void
setPadding(UnitValue[] sides)
Sets the absolute resizing in the last stage of the layout cycle.void
setPos(UnitValue[] pos)
Sets absolute positioning of one or more of the edges.void
setPushX(Float weight)
"pushx" indicates that the column that this component is in (this first if the component spans) should default to growing.void
setPushY(Float weight)
"pushx" indicates that the row that this component is in (this first if the component spans) should default to growing.void
setSkip(int cells)
Sets how many cells in the grid that should be skipped before the component that this constraint belongs to.void
setSpanX(int cells)
Sets the number of cells the cell that this constraint's component will span in the indicated dimension.void
setSpanY(int cells)
Sets the number of cells the cell that this constraint's component will span in the indicated dimension.void
setSplit(int parts)
Sets in how many parts the current cell (that this constraint's component will be in) should be split in.void
setTag(String tag)
Optional tag that gives more context to this constraint's component.void
setVertical(DimConstraint v)
Sets the vertical dimension constraint for this component constraint.void
setVisualPadding(UnitValue[] sides)
Sets the visual padding used when laying out this Component.void
setWrap(boolean b)
Sets if the flow should wrap to the next line/column after the component that this constraint belongs to.void
setWrapGapSize(BoundSize s)
Set the wrap size and turns wrap on if!= null
.CC
shrink(float... widthHeight)
Shrink weight for the component horizontally and optionally vertically.CC
shrinkPrio(int... widthHeight)
Shrink priority for the component horizontally and optionally vertically.CC
shrinkPrioX(int p)
The shrink priority compared to other components in the same cell.CC
shrinkPrioY(int p)
The shrink priority compared to other components in the same cell.CC
shrinkX(float w)
Shrink weight for the component horizontally.CC
shrinkY(float w)
Shrink weight for the component horizontally.CC
sizeGroup(String... xy)
The size group(s) that this component should be placed in.CC
sizeGroupX(String s)
Specifies that the component should be put in the size groups
and will thus share the same size as them within the group.CC
sizeGroupY(String s)
The size group that this component should be placed in.CC
skip()
Same functionality as skip(1).CC
skip(int cells)
Same functionality assetSkip(int)
only this method returnsthis
for chaining multiple calls.CC
span(int... cells)
Same functionality asspanX(cellsX).spanY(cellsY)
which means this cell will span cells in both x and y.CC
spanX()
Same functionality assetSpanX(int)
which means this cell will span the rest of the row.CC
spanX(int cells)
Same functionality assetSpanX(int)
only this method returnsthis
for chaining multiple calls.CC
spanY()
Same functionality as callingsetSpanY(int)
withLayoutUtil.INF
which means this cell will span the rest of the column.CC
spanY(int cells)
Same functionality assetSpanY(int)
only this method returnsthis
for chaining multiple calls.CC
split()
Same functionality as split(LayoutUtil.INF), which means split until one of the keywords that breaks the split is found for a component after this one (e.g.CC
split(int parts)
Same functionality assetSplit(int parts)
only this method returnsthis
for chaining multiple calls.CC
tag(String tag)
Same functionality assetTag(String tag)
only this method returnsthis
for chaining multiple calls.CC
width(String size)
The size for the component as a min and/or preferred and/or maximum size.CC
wrap()
Same functionality as callingsetWrap(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.CC
wrap(String gapSize)
Same functionality assetWrapGapSize(BoundSize)
only this method returnsthis
for chaining multiple calls.void
writeExternal(ObjectOutput out)
CC
x(String x)
Sets the x-coordinate for the component.CC
x2(String x2)
Sets the x2-coordinate for the component (right side).CC
y(String y)
Sets the y-coordinate for the component.CC
y2(String y2)
Sets the y2-coordinate for the component (bottom side).
-
-
-
Method Detail
-
endGroupX
public final CC endGroupX(String s)
Specifies that the component should be put in the end groups
and will thus share the same ending coordinate as them within the group.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
s
- A name to associate on the group that should be the same for other rows/columns in the same group.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
sizeGroupX
public final CC sizeGroupX(String s)
Specifies that the component should be put in the size groups
and will thus share the same size as them within the group.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
s
- A name to associate on the group that should be the same for other rows/columns in the same group.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
minWidth
public final CC minWidth(String size)
The minimum size for the component. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aUnitValue
. E.g. "100px" or "200mm".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
width
public final CC width(String size)
The size for the component as a min and/or preferred and/or maximum size. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
maxWidth
public final CC maxWidth(String size)
The maximum size for the component. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aUnitValue
. E.g. "100px" or "200mm".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
gapX
public final CC gapX(String before, String after)
The horizontal gap before and/or after the component. The gap is towards cell bounds and/or other component bounds.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
before
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".after
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
alignX
public final CC alignX(String align)
Same functionality asgetHorizontal().setAlign(ConstraintParser.parseUnitValue(unitValue, true))
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
align
- The align keyword or for instance "100px". E.g "left", "right", "leading" or "trailing".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
growPrioX
public final CC growPrioX(int p)
The grow priority compared to other components in the same cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
p
- The grow priority.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
growPrio
public final CC growPrio(int... widthHeight)
Grow priority for the component horizontally and optionally vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
widthHeight
- The new shrink weight and height. 1-2 arguments, never null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
growX
public final CC growX()
Grow weight for the component horizontally. It default to weight100
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
growX(float)
-
growX
public final CC growX(float w)
Grow weight for the component horizontally.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
w
- The new grow weight.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
grow
public final CC grow(float... widthHeight)
grow weight for the component horizontally and optionally vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
widthHeight
- The new shrink weight and height. 1-2 arguments, never null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
shrinkPrioX
public final CC shrinkPrioX(int p)
The shrink priority compared to other components in the same cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
p
- The shrink priority.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
shrinkPrio
public final CC shrinkPrio(int... widthHeight)
Shrink priority for the component horizontally and optionally vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
widthHeight
- The new shrink weight and height. 1-2 arguments, never null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
shrinkX
public final CC shrinkX(float w)
Shrink weight for the component horizontally.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
w
- The new shrink weight.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
shrink
public final CC shrink(float... widthHeight)
Shrink weight for the component horizontally and optionally vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
widthHeight
- The new shrink weight and height. 1-2 arguments, never null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
endGroupY
public final CC endGroupY(String s)
The end group that this component should be placed in.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
s
- The name of the group. Ifnull
that means no group (default)- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
endGroup
public final CC endGroup(String... xy)
The end group(s) that this component should be placed in.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
xy
- The end group for x and y respectively. 1-2 arguments, not null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
sizeGroupY
public final CC sizeGroupY(String s)
The size group that this component should be placed in.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
s
- The name of the group. Ifnull
that means no group (default)- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
sizeGroup
public final CC sizeGroup(String... xy)
The size group(s) that this component should be placed in.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
xy
- The size group for x and y respectively. 1-2 arguments, not null.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
minHeight
public final CC minHeight(String size)
The minimum size for the component. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aUnitValue
. E.g. "100px" or "200mm".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
height
public final CC height(String size)
The size for the component as a min and/or preferred and/or maximum size. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
maxHeight
public final CC maxHeight(String size)
The maximum size for the component. The value will override any value that is set on the component itself.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
size
- The size expressed as aUnitValue
. E.g. "100px" or "200mm".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
gapY
public final CC gapY(String before, String after)
The vertical gap before (normally above) and/or after (normally below) the component. The gap is towards cell bounds and/or other component bounds.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
before
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".after
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
alignY
public final CC alignY(String align)
Same functionality asgetVertical().setAlign(ConstraintParser.parseUnitValue(unitValue, true))
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
align
- The align keyword or for instance "100px". E.g "top" or "bottom".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
growPrioY
public final CC growPrioY(int p)
The grow priority compared to other components in the same cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
p
- The grow priority.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
growY
public final CC growY()
Grow weight for the component vertically. Defaults to100
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
growY(Float)
-
growY
public final CC growY(float w)
Grow weight for the component vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
w
- The new grow weight.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
growY
@Deprecated public final CC growY(Float w)
Deprecated.Grow weight for the component vertically.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
w
- The new grow weight.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
shrinkPrioY
public final CC shrinkPrioY(int p)
The shrink priority compared to other components in the same cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
p
- The shrink priority.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
shrinkY
public final CC shrinkY(float w)
Shrink weight for the component horizontally.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
w
- The new shrink weight.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
hideMode
public final CC hideMode(int mode)
How this component, if hidden (not visible), should be treated.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
mode
- The mode. Default to the mode in theLC
. 0 == Normal. Bounds will be calculated as if the component was visible.
1 == If hidden the size will be 0, 0 but the gaps remain.
2 == If hidden the size will be 0, 0 and gaps set to zero.
3 == If hidden the component will be disregarded completely and not take up a cell in the grid..- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
id
public final CC id(String s)
The id used to reference this component in some constraints.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
s
- The id ornull
. May consist of a groupID and an componentID which are separated by a dot: ".". E.g. "grp1.id1". The dot should never be first or last if present.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.
-
tag
public final CC tag(String tag)
Same functionality assetTag(String tag)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
tag
- The new tag. May benull
.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setTag(String)
-
cell
public final CC cell(int... colRowWidthHeight)
Set the cell(s) that the component should occupy in the grid. Same functionality assetCellX(int col)
andsetCellY(int row)
together withsetSpanX(int width)
andsetSpanY(int height)
. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
colRowWidthHeight
- cellX, cellY, spanX, spanY respectively. 1-4 arguments, not null.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2. Replacing cell(int, int) and cell(int, int, int, int)
- See Also:
setCellX(int)
,setCellY(int)
,setSpanX(int)
,setSpanY(int)
-
span
public final CC span(int... cells)
Same functionality asspanX(cellsX).spanY(cellsY)
which means this cell will span cells in both x and y. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com. Since 3.7.2 this takes an array/vararg whereas it previously only took two specific values, xSpan and ySpan.
- Parameters:
cells
- spanX and spanY, when present, and in that order.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2 Replaces span(int, int).
- See Also:
setSpanY(int)
,setSpanX(int)
,spanY()
,spanX()
-
gap
public final CC gap(String... args)
Corresponds exactly to the "gap left right top bottom" keyword.- Parameters:
args
- Same as for the "gap" keyword. Length 1-4, never null buf elements can be null.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapBefore
public final CC gapBefore(String boundsSize)
Sets the horizontal gap before the component.Note! This is currently same as gapLeft(). This might change in 4.x.
- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapAfter
public final CC gapAfter(String boundsSize)
Sets the horizontal gap after the component.Note! This is currently same as gapRight(). This might change in 4.x.
- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapTop
public final CC gapTop(String boundsSize)
Sets the gap above the component.- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapLeft
public final CC gapLeft(String boundsSize)
Sets the gap to the left the component.- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapBottom
public final CC gapBottom(String boundsSize)
Sets the gap below the component.- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
gapRight
public final CC gapRight(String boundsSize)
Sets the gap to the right of the component.- Parameters:
boundsSize
- The size of the gap expressed as aBoundSize
. E.g. "50:100px:200mm" or "100px!".- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
-
spanY
public final CC spanY()
Same functionality as callingsetSpanY(int)
withLayoutUtil.INF
which means this cell will span the rest of the column. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setSpanY(int)
,spanY()
-
spanY
public final CC spanY(int cells)
Same functionality assetSpanY(int)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- The number of cells to span (i.e. merge).- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setSpanY(int)
-
spanX
public final CC spanX()
Same functionality assetSpanX(int)
which means this cell will span the rest of the row. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setSpanX(int)
,spanX()
-
spanX
public final CC spanX(int cells)
Same functionality assetSpanX(int)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- The number of cells to span (i.e. merge).- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setSpanY(int)
-
push
public final CC push()
Same functionality aspushX().pushY()
which means this cell will push in both x and y dimensions. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushX(Float)
,setPushX(Float)
,pushY()
,pushX()
-
push
public final CC push(Float weightX, Float weightY)
Same functionality aspushX(weightX).pushY(weightY)
which means this cell will push in both x and y dimensions. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
weightX
- The weight used in the push.weightY
- The weight used in the push.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushY(Float)
,setPushX(Float)
,pushY()
,pushX()
-
pushY
public final CC pushY()
Same functionality assetPushY(Float)
which means this cell will push the rest of the column. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushY(Float)
-
pushY
public final CC pushY(Float weight)
Same functionality assetPushY(Float weight)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
weight
- The weight used in the push.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushY(Float)
-
pushX
public final CC pushX()
Same functionality assetPushX(Float)
which means this cell will push the rest of the row. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushX(Float)
-
pushX
public final CC pushX(Float weight)
Same functionality assetPushX(Float weight)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
weight
- The weight used in the push.- Returns:
this
so it is possible to chain calls. E.g.new LayoutConstraint().noGrid().gap().fill()
.- See Also:
setPushY(Float)
-
split
public final CC split(int parts)
Same functionality assetSplit(int parts)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
parts
- The number of parts (i.e. component slots) the cell should be divided into.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setSplit(int)
-
split
public final CC split()
Same functionality as split(LayoutUtil.INF), which means split until one of the keywords that breaks the split is found for a component after this one (e.g. wrap, newline and skip).For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
- See Also:
setSplit(int)
-
skip
public final CC skip(int cells)
Same functionality assetSkip(int)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- How many cells in the grid that should be skipped before the component that this constraint belongs to- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setSkip(int)
-
skip
public final CC skip()
Same functionality as skip(1).For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- Since:
- 3.7.2
- See Also:
setSkip(int)
-
external
public final CC external()
Same functionality as callingsetExternal(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setExternal(boolean)
-
flowX
public final CC flowX()
Same functionality as callingsetFlowX(Boolean)
withBoolean.TRUE
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setFlowX(Boolean)
-
flowY
public final CC flowY()
Same functionality as callingsetFlowX(Boolean)
withBoolean.FALSE
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setFlowX(Boolean)
-
grow
public final CC grow()
-
newline
public final CC newline()
Same functionality as callingsetNewline(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setNewline(boolean)
-
newline
public final CC newline(String gapSize)
Same functionality assetNewlineGapSize(BoundSize)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
gapSize
- The gap size that will override the gap size in the row/column constraints if!= null
. E.g. "5px" or "unrel". Ifnull
or""
the newline size will be set to the default size and turned on. This is different compared tosetNewlineGapSize(BoundSize)
.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setNewlineGapSize(BoundSize)
-
wrap
public final CC wrap()
Same functionality as callingsetWrap(boolean)
withtrue
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setWrap(boolean)
-
wrap
public final CC wrap(String gapSize)
Same functionality assetWrapGapSize(BoundSize)
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
gapSize
- The gap size that will override the gap size in the row/column constraints if!= null
. E.g. "5px" or "unrel". Ifnull
or""
the wrap size will be set to the default size and turned on. This is different compared tosetWrapGapSize(BoundSize)
.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setWrapGapSize(BoundSize)
-
dockNorth
public final CC dockNorth()
Same functionality as callingsetDockSide(int)
with0
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setDockSide(int)
-
dockWest
public final CC dockWest()
Same functionality as callingsetDockSide(int)
with1
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setDockSide(int)
-
dockSouth
public final CC dockSouth()
Same functionality as callingsetDockSide(int)
with2
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setDockSide(int)
-
dockEast
public final CC dockEast()
Same functionality as callingsetDockSide(int)
with3
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setDockSide(int)
-
x
public final CC x(String x)
Sets the x-coordinate for the component. This is used to set the x coordinate position to a specific value. The component bounds is still precalculated to the grid cell and this method should be seen as a way to correct the x position.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
x
- The x position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
,setBoundsInGrid(boolean)
-
y
public final CC y(String y)
Sets the y-coordinate for the component. This is used to set the y coordinate position to a specific value. The component bounds is still precalculated to the grid cell and this method should be seen as a way to correct the y position.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
y
- The y position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
,setBoundsInGrid(boolean)
-
x2
public final CC x2(String x2)
Sets the x2-coordinate for the component (right side). This is used to set the x2 coordinate position to a specific value. The component bounds is still precalculated to the grid cell and this method should be seen as a way to correct the x position.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
x2
- The x2 side's position as a UnitValue. E.g. "10" or "40mm" or "container.x2 - 10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
,setBoundsInGrid(boolean)
-
y2
public final CC y2(String y2)
Sets the y2-coordinate for the component (bottom side). This is used to set the y2 coordinate position to a specific value. The component bounds is still precalculated to the grid cell and this method should be seen as a way to correct the y position.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
y2
- The y2 side's position as a UnitValue. E.g. "10" or "40mm" or "container.x2 - 10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
,setBoundsInGrid(boolean)
-
pos
public final CC pos(String x, String y)
Same functionality asx(String x)
andy(String y)
together.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
x
- The x position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".y
- The y position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
-
pos
public final CC pos(String x, String y, String x2, String y2)
Same functionality asx(String x)
,y(String y)
,y2(String y)
andy2(String y)
together.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
x
- The x position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".y
- The y position as a UnitValue. E.g. "10" or "40mm" or "container.x+10".x2
- The x2 side's position as a UnitValue. E.g. "10" or "40mm" or "container.x2 - 10".y2
- The y2 side's position as a UnitValue. E.g. "10" or "40mm" or "container.x2 - 10".- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setPos(UnitValue[])
-
pad
public final CC pad(int top, int left, int bottom, int right)
Same functionality assetPadding(UnitValue[])
but the unit values as absolute pixels. This method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
top
- The top padding that will be added to the y coordinate at the last stage in the layout.left
- The top padding that will be added to the x coordinate at the last stage in the layout.bottom
- The top padding that will be added to the y2 coordinate at the last stage in the layout.right
- The top padding that will be added to the x2 coordinate at the last stage in the layout.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setTag(String)
-
pad
public final CC pad(String pad)
Same functionality assetPadding(ConstraintParser.parseInsets(pad, false))}
only this method returnsthis
for chaining multiple calls.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
pad
- The string to parse. E.g. "10 10 10 10" or "20". If less than 4 groups the last will be used for the missing.- Returns:
this
so it is possible to chain calls. E.g.new ComponentConstraint().noGrid().gap().fill()
.- See Also:
setTag(String)
-
getHorizontal
public DimConstraint getHorizontal()
Returns the horizontal dimension constraint for this component constraint. It has constraints for the horizontal size and grow/shrink priorities and weights.Note! If any changes is to be made it must be made direct when the object is returned. It is not allowed to save the constraint for later use.
- Returns:
- The current dimension constraint. Never
null
.
-
setHorizontal
public void setHorizontal(DimConstraint h)
Sets the horizontal dimension constraint for this component constraint. It has constraints for the horizontal size and grow/shrink priorities and weights.- Parameters:
h
- The new dimension constraint. Ifnull
it will be reset tonew DimConstraint();
-
getVertical
public DimConstraint getVertical()
Returns the vertical dimension constraint for this component constraint. It has constraints for the vertical size and grow/shrink priorities and weights.Note! If any changes is to be made it must be made direct when the object is returned. It is not allowed to save the constraint for later use.
- Returns:
- The current dimension constraint. Never
null
.
-
setVertical
public void setVertical(DimConstraint v)
Sets the vertical dimension constraint for this component constraint. It has constraints for the vertical size and grow/shrink priorities and weights.- Parameters:
v
- The new dimension constraint. Ifnull
it will be reset tonew DimConstraint();
-
getDimConstraint
public DimConstraint getDimConstraint(boolean isHor)
Returns the vertical or horizontal dim constraint.Note! If any changes is to be made it must be made direct when the object is returned. It is not allowed to save the constraint for later use.
- Parameters:
isHor
- If the horizontal constraint should be returned.- Returns:
- The dim constraint. Never
null
.
-
getPos
public UnitValue[] getPos()
Returns the absolute positioning of one or more of the edges. This will be applied last in the layout cycle and will not affect the flow or grid positions. The positioning is relative to the parent and can not (as padding) be used to adjust the edges relative to the old value. May benull
and elements may benull
.null
value(s) for the x2 and y2 will be interpreted as to keep the preferred size and thus the x1 and x2 will just absolutely positions the component.Note that
setBoundsInGrid(boolean)
changes the interpretation of this property slightly.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value as a new array, free to modify.
-
setPos
public void setPos(UnitValue[] pos)
Sets absolute positioning of one or more of the edges. This will be applied last in the layout cycle and will not affect the flow or grid positions. The positioning is relative to the parent and can not (as padding) be used to adjust the edges relative to the old value. May benull
and elements may benull
.null
value(s) for the x2 and y2 will be interpreted as to keep the preferred size and thus the x1 and x2 will just absolutely positions the component.Note that
setBoundsInGrid(boolean)
changes the interpretation of this property slightly.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
pos
-UnitValue[] {x, y, x2, y2}
. Must benull
or of length 4. Elements can benull
.
-
isBoundsInGrid
public boolean isBoundsInGrid()
Returns if the absolutepos
value should be corrections to the component that is in a normal cell. Iffalse
the value ofpos
is truly absolute in that it will not affect the grid or have a default bounds in the grid.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
- See Also:
getPos()
-
setBoundsInGrid
public void setBoundsInGrid(boolean b)
Sets if the absolutepos
value should be corrections to the component that is in a normal cell. Iffalse
the value ofpos
is truly absolute in that it will not affect the grid or have a default bounds in the grid.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
b
-true
for bounds taken from the grid position.false
is default.- See Also:
setPos(UnitValue[])
-
getCellX
public int getCellX()
Returns the absolute cell position in the grid or-1
if cell positioning is not used.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setCellX
public void setCellX(int x)
Set an absolute cell x-position in the grid. If >= 0 this point points to the absolute cell that this constaint's component should occupy. If there's already a component in that cell they will split the cell. The flow will then continue after this cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
x
- The x-position or-1
to disable cell positioning.
-
getCellY
public int getCellY()
Returns the absolute cell position in the grid or-1
if cell positioning is not used.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setCellY
public void setCellY(int y)
Set an absolute cell x-position in the grid. If >= 0 this point points to the absolute cell that this constaint's component should occupy. If there's already a component in that cell they will split the cell. The flow will then continue after this cell.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
y
- The y-position or-1
to disable cell positioning.
-
getDockSide
public int getDockSide()
Sets the docking side. -1 means no docking.
Valid sides are:north = 0, west = 1, south = 2, east = 3
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current side.
-
setDockSide
public void setDockSide(int side)
Sets the docking side. -1 means no docking.
Valid sides are:north = 0, west = 1, south = 2, east = 3
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
side
- -1 or 0-3.
-
isExternal
public boolean isExternal()
Returns if this component should have its bounds handled by an external source and not this layout manager.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setExternal
public void setExternal(boolean b)
If this boolean is true this component is not handled in any way by the layout manager and the component can have its bounds set by an external handler which is normally by the use of somecomponent.setBounds(x, y, width, height)
directly (for Swing).The bounds will not affect the minimum and preferred size of the container.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
b
-true
means that the bounds are not changed.
-
getFlowX
public Boolean getFlowX()
Returns if the flow in the cell is in the horizontal dimension. Vertical iffalse
. Only the first component is a cell can set the flow.If
null
the flow direction is inherited by from theLC
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setFlowX
public void setFlowX(Boolean b)
Sets if the flow in the cell is in the horizontal dimension. Vertical iffalse
. Only the first component is a cell can set the flow.If
null
the flow direction is inherited by from theLC
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
b
-Boolean.TRUE
means horizontal flow in the cell.
-
getHideMode
public int getHideMode()
Sets how a component that is hidden (not visible) should be treated by default. For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.- Returns:
- The mode:
0 == Normal. Bounds will be calculated as if the component was visible.
1 == If hidden the size will be 0, 0 but the gaps remain.
2 == If hidden the size will be 0, 0 and gaps set to zero.
3 == If hidden the component will be disregarded completely and not take up a cell in the grid..
-
setHideMode
public void setHideMode(int mode)
Sets how a component that is hidden (not visible) should be treated by default.- Parameters:
mode
- The mode:
0 == Normal. Bounds will be calculated as if the component was visible.
1 == If hidden the size will be 0, 0 but the gaps remain.
2 == If hidden the size will be 0, 0 and gaps set to zero.
3 == If hidden the component will be disregarded completely and not take up a cell in the grid..
-
getId
public String getId()
Returns the id used to reference this component in some constraints.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The id or
null
. May consist of a groupID and an componentID which are separated by a dot: ".". E.g. "grp1.id1". The dot should never be first or last if present.
-
setId
public void setId(String id)
Sets the id used to reference this component in some constraints.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
id
- The id ornull
. May consist of a groupID and an componentID which are separated by a dot: ".". E.g. "grp1.id1". The dot should never be first or last if present.
-
getPadding
public UnitValue[] getPadding()
Returns the absolute resizing in the last stage of the layout cycle. May benull
and elements may benull
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
null
or of length 4.
-
setPadding
public void setPadding(UnitValue[] sides)
Sets the absolute resizing in the last stage of the layout cycle. These values are added to the edges and can thus for instance be used to grow or reduce the size or move the component an absolute number of pixels. May benull
and elements may benull
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
sides
- top, left, bottom right. Must benull
or of length 4.
-
getVisualPadding
public UnitValue[] getVisualPadding()
Returns the visual padding used when laying out this Component. May benull
and elements may benull
.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
null
or of length 4.
-
setVisualPadding
public void setVisualPadding(UnitValue[] sides)
Sets the visual padding used when laying out this Component.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
sides
- top, left, bottom right. Must benull
or of length 4.
-
getSkip
public int getSkip()
Returns how many cells in the grid that should be skipped before the component that this constraint belongs to.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value. 0 if no skip.
-
setSkip
public void setSkip(int cells)
Sets how many cells in the grid that should be skipped before the component that this constraint belongs to.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- How many cells in the grid that should be skipped before the component that this constraint belongs to
-
getSpanX
public int getSpanX()
Returns the number of cells the cell that this constraint's component will span in the indicated dimension.1
is default and means that it only spans the current cell.LayoutUtil.INF
is used to indicate a span to the end of the column/row.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setSpanX
public void setSpanX(int cells)
Sets the number of cells the cell that this constraint's component will span in the indicated dimension.1
is default and means that it only spans the current cell.LayoutUtil.INF
is used to indicate a span to the end of the column/row.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- The number of cells to span (i.e. merge).
-
getSpanY
public int getSpanY()
Returns the number of cells the cell that this constraint's component will span in the indicated dimension.1
is default and means that it only spans the current cell.LayoutUtil.INF
is used to indicate a span to the end of the column/row.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setSpanY
public void setSpanY(int cells)
Sets the number of cells the cell that this constraint's component will span in the indicated dimension.1
is default and means that it only spans the current cell.LayoutUtil.INF
is used to indicate a span to the end of the column/row.Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
cells
- The number of cells to span (i.e. merge).
-
getPushX
public Float getPushX()
"pushx" indicates that the column that this component is in (this first if the component spans) should default to growing. If any other column has been set to grow this push value on the component does nothing as the column's explicit grow weight will take precedence. Push is normally used when the grid has not been defined in the layout.If multiple components in a column has push weights set the largest one will be used for the column.
- Returns:
- The current push value. Default is
null
.
-
setPushX
public void setPushX(Float weight)
"pushx" indicates that the column that this component is in (this first if the component spans) should default to growing. If any other column has been set to grow this push value on the component does nothing as the column's explicit grow weight will take precedence. Push is normally used when the grid has not been defined in the layout.If multiple components in a column has push weights set the largest one will be used for the column.
- Parameters:
weight
- The new push value. Default isnull
.
-
getPushY
public Float getPushY()
"pushx" indicates that the row that this component is in (this first if the component spans) should default to growing. If any other row has been set to grow this push value on the component does nothing as the row's explicit grow weight will take precedence. Push is normally used when the grid has not been defined in the layout.If multiple components in a row has push weights set the largest one will be used for the row.
- Returns:
- The current push value. Default is
null
.
-
setPushY
public void setPushY(Float weight)
"pushx" indicates that the row that this component is in (this first if the component spans) should default to growing. If any other row has been set to grow this push value on the component does nothing as the row's explicit grow weight will take precedence. Push is normally used when the grid has not been defined in the layout.If multiple components in a row has push weights set the largest one will be used for the row.
- Parameters:
weight
- The new push value. Default isnull
.
-
getSplit
public int getSplit()
Returns in how many parts the current cell (that this constraint's component will be in) should be split in. If for instance it is split in two, the next component will also share the same cell. Note that the cell can also span a number of cells, which means that you can for instance span three cells and split that big cell for two components. Split can be set to a very high value to make all components in the same row/column share the same cell (e.g.LayoutUtil.INF
).Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setSplit
public void setSplit(int parts)
Sets in how many parts the current cell (that this constraint's component will be in) should be split in. If for instance it is split in two, the next component will also share the same cell. Note that the cell can also span a number of cells, which means that you can for instance span three cells and split that big cell for two components. Split can be set to a very high value to make all components in the same row/column share the same cell (e.g.LayoutUtil.INF
).Note that only the first component will be checked for this property.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
parts
- The number of parts (i.e. component slots) the cell should be divided into.
-
getTag
public String getTag()
Tags the component with metadata. Currently only used to tag buttons with for instance "cancel" or "ok" to make them show up in the correct order depending on platform. SeePlatformDefaults.setButtonOrder(String)
for information.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value. May be
null
.
-
setTag
public void setTag(String tag)
Optional tag that gives more context to this constraint's component. It is for instance used to tag buttons in a button bar with the button type such as "ok", "help" or "cancel".For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
tag
- The new tag. May benull
.
-
isWrap
public boolean isWrap()
Returns if the flow should wrap to the next line/column after the component that this constraint belongs to.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setWrap
public void setWrap(boolean b)
Sets if the flow should wrap to the next line/column after the component that this constraint belongs to.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
b
-true
means wrap after.
-
getWrapGapSize
public BoundSize getWrapGapSize()
Returns the wrap size if it is a custom size. If wrap was set to true withsetWrap(boolean)
then this method will returnnull
since that means that the gap size should be the default one as defined in the rows spec.- Returns:
- The custom gap size. NOTE! Will return
null
for both no wrap and default wrap. - Since:
- 2.4.2
- See Also:
isWrap()
,setWrap(boolean)
-
setWrapGapSize
public void setWrapGapSize(BoundSize s)
Set the wrap size and turns wrap on if!= null
.- Parameters:
s
- The custom gap size. NOTE!null
will not turn on or off wrap, it will only set the wrap gap size to "default". A non-null value will turn on wrap though.- Since:
- 2.4.2
- See Also:
isWrap()
,setWrap(boolean)
-
isNewline
public boolean isNewline()
Returns if the flow should wrap to the next line/column before the component that this constraint belongs to.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Returns:
- The current value.
-
setNewline
public void setNewline(boolean b)
Sets if the flow should wrap to the next line/column before the component that this constraint belongs to.For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
- Parameters:
b
-true
means wrap before.
-
getNewlineGapSize
public BoundSize getNewlineGapSize()
Returns the newline size if it is a custom size. If newline was set to true withsetNewline(boolean)
then this method will returnnull
since that means that the gap size should be the default one as defined in the rows spec.- Returns:
- The custom gap size. NOTE! Will return
null
for both no newline and default newline. - Since:
- 2.4.2
- See Also:
isNewline()
,setNewline(boolean)
-
setNewlineGapSize
public void setNewlineGapSize(BoundSize s)
Set the newline size and turns newline on if!= null
.- Parameters:
s
- The custom gap size. NOTE!null
will not turn on or off newline, it will only set the newline gap size to "default". A non-null value will turn on newline though.- Since:
- 2.4.2
- See Also:
isNewline()
,setNewline(boolean)
-
getAnimSpec
public AnimSpec getAnimSpec()
Returns the animation spec. Default is a spec where animation is off (prio 0).- Returns:
- Never null.
-
readExternal
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
writeExternal
public void writeExternal(ObjectOutput out) throws IOException
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
-