Module org.tentackle.fx
Package org.tentackle.fx.component

Class FxTableView<S>

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javafx.scene.control.TableView

        javafx.scene.control.TableView.ResizeFeatures<S extends java.lang.Object>, javafx.scene.control.TableView.TableViewFocusModel<S extends java.lang.Object>, javafx.scene.control.TableView.TableViewSelectionModel<S extends java.lang.Object>

    • Field Summary

      • Fields inherited from class javafx.scene.control.TableView

        CONSTRAINED_RESIZE_POLICY, DEFAULT_SORT_POLICY, UNCONSTRAINED_RESIZE_POLICY

      • 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
      FxTableView()
      Creates a default TableView control with no content.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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 changaeble property.
      void configure()
      Configures or re-configures the table.
      Requires a valid table configuration.
      java.lang.String copyToClipboard()
      Copies the selected cells to the clipboard.
      Multiple cells are separated by tabs.
      protected FxTableViewDelegate createDelegate()
      Creates the delegate.
      FxComponentBinding getBinding()
      Gets the binding.
      java.lang.String getBindingPath()
      Gets the binding path.
      java.lang.String getComponentPath()
      Gets the component path.
      TableConfiguration<S> getConfiguration()
      Gets the table configuration.
      FxTableViewDelegate getDelegate()
      Gets the lazily created component delegate.
      java.lang.String getError()
      Gets the error message.
      java.lang.reflect.Type getGenericType()
      Gets the generic type.
      java.lang.String getHelpUrl()
      Gets the online-help URL.
      java.lang.String getInfo()
      Gets the info message.
      FxContainer getParentContainer()
      Gets the parent container.
      java.lang.Object getSavedViewObject()
      Retrieves the view value saved with FxControl.saveView().
      The returned type is the internal native type of the component.
      FxTableCell<?,​?> getTableCell()
      Gets the table cell if the component is used as a table cell editor.
      TotalsTableView<S> getTotalsTableView()
      Gets the totals table.
      java.lang.Class<?> getType()
      Gets the type this component returns via FxComponent.getViewValue().
      ValueTranslator<?,​?> getValueTranslator()
      Gets the value translator.
      java.lang.Object getViewObject()
      Retrieves the internal native object of the component.
      <V> V getViewValue()
      Retrieves the value from this component.
      The value's type is that of the model.
      protected void handleKeyEvent​(javafx.scene.input.KeyEvent event)
      Handles all key events.
      void hideErrorPopup()
      Hides the error popup if shown.
      void hideInfoPopup()
      Hides the info popup if shown.
      void invalidateSavedView()
      Invalidates the saved view.
      boolean isBindable()
      Determines whether this container is bindable.
      boolean isChangeable()
      Returns if this control is changeable.
      boolean isContainerChangeableIgnored()
      Returns whether setContainerChangeable is ignored by this control.
      boolean isCopyToClipboardEnabled()
      Returns whether the copy to clipboard feature is enabled.
      boolean isErrorTemporary()
      Returns whether this is a temporary error.
      Temporary errors are set by the value translators typically if some parsing failed.
      boolean isMandatory()
      Gets the mandatory option.
      boolean isModelUpdated()
      Returns whether model was updated and updateview not invoked since then.
      Some components, such as FxTableView, never update the model because this is already done by the ObservableList.
      boolean isSavedViewObjectValid()
      Returns whether the view object is saved.
      boolean isViewModified()
      Returns whether the user has modified the view since the last FxControl.updateView().
      void loadPreferences​(java.lang.String suffix, boolean system)
      Loads the column sizes, visability, view size and sorting from the preferences.
      javafx.beans.property.BooleanProperty mandatoryProperty()
      Gets the mandatory property.
      void removeModelToViewListener​(ModelToViewListener listener)
      Removes a model-to-view listener.
      void removeViewToModelListener​(ViewToModelListener listener)
      Removes a view-to-model listener.
      void savePreferences​(java.lang.String suffix, boolean system)
      Saves the column sizes, visability, view size and sorting to the preferences.
      void saveView()
      Creates a copy of the value shown to the user.
      void setBindable​(boolean bindable)
      Sets whether this control is bindable, i.e.
      void setBinding​(FxComponentBinding binding)
      Sets the binding.
      void setBindingPath​(java.lang.String bindingPath)
      Sets the path to bind this component to.
      void setChangeable​(boolean changeable)
      Set the control to be changeable.
      This is a unified abstraction and will be translated to setEditable or setDisabled, whatever is appropriate to this control.
      void setComponentPath​(java.lang.String componentPath)
      Sets the component path.
      void setConfiguration​(TableConfiguration<S> configuration)
      Sets the table configuration.
      void setContainerChangableIgnored​(boolean containerChangeableIgnored)
      Sets whether to ignore setContainerChangeable.
      void setContainerChangeable​(boolean containerChangeable)
      Invoked when setChangeable() is invoked on the container of this component.
      void setCopyToClipboardEnabled​(boolean copyToClipboardEnabled)
      Configures the table to copy a cell via Crtl-C to the clipboard.
      void setDelegate​(FxTableViewDelegate delegate)
      Sets the delegate.
      Useful for application specific needs.
      void setError​(java.lang.String error)
      Sets the error message.
      Notice that an empty string will set the style but dows not show any popup.
      void setErrorTemporary​(boolean errorTemporary)
      Sets the temporary error flag.
      void setGenericType​(java.lang.reflect.Type type)
      Sets the generic type.
      void setHelpUrl​(java.lang.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 setInfo​(java.lang.String info)
      Sets the info message.
      Notice that an empty string will set the style but dows not show any popup.
      void setMandatory​(boolean mandatory)
      Sets the mandatory option.
      Mandatory fields are differently visualized.
      void setSortable​(boolean sortable)
      Sets the sortable property of all columns.
      void setTableCell​(FxTableCell<?,​?> tableCell)
      Sets the table cell if the component is used as a table cell editor.
      void setTotalsTableView​(TotalsTableView<S> totalsTableView)
      Sets the totals table.
      void setType​(java.lang.Class<?> type)
      Sets the type for this component.
      void setValueTranslator​(ValueTranslator<?,​?> valueTranslator)
      Sets a value translator.
      void setViewModified​(boolean viewModified)
      Sets whether the view has been modified.
      void setViewObject​(java.lang.Object viewObject)
      Sets the internal native object of the component.
      void setViewValue​(java.lang.Object value)
      Sets a value in this component.
      The value's type is that of the model.
      void showErrorPopup()
      Shows the error popup.
      Requires the error message set.
      void showHelp()
      Displays online help if configured.
      void showInfoPopup()
      Shows the info popup.
      Requires the info message set.
      java.lang.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.
      javafx.beans.property.BooleanProperty viewModifiedProperty()
      Gets the viewModified property.

      • Methods inherited from class javafx.scene.control.TableView

        columnResizePolicyProperty, comparatorProperty, createDefaultSkin, edit, editableProperty, editingCellProperty, fixedCellSizeProperty, focusModelProperty, getClassCssMetaData, getColumnResizePolicy, getColumns, getComparator, getControlCssMetaData, getEditingCell, getFixedCellSize, getFocusModel, getItems, getOnScrollTo, getOnScrollToColumn, getOnSort, getPlaceholder, getRowFactory, getSelectionModel, getSortOrder, getSortPolicy, getVisibleLeafColumn, getVisibleLeafColumns, getVisibleLeafIndex, isEditable, isTableMenuButtonVisible, itemsProperty, onScrollToColumnProperty, onScrollToProperty, onSortProperty, placeholderProperty, queryAccessibleAttribute, refresh, resizeColumn, rowFactoryProperty, scrollTo, scrollTo, scrollToColumn, scrollToColumnIndex, selectionModelProperty, setColumnResizePolicy, setEditable, setFixedCellSize, setFocusModel, setItems, setOnScrollTo, setOnScrollToColumn, setOnSort, setPlaceholder, setRowFactory, setSelectionModel, setSortPolicy, setTableMenuButtonVisible, sort, sortPolicyProperty, tableMenuButtonVisibleProperty

      • Methods inherited from class javafx.scene.control.Control

        computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

      • Methods inherited from class javafx.scene.layout.Region

        backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, 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

        getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, 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, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, 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, 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, toString, 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

    • Constructor Detail

      • FxTableView

        public FxTableView()
        Creates a default TableView control with no content.

        Refer to the TableView class documentation for details on the default state of other properties.

    • Method Detail

      • getConfiguration

        public TableConfiguration<S> getConfiguration()
        Gets the table configuration.
        Returns:
        the configuration, null if not configured

      • setConfiguration

        public void setConfiguration​(TableConfiguration<S> configuration)
        Sets the table configuration.
        Parameters:
        configuration - the configuration

      • configure

        public void configure()
        Configures or re-configures the table.
        Requires a valid table configuration.

      • getTotalsTableView

        public TotalsTableView<S> getTotalsTableView()
        Gets the totals table.
        Returns:
        null if no totals (default)

      • setTotalsTableView

        public void setTotalsTableView​(TotalsTableView<S> totalsTableView)
        Sets the totals table.
        Parameters:
        totalsTableView - null to clear

      • savePreferences

        public void savePreferences​(java.lang.String suffix,
                            boolean system)
        Saves the column sizes, visability, view size and sorting to the preferences.
        Parameters:
        suffix - the configuration suffix, null if none
        system - true if save to system prefs, else user prefs

      • loadPreferences

        public void loadPreferences​(java.lang.String suffix,
                            boolean system)
        Loads the column sizes, visability, view size and sorting from the preferences.
        Parameters:
        suffix - the configuration suffix, null if none
        system - true if load from system prefs only, else user prefs first

      • setSortable

        public void setSortable​(boolean sortable)
        Sets the sortable property of all columns.
        Parameters:
        sortable - true if sortable

      • setCopyToClipboardEnabled

        public void setCopyToClipboardEnabled​(boolean copyToClipboardEnabled)
        Configures the table to copy a cell via Crtl-C to the clipboard.
        Parameters:
        copyToClipboardEnabled - true to enable

      • isCopyToClipboardEnabled

        public boolean isCopyToClipboardEnabled()
        Returns whether the copy to clipboard feature is enabled.
        Returns:
        true if enabled

      • handleKeyEvent

        protected void handleKeyEvent​(javafx.scene.input.KeyEvent event)
        Handles all key events.
        Parameters:
        event - the key event

      • copyToClipboard

        public java.lang.String copyToClipboard()
        Copies the selected cells to the clipboard.
        Multiple cells are separated by tabs.
        Returns:
        the copied text, null if nothing copied

      • createDelegate

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

      • setDelegate

        public void setDelegate​(FxTableViewDelegate delegate)
        Sets the delegate.
        Useful for application specific needs.
        Parameters:
        delegate - 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

      • setValueTranslator

        public void setValueTranslator​(ValueTranslator<?,​?> valueTranslator)
        Description copied from interface: FxComponent
        Sets a value translator.
        Specified by:
        setValueTranslator in interface FxComponent
        Parameters:
        valueTranslator - the translator

      • invalidateSavedView

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

      • isSavedViewObjectValid

        public boolean isSavedViewObjectValid()
        Description copied from interface: FxComponent
        Returns whether the view object is saved.
        Specified by:
        isSavedViewObjectValid in interface FxComponent
        Returns:
        true if saved, false if invalid

      • getViewValue

        public <V> V getViewValue()
        Description copied from interface: FxComponent
        Retrieves the value from this component.
        The value's type is that of the model.
        Specified by:
        getViewValue in interface FxComponent
        Type Parameters:
        V - the value's type
        Returns:
        the value shown by the component

      • setViewValue

        public void setViewValue​(java.lang.Object value)
        Description copied from interface: FxComponent
        Sets a value in this component.
        The value's type is that of the model.
        Specified by:
        setViewValue in interface FxComponent
        Parameters:
        value - is the value to set

      • setType

        public void setType​(java.lang.Class<?> type)
        Description copied from interface: FxComponent
        Sets the type for this component.

        Notice that the type can be applied only once. This is because previously installed listeners could cause memleaks.

        Specified by:
        setType in interface FxComponent
        Parameters:
        type - the type

      • setGenericType

        public void setGenericType​(java.lang.reflect.Type type)
        Description copied from interface: FxComponent
        Sets the generic type.
        Specified by:
        setGenericType in interface FxComponent
        Parameters:
        type - the generic type

      • getGenericType

        public java.lang.reflect.Type getGenericType()
        Description copied from interface: FxComponent
        Gets the generic type.
        Specified by:
        getGenericType in interface FxComponent
        Returns:
        the generic type

      • 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

      • 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

      • 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

      • setMandatory

        public void setMandatory​(boolean mandatory)
        Description copied from interface: FxComponent
        Sets the mandatory option.
        Mandatory fields are differently visualized. There is no further functional difference.
        Specified by:
        setMandatory in interface FxComponent
        Parameters:
        mandatory - true if mandatory

      • isMandatory

        public boolean isMandatory()
        Description copied from interface: FxComponent
        Gets the mandatory option.
        Specified by:
        isMandatory in interface FxComponent
        Returns:
        true if mandatory

      • mandatoryProperty

        public javafx.beans.property.BooleanProperty mandatoryProperty()
        Description copied from interface: FxComponent
        Gets the mandatory property.
        Specified by:
        mandatoryProperty in interface FxComponent
        Returns:
        the property

      • setBindingPath

        public void setBindingPath​(java.lang.String bindingPath)
        Description copied from interface: FxComponent
        Sets the path to bind this component to.

        Usually the binding path will be determined from the components declared name. However, it can be set programatically as well.

        Specified by:
        setBindingPath in interface FxComponent
        Parameters:
        bindingPath - the binding path, for ex. "invoiceNumber", null if autobinding
        See Also:
        Binder

      • getBindingPath

        public java.lang.String getBindingPath()
        Description copied from interface: FxComponent
        Gets the binding path.
        Specified by:
        getBindingPath in interface FxComponent
        Returns:
        the field path, null if autobinding (default)

      • setComponentPath

        public void setComponentPath​(java.lang.String componentPath)
        Description copied from interface: FxComponent
        Sets the component path.

        The path is <declaring-class-name>.<field-name>. Example "de.krake.invoicer.InvoicePanel.customerNumberField".

        Notice: the component path is set during binding.

        Specified by:
        setComponentPath in interface FxComponent
        Parameters:
        componentPath - the component path

      • getComponentPath

        public java.lang.String getComponentPath()
        Description copied from interface: FxComponent
        Gets the component path.
        Specified by:
        getComponentPath in interface FxComponent
        Returns:
        the component path, null if not bound

      • setChangeable

        public void setChangeable​(boolean changeable)
        Description copied from interface: FxControl
        Set the control to be changeable.
        This is a unified abstraction and will be translated to setEditable or setDisabled, whatever is appropriate to this control.
        Specified by:
        setChangeable in interface FxControl
        Parameters:
        changeable - true the user can edit the data, false if show only

      • isChangeable

        public boolean isChangeable()
        Description copied from interface: FxControl
        Returns if this control is changeable.
        Specified by:
        isChangeable in interface FxControl
        Returns:
        true the user can edit the data, false if show only

      • changeableProperty

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

      • 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

      • setContainerChangableIgnored

        public void setContainerChangableIgnored​(boolean containerChangeableIgnored)
        Description copied from interface: FxControl
        Sets whether to ignore setContainerChangeable.
        Specified by:
        setContainerChangableIgnored 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

      • setViewModified

        public void setViewModified​(boolean viewModified)
        Description copied from interface: FxControl
        Sets whether the view has been modified.
        Specified by:
        setViewModified in interface FxControl
        Parameters:
        viewModified - true if user has modified the visual representation

      • isViewModified

        public boolean isViewModified()
        Description copied from interface: FxControl
        Returns whether the user has modified the view since the last FxControl.updateView().
        Specified by:
        isViewModified in interface FxControl
        Returns:
        true if user changed the visual representation

      • viewModifiedProperty

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

      • 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

      • 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

      • getSavedViewObject

        public java.lang.Object getSavedViewObject()
        Description copied from interface: FxComponent
        Retrieves the view value saved with FxControl.saveView().
        The returned type is the internal native type of the component.
        Specified by:
        getSavedViewObject in interface FxComponent
        Returns:
        the saved view value

      • getViewObject

        public java.lang.Object getViewObject()
        Description copied from interface: FxComponent
        Retrieves the internal native object of the component.
        Specified by:
        getViewObject in interface FxComponent
        Returns:
        the component's object

      • setViewObject

        public void setViewObject​(java.lang.Object viewObject)
        Description copied from interface: FxComponent
        Sets the internal native object of the component.
        Specified by:
        setViewObject in interface FxComponent
        Parameters:
        viewObject - the internal object

      • 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​(java.lang.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 java.lang.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 java.lang.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

      • setError

        public void setError​(java.lang.String error)
        Description copied from interface: ErrorPopupSupported
        Sets the error message.
        Notice that an empty string will set the style but dows not show any popup.
        Specified by:
        setError in interface ErrorPopupSupported
        Parameters:
        error - the error message, null to clear

      • setErrorTemporary

        public void setErrorTemporary​(boolean errorTemporary)
        Description copied from interface: ErrorPopupSupported
        Sets the temporary error flag.
        Specified by:
        setErrorTemporary in interface ErrorPopupSupported
        Parameters:
        errorTemporary - true if this is a temporary error

      • isErrorTemporary

        public boolean isErrorTemporary()
        Description copied from interface: ErrorPopupSupported
        Returns whether this is a temporary error.
        Temporary errors are set by the value translators typically if some parsing failed. Non-temporary are set by the application, for example when a persistence validation failed.
        Specified by:
        isErrorTemporary in interface ErrorPopupSupported
        Returns:
        true if temporary error

      • setInfo

        public void setInfo​(java.lang.String info)
        Description copied from interface: InfoPopupSupported
        Sets the info message.
        Notice that an empty string will set the style but dows not show any popup.
        Specified by:
        setInfo in interface InfoPopupSupported
        Parameters:
        info - the info message, null to clear

      • getInfo

        public java.lang.String getInfo()
        Description copied from interface: InfoPopupSupported
        Gets the info message.
        Specified by:
        getInfo in interface InfoPopupSupported
        Returns:
        the message, null if no info

      • isModelUpdated

        public boolean isModelUpdated()
        Description copied from interface: FxComponent
        Returns whether model was updated and updateview not invoked since then.
        Some components, such as FxTableView, never update the model because this is already done by the ObservableList. On those cases, false will be returned.
        Specified by:
        isModelUpdated in interface FxComponent
        Returns:
        true if updateView could make sense

      • setTableCell

        public void setTableCell​(FxTableCell<?,​?> tableCell)
        Description copied from interface: FxComponent
        Sets the table cell if the component is used as a table cell editor.
        Specified by:
        setTableCell in interface FxComponent
        Parameters:
        tableCell - the cell, null to disconnect from table cell

      • getTableCell

        public FxTableCell<?,​?> getTableCell()
        Description copied from interface: FxComponent
        Gets the table cell if the component is used as a table cell editor.
        Specified by:
        getTableCell in interface FxComponent
        Returns:
        the cell, null if not a cell editor