|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.miginfocom.layout.LC
public final class LC
Contains the constraints for an instance of the LC
layout manager.
Constructor Summary | |
---|---|
LC()
Empty constructor. |
Method Summary | |
---|---|
LC |
align(java.lang.String ax,
java.lang.String ay)
Sets both the alignX and alignY as the same time. |
LC |
alignX(java.lang.String align)
Same functionality as setAlignX(ConstraintParser.parseUnitValueOrAlign(unitValue, true)) only this method returns this
for chaining multiple calls. |
LC |
alignY(java.lang.String align)
Same functionality as setAlignY(ConstraintParser.parseUnitValueOrAlign(align, false)) only this method returns this for chaining multiple calls. |
LC |
bottomToTop()
Same functionality as setTopToBottom(boolean false) only this method returns this for chaining multiple calls. |
LC |
debug(int repaintMillis)
Same functionality as setDebugMillis(int repaintMillis) only this method returns this for chaining multiple calls. |
LC |
fill()
Same functionality as setFillX(boolean true) and setFillY(boolean true) conmbined.T his method returns
this for chaining multiple calls. |
LC |
fillX()
Same functionality as setFillX(boolean true) only this method returns this for chaining multiple calls. |
LC |
fillY()
Same functionality as setFillY(boolean true) only this method returns this for chaining multiple calls. |
LC |
flowY()
Same functionality as setFlowX(boolean true) only this method returns this for chaining multiple calls. |
UnitValue |
getAlignX()
If the laid out components' bounds in total is less than the final size of the container these align values will be used to align the components in the parent. |
UnitValue |
getAlignY()
If the laid out components' bounds in total is less than the final size of the container these align values will be used to align the components in the parent. |
int |
getDebugMillis()
If > 0 the debug decorations will be repainted every millis . |
BoundSize |
getGridGapX()
If non- null (null is default) these value will be used as the default gaps between the columns in the grid. |
BoundSize |
getGridGapY()
If non- null (null is default) these value will be used as the default gaps between the rows in the grid. |
int |
getHideMode()
How a component that is hidden (not visible) should be treated by default. |
UnitValue[] |
getInsets()
The insets for the layed out panel. |
java.lang.Boolean |
getLeftToRight()
If the layout should be forced to be left-to-right or right-to-left. |
int |
getWrapAfter()
Returns after what cell the grid should always auto wrap. |
LC |
gridGap(java.lang.String gapx,
java.lang.String gapy)
Sets both grid gaps at the same time. see gridGapX(String) and gridGapY(String) . |
LC |
gridGapX(java.lang.String boundsSize)
Same functionality as setGridGapX(ConstraintParser.parseBoundSize(boundsSize, true, true)) only this method
returns this for chaining multiple calls. |
LC |
gridGapY(java.lang.String boundsSize)
Same functionality as setGridGapY(ConstraintParser.parseBoundSize(boundsSize, true, false)) only this method
returns this for chaining multiple calls. |
LC |
hideMode(int mode)
Same functionality as setHideMode(int mode) only this method returns this for chaining multiple calls. |
LC |
insets(java.lang.String s)
Same functionality as setInsets(ConstraintParser.parseInsets(s, true)) . |
LC |
insets(java.lang.String top,
java.lang.String left,
java.lang.String bottom,
java.lang.String right)
Sets the different insets (expressed as a UnitValue s, e.g. "10px" or "20mm") for the corresponding sides. |
LC |
insetsAll(java.lang.String allSides)
Sets the same inset (expressed as a UnitValue , e.g. "10px" or "20mm") all around. |
boolean |
isFillX()
If the layout should always claim the whole bounds of the laid out container even if the preferred size is smaller. |
boolean |
isFillY()
If the layout should always claim the whole bounds of the laid out container even if the preferred size is smaller. |
boolean |
isFlowX()
The default flow direction. |
boolean |
isNoCache()
If components have sizes or positions linked to the bounds of the parent in some way (as for instance the "%" unit has) the cache
must be turned off for the panel. |
boolean |
isNoGrid()
If the whole layout should be non grid based. |
boolean |
isTopToBottom()
If the layout should go from the default top-to-bottom in the grid instead of the optinal bottom-to-top. |
boolean |
isVisualPadding()
If visual padding should be automatically used and compensated for by this layout instance. |
LC |
leftToRight(boolean b)
Same functionality as setLeftToRight(Boolean) only this method returns this for chaining multiple calls. |
LC |
noCache()
Same functionality as setNoCache(boolean true) only this method returns this for chaining multiple calls. |
LC |
noGrid()
Same functionality as setNoGrid(boolean true) only this method returns this for chaining multiple calls. |
LC |
noVisualPadding()
Same functionality as setVisualPadding(boolean false) only this method returns this for chaining multiple calls. |
void |
readExternal(java.io.ObjectInput in)
|
void |
setAlignX(UnitValue uv)
If the laid out components' bounds in total is less than the final size of the container these align values will be used to align the components in the parent. |
void |
setAlignY(UnitValue uv)
If the laid out components' bounds in total is less than the final size of the container these align values will be used to align the components in the parent. |
void |
setDebugMillis(int millis)
If > 0 the debug decorations will be repainted every millis . |
void |
setFillX(boolean b)
If the layout should always claim the whole bounds of the laid out container even if the preferred size is smaller. |
void |
setFillY(boolean b)
If the layout should always claim the whole bounds of the laid out container even if the preferred size is smaller. |
void |
setFlowX(boolean b)
The default flow direction. |
void |
setGridGapX(BoundSize x)
If non- null (null is default) these value will be used as the default gaps between the columns in the grid. |
void |
setGridGapY(BoundSize y)
If non- null (null is default) these value will be used as the default gaps between the rows in the grid. |
void |
setHideMode(int mode)
How a component that is hidden (not visible) should be treated. |
void |
setInsets(UnitValue[] ins)
The insets for the layed out panel. |
void |
setLeftToRight(java.lang.Boolean b)
If the layout should be forced to be left-to-right or right-to-left. |
void |
setNoCache(boolean b)
If components have sizes or positions linked to the bounds of the parent in some way (as for instance the "%" unit has) the cache
must be turned off for the panel. |
void |
setNoGrid(boolean b)
If the whole layout should be non grid based. |
void |
setTopToBottom(boolean b)
If the layout should go from the default top-to-bottom in the grid instead of the optinal bottom-to-top. |
void |
setVisualPadding(boolean b)
If visual padding should be automatically used and compensated for by this layout instance. |
void |
setWrapAfter(int count)
Sets after what cell the grid should always auto wrap. |
LC |
wrap()
Sets a wrap after the number of columns/rows that is defined in the AC . |
LC |
wrapAfter(int count)
Same functionality as setWrapAfter(int) only this method returns this for chaining multiple calls. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LC()
Method Detail |
---|
public boolean isNoCache()
"%"
unit has) the cache
must be turned off for the panel. If components does not get the correct or expected size or position try to set this property to true
.
true
means no cache and slightly slower layout.public void setNoCache(boolean b)
"%"
unit has) the cache
must be turned off for the panel. If components does not get the correct or expected size or position try to set this property to true
.
b
- true
means no cache and slightly slower layout.public final UnitValue getAlignX()
null
is default and that means top/left alignment. The relative distances between the components will not be affected
by this property.
public final void setAlignX(UnitValue uv)
null
is default and that means top/left alignment. The relative distances between the components will not be affected
by this property.
uv
- The new alignment. Use ConstraintParser.parseAlignKeywords(String, boolean)
to create the UnitValue
. May be null
.public final UnitValue getAlignY()
null
is default and that means top/left alignment. The relative distances between the components will not be affected
by this property.
public final void setAlignY(UnitValue uv)
null
is default and that means top/left alignment. The relative distances between the components will not be affected
by this property.
uv
- The new alignment. Use ConstraintParser.parseAlignKeywords(String, boolean)
to create the UnitValue
. May be null
.public final int getDebugMillis()
> 0
the debug decorations will be repainted every millis
. No debug information if <= 0
(default).
public final void setDebugMillis(int millis)
> 0
the debug decorations will be repainted every millis
. No debug information if <= 0
(default).
millis
- The new debug repaint interval.public final boolean isFillX()
true
means fill. false
is default.public final void setFillX(boolean b)
b
- true
means fill. false
is default.public final boolean isFillY()
true
means fill. false
is default.public final void setFillY(boolean b)
b
- true
means fill. false
is default.public final boolean isFlowX()
true
) this is horizontal and that means that the "next" component
will be put in the cell to the right (or to the left if left-to-right is false).
true
is the default flow horizontally.setLeftToRight(Boolean)
public final void setFlowX(boolean b)
true
) this is horizontal and that means that the "next" component
will be put in the cell to the right (or to the left if left-to-right is false).
b
- true
is the default flow horizontally.setLeftToRight(Boolean)
public final BoundSize getGridGapX()
null
(null
is default) these value will be used as the default gaps between the columns in the grid.
null
if the platform default is used.public final void setGridGapX(BoundSize x)
null
(null
is default) these value will be used as the default gaps between the columns in the grid.
x
- The default grid gap between columns in the grid. If null
the platform default is used.public final BoundSize getGridGapY()
null
(null
is default) these value will be used as the default gaps between the rows in the grid.
null
if the platform default is used.public final void setGridGapY(BoundSize y)
null
(null
is default) these value will be used as the default gaps between the rows in the grid.
y
- The default grid gap between rows in the grid. If null
the platform default is used.public final int getHideMode()
public final void setHideMode(int mode)
mode
- The mode:public final UnitValue[] getInsets()
null
values
means that the default panel insets for the platform is used. See PlatformDefaults.setDialogInsets(net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue)
.
null
. The elements (1 to 4) may be null
. The array is a copy and can be used freely.ConstraintParser.parseInsets(String, boolean)
public final void setInsets(UnitValue[] ins)
null
values
means that the default panel insets for the platform is used. See PlatformDefaults.setDialogInsets(net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue, net.miginfocom.layout.UnitValue)
.
ins
- The new insets. Must be of length 4 (top, left, bottom, right) or null
. The elements (1 to 4) may be null
to use
the platform default for that side. The array is copied for storage.ConstraintParser.parseInsets(String, boolean)
public final java.lang.Boolean getLeftToRight()
null
is default and
means that this will be picked up from the Locale
that the container being layed out is reporting.
Boolean.TRUE
if force left-to-right. Boolean.FALSE
if force tight-to-left. null
for the default "let the current Locale decide".public final void setLeftToRight(java.lang.Boolean b)
null
is default and
means that this will be picked up from the Locale
that the container being layed out is reporting.
b
- Boolean.TRUE
to force left-to-right. Boolean.FALSE
to force tight-to-left. null
for the default "let the current Locale decide".public final boolean isNoGrid()
true
means not grid based. false
is default.public final void setNoGrid(boolean b)
b
- true
means no grid. false
is default.public final boolean isTopToBottom()
true
for the default top-to-bottom.public final void setTopToBottom(boolean b)
b
- true
for the default top-to-bottom.public final boolean isVisualPadding()
true
if visual padding.public final void setVisualPadding(boolean b)
b
- true
turns on visual padding.public final int getWrapAfter()
0
the number of columns/rows in the
AC
is used. LayoutUtil.INF
is used for no auto wrap.public final void setWrapAfter(int count)
count
- After what cell the grid should always auto wrap. If 0
the number of columns/rows in the
AC
is used. LayoutUtil.INF
is used for no auto wrap.public final LC wrap()
AC
.
Same functionality as setWrapAfter(int 0)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC wrapAfter(int count)
setWrapAfter(int)
only this method returns this
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.
count
- After what cell the grid should always auto wrap. If 0
the number of columns/rows in the
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC noCache()
setNoCache(boolean true)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC flowY()
setFlowX(boolean true)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC fill()
setFillX(boolean true)
and setFillY(boolean true)
conmbined.T his method returns
this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC fillX()
setFillX(boolean true)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC fillY()
setFillY(boolean true)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC leftToRight(boolean b)
setLeftToRight(Boolean)
only this method returns this
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.
b
- true
for forcing left-to-right. false
for forcing right-to-left.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC bottomToTop()
setTopToBottom(boolean false)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC noGrid()
setNoGrid(boolean true)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC noVisualPadding()
setVisualPadding(boolean false)
only this method returns this
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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.public final LC insetsAll(java.lang.String allSides)
UnitValue
, e.g. "10px" or "20mm") all around.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
allSides
- The unit value to set for all sides. May be null
which means that the default panel insets
for the platform is used.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setInsets(UnitValue[])
public final LC insets(java.lang.String s)
setInsets(ConstraintParser.parseInsets(s, true))
. This method returns this
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.
s
- 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.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setInsets(UnitValue[])
public final LC insets(java.lang.String top, java.lang.String left, java.lang.String bottom, java.lang.String right)
UnitValue
s, e.g. "10px" or "20mm") for the corresponding sides.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
top
- The top inset. E.g. "10px" or "10mm" or "related". May be null
in which case the default inset for this
side for the platform will be used.left
- The left inset. E.g. "10px" or "10mm" or "related". May be null
in which case the default inset for this
side for the platform will be used.bottom
- The bottom inset. E.g. "10px" or "10mm" or "related". May be null
in which case the default inset for this
side for the platform will be used.right
- The right inset. E.g. "10px" or "10mm" or "related". May be null
in which case the default inset for this
side for the platform will be used.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setInsets(UnitValue[])
public final LC alignX(java.lang.String align)
setAlignX(ConstraintParser.parseUnitValueOrAlign(unitValue, true))
only this method returns this
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.
align
- The align keyword or for instance "100px". E.g "left", "right", "leading" or "trailing".
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setAlignX(UnitValue)
public final LC alignY(java.lang.String align)
setAlignY(ConstraintParser.parseUnitValueOrAlign(align, false))
only this method returns this
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.
align
- The align keyword or for instance "100px". E.g "top" or "bottom".
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setAlignY(UnitValue)
public final LC align(java.lang.String ax, java.lang.String ay)
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
ax
- The align keyword or for instance "100px". E.g "left", "right", "leading" or "trailing".ay
- The align keyword or for instance "100px". E.g "top" or "bottom".
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.alignX(String)
,
alignY(String)
public final LC gridGapX(java.lang.String boundsSize)
setGridGapX(ConstraintParser.parseBoundSize(boundsSize, true, true))
only this method
returns this
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.
boundsSize
- The BoundSize
of the gap. This is a minimum and/or preferred and/or maximum size. E.g.
"50:100:200"
or "100px"
.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setGridGapX(BoundSize)
public final LC gridGapY(java.lang.String boundsSize)
setGridGapY(ConstraintParser.parseBoundSize(boundsSize, true, false))
only this method
returns this
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.
boundsSize
- The BoundSize
of the gap. This is a minimum and/or preferred and/or maximum size. E.g.
"50:100:200"
or "100px"
.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setGridGapY(BoundSize)
public final LC gridGap(java.lang.String gapx, java.lang.String gapy)
gridGapX(String)
and gridGapY(String)
.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
gapx
- The BoundSize
of the gap. This is a minimum and/or preferred and/or maximum size. E.g.
"50:100:200"
or "100px"
.gapy
- The BoundSize
of the gap. This is a minimum and/or preferred and/or maximum size. E.g.
"50:100:200"
or "100px"
.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.gridGapX(String)
,
gridGapY(String)
public final LC debug(int repaintMillis)
setDebugMillis(int repaintMillis)
only this method returns this
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.
repaintMillis
- The new debug repaint interval.
this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setDebugMillis(int)
public final LC hideMode(int mode)
setHideMode(int mode)
only this method returns this
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.
mode
- The mode:this
so it is possible to chain calls. E.g. new LayoutConstraint().noGrid().gap().fill()
.setHideMode(int)
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |