org.eclipse.fx.ui.panes

Class GridLayoutPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

org.eclipse.fx.ui.panes.AbstractLayoutPane<GridData>

org.eclipse.fx.ui.panes.GridLayoutPane

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class GridLayoutPane
extends AbstractLayoutPane<GridData>

Layout pane known from SWT

Property Summary

Type	Property and Description
@NonNull javafx.beans.property.IntegerProperty	horizontalSpacing
@NonNull javafx.beans.property.BooleanProperty	makeColumnsEqualWidth
@NonNull javafx.beans.property.IntegerProperty	marginBottom
@NonNull javafx.beans.property.IntegerProperty	marginHeight
@NonNull javafx.beans.property.IntegerProperty	marginLeft
@NonNull javafx.beans.property.IntegerProperty	marginRight
@NonNull javafx.beans.property.IntegerProperty	marginTop
@NonNull javafx.beans.property.IntegerProperty	marginWidth
@NonNull javafx.beans.property.IntegerProperty	numColumns
@NonNull javafx.beans.property.IntegerProperty	verticalSpacing

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields inherited from class org.eclipse.fx.ui.panes.AbstractLayoutPane

FX_DEFAULT

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
GridLayoutPane()

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.fx.ui.panes.AbstractLayoutPane.Size	computeSize(double width, double height, boolean flushCache) Compute the size
static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()
static @Nullable GridData	getConstraint(@NonNull javafx.scene.Node n) Get the layout constraint for the node
java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getCssMetaData()
int	getHorizontalSpacing()
int	getMarginBottom()
int	getMarginHeight()
int	getMarginLeft()
int	getMarginRight()
int	getMarginTop()
int	getMarginWidth()
int	getNumColumns()
int	getVerticalSpacing()
@NonNull javafx.beans.property.IntegerProperty	horizontalSpacingProperty()
boolean	isMakeColumnsEqualWidth()
protected void	layoutChildren()
@NonNull javafx.beans.property.BooleanProperty	makeColumnsEqualWidthProperty()
@NonNull javafx.beans.property.IntegerProperty	marginBottomProperty()
@NonNull javafx.beans.property.IntegerProperty	marginHeightProperty()
@NonNull javafx.beans.property.IntegerProperty	marginLeftProperty()
@NonNull javafx.beans.property.IntegerProperty	marginRightProperty()
@NonNull javafx.beans.property.IntegerProperty	marginTopProperty()
@NonNull javafx.beans.property.IntegerProperty	marginWidthProperty()
@NonNull javafx.beans.property.IntegerProperty	numColumnsProperty()
static void	setConstraint(@NonNull javafx.scene.Node n, @NonNull GridData griddata) Associate a layout constraint with the node
void	setHorizontalSpacing(int value) Horizontal spacing between columns
void	setMakeColumnsEqualWidth(boolean makeColumnsEqualWidth) If true all columns have the same width
void	setMarginBottom(int value) The margin on the bottom
void	setMarginHeight(int value) Margin on the top and bottom
void	setMarginLeft(int value) The margin on the left
void	setMarginRight(int value) The margin on the right
void	setMarginTop(int value) The margin on the top
void	setMarginWidth(int value) Margin on the left and right
void	setNumColumns(int numColumns) The number of columns
void	setVerticalSpacing(int value) The vertical spacing between rows
@NonNull javafx.beans.property.IntegerProperty	verticalSpacingProperty()

Methods inherited from class org.eclipse.fx.ui.panes.AbstractLayoutPane

computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getConstraint, setConstraint

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

numColumns

public final @NonNull javafx.beans.property.IntegerProperty numColumnsProperty

See Also:

getNumColumns(), setNumColumns(int)

makeColumnsEqualWidth

public final @NonNull javafx.beans.property.BooleanProperty makeColumnsEqualWidthProperty

See Also:

isMakeColumnsEqualWidth(), setMakeColumnsEqualWidth(boolean)

horizontalSpacing

public final @NonNull javafx.beans.property.IntegerProperty horizontalSpacingProperty

See Also:

getHorizontalSpacing(), setHorizontalSpacing(int)

marginWidth

public final @NonNull javafx.beans.property.IntegerProperty marginWidthProperty

See Also:

getMarginWidth(), setMarginWidth(int)

marginHeight

public final @NonNull javafx.beans.property.IntegerProperty marginHeightProperty

See Also:

getMarginHeight(), setMarginHeight(int)

marginLeft

public final @NonNull javafx.beans.property.IntegerProperty marginLeftProperty

See Also:

getMarginLeft(), setMarginLeft(int)

marginTop

public final @NonNull javafx.beans.property.IntegerProperty marginTopProperty

See Also:

getMarginTop(), setMarginTop(int)

marginRight

public final @NonNull javafx.beans.property.IntegerProperty marginRightProperty

See Also:

getMarginRight(), setMarginRight(int)

marginBottom

public final @NonNull javafx.beans.property.IntegerProperty marginBottomProperty

See Also:

getMarginBottom(), setMarginBottom(int)

verticalSpacing

public final @NonNull javafx.beans.property.IntegerProperty verticalSpacingProperty

See Also:

getVerticalSpacing(), setVerticalSpacing(int)

Constructor Detail

GridLayoutPane

public GridLayoutPane()

Method Detail

getClassCssMetaData

public static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()

getCssMetaData

public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getCssMetaData()

Specified by:

getCssMetaData in interface javafx.css.Styleable

Overrides:

getCssMetaData in class javafx.scene.layout.Region

setConstraint

public static final void setConstraint(@NonNull javafx.scene.Node n,
                                       @NonNull GridData griddata)

Associate a layout constraint with the node

Parameters:

n - the node

griddata - the constraint

getConstraint

public static final @Nullable GridData getConstraint(@NonNull javafx.scene.Node n)

Get the layout constraint for the node

Parameters:

n - the node

Returns:

the layout constraint or null

computeSize

protected org.eclipse.fx.ui.panes.AbstractLayoutPane.Size computeSize(double width,
                                                                      double height,
                                                                      boolean flushCache)

Description copied from class: AbstractLayoutPane

Compute the size

Specified by:

computeSize in class AbstractLayoutPane<GridData>

Parameters:

width - the available width

height - the available height

flushCache - flush cached informations

Returns:

the size

layoutChildren

protected void layoutChildren()

Overrides:

layoutChildren in class javafx.scene.Parent

setNumColumns

public final void setNumColumns(int numColumns)

The number of columns

Parameters:

numColumns - the columns

getNumColumns

public final int getNumColumns()

Returns:

The number of columns

numColumnsProperty

public final @NonNull javafx.beans.property.IntegerProperty numColumnsProperty()

See Also:

getNumColumns(), setNumColumns(int)

setMakeColumnsEqualWidth

public final void setMakeColumnsEqualWidth(boolean makeColumnsEqualWidth)

If true all columns have the same width

Parameters:

makeColumnsEqualWidth - make all columns equal

isMakeColumnsEqualWidth

public final boolean isMakeColumnsEqualWidth()

Returns:

If true all columns have the same width

makeColumnsEqualWidthProperty

public final @NonNull javafx.beans.property.BooleanProperty makeColumnsEqualWidthProperty()

See Also:

isMakeColumnsEqualWidth(), setMakeColumnsEqualWidth(boolean)

setHorizontalSpacing

public final void setHorizontalSpacing(int value)

Horizontal spacing between columns

Parameters:

value - the spacing

getHorizontalSpacing

public final int getHorizontalSpacing()

Returns:

Horizontal spacing between columns

horizontalSpacingProperty

public final @NonNull javafx.beans.property.IntegerProperty horizontalSpacingProperty()

See Also:

getHorizontalSpacing(), setHorizontalSpacing(int)

setMarginWidth

public final void setMarginWidth(int value)

Margin on the left and right

Parameters:

value - the margin

getMarginWidth

public final int getMarginWidth()

Returns:

Margin on the left and right

marginWidthProperty

public final @NonNull javafx.beans.property.IntegerProperty marginWidthProperty()

See Also:

getMarginWidth(), setMarginWidth(int)

setMarginHeight

public final void setMarginHeight(int value)

Margin on the top and bottom

Parameters:

value - the margin

getMarginHeight

public final int getMarginHeight()

Returns:

Margin on the top and bottom

marginHeightProperty

public final @NonNull javafx.beans.property.IntegerProperty marginHeightProperty()

See Also:

getMarginHeight(), setMarginHeight(int)

setMarginLeft

public final void setMarginLeft(int value)

The margin on the left

Parameters:

value - the left margin

getMarginLeft

public final int getMarginLeft()

Returns:

The margin on the left

marginLeftProperty

public final @NonNull javafx.beans.property.IntegerProperty marginLeftProperty()

See Also:

getMarginLeft(), setMarginLeft(int)

setMarginTop

public final void setMarginTop(int value)

The margin on the top

Parameters:

value - the new margin

getMarginTop

public final int getMarginTop()

Returns:

The margin on the top

marginTopProperty

public final @NonNull javafx.beans.property.IntegerProperty marginTopProperty()

See Also:

getMarginTop(), setMarginTop(int)

setMarginRight

public final void setMarginRight(int value)

The margin on the right

Parameters:

value - the new margin

getMarginRight

public final int getMarginRight()

Returns:

The margin on the right

marginRightProperty

public final @NonNull javafx.beans.property.IntegerProperty marginRightProperty()

See Also:

getMarginRight(), setMarginRight(int)

setMarginBottom

public final void setMarginBottom(int value)

The margin on the bottom

Parameters:

value - the new margin

getMarginBottom

public final int getMarginBottom()

Returns:

The margin on the bottom

marginBottomProperty

public final @NonNull javafx.beans.property.IntegerProperty marginBottomProperty()

See Also:

getMarginBottom(), setMarginBottom(int)

setVerticalSpacing

public final void setVerticalSpacing(int value)

The vertical spacing between rows

Parameters:

value - the spacing

getVerticalSpacing

public final int getVerticalSpacing()

Returns:

The vertical spacing between rows

verticalSpacingProperty

public final @NonNull javafx.beans.property.IntegerProperty verticalSpacingProperty()

See Also:

getVerticalSpacing(), setVerticalSpacing(int)