Module org.tentackle.fx
Package org.tentackle.fx.container

Class FxGridPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.GridPane
org.tentackle.fx.container.FxGridPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, FxContainer, FxControl
public class FxGridPane extends javafx.scene.layout.GridPane implements FxContainer
Extended GridPane.
Author:
harald

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ReadOnlyBooleanProperty
    changeable
    Gets the changeable property.
    javafx.beans.property.BooleanProperty
    viewModified
    Gets the viewModified property.

    Properties inherited from class javafx.scene.layout.GridPane

    alignment, gridLinesVisible, hgap, vgap

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Field Summary

    Fields inherited from class javafx.scene.layout.GridPane

    REMAINING

    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
    Description
    FxGridPane()
    Creates a FxGridPane.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addModelToViewListener(ModelToViewListener listener)
    Adds a model-to-view listener.
    The listener will be invoked before the binding operation.
    If the control is a container, the listener will be invoked if any of the container's components get updated.
    void
    addViewToModelListener(ViewToModelListener listener)
    Adds a view-to-model listener.
    The listener will be invoked after the binding operation.
    If the control is a container, the listener will be invoked if any of the container's components update the model.
    javafx.beans.property.ReadOnlyBooleanProperty
    changeableProperty()
    Gets the changeable property.
    void
    clearErrors()
    Clears all error messages in all components.
    protected FxGridPaneDelegate
    createDelegate()
    Creates the delegate.
    javafx.collections.ObservableList<?>
    getComponents()
    Gets the component nodes maintained by this container.
    FxController
    getController()
    Gets the controller of this container.
    <C extends FxController>
    C
    getController(Class<C> clazz)
    Gets the controller along the parent hierarchy that is an instanceof the given class.
    FxGridPaneDelegate
    getDelegate()
    Gets the lazily created component delegate.
    String
    getHelpUrl()
    Gets the online-help URL.
    FxContainer
    getParentContainer()
    Gets the parent container.
    void
    invalidateSavedView()
    Invalidates the saved view.
    boolean
    isBindable()
    Determines whether this container is bindable.
    boolean
    isChangeable()
    Gets the value of the changeable property.
    boolean
    isContainerChangeableIgnored()
    Returns whether setContainerChangeable is ignored by this control.
    boolean
    isViewModified()
    Gets the value of the viewModified property.
    void
    removeModelToViewListener(ModelToViewListener listener)
    Removes a model-to-view listener.
    void
    removeViewToModelListener(ViewToModelListener listener)
    Removes a view-to-model listener.
    void
    saveView()
    Creates a copy of the value shown to the user.
    void
    setBindable(boolean bindable)
    Sets whether this control is bindable, i.e. should be checked within a binding hierarchy.
    void
    setChangeable(boolean changeable)
    Sets the value of the changeable property.
    void
    setContainerChangeable(boolean containerChangeable)
    Invoked when setChangeable() is invoked on the container of this component.
    void
    setContainerChangeableIgnored(boolean containerChangeableIgnored)
    Sets whether to ignore setContainerChangeable.
    void
    setController(FxController controller)
    Sets the controller of this container.
    void
    setHelpUrl(String helpUrl)
    Sets the online-help URL.
    If a help url is set, a browser will be launched to show that url if there is no help url for the control the help was requested for.
    void
    setViewModified(boolean viewModified)
    Sets the value of the viewModified property.
    void
    showHelp()
    Displays online help if configured.
    String
    toGenericString()
    Returns the classname plus optional fx:id.
    void
    triggerViewModified()
    Walks up the component hierarchy and updates the viewModified property.
    This is done by comparing the saved view value with the current view.
    void
    updateModel()
    Updates the model according to the view.
    void
    updateView()
    Updates the view according to the model.
    void
    updateViewNonFocused()
    Updates the view according to the model.
    The method is the same as FxControl.updateView() but skips any focused component.
    javafx.beans.property.BooleanProperty
    viewModifiedProperty()
    Gets the viewModified property.

    Methods inherited from class javafx.scene.layout.GridPane

    add, add, addColumn, addRow, alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getCellBounds, getClassCssMetaData, getColumnConstraints, getColumnCount, getColumnIndex, getColumnSpan, getContentBias, getCssMetaData, getHalignment, getHgap, getHgrow, getMargin, getRowConstraints, getRowCount, getRowIndex, getRowSpan, getValignment, getVgap, getVgrow, gridLinesVisibleProperty, hgapProperty, isFillHeight, isFillWidth, isGridLinesVisible, layoutChildren, requestLayout, setAlignment, setColumnIndex, setColumnSpan, setConstraints, setConstraints, setConstraints, setConstraints, setConstraints, setFillHeight, setFillWidth, setGridLinesVisible, setHalignment, setHgap, setHgrow, setMargin, setRowIndex, setRowSpan, setValignment, setVgap, setVgrow, toString, vgapProperty

    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, getUserAgentStylesheet, getWidth, heightProperty, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Constructor Details

    • FxGridPane

      public FxGridPane()
      Creates a FxGridPane.

  • Method Details

    • createDelegate

      protected FxGridPaneDelegate createDelegate()
      Creates the delegate.
      Returns:
      the delegate

    • getDelegate

      public FxGridPaneDelegate getDelegate()
      Description copied from interface: FxControl
      Gets the lazily created component delegate.
      Specified by:
      getDelegate in interface FxControl
      Returns:
      the delegate

    • getParentContainer

      public FxContainer getParentContainer()
      Description copied from interface: FxControl
      Gets the parent container.
      Specified by:
      getParentContainer in interface FxControl
      Returns:
      the parent, null if not a component of a container

    • getComponents

      public javafx.collections.ObservableList<?> getComponents()
      Description copied from interface: FxContainer
      Gets the component nodes maintained by this container.
      Specified by:
      getComponents in interface FxContainer
      Returns:
      list of components

    • setChangeable

      public void setChangeable(boolean changeable)
      Sets the value of the changeable property.
      Specified by:
      setChangeable in interface FxControl
      Property description:
      Parameters:
      changeable - the value for the changeable property
      See Also:

    • isChangeable

      public boolean isChangeable()
      Gets the value of the changeable property.
      Specified by:
      isChangeable in interface FxControl
      Property description:
      Returns:
      the value of the changeable property
      See Also:

    • setContainerChangeable

      public void setContainerChangeable(boolean containerChangeable)
      Description copied from interface: FxControl
      Invoked when setChangeable() is invoked on the container of this component.
      Specified by:
      setContainerChangeable in interface FxControl
      Parameters:
      containerChangeable - true if container is changeable, false if all components readonly

    • setContainerChangeableIgnored

      public void setContainerChangeableIgnored(boolean containerChangeableIgnored)
      Description copied from interface: FxControl
      Sets whether to ignore setContainerChangeable.
      Specified by:
      setContainerChangeableIgnored in interface FxControl
      Parameters:
      containerChangeableIgnored - true if ignore, default is false

    • isContainerChangeableIgnored

      public boolean isContainerChangeableIgnored()
      Description copied from interface: FxControl
      Returns whether setContainerChangeable is ignored by this control.
      Specified by:
      isContainerChangeableIgnored in interface FxControl
      Returns:
      true if ignore

    • changeableProperty

      public javafx.beans.property.ReadOnlyBooleanProperty changeableProperty()
      Description copied from interface: FxControl
      Gets the changeable property.
      Specified by:
      changeableProperty in interface FxControl
      Returns:
      the changeable property
      See Also:

    • updateViewNonFocused

      public void updateViewNonFocused()
      Description copied from interface: FxContainer
      Updates the view according to the model.
      The method is the same as FxControl.updateView() but skips any focused component.
      Specified by:
      updateViewNonFocused in interface FxContainer

    • updateView

      public void updateView()
      Description copied from interface: FxControl
      Updates the view according to the model.
      Specified by:
      updateView in interface FxControl

    • updateModel

      public void updateModel()
      Description copied from interface: FxControl
      Updates the model according to the view.
      Specified by:
      updateModel in interface FxControl

    • saveView

      public void saveView()
      Description copied from interface: FxControl
      Creates a copy of the value shown to the user.
      Specified by:
      saveView in interface FxControl

    • invalidateSavedView

      public void invalidateSavedView()
      Description copied from interface: FxControl
      Invalidates the saved view.
      Specified by:
      invalidateSavedView in interface FxControl

    • triggerViewModified

      public void triggerViewModified()
      Description copied from interface: FxControl
      Walks up the component hierarchy and updates the viewModified property.
      This is done by comparing the saved view value with the current view.
      Specified by:
      triggerViewModified in interface FxControl

    • setViewModified

      public void setViewModified(boolean viewModified)
      Sets the value of the viewModified property.
      Specified by:
      setViewModified in interface FxControl
      Property description:
      Parameters:
      viewModified - the value for the viewModified property
      See Also:

    • isViewModified

      public boolean isViewModified()
      Gets the value of the viewModified property.
      Specified by:
      isViewModified in interface FxControl
      Property description:
      Returns:
      the value of the viewModified property
      See Also:

    • viewModifiedProperty

      public javafx.beans.property.BooleanProperty viewModifiedProperty()
      Description copied from interface: FxControl
      Gets the viewModified property.
      Specified by:
      viewModifiedProperty in interface FxControl
      Returns:
      the viewModified property
      See Also:

    • setBindable

      public void setBindable(boolean bindable)
      Description copied from interface: FxControl
      Sets whether this control is bindable, i.e. should be checked within a binding hierarchy.
      Specified by:
      setBindable in interface FxControl
      Parameters:
      bindable - true if bindable, else not eligible for the binding process

    • isBindable

      public boolean isBindable()
      Description copied from interface: FxControl
      Determines whether this container is bindable.
      Specified by:
      isBindable in interface FxControl
      Returns:
      true if bindable, else not eligible for the binding process

    • setHelpUrl

      public void setHelpUrl(String helpUrl)
      Description copied from interface: FxControl
      Sets the online-help URL.
      If a help url is set, a browser will be launched to show that url if there is no help url for the control the help was requested for.
      Specified by:
      setHelpUrl in interface FxControl
      Parameters:
      helpUrl - the help url

    • getHelpUrl

      public String getHelpUrl()
      Description copied from interface: FxControl
      Gets the online-help URL.
      Specified by:
      getHelpUrl in interface FxControl
      Returns:
      the help url, default is null

    • showHelp

      public void showHelp()
      Description copied from interface: FxControl
      Displays online help if configured.
      Specified by:
      showHelp in interface FxControl

    • toGenericString

      public String toGenericString()
      Description copied from interface: FxControl
      Returns the classname plus optional fx:id.
      Specified by:
      toGenericString in interface FxControl
      Returns:
      the generic string for diagnostics and logging

    • clearErrors

      public void clearErrors()
      Description copied from interface: FxContainer
      Clears all error messages in all components.
      Specified by:
      clearErrors in interface FxContainer

    • getController

      public FxController getController()
      Description copied from interface: FxContainer
      Gets the controller of this container.
      Specified by:
      getController in interface FxContainer
      Returns:
      the controller, null if nested container without a controller

    • setController

      public void setController(FxController controller)
      Description copied from interface: FxContainer
      Sets the controller of this container.
      Specified by:
      setController in interface FxContainer
      Parameters:
      controller - the controller, null if nested container without a controller

    • getController

      public <C extends FxController> C getController(Class<C> clazz)
      Description copied from interface: FxContainer
      Gets the controller along the parent hierarchy that is an instanceof the given class.
      Specified by:
      getController in interface FxContainer
      Type Parameters:
      C - the controller type
      Parameters:
      clazz - the controller class
      Returns:
      the controller, null if no such controller

    • addModelToViewListener

      public void addModelToViewListener(ModelToViewListener listener)
      Description copied from interface: FxControl
      Adds a model-to-view listener.
      The listener will be invoked before the binding operation.
      If the control is a container, the listener will be invoked if any of the container's components get updated.
      Specified by:
      addModelToViewListener in interface FxControl
      Parameters:
      listener - the value listener to add

    • removeModelToViewListener

      public void removeModelToViewListener(ModelToViewListener listener)
      Description copied from interface: FxControl
      Removes a model-to-view listener.
      Specified by:
      removeModelToViewListener in interface FxControl
      Parameters:
      listener - the value listener to remove

    • addViewToModelListener

      public void addViewToModelListener(ViewToModelListener listener)
      Description copied from interface: FxControl
      Adds a view-to-model listener.
      The listener will be invoked after the binding operation.
      If the control is a container, the listener will be invoked if any of the container's components update the model.
      Specified by:
      addViewToModelListener in interface FxControl
      Parameters:
      listener - the value listener to add

    • removeViewToModelListener

      public void removeViewToModelListener(ViewToModelListener listener)
      Description copied from interface: FxControl
      Removes a view-to-model listener.
      Specified by:
      removeViewToModelListener in interface FxControl
      Parameters:
      listener - the value listener to remove