GridData

java.lang.Object
- org.eclipse.fx.ui.panes.GridData

public class GridData
extends java.lang.Object

Constraints for grid elements

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`exclude`
`javafx.beans.property.BooleanProperty`	`grabExcessHorizontalSpace`
`javafx.beans.property.BooleanProperty`	`grabExcessVerticalSpace`
`javafx.beans.property.IntegerProperty`	`heightHint`
`javafx.beans.property.ObjectProperty<GridData.Alignment>`	`horizontalAlignment`
`javafx.beans.property.IntegerProperty`	`horizontalIndent`
`javafx.beans.property.IntegerProperty`	`horizontalSpan`
`javafx.beans.property.IntegerProperty`	`minimumHeight`
`javafx.beans.property.IntegerProperty`	`minimumWidth`
`javafx.beans.property.ObjectProperty<GridData.Alignment>`	`verticalAlignment`
`javafx.beans.property.IntegerProperty`	`verticalIndent`
`javafx.beans.property.IntegerProperty`	`verticalSpan`
`javafx.beans.property.IntegerProperty`	`widthHint`

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GridData.Alignment
The alignment of the item in the cell

Nested Classes
Modifier and Type	Class and Description
`static class`	`GridData.Alignment` The alignment of the item in the cell

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FILL_BOTH` Style bit for `new GridData(int)` to resize the control to fill the cell horizontally and vertically and to fit the remaining horizontal and vertical space.
`static int`	`FILL_HORIZONTAL` Style bit for `new GridData(int)` to resize the control to fill the cell horizontally and to fit the remaining horizontal space.
`static int`	`FILL_VERTICAL` Style bit for `new GridData(int)` to resize the control to fill the cell vertically and to fit the remaining vertical space.
`static int`	`GRAB_HORIZONTAL` Style bit for `new GridData(int)` to resize the control to fit the remaining horizontal space.
`static int`	`GRAB_VERTICAL` Style bit for `new GridData(int)` to resize the control to fit the remaining vertical space.
`static int`	`HORIZONTAL_ALIGN_BEGINNING` Style bit for `new GridData(int)` to position the control at the left of the cell.
`static int`	`HORIZONTAL_ALIGN_CENTER` Style bit for `new GridData(int)` to position the control in the horizontal center of the cell.
`static int`	`HORIZONTAL_ALIGN_END` Style bit for `new GridData(int)` to position the control at the right of the cell.
`static int`	`HORIZONTAL_ALIGN_FILL` Style bit for `new GridData(int)` to resize the control to fill the cell horizontally.
`static int`	`VERTICAL_ALIGN_BEGINNING` Style bit for `new GridData(int)`.
`static int`	`VERTICAL_ALIGN_CENTER` Style bit for `new GridData(int)` to position the control in the vertical center of the cell.
`static int`	`VERTICAL_ALIGN_END` Style bit for `new GridData(int)` to position the control at the bottom of the cell.
`static int`	`VERTICAL_ALIGN_FILL` Style bit for `new GridData(int)` to resize the control to fill the cell vertically.

Constructor Summary

Constructors
Constructor and Description
`GridData()` Constructs a new instance of GridData using default values.
`GridData(GridData.Alignment horizontalAlignment, GridData.Alignment verticalAlignment, boolean grabExcessHorizontalSpace, boolean grabExcessVerticalSpace)` Constructs a new instance of GridData according to the parameters.
`GridData(GridData.Alignment horizontalAlignment, GridData.Alignment verticalAlignment, boolean grabExcessHorizontalSpace, boolean grabExcessVerticalSpace, int horizontalSpan, int verticalSpan)` Constructs a new instance of GridData according to the parameters.
`GridData(int style)` Constructs a new instance based on the GridData style.
`GridData(int width, int height)` Constructs a new instance of GridData according to the parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.beans.property.BooleanProperty`	`excludeProperty()`
`int`	`getHeightHint()`
`GridData.Alignment`	`getHorizontalAlignment()`
`int`	`getHorizontalIndent()`
`int`	`getHorizontalSpan()`
`int`	`getMinimumHeight()`
`int`	`getMinimumWidth()`
`GridData.Alignment`	`getVerticalAlignment()`
`int`	`getVerticalIndent()`
`int`	`getVerticalSpan()`
`int`	`getWidthHint()`
`javafx.beans.property.BooleanProperty`	`grabExcessHorizontalSpaceProperty()`
`javafx.beans.property.BooleanProperty`	`grabExcessVerticalSpaceProperty()`
`javafx.beans.property.IntegerProperty`	`heightHintProperty()`
`javafx.beans.property.ObjectProperty<GridData.Alignment>`	`horizontalAlignmentProperty()`
`javafx.beans.property.IntegerProperty`	`horizontalIndentProperty()`
`javafx.beans.property.IntegerProperty`	`horizontalSpanProperty()`
`boolean`	`isExclude()`
`boolean`	`isGrabExcessHorizontalSpace()`
`boolean`	`isGrabExcessVerticalSpace()`
`javafx.beans.property.IntegerProperty`	`minimumHeightProperty()`
`javafx.beans.property.IntegerProperty`	`minimumWidthProperty()`
`void`	`setExclude(boolean value)` Exclude the node when layouting
`void`	`setGrabExcessHorizontalSpace(boolean value)` Grab all available horizontal space
`void`	`setGrabExcessVerticalSpace(boolean value)` Grab vertical space if available
`void`	`setHeightHint(int value)` Set a height hint
`void`	`setHorizontalAlignment(GridData.Alignment value)` Set a horizontal alignment
`void`	`setHorizontalIndent(int value)` Set the horizontal indent
`void`	`setHorizontalSpan(int value)` Set a horizontal span
`void`	`setMinimumHeight(int value)` Set a minimum height
`void`	`setMinimumWidth(int value)` Set a minimum width
`void`	`setVerticalAlignment(GridData.Alignment value)` Set a vertical alignment
`void`	`setVerticalIndent(int value)` Set a vertical indent
`void`	`setVerticalSpan(int value)` Set the vertical span
`void`	`setWidthHint(int value)` Set the width hint
`java.lang.String`	`toString()` Returns a string containing a concise, human-readable description of the receiver.
`javafx.beans.property.ObjectProperty<GridData.Alignment>`	`verticalAlignmentProperty()`
`javafx.beans.property.IntegerProperty`	`verticalIndentProperty()`
`javafx.beans.property.IntegerProperty`	`verticalSpanProperty()`
`javafx.beans.property.IntegerProperty`	`widthHintProperty()`

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

- Property Detail
  - exclude
```
public javafx.beans.property.BooleanProperty excludeProperty
```
    See Also:
    
    isExclude(), setExclude(boolean)
  - grabExcessHorizontalSpace
```
public javafx.beans.property.BooleanProperty grabExcessHorizontalSpaceProperty
```
    See Also:
    
    isGrabExcessHorizontalSpace(), setGrabExcessHorizontalSpace(boolean)
  - grabExcessVerticalSpace
```
public javafx.beans.property.BooleanProperty grabExcessVerticalSpaceProperty
```
    See Also:
    
    isGrabExcessVerticalSpace(), setGrabExcessVerticalSpace(boolean)
  - heightHint
```
public javafx.beans.property.IntegerProperty heightHintProperty
```
    See Also:
    
    getHeightHint(), setHeightHint(int)
  - horizontalAlignment
```
public javafx.beans.property.ObjectProperty<GridData.Alignment> horizontalAlignmentProperty
```
    See Also:
    
    getHorizontalAlignment(), setHorizontalAlignment(Alignment)
  - horizontalIndent
```
public javafx.beans.property.IntegerProperty horizontalIndentProperty
```
    See Also:
    
    getHorizontalIndent(), setHorizontalIndent(int)
  - horizontalSpan
```
public javafx.beans.property.IntegerProperty horizontalSpanProperty
```
    See Also:
    
    getHorizontalSpan(), setHorizontalSpan(int)
  - minimumHeight
```
public javafx.beans.property.IntegerProperty minimumHeightProperty
```
    See Also:
    
    getMinimumHeight(), setMinimumHeight(int)
  - minimumWidth
```
public javafx.beans.property.IntegerProperty minimumWidthProperty
```
    See Also:
    
    getMinimumWidth(), setMinimumWidth(int)
  - verticalAlignment
```
public javafx.beans.property.ObjectProperty<GridData.Alignment> verticalAlignmentProperty
```
    See Also:
    
    getVerticalAlignment(), setVerticalAlignment(Alignment)
  - verticalIndent
```
public javafx.beans.property.IntegerProperty verticalIndentProperty
```
    See Also:
    
    getVerticalIndent(), setVerticalIndent(int)
  - verticalSpan
```
public javafx.beans.property.IntegerProperty verticalSpanProperty
```
    See Also:
    
    getVerticalSpan(), setVerticalSpan(int)
  - widthHint
```
public javafx.beans.property.IntegerProperty widthHintProperty
```
    See Also:
    
    getWidthHint(), setWidthHint(int)
- Field Detail
  - VERTICAL_ALIGN_BEGINNING
```
public static final int VERTICAL_ALIGN_BEGINNING
```
    Style bit for new GridData(int). Position the control at the top of the cell. Not recommended. Use new GridData(int, SWT.BEGINNING, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - VERTICAL_ALIGN_CENTER
```
public static final int VERTICAL_ALIGN_CENTER
```
    Style bit for new GridData(int) to position the control in the vertical center of the cell. Not recommended. Use new GridData(int, SWT.CENTER, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - VERTICAL_ALIGN_END
```
public static final int VERTICAL_ALIGN_END
```
    Style bit for new GridData(int) to position the control at the bottom of the cell. Not recommended. Use new GridData(int, SWT.END, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - VERTICAL_ALIGN_FILL
```
public static final int VERTICAL_ALIGN_FILL
```
    Style bit for new GridData(int) to resize the control to fill the cell vertically. Not recommended. Use new GridData(int, SWT.FILL, boolean, boolean) instead
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL_ALIGN_BEGINNING
```
public static final int HORIZONTAL_ALIGN_BEGINNING
```
    Style bit for new GridData(int) to position the control at the left of the cell. Not recommended. Use new GridData(SWT.BEGINNING, int, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL_ALIGN_CENTER
```
public static final int HORIZONTAL_ALIGN_CENTER
```
    Style bit for new GridData(int) to position the control in the horizontal center of the cell. Not recommended. Use new GridData(SWT.CENTER, int, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL_ALIGN_END
```
public static final int HORIZONTAL_ALIGN_END
```
    Style bit for new GridData(int) to position the control at the right of the cell. Not recommended. Use new GridData(SWT.END, int, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL_ALIGN_FILL
```
public static final int HORIZONTAL_ALIGN_FILL
```
    Style bit for new GridData(int) to resize the control to fill the cell horizontally. Not recommended. Use new GridData(SWT.FILL, int, boolean, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - GRAB_HORIZONTAL
```
public static final int GRAB_HORIZONTAL
```
    Style bit for new GridData(int) to resize the control to fit the remaining horizontal space. Not recommended. Use new GridData(int, int, true, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - GRAB_VERTICAL
```
public static final int GRAB_VERTICAL
```
    Style bit for new GridData(int) to resize the control to fit the remaining vertical space. Not recommended. Use new GridData(int, int, boolean, true) instead.
    
    See Also:
    
    Constant Field Values
  - FILL_VERTICAL
```
public static final int FILL_VERTICAL
```
    Style bit for new GridData(int) to resize the control to fill the cell vertically and to fit the remaining vertical space. FILL_VERTICAL = VERTICAL_ALIGN_FILL | GRAB_VERTICAL Not recommended. Use new GridData(int, SWT.FILL, boolean, true) instead.
    
    See Also:
    
    Constant Field Values
  - FILL_HORIZONTAL
```
public static final int FILL_HORIZONTAL
```
    Style bit for new GridData(int) to resize the control to fill the cell horizontally and to fit the remaining horizontal space. FILL_HORIZONTAL = HORIZONTAL_ALIGN_FILL | GRAB_HORIZONTAL Not recommended. Use new GridData(SWT.FILL, int, true, boolean) instead.
    
    See Also:
    
    Constant Field Values
  - FILL_BOTH
```
public static final int FILL_BOTH
```
    Style bit for new GridData(int) to resize the control to fill the cell horizontally and vertically and to fit the remaining horizontal and vertical space. FILL_BOTH = FILL_VERTICAL | FILL_HORIZONTAL Not recommended. Use new GridData(SWT.FILL, SWT.FILL, true, true) instead.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GridData
```
public GridData()
```
    Constructs a new instance of GridData using default values.
  - GridData
```
public GridData(int style)
```
    Constructs a new instance based on the GridData style. This constructor is not recommended.
    
    Parameters:
    
    style - the GridData style
  - GridData
```
public GridData(GridData.Alignment horizontalAlignment,
                GridData.Alignment verticalAlignment,
                boolean grabExcessHorizontalSpace,
                boolean grabExcessVerticalSpace)
```
    Constructs a new instance of GridData according to the parameters.
    
    Parameters:
    
    horizontalAlignment - how control will be positioned horizontally within a cell, one of: SWT.BEGINNING (or SWT.LEFT), SWT.CENTER, SWT.END (or SWT.RIGHT), or SWT.FILL
    
    verticalAlignment - how control will be positioned vertically within a cell, one of: SWT.BEGINNING (or SWT.TOP), SWT.CENTER, SWT.END (or SWT.BOTTOM), or SWT.FILL
    
    grabExcessHorizontalSpace - whether cell will be made wide enough to fit the remaining horizontal space
    
    grabExcessVerticalSpace - whether cell will be made high enough to fit the remaining vertical space
    
    Since:
    
    3.0
  - GridData
```
public GridData(GridData.Alignment horizontalAlignment,
                GridData.Alignment verticalAlignment,
                boolean grabExcessHorizontalSpace,
                boolean grabExcessVerticalSpace,
                int horizontalSpan,
                int verticalSpan)
```
    Constructs a new instance of GridData according to the parameters.
    
    Parameters:
    
    horizontalAlignment - how control will be positioned horizontally within a cell, one of: SWT.BEGINNING (or SWT.LEFT), SWT.CENTER, SWT.END (or SWT.RIGHT), or SWT.FILL
    
    verticalAlignment - how control will be positioned vertically within a cell, one of: SWT.BEGINNING (or SWT.TOP), SWT.CENTER, SWT.END (or SWT.BOTTOM), or SWT.FILL
    
    grabExcessHorizontalSpace - whether cell will be made wide enough to fit the remaining horizontal space
    
    grabExcessVerticalSpace - whether cell will be made high enough to fit the remaining vertical space
    
    horizontalSpan - the number of column cells that the control will take up
    
    verticalSpan - the number of row cells that the control will take up
    
    Since:
    
    3.0
  - GridData
```
public GridData(int width,
                int height)
```
    Constructs a new instance of GridData according to the parameters. A value of SWT.DEFAULT indicates that no minimum width or no minimum height is specified.
    
    Parameters:
    
    width - a minimum width for the column
    
    height - a minimum height for the row
    
    Since:
    
    3.0
- Method Detail
  - setExclude
```
public void setExclude(boolean value)
```
    Exclude the node when layouting
    
    Parameters:
    
    value - the new value
  - isExclude
```
public boolean isExclude()
```
    Returns:
    
    Exclude the node when layouting
  - excludeProperty
```
public javafx.beans.property.BooleanProperty excludeProperty()
```
    See Also:
    
    isExclude(), setExclude(boolean)
  - setGrabExcessHorizontalSpace
```
public void setGrabExcessHorizontalSpace(boolean value)
```
    Grab all available horizontal space
    
    Parameters:
    
    value - true to grab space
  - isGrabExcessHorizontalSpace
```
public boolean isGrabExcessHorizontalSpace()
```
    Returns:
    
    true if space is grabbed
  - grabExcessHorizontalSpaceProperty
```
public javafx.beans.property.BooleanProperty grabExcessHorizontalSpaceProperty()
```
    See Also:
    
    isGrabExcessHorizontalSpace(), setGrabExcessHorizontalSpace(boolean)
  - setGrabExcessVerticalSpace
```
public void setGrabExcessVerticalSpace(boolean value)
```
    Grab vertical space if available
    
    Parameters:
    
    value - true to grab space
  - isGrabExcessVerticalSpace
```
public boolean isGrabExcessVerticalSpace()
```
    Returns:
    
    true is space is grabbed
  - grabExcessVerticalSpaceProperty
```
public javafx.beans.property.BooleanProperty grabExcessVerticalSpaceProperty()
```
    See Also:
    
    isGrabExcessVerticalSpace(), setGrabExcessVerticalSpace(boolean)
  - setHeightHint
```
public void setHeightHint(int value)
```
    Set a height hint
    
    Parameters:
    
    value - the hint of or AbstractLayoutPane.FX_DEFAULT to set back
  - getHeightHint
```
public int getHeightHint()
```
    Returns:
    
    the current height hint
  - heightHintProperty
```
public javafx.beans.property.IntegerProperty heightHintProperty()
```
    See Also:
    
    getHeightHint(), setHeightHint(int)
  - setHorizontalAlignment
```
public void setHorizontalAlignment(GridData.Alignment value)
```
    Set a horizontal alignment
    
    Parameters:
    
    value - the alignment
  - getHorizontalAlignment
```
public GridData.Alignment getHorizontalAlignment()
```
    Returns:
    
    the current horizontal alignment
  - horizontalAlignmentProperty
```
public javafx.beans.property.ObjectProperty<GridData.Alignment> horizontalAlignmentProperty()
```
    See Also:
    
    getHorizontalAlignment(), setHorizontalAlignment(Alignment)
  - setHorizontalIndent
```
public void setHorizontalIndent(int value)
```
    Set the horizontal indent
    
    Parameters:
    
    value - the indent
  - getHorizontalIndent
```
public int getHorizontalIndent()
```
    Returns:
    
    the horizontal indent
  - horizontalIndentProperty
```
public javafx.beans.property.IntegerProperty horizontalIndentProperty()
```
    See Also:
    
    getHorizontalIndent(), setHorizontalIndent(int)
  - setHorizontalSpan
```
public void setHorizontalSpan(int value)
```
    Set a horizontal span
    
    Parameters:
    
    value - the horizontal span
  - getHorizontalSpan
```
public int getHorizontalSpan()
```
    Returns:
    
    the current horizontal span
  - horizontalSpanProperty
```
public javafx.beans.property.IntegerProperty horizontalSpanProperty()
```
    See Also:
    
    getHorizontalSpan(), setHorizontalSpan(int)
  - setMinimumHeight
```
public void setMinimumHeight(int value)
```
    Set a minimum height
    
    Parameters:
    
    value - the value or AbstractLayoutPane.FX_DEFAULT for the default
  - getMinimumHeight
```
public int getMinimumHeight()
```
    Returns:
    
    the current minimum height
  - minimumHeightProperty
```
public javafx.beans.property.IntegerProperty minimumHeightProperty()
```
    See Also:
    
    getMinimumHeight(), setMinimumHeight(int)
  - setMinimumWidth
```
public void setMinimumWidth(int value)
```
    Set a minimum width
    
    Parameters:
    
    value - the new minimum width or AbstractLayoutPane.FX_DEFAULT for the default
  - getMinimumWidth
```
public int getMinimumWidth()
```
    Returns:
    
    the current minimum width
  - minimumWidthProperty
```
public javafx.beans.property.IntegerProperty minimumWidthProperty()
```
    See Also:
    
    getMinimumWidth(), setMinimumWidth(int)
  - setVerticalAlignment
```
public void setVerticalAlignment(GridData.Alignment value)
```
    Set a vertical alignment
    
    Parameters:
    
    value - the new alignment
  - getVerticalAlignment
```
public GridData.Alignment getVerticalAlignment()
```
    Returns:
    
    the current vertical alignment
  - verticalAlignmentProperty
```
public javafx.beans.property.ObjectProperty<GridData.Alignment> verticalAlignmentProperty()
```
    See Also:
    
    getVerticalAlignment(), setVerticalAlignment(Alignment)
  - setVerticalIndent
```
public void setVerticalIndent(int value)
```
    Set a vertical indent
    
    Parameters:
    
    value - the indent
  - getVerticalIndent
```
public int getVerticalIndent()
```
    Returns:
    
    The current vertical indent
  - verticalIndentProperty
```
public javafx.beans.property.IntegerProperty verticalIndentProperty()
```
    See Also:
    
    getVerticalIndent(), setVerticalIndent(int)
  - setVerticalSpan
```
public void setVerticalSpan(int value)
```
    Set the vertical span
    
    Parameters:
    
    value - the new vertical span
  - getVerticalSpan
```
public int getVerticalSpan()
```
    Returns:
    
    the current vertical span
  - verticalSpanProperty
```
public javafx.beans.property.IntegerProperty verticalSpanProperty()
```
    See Also:
    
    getVerticalSpan(), setVerticalSpan(int)
  - setWidthHint
```
public void setWidthHint(int value)
```
    Set the width hint
    
    Parameters:
    
    value - the width hint or AbstractLayoutPane.FX_DEFAULT
  - getWidthHint
```
public int getWidthHint()
```
    Returns:
    
    the current width hint
  - widthHintProperty
```
public javafx.beans.property.IntegerProperty widthHintProperty()
```
    See Also:
    
    getWidthHint(), setWidthHint(int)
  - toString
```
public java.lang.String toString()
```
    Returns a string containing a concise, human-readable description of the receiver.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the GridData object

Class GridData

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

exclude

grabExcessHorizontalSpace

grabExcessVerticalSpace

heightHint

horizontalAlignment

horizontalIndent

horizontalSpan

minimumHeight

minimumWidth

verticalAlignment

verticalIndent

verticalSpan

widthHint

Field Detail

VERTICAL_ALIGN_BEGINNING

VERTICAL_ALIGN_CENTER

VERTICAL_ALIGN_END

VERTICAL_ALIGN_FILL

HORIZONTAL_ALIGN_BEGINNING

HORIZONTAL_ALIGN_CENTER

HORIZONTAL_ALIGN_END

HORIZONTAL_ALIGN_FILL

GRAB_HORIZONTAL

GRAB_VERTICAL

FILL_VERTICAL

FILL_HORIZONTAL

FILL_BOTH

Constructor Detail

GridData

GridData

GridData

GridData

GridData

Method Detail

setExclude

isExclude

excludeProperty

setGrabExcessHorizontalSpace

isGrabExcessHorizontalSpace

grabExcessHorizontalSpaceProperty

setGrabExcessVerticalSpace

isGrabExcessVerticalSpace

grabExcessVerticalSpaceProperty

setHeightHint

getHeightHint

heightHintProperty

setHorizontalAlignment

getHorizontalAlignment

horizontalAlignmentProperty

setHorizontalIndent

getHorizontalIndent

horizontalIndentProperty

setHorizontalSpan

getHorizontalSpan

horizontalSpanProperty

setMinimumHeight

getMinimumHeight

minimumHeightProperty

setMinimumWidth

getMinimumWidth

minimumWidthProperty

setVerticalAlignment

getVerticalAlignment

verticalAlignmentProperty

setVerticalIndent

getVerticalIndent

verticalIndentProperty

setVerticalSpan

getVerticalSpan

verticalSpanProperty

setWidthHint

getWidthHint