org.tbee.javafx.scene.layout

Class MigPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

org.tbee.javafx.scene.layout.MigPane

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

Direct Known Subclasses:

MigPane

public class MigPane
extends javafx.scene.layout.Pane

Manages nodes with MigLayout added via add(node, CC)

Author:

Tom Eugelink

Property Summary

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

Modifier and Type	Field and Description
static String	COLUMNCONSTRAINTS_PROPERTY_ID
protected static String	FXML_CC_KEY
static String	LAYOUTCONSTRAINTS_PROPERTY_ID
static String	ROWCONSTRAINTS_PROPERTY_ID

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
MigPane()
MigPane(LC layoutConstraints) use the class layout constraints
MigPane(LC layoutConstraints, AC colConstraints) use the class layout constraints
MigPane(LC layoutConstraints, AC colConstraints, AC rowConstraints) use the class layout constraints
MigPane(String layoutConstraints) usee the string layout constraints
MigPane(String layoutConstraints, String colConstraints) usee the string layout constraints
MigPane(String layoutConstraints, String colConstraints, String rowConstraints) usee the string layout constraints

Method Summary

Modifier and Type	Method and Description
MigPane	add(int index, javafx.scene.Node node)
MigPane	add(int index, javafx.scene.Node node, CC cc)
MigPane	add(int index, javafx.scene.Node node, String sCc)
MigPane	add(javafx.scene.Node node)
MigPane	add(javafx.scene.Node node, CC cc)
MigPane	add(javafx.scene.Node node, String sCc)
void	addLayoutCallback(LayoutCallback callback) Adds the callback function that will be called at different stages of the layout cylce.
void	animateAdded(javafx.scene.Node node)
boolean	animateBoundsChange(javafx.scene.Node node, int x, int y, int width, int height)
void	animateRemoved(javafx.scene.Node node)
void	clearDebug()
protected double	computeHeight(double refWidth, int type)
protected double	computeMaxHeight(double width)
protected double	computeMaxWidth(double height)
protected double	computeMinHeight(double width)
protected double	computeMinWidth(double height)
protected double	computePrefHeight(double width)
protected double	computePrefWidth(double height)
protected double	computeWidth(double refHeight, int type)
AC	getColumnConstraints() ColumnConstraints:
CC	getComponentConstraints(javafx.scene.Node node) Returns the constraints for the node
javafx.geometry.Orientation	getContentBias()
javafx.scene.paint.Color	getDebugCellColor() debugCellColor
javafx.scene.paint.Color	getDebugContainerOutlineColor() debugContainerOutlineColor
javafx.scene.paint.Color	getDebugExternalColor() debugExternalColor
javafx.scene.paint.Color	getDebugOutlineColor() debugOutlineColor
LC	getLayoutConstraints() LayoutConstraints:
AC	getRowConstraints() RowConstraints:
void	invalidateGrid() Removes the grid so it is recreated as needed next time.
protected void	layoutChildren() This is where the actual layout happens
javafx.scene.Node	remove(int ix)
boolean	remove(javafx.scene.Node node)
void	removeLayoutCallback(LayoutCallback callback) Removes the callback if it exists.
void	requestLayout()
void	setColumnConstraints(AC value)
void	setDebugCellColor(javafx.scene.paint.Color value)
void	setDebugContainerOutlineColor(javafx.scene.paint.Color value)
void	setDebugExternalColor(javafx.scene.paint.Color value)
void	setDebugOutlineColor(javafx.scene.paint.Color value)
void	setLayoutConstraints(LC lc)
void	setRowConstraints(AC value)
MigPane	withColumnConstraints(AC value)
MigPane	withLayoutConstraints(LC value)
MigPane	withRowConstraints(AC value)

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getClassCssMetaData, getCssMetaData, 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, 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, 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_geomChanged, impl_getAccessible, 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

Field Detail

FXML_CC_KEY

protected static final String FXML_CC_KEY

See Also:

Constant Field Values

LAYOUTCONSTRAINTS_PROPERTY_ID

public static final String LAYOUTCONSTRAINTS_PROPERTY_ID

See Also:

Constant Field Values

COLUMNCONSTRAINTS_PROPERTY_ID

public static final String COLUMNCONSTRAINTS_PROPERTY_ID

See Also:

Constant Field Values

ROWCONSTRAINTS_PROPERTY_ID

public static final String ROWCONSTRAINTS_PROPERTY_ID

See Also:

Constant Field Values

Constructor Detail

MigPane

public MigPane()

MigPane

public MigPane(LC layoutConstraints)

use the class layout constraints

MigPane

public MigPane(LC layoutConstraints,
               AC colConstraints)

use the class layout constraints

MigPane

public MigPane(LC layoutConstraints,
               AC colConstraints,
               AC rowConstraints)

use the class layout constraints

MigPane

public MigPane(String layoutConstraints)

usee the string layout constraints

MigPane

public MigPane(String layoutConstraints,
               String colConstraints)

usee the string layout constraints

MigPane

public MigPane(String layoutConstraints,
               String colConstraints,
               String rowConstraints)

usee the string layout constraints

Method Detail

computeMinWidth

protected double computeMinWidth(double height)

Overrides:

computeMinWidth in class javafx.scene.layout.Region

computeMinHeight

protected double computeMinHeight(double width)

Overrides:

computeMinHeight in class javafx.scene.layout.Region

computePrefWidth

protected double computePrefWidth(double height)

Overrides:

computePrefWidth in class javafx.scene.layout.Region

computePrefHeight

protected double computePrefHeight(double width)

Overrides:

computePrefHeight in class javafx.scene.layout.Region

computeMaxWidth

protected double computeMaxWidth(double height)

Overrides:

computeMaxWidth in class javafx.scene.layout.Region

computeMaxHeight

protected double computeMaxHeight(double width)

Overrides:

computeMaxHeight in class javafx.scene.layout.Region

computeWidth

protected double computeWidth(double refHeight,
                              int type)

computeHeight

protected double computeHeight(double refWidth,
                               int type)

getContentBias

public javafx.geometry.Orientation getContentBias()

Overrides:

getContentBias in class javafx.scene.Node

getLayoutConstraints

public LC getLayoutConstraints()

LayoutConstraints:

setLayoutConstraints

public void setLayoutConstraints(LC lc)

withLayoutConstraints

public MigPane withLayoutConstraints(LC value)

getColumnConstraints

public AC getColumnConstraints()

ColumnConstraints:

setColumnConstraints

public void setColumnConstraints(AC value)

withColumnConstraints

public MigPane withColumnConstraints(AC value)

getRowConstraints

public AC getRowConstraints()

RowConstraints:

setRowConstraints

public void setRowConstraints(AC value)

withRowConstraints

public MigPane withRowConstraints(AC value)

getComponentConstraints

public CC getComponentConstraints(javafx.scene.Node node)

Returns the constraints for the node

Returns:

May be null which means all default constraints.

animateAdded

public void animateAdded(javafx.scene.Node node)

animateRemoved

public void animateRemoved(javafx.scene.Node node)

animateBoundsChange

public boolean animateBoundsChange(javafx.scene.Node node,
                                   int x,
                                   int y,
                                   int width,
                                   int height)

addLayoutCallback

public void addLayoutCallback(LayoutCallback callback)

Adds the callback function that will be called at different stages of the layout cylce.

Parameters:

callback - The callback. Not null.

removeLayoutCallback

public void removeLayoutCallback(LayoutCallback callback)

Removes the callback if it exists.

Parameters:

callback - The callback. May be null.

add

public MigPane add(javafx.scene.Node node,
                   CC cc)

add

public MigPane add(javafx.scene.Node node)

add

public MigPane add(javafx.scene.Node node,
                   String sCc)

add

public MigPane add(int index,
                   javafx.scene.Node node)

add

public MigPane add(int index,
                   javafx.scene.Node node,
                   String sCc)

add

public MigPane add(int index,
                   javafx.scene.Node node,
                   CC cc)

remove

public boolean remove(javafx.scene.Node node)

remove

public javafx.scene.Node remove(int ix)

layoutChildren

protected void layoutChildren()

This is where the actual layout happens

Overrides:

layoutChildren in class javafx.scene.Parent

requestLayout

public void requestLayout()

Overrides:

requestLayout in class javafx.scene.Parent

invalidateGrid

public void invalidateGrid()

Removes the grid so it is recreated as needed next time. Should only be needed when the grid structure, or the interpretation of it, has changed. Should normally don't have to be called by client code since this should be fully handled by MigPane.

clearDebug

public void clearDebug()

getDebugCellColor

public javafx.scene.paint.Color getDebugCellColor()

debugCellColor

setDebugCellColor

public void setDebugCellColor(javafx.scene.paint.Color value)

getDebugExternalColor

public javafx.scene.paint.Color getDebugExternalColor()

debugExternalColor

setDebugExternalColor

public void setDebugExternalColor(javafx.scene.paint.Color value)

getDebugOutlineColor

public javafx.scene.paint.Color getDebugOutlineColor()

debugOutlineColor

setDebugOutlineColor

public void setDebugOutlineColor(javafx.scene.paint.Color value)

getDebugContainerOutlineColor

public javafx.scene.paint.Color getDebugContainerOutlineColor()

debugContainerOutlineColor

setDebugContainerOutlineColor

public void setDebugContainerOutlineColor(javafx.scene.paint.Color value)