GConstraint (Genius 1.13.1 API)

java.lang.Object
- fr.cnes.genius.constraints.GConstraint

```
public class GConstraint
extends Object
```
Classs implementing the constraints that can be applied to a component.

Author:

jjct

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GConstraint.Direction` Available flow directions for the flow constraint.
`static class`	`GConstraint.Position` Available docking positions for the dock constraint.
`static class`	`GConstraint.XAlign` Available values for the X alignment.
`static class`	`GConstraint.YAlign` Available values for the Y alignment.

Constructor Summary

Constructors
Constructor and Description

GConstraint(GBasicConstraintInterface... basicConstraintsList)
Constructor to buid a constraint with the values defined in the argument list.

Constructors
Constructor and Description
`GConstraint(GBasicConstraintInterface... basicConstraintsList)` Constructor to buid a constraint with the values defined in the argument list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GBasicConstraintInterface`	`align(GConstraint.XAlign xValue, GConstraint.YAlign yValue)` Create align basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`alignx(GConstraint.XAlign xValue)` Create align basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`aligny(GConstraint.YAlign yValue)` Create align basic constraint to be passed to the constructor.
`static void`	`avoidHorizontalDisplacement(GLabel longestGLabel, GLabelWithIndicator alwaysVisibleGLabel)` Given the label that arrives the most to the right hand side of the panel, normally the loguest, or the one with the greater gap at left, and given one label that is always visible, it computes the minimum width for the indicator of the allways visible label in order to avoid lateral displacement of the layout second column widgets when displaying/occulting ihm subparts, and it appyies it by the method `setWMin(int)`.
`static GBasicConstraintInterface`	`cell(int column, int row)` Create cell basic constraint to be passed to the constructor, the cell associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`cell(int column, int row, Integer spanx)` Create cell basic constraint to be passed to the constructor, the cell associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`cell(int column, int row, Integer spanx, Integer spany)` Create cell basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`dock(GConstraint.Position position)` Create a dock basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`flow(GConstraint.Direction direction)` Create a flow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`gap(Integer gapLeft, Integer gapRight, Integer gapTop, Integer gapBottom)` Create gap basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`gapbottom(Integer gapBottom)` Create gap basic constraint to be passed to the constructor, only the gap left value is set the other values are not modified.
`static GBasicConstraintInterface`	`gapleft(Integer gapLeft)` Create gap basic constraint to be passed to the constructor, only the gap left value is set the other values are not modified.
`static GBasicConstraintInterface`	`gapright(Integer gapRight)` Create gap basic constraint to be passed to the constructor, only the gap right value is set the other values are not modified.
`static GBasicConstraintInterface`	`gaptop(Integer gapTop)` Create gap basic constraint to be passed to the constructor, only the gap top value is set the other values are not modified.
`GConstraint.XAlign`	`getalignX()` Get the alignx value or null if no alignx is defined.
`GConstraint.YAlign`	`getalignY()` Get the aligny value or null if no aligny is defined.
`Integer`	`getCellColumn()` Get the column associated to the cell.
`Integer`	`getCellRow()` Get the row associated to the cell.
`Integer`	`getCellSpanx()` Get the spanx associated to the cell.
`Integer`	`getCellSpany()` Get the spany associated to the cell.
`GConstraint.Position`	`getDock()` Get the position associated to the dock.
`boolean`	`getDoNewline()` Get the doWrap attribute value.
`boolean`	`getDoWrap()` Get the doWrap attribute value.
`GConstraint.Direction`	`getFlow()` Get the direction associated to the flow.
`Integer[]`	`getGap()` Get the gap value.
`Integer`	`getGrowX()` Get the growx value or null if no growx is defined.
`Integer`	`getGrowY()` Get the growy value or null if no growy is defined.
`Integer`	`getHeight()` Get the height value.
`Integer`	`getHMax()` Get the hmax value.
`Integer`	`getHMin()` Get the hmin value.
`Integer`	`getNewlineGap()` Get the gap associated to the gap.
`Integer`	`getPushX()` Get the pushx value or null if no pushx is defined.
`Integer`	`getPushY()` Get the pushy value or null if no pushy is defined.
`Integer`	`getSkip()` Get the skip value, or null if no skip is defined.
`Integer`	`getSpanX()` Get the spanx value or null if no spanx is defined.
`Integer`	`getSpanY()` Get the spany value or null if no spany is defined.
`Integer`	`getSplit()` Get the split value, or null if no split is defined.
`Integer`	`getWidth()` Get the width value.
`Integer`	`getWMax()` Get the wmax value.
`Integer`	`getWMin()` Get the wmin value.
`Integer`	`getWrapGap()` Get the gap associated to the gap.
`static GBasicConstraintInterface`	`grow()` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`grow(Integer xValue, Integer yValue)` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`growx()` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`growx(Integer xValue)` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`growy()` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`growy(Integer yValue)` Create grow basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`height(int value)` Create height basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`hmax(int value)` Create hmax basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`hmin(int value)` Create hmin basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`newline()` Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`newline(boolean doNewline)` Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`newline(boolean doNewline, Integer newlineWrap)` Create wrap basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`push()` Create push basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`push(Integer xValue, Integer yValue)` Create push basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`pushx()` Create push basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`pushx(Integer xValue)` Create push basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`pushy()` Create push basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`pushy(Integer yValue)` Create push basic constraint to be passed to the constructor.
`void`	`setAlign(GConstraint.XAlign alignX, GConstraint.YAlign alignY)` Set the align constraint value.
`void`	`setCell(int column, int row, Integer spanx, Integer spany)` Set the cell value.
`void`	`setDock(GConstraint.Position position)` Set the dock position.
`void`	`setFlow(GConstraint.Direction direction)` Set the flow direction.
`void`	`setGap(Integer gapLeft, Integer gapRight, Integer gapTop, Integer gapBottom)` Set the gap value.
`void`	`setGrow(boolean doGrowX, boolean doGrowY, Integer growX, Integer growY)` Set the grow constraint value.
`void`	`setHeight(int value)` Set the height value.
`void`	`setHMax(int value)` Set the hmax value.
`void`	`setHMin(int value)` Set the hmin value.
`void`	`setNewline(boolean doNewLine, Integer newLineGap)` Set the wrap constraint value.
`void`	`setPush(boolean doPushX, boolean doPushY, Integer pushX, Integer pushY)` Set the push constraint value.
`void`	`setSkip(Boolean doSkip, Integer skip)` Set the skip value.
`void`	`setSpan(Integer spanX, Integer spanY)` Set the span constraint value.
`void`	`setSplit(boolean doSplit, Integer split)` Set the split value.
`void`	`setWidth(int value)` Set the width value.
`void`	`setWMax(int value)` Set the wmax value.
`void`	`setWMin(int value)` Set the wmin value.
`void`	`setWrap(boolean doWrap, Integer wrapGap)` Set the wrap constraint value.
`void`	`setWrap(int column, int row, Integer spanx, Integer spany)` Set the cell constraint value.
`static GBasicConstraintInterface`	`skip()` Create skip basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`skip(boolean doSkip)` Create skip basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`skip(boolean doSkip, Integer skip)` Create skip basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`skip(Integer skip)` Create skip basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`span(int xValue, int yValue)` Create span basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`spanx(int xValue)` Create span basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`spany(int yValue)` Create span basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`split()` Create split basic constraint to be passed to the constructor, the split associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`split(boolean doSplit)` Create split basic constraint to be passed to the constructor, the split associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`split(boolean doSplit, Integer value)` Create split basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`split(Integer value)` Create split basic constraint to be passed to the constructor.
`String`	`toString()` Builds and returns the constraint based on the stored values.
`static GBasicConstraintInterface`	`width(int value)` Create width basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`wmax(int value)` Create wmax basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`wmin(int value)` Create wmin basic constraint to be passed to the constructor.
`static GBasicConstraintInterface`	`wrap()` Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`wrap(boolean doWrap)` Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
`static GBasicConstraintInterface`	`wrap(boolean doWrap, Integer wrapGap)` Create wrap basic constraint to be passed to the constructor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GConstraint
```
public GConstraint(GBasicConstraintInterface... basicConstraintsList)
```
    Constructor to buid a constraint with the values defined in the argument list.
    
    Parameters:
    
    basicConstraintsList - list of basic constraints to apply to the constraint in the creation of the object.
- Method Detail
  - avoidHorizontalDisplacement
```
public static void avoidHorizontalDisplacement(GLabel longestGLabel,
                                               GLabelWithIndicator alwaysVisibleGLabel)
```
    Given the label that arrives the most to the right hand side of the panel, normally the loguest, or the one with the greater gap at left, and given one label that is always visible, it computes the minimum width for the indicator of the allways visible label in order to avoid lateral displacement of the layout second column widgets when displaying/occulting ihm subparts, and it appyies it by the method setWMin(int). The minimum width is the width of the longuest label plus its gap plus the indicator width (5 pxl) minus the width of the always visible label minus its gap. It takes into account the font metrics, so this is a portable method.
    
    Parameters:
    
    longestGLabel - the longest GLabel in the panel including its gap (it might not be always visible).
    
    alwaysVisibleGLabel - a label that is always visible in the panel (the most upper label normally).
  - toString
```
public String toString()
```
    Builds and returns the constraint based on the stored values. The returned string can be passed straight forward to mig layout.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representing the constraint to be send to mig layout.
  - setNewline
```
public void setNewline(boolean doNewLine,
                       Integer newLineGap)
```
    Set the wrap constraint value.
    
    Parameters:
    
    doNewLine - true if there is a newline to be applied, false otherwise.
    
    newLineGap - gap associated with the wrap.
  - setPush
```
public void setPush(boolean doPushX,
                    boolean doPushY,
                    Integer pushX,
                    Integer pushY)
```
    Set the push constraint value.
    
    Parameters:
    
    doPushX - boolean to activate the pushX constraint
    
    doPushY - boolean to activate the pushY constraint
    
    pushX - pushx value or null if no pushx.
    
    pushY - pushy value or null if no pushy.
  - setAlign
```
public void setAlign(GConstraint.XAlign alignX,
                     GConstraint.YAlign alignY)
```
    Set the align constraint value.
    
    Parameters:
    
    alignX - alignx value or null if no alignx.
    
    alignY - aligny value or null if no aligny.
  - setGrow
```
public void setGrow(boolean doGrowX,
                    boolean doGrowY,
                    Integer growX,
                    Integer growY)
```
    Set the grow constraint value.
    
    Parameters:
    
    doGrowX - boolean to activate the growX constraint
    
    doGrowY - boolean to activate the growY constraint
    
    growX - growx value.
    
    growY - growy value.
  - setSpan
```
public void setSpan(Integer spanX,
                    Integer spanY)
```
    Set the span constraint value.
    
    Parameters:
    
    spanX - spanx value or null if no spanx.
    
    spanY - spany value or null if no spany.
  - setSkip
```
public void setSkip(Boolean doSkip,
                    Integer skip)
```
    Set the skip value.
    
    Parameters:
    
    doSkip - boolean to activate the skip constraint
    
    skip - skip value or null if no skip.
  - setSplit
```
public void setSplit(boolean doSplit,
                     Integer split)
```
    Set the split value.
    
    Parameters:
    
    doSplit - boolean to activate the split constraint
    
    split - split value or null if no split.
  - getDoNewline
```
public boolean getDoNewline()
```
    Get the doWrap attribute value.
    
    Returns:
    
    the doWrap attribute value.
  - getNewlineGap
```
public Integer getNewlineGap()
```
    Get the gap associated to the gap.
    
    Returns:
    
    the gap associated to the gap.
  - setWrap
```
public void setWrap(boolean doWrap,
                    Integer wrapGap)
```
    Set the wrap constraint value.
    
    Parameters:
    
    doWrap - true if there is a newline to be applied, false otherwise.
    
    wrapGap - gap associated with the wrap.
  - setWrap
```
public void setWrap(int column,
                    int row,
                    Integer spanx,
                    Integer spany)
```
    Set the cell constraint value.
    
    Parameters:
    
    column - column value for the constraint.
    
    row - column value for the constraint.
    
    spanx - spanx value for the constraint.
    
    spany - spany value for the constraint.
  - setDock
```
public void setDock(GConstraint.Position position)
```
    Set the dock position.
    
    Parameters:
    
    position - dock position.
  - setFlow
```
public void setFlow(GConstraint.Direction direction)
```
    Set the flow direction.
    
    Parameters:
    
    direction - flow direction.
  - getDoWrap
```
public boolean getDoWrap()
```
    Get the doWrap attribute value.
    
    Returns:
    
    the doWrap attribute value.
  - getWrapGap
```
public Integer getWrapGap()
```
    Get the gap associated to the gap.
    
    Returns:
    
    the gap associated to the gap.
  - getDock
```
public GConstraint.Position getDock()
```
    Get the position associated to the dock.
    
    Returns:
    
    the position associated to the dock.
  - getFlow
```
public GConstraint.Direction getFlow()
```
    Get the direction associated to the flow.
    
    Returns:
    
    the direction associated to the flow.
  - getCellColumn
```
public Integer getCellColumn()
```
    Get the column associated to the cell.
    
    Returns:
    
    the column associated to the cell.
  - getCellRow
```
public Integer getCellRow()
```
    Get the row associated to the cell.
    
    Returns:
    
    the row associated to the cell.
  - getCellSpanx
```
public Integer getCellSpanx()
```
    Get the spanx associated to the cell.
    
    Returns:
    
    the spanx associated to the cell.
  - getCellSpany
```
public Integer getCellSpany()
```
    Get the spany associated to the cell.
    
    Returns:
    
    the spany associated to the cell.
  - setGap
```
public void setGap(Integer gapLeft,
                   Integer gapRight,
                   Integer gapTop,
                   Integer gapBottom)
```
    Set the gap value.
    
    Parameters:
    
    gapLeft - of the left gap, if null the left gap is not modified.
    
    gapRight - of the right gap, if null the right gap is not modified.
    
    gapTop - of the top gap, if null the top gap is not modified.
    
    gapBottom - of the bottom gap, if null the bottom gap is not modified.
  - setCell
```
public void setCell(int column,
                    int row,
                    Integer spanx,
                    Integer spany)
```
    Set the cell value.
    
    Parameters:
    
    column - column value for the constraint.
    
    row - column value for the constraint.
    
    spanx - spanx value for the constraint.
    
    spany - spany value for the constraint.
  - setWidth
```
public void setWidth(int value)
```
    Set the width value.
    
    Parameters:
    
    value - of the width.
  - setWMin
```
public void setWMin(int value)
```
    Set the wmin value.
    
    Parameters:
    
    value - of the wmin.
  - setWMax
```
public void setWMax(int value)
```
    Set the wmax value.
    
    Parameters:
    
    value - of the wmax.
  - setHeight
```
public void setHeight(int value)
```
    Set the height value.
    
    Parameters:
    
    value - of the height.
  - setHMin
```
public void setHMin(int value)
```
    Set the hmin value.
    
    Parameters:
    
    value - of the hmin.
  - setHMax
```
public void setHMax(int value)
```
    Set the hmax value.
    
    Parameters:
    
    value - of the hmax.
  - getGap
```
public Integer[] getGap()
```
    Get the gap value.
    
    Returns:
    
    Array containing the gap values (left, right, top, bottom).
  - getWidth
```
public Integer getWidth()
```
    Get the width value.
    
    Returns:
    
    the width value or null if no width is defined.
  - getWMin
```
public Integer getWMin()
```
    Get the wmin value.
    
    Returns:
    
    the wmin value or null if no wmin is defined.
  - getWMax
```
public Integer getWMax()
```
    Get the wmax value.
    
    Returns:
    
    the wmax value or null if no wmax is defined.
  - getHeight
```
public Integer getHeight()
```
    Get the height value.
    
    Returns:
    
    the height value or null if no height is defined.
  - getHMin
```
public Integer getHMin()
```
    Get the hmin value.
    
    Returns:
    
    the hmin value or null if no hmin is defined.
  - getHMax
```
public Integer getHMax()
```
    Get the hmax value.
    
    Returns:
    
    the hmax value or null if no hmax is defined.
  - getPushX
```
public Integer getPushX()
```
    Get the pushx value or null if no pushx is defined.
    
    Returns:
    
    the pushx value or null if no pushx is defined.
  - getPushY
```
public Integer getPushY()
```
    Get the pushy value or null if no pushy is defined.
    
    Returns:
    
    the pushy value or null if no pushy is defined.
  - getalignX
```
public GConstraint.XAlign getalignX()
```
    Get the alignx value or null if no alignx is defined.
    
    Returns:
    
    the alignx value or null if no alignx is defined.
  - getalignY
```
public GConstraint.YAlign getalignY()
```
    Get the aligny value or null if no aligny is defined.
    
    Returns:
    
    the aligny value or null if no aligny is defined.
  - getGrowX
```
public Integer getGrowX()
```
    Get the growx value or null if no growx is defined.
    
    Returns:
    
    the growx value or null if no growx is defined.
  - getGrowY
```
public Integer getGrowY()
```
    Get the growy value or null if no growy is defined.
    
    Returns:
    
    the growy value or null if no growy is defined.
  - getSpanX
```
public Integer getSpanX()
```
    Get the spanx value or null if no spanx is defined.
    
    Returns:
    
    the spanx value or null if no spanx is defined.
  - getSpanY
```
public Integer getSpanY()
```
    Get the spany value or null if no spany is defined.
    
    Returns:
    
    the spany value or null if no spany is defined.
  - getSkip
```
public Integer getSkip()
```
    Get the skip value, or null if no skip is defined.
    
    Returns:
    
    the skip value, or null if no skip is defined.
  - getSplit
```
public Integer getSplit()
```
    Get the split value, or null if no split is defined.
    
    Returns:
    
    the split value, or null if no split is defined.
  - wrap
```
public static GBasicConstraintInterface wrap()
```
    Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Returns:
    
    the basic constraint representing the wrap.
  - wrap
```
public static GBasicConstraintInterface wrap(boolean doWrap)
```
    Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Parameters:
    
    doWrap - true if there is a newline to be applied, false otherwise.
    
    Returns:
    
    the basic constraint representing the wrap.
  - cell
```
public static GBasicConstraintInterface cell(int column,
                                             int row)
```
    Create cell basic constraint to be passed to the constructor, the cell associated to the constraint will be set to null.
    
    Parameters:
    
    column - column value for the constraint.
    
    row - column value for the constraint.
    
    Returns:
    
    the basic constraint representing the cell.
  - cell
```
public static GBasicConstraintInterface cell(int column,
                                             int row,
                                             Integer spanx)
```
    Create cell basic constraint to be passed to the constructor, the cell associated to the constraint will be set to null.
    
    Parameters:
    
    column - column value for the constraint.
    
    row - column value for the constraint.
    
    spanx - spanx value for the constraint.
    
    Returns:
    
    the basic constraint representing the cell.
  - cell
```
public static GBasicConstraintInterface cell(int column,
                                             int row,
                                             Integer spanx,
                                             Integer spany)
```
    Create cell basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Parameters:
    
    column - column value for the constraint.
    
    row - column value for the constraint.
    
    spanx - spanx value for the constraint.
    
    spany - spany value for the constraint.
    
    Returns:
    
    the basic constraint representing the cell.
  - newline
```
public static GBasicConstraintInterface newline(boolean doNewline,
                                                Integer newlineWrap)
```
    Create wrap basic constraint to be passed to the constructor.
    
    Parameters:
    
    doNewline - true if there is a newline to be applied, false otherwise.
    
    newlineWrap - gap associated with the wrap.
    
    Returns:
    
    the basic constraint representing the wrap.
  - newline
```
public static GBasicConstraintInterface newline()
```
    Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Returns:
    
    the basic constraint representing the wrap.
  - newline
```
public static GBasicConstraintInterface newline(boolean doNewline)
```
    Create wrap basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Parameters:
    
    doNewline - true if there is a newline to be applied, false otherwise.
    
    Returns:
    
    the basic constraint representing the wrap.
  - wrap
```
public static GBasicConstraintInterface wrap(boolean doWrap,
                                             Integer wrapGap)
```
    Create wrap basic constraint to be passed to the constructor.
    
    Parameters:
    
    doWrap - true if there is a newline to be applied, false otherwise.
    
    wrapGap - gap associated with the wrap.
    
    Returns:
    
    the basic constraint representing the wrap.
  - skip
```
public static GBasicConstraintInterface skip()
```
    Create skip basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Returns:
    
    the basic constraint representing the skip.
  - skip
```
public static GBasicConstraintInterface skip(boolean doSkip)
```
    Create skip basic constraint to be passed to the constructor, the gap associated to the constraint will be set to null.
    
    Parameters:
    
    doSkip - true if there is a skip to be applied, false otherwise.
    
    Returns:
    
    the basic constraint representing the skip.
  - skip
```
public static GBasicConstraintInterface skip(Integer skip)
```
    Create skip basic constraint to be passed to the constructor.
    
    Parameters:
    
    skip - number of columns to be skipped.
    
    Returns:
    
    the basic constraint representing the wrap.
  - skip
```
public static GBasicConstraintInterface skip(boolean doSkip,
                                             Integer skip)
```
    Create skip basic constraint to be passed to the constructor.
    
    Parameters:
    
    doSkip - true if there is a skip to be applied, false otherwise.
    
    skip - number of columns to be skipped.
    
    Returns:
    
    the basic constraint representing the wrap.
  - dock
```
public static GBasicConstraintInterface dock(GConstraint.Position position)
```
    Create a dock basic constraint to be passed to the constructor.
    
    Parameters:
    
    position - dock position to be applied.
    
    Returns:
    
    the basic constraint representing the dock.
  - flow
```
public static GBasicConstraintInterface flow(GConstraint.Direction direction)
```
    Create a flow basic constraint to be passed to the constructor.
    
    Parameters:
    
    direction - flow direction to be applied.
    
    Returns:
    
    the basic constraint representing the flow.
  - gap
```
public static GBasicConstraintInterface gap(Integer gapLeft,
                                            Integer gapRight,
                                            Integer gapTop,
                                            Integer gapBottom)
```
    Create gap basic constraint to be passed to the constructor.
    
    Parameters:
    
    gapLeft - of the left gap, if null the left gap is not modified.
    
    gapRight - of the right gap, if null the right gap is not modified.
    
    gapTop - of the top gap, if null the top gap is not modified.
    
    gapBottom - of the bottom gap, if null the bottom gap is not modified.
    
    Returns:
    
    the basic constraint representing the gap.
  - gapleft
```
public static GBasicConstraintInterface gapleft(Integer gapLeft)
```
    Create gap basic constraint to be passed to the constructor, only the gap left value is set the other values are not modified.
    
    Parameters:
    
    gapLeft - of the left gap, if null the left gap is not modified.
    
    Returns:
    
    the basic constraint representing the gap.
  - gapright
```
public static GBasicConstraintInterface gapright(Integer gapRight)
```
    Create gap basic constraint to be passed to the constructor, only the gap right value is set the other values are not modified.
    
    Parameters:
    
    gapRight - of the right gap, if null the right gap is not modified.
    
    Returns:
    
    the basic constraint representing the gap.
  - gaptop
```
public static GBasicConstraintInterface gaptop(Integer gapTop)
```
    Create gap basic constraint to be passed to the constructor, only the gap top value is set the other values are not modified.
    
    Parameters:
    
    gapTop - of the top gap, if null the top gap is not modified.
    
    Returns:
    
    the basic constraint representing the gap.
  - gapbottom
```
public static GBasicConstraintInterface gapbottom(Integer gapBottom)
```
    Create gap basic constraint to be passed to the constructor, only the gap left value is set the other values are not modified.
    
    Parameters:
    
    gapBottom - of the bottom gap, if null the bottom gap is not modified.
    
    Returns:
    
    the basic constraint representing the gap.
  - pushx
```
public static GBasicConstraintInterface pushx()
```
    Create push basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the push.
  - pushx
```
public static GBasicConstraintInterface pushx(Integer xValue)
```
    Create push basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the pushx.
    
    Returns:
    
    the basic constraint representing the push.
  - pushy
```
public static GBasicConstraintInterface pushy()
```
    Create push basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the push.
  - pushy
```
public static GBasicConstraintInterface pushy(Integer yValue)
```
    Create push basic constraint to be passed to the constructor.
    
    Parameters:
    
    yValue - of the pushy.
    
    Returns:
    
    the basic constraint representing the push.
  - push
```
public static GBasicConstraintInterface push()
```
    Create push basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the push.
  - push
```
public static GBasicConstraintInterface push(Integer xValue,
                                             Integer yValue)
```
    Create push basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the pushx.
    
    yValue - of the pushy.
    
    Returns:
    
    the basic constraint representing the push.
  - alignx
```
public static GBasicConstraintInterface alignx(GConstraint.XAlign xValue)
```
    Create align basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the alignx.
    
    Returns:
    
    the basic constraint representing the align.
  - aligny
```
public static GBasicConstraintInterface aligny(GConstraint.YAlign yValue)
```
    Create align basic constraint to be passed to the constructor.
    
    Parameters:
    
    yValue - of the aligny.
    
    Returns:
    
    the basic constraint representing the align.
  - align
```
public static GBasicConstraintInterface align(GConstraint.XAlign xValue,
                                              GConstraint.YAlign yValue)
```
    Create align basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the alignx.
    
    yValue - of the aligny.
    
    Returns:
    
    the basic constraint representing the align.
  - growx
```
public static GBasicConstraintInterface growx()
```
    Create grow basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the grow.
  - growx
```
public static GBasicConstraintInterface growx(Integer xValue)
```
    Create grow basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the pushx.
    
    Returns:
    
    the basic constraint representing the grow.
  - growy
```
public static GBasicConstraintInterface growy()
```
    Create grow basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the grow.
  - growy
```
public static GBasicConstraintInterface growy(Integer yValue)
```
    Create grow basic constraint to be passed to the constructor.
    
    Parameters:
    
    yValue - of the growy.
    
    Returns:
    
    the basic constraint representing the grow.
  - grow
```
public static GBasicConstraintInterface grow()
```
    Create grow basic constraint to be passed to the constructor.
    
    Returns:
    
    the basic constraint representing the grow.
  - grow
```
public static GBasicConstraintInterface grow(Integer xValue,
                                             Integer yValue)
```
    Create grow basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the growx.
    
    yValue - of the growy.
    
    Returns:
    
    the basic constraint representing the grow.
  - spanx
```
public static GBasicConstraintInterface spanx(int xValue)
```
    Create span basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the spanx.
    
    Returns:
    
    the basic constraint representing the span.
  - spany
```
public static GBasicConstraintInterface spany(int yValue)
```
    Create span basic constraint to be passed to the constructor.
    
    Parameters:
    
    yValue - of the spany.
    
    Returns:
    
    the basic constraint representing the span.
  - span
```
public static GBasicConstraintInterface span(int xValue,
                                             int yValue)
```
    Create span basic constraint to be passed to the constructor.
    
    Parameters:
    
    xValue - of the spanx.
    
    yValue - of the spany.
    
    Returns:
    
    the basic constraint representing the span.
  - split
```
public static GBasicConstraintInterface split()
```
    Create split basic constraint to be passed to the constructor, the split associated to the constraint will be set to null.
    
    Returns:
    
    the basic constraint representing the split.
  - split
```
public static GBasicConstraintInterface split(boolean doSplit)
```
    Create split basic constraint to be passed to the constructor, the split associated to the constraint will be set to null.
    
    Parameters:
    
    doSplit - true if there is a split to be applied, false otherwise.
    
    Returns:
    
    the basic constraint representing the skip.
  - split
```
public static GBasicConstraintInterface split(Integer value)
```
    Create split basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - the number of cell in which to split the current cell
    
    Returns:
    
    the basic constraint representing the split.
  - split
```
public static GBasicConstraintInterface split(boolean doSplit,
                                              Integer value)
```
    Create split basic constraint to be passed to the constructor.
    
    Parameters:
    
    doSplit - true if there is a split to be applied, false otherwise.
    
    value - the number of cell in which to split the current cell
    
    Returns:
    
    the basic constraint representing the split.
  - width
```
public static GBasicConstraintInterface width(int value)
```
    Create width basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the width.
    
    Returns:
    
    the basic constraint representing the width.
  - wmin
```
public static GBasicConstraintInterface wmin(int value)
```
    Create wmin basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the wmin.
    
    Returns:
    
    the basic constraint representing the wmin.
  - wmax
```
public static GBasicConstraintInterface wmax(int value)
```
    Create wmax basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the wmax.
    
    Returns:
    
    the basic constraint representing the wmax.
  - height
```
public static GBasicConstraintInterface height(int value)
```
    Create height basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the height.
    
    Returns:
    
    the basic constraint representing the height.
  - hmin
```
public static GBasicConstraintInterface hmin(int value)
```
    Create hmin basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the hmin.
    
    Returns:
    
    the basic constraint representing the hmin.
  - hmax
```
public static GBasicConstraintInterface hmax(int value)
```
    Create hmax basic constraint to be passed to the constructor.
    
    Parameters:
    
    value - of the hmax.
    
    Returns:
    
    the basic constraint representing the hmax.

Class GConstraint

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GConstraint

Method Detail

avoidHorizontalDisplacement

toString

setNewline

setPush

setAlign

setGrow

setSpan

setSkip

setSplit

getDoNewline

getNewlineGap

setWrap

setWrap

setDock

setFlow

getDoWrap

getWrapGap

getDock

getFlow

getCellColumn

getCellRow

getCellSpanx

getCellSpany

setGap

setCell

setWidth

setWMin

setWMax

setHeight

setHMin

setHMax

getGap

getWidth

getWMin

getWMax

getHeight

getHMin

getHMax

getPushX

getPushY

getalignX

getalignY

getGrowX

getGrowY

getSpanX

getSpanY

getSkip

getSplit

wrap

wrap

cell

cell

cell

newline

newline

newline

wrap

skip

skip

skip

skip

dock

flow

gap

gapleft

gapright

gaptop

gapbottom

pushx

pushx

pushy

pushy