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

Class FxToggleButton

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.ButtonBase
javafx.scene.control.ToggleButton
org.tentackle.fx.component.FxToggleButton
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable, javafx.scene.control.Toggle, ErrorPopupSupported, FxComponent, FxControl, InfoPopupSupported
public class FxToggleButton extends javafx.scene.control.ToggleButton implements FxComponent
Extended ToggleButton.
Author:
harald

  • Property Summary

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

    Properties inherited from class javafx.scene.control.ToggleButton

    selected, toggleGroup

    Properties inherited from class javafx.scene.control.ButtonBase

    armed, onAction

    Properties inherited from class javafx.scene.control.Labeled

    alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    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.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    FxToggleButton()
    Creates a FxToggleButton.

  • 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.
    protected FxToggleButtonDelegate
    createDelegate()
    Creates the delegate.
    FxComponentBinding
    getBinding()
    Gets the binding.
    String
    getBindingPath()
    Gets the binding path.
    String
    getComponentPath()
    Gets the component path.
    FxToggleButtonDelegate
    getDelegate()
    Gets the lazily created component delegate.
    String
    getError()
    Gets the error message.
    Type
    getGenericType()
    Gets the generic type.
    String
    getHelpUrl()
    Gets the online-help URL.
    String
    getInfo()
    Gets the info message.
    FxContainer
    getParentContainer()
    Gets the parent container.
    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.
    FxTreeTableCell<?,?>
    getTreeTableCell()
    Gets the treetable cell if the component is used as a treetable cell editor.
    Class<?>
    getType()
    Gets the type this component returns via FxComponent.getViewValue().
    ValueTranslator<?,?>
    getValueTranslator()
    Gets the value translator.
    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.
    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()
    Gets the value of the changeable property.
    boolean
    isContainerChangeableIgnored()
    Returns whether setContainerChangeable is ignored by this control.
    boolean
    isErrorTemporary()
    Returns whether this is a temporary error.
    Temporary errors are set by the value translators typically if some parsing failed.
    boolean
    isListenerSuppressedIfModelUnchanged()
    Returns whether the ViewToModelListeners should be invoked even if the model's value did not change at all.
    By default, the listener will always be invoked.
    boolean
    isListenerSuppressedIfViewUnchanged()
    Returns whether the ModelToViewListeners should be invoked even if the view's value will not change at all.
    By default, the listener will always be invoked.
    boolean
    isMandatory()
    Gets the value of the mandatory property.
    boolean
    isModelUpdated()
    Returns whether model was updated and FxControl.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()
    Gets the value of the viewModified property.
    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
    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
    setBinding(FxComponentBinding binding)
    Sets the binding.
    void
    setBindingPath(String bindingPath)
    Sets the path to bind this component to.
    void
    setChangeable(boolean changeable)
    Sets the value of the changeable property.
    void
    setComponentPath(String componentPath)
    Sets the component path.
    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
    setDelegate(FxToggleButtonDelegate delegate)
    Sets the delegate.
    Useful for application specific needs.
    void
    setError(String error)
    Sets the error message.
    Notice that an empty string will set the style but does not show any popup.
    void
    setErrorTemporary(boolean errorTemporary)
    Sets the temporary error flag.
    void
    setGenericType(Type type)
    Sets the generic type.
    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
    setInfo(String info)
    Sets the info message.
    Notice that an empty string will set the style but does not show any popup.
    void
    setListenerSuppressedIfModelUnchanged(boolean listenerSuppressedIfModelUnchanged)
    Sets whether the ViewToModelListeners should be invoked even if the model's value did not change at all.
    void
    setListenerSuppressedIfViewUnchanged(boolean listenerSuppressedIfViewUnchanged)
    Sets whether the ModelToViewListeners should be invoked even if the view's value will not change at all.
    void
    setMandatory(boolean mandatory)
    Sets the value of the mandatory property.
    void
    setTableCell(FxTableCell<?,?> tableCell)
    Sets the table cell if the component is used as a table cell editor.
    void
    setTreeTableCell(FxTreeTableCell<?,?> treeTableCell)
    Sets the treetable cell if the component is used as a treetable cell editor.
    void
    setType(Class<?> type)
    Sets the type for this component.
    void
    setValueTranslator(ValueTranslator<?,?> valueTranslator)
    Sets a value translator.
    void
    setViewModified(boolean viewModified)
    Sets the value of the viewModified property.
    void
    setViewObject(Object viewObject)
    Sets the internal native object of the component.
    void
    setViewValue(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.
    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.ToggleButton

    createDefaultSkin, fire, getInitialAlignment, getToggleGroup, isSelected, queryAccessibleAttribute, selectedProperty, setSelected, setToggleGroup, toggleGroupProperty

    Methods inherited from class javafx.scene.control.ButtonBase

    arm, armedProperty, disarm, executeAccessibleAction, getOnAction, isArmed, onActionProperty, setOnAction

    Methods inherited from class javafx.scene.control.Labeled

    alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, 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, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, 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, 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 org.tentackle.fx.FxComponent

    isCellEditor

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

    Methods inherited from interface javafx.scene.control.Toggle

    getProperties, getUserData, setUserData

  • Property Details

  • Constructor Details

    • FxToggleButton

      public FxToggleButton()
      Creates a FxToggleButton.

  • Method Details

    • createDelegate

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

    • getDelegate

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

    • setDelegate

      public void setDelegate(FxToggleButtonDelegate 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

    • getValueTranslator

      public ValueTranslator<?,?> getValueTranslator()
      Description copied from interface: FxComponent
      Gets the value translator.
      Specified by:
      getValueTranslator in interface FxComponent
      Returns:
      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(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(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 memory leaks.

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

    • getType

      public Class<?> getType()
      Description copied from interface: FxComponent
      Gets the type this component returns via FxComponent.getViewValue().
      Specified by:
      getType in interface FxComponent
      Returns:
      the type

    • setGenericType

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

    • getGenericType

      public 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

    • 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

    • setMandatory

      public void setMandatory(boolean mandatory)
      Sets the value of the mandatory property.
      Specified by:
      setMandatory in interface FxComponent
      Property description:
      Parameters:
      mandatory - the value for the mandatory property
      See Also:

    • isMandatory

      public boolean isMandatory()
      Gets the value of the mandatory property.
      Specified by:
      isMandatory in interface FxComponent
      Property description:
      Returns:
      the value of the mandatory property
      See Also:

    • mandatoryProperty

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

    • setBindingPath

      public void setBindingPath(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 programmatically as well.

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

    • getBindingPath

      public 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(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 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

    • setBinding

      public void setBinding(FxComponentBinding binding)
      Description copied from interface: FxComponent
      Sets the binding.
      Specified by:
      setBinding in interface FxComponent
      Parameters:
      binding - the binding, null if none.

    • getBinding

      public FxComponentBinding getBinding()
      Description copied from interface: FxComponent
      Gets the binding.
      Specified by:
      getBinding in interface FxComponent
      Returns:
      the binding, null if none

    • 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:

    • 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:

    • 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

    • 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:

    • 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 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 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(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(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

    • setError

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

    • getError

      public String getError()
      Description copied from interface: ErrorPopupSupported
      Gets the error message.
      Specified by:
      getError in interface ErrorPopupSupported
      Returns:
      the message, null if no error

    • 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

    • showErrorPopup

      public void showErrorPopup()
      Description copied from interface: ErrorPopupSupported
      Shows the error popup.
      Requires the error message set.
      Specified by:
      showErrorPopup in interface ErrorPopupSupported

    • hideErrorPopup

      public void hideErrorPopup()
      Description copied from interface: ErrorPopupSupported
      Hides the error popup if shown.
      Specified by:
      hideErrorPopup in interface ErrorPopupSupported

    • setInfo

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

    • getInfo

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

    • showInfoPopup

      public void showInfoPopup()
      Description copied from interface: InfoPopupSupported
      Shows the info popup.
      Requires the info message set.
      Specified by:
      showInfoPopup in interface InfoPopupSupported

    • hideInfoPopup

      public void hideInfoPopup()
      Description copied from interface: InfoPopupSupported
      Hides the info popup if shown.
      Specified by:
      hideInfoPopup in interface InfoPopupSupported

    • isModelUpdated

      public boolean isModelUpdated()
      Description copied from interface: FxComponent
      Returns whether model was updated and FxControl.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

    • setTreeTableCell

      public void setTreeTableCell(FxTreeTableCell<?,?> treeTableCell)
      Description copied from interface: FxComponent
      Sets the treetable cell if the component is used as a treetable cell editor.
      Specified by:
      setTreeTableCell in interface FxComponent
      Parameters:
      treeTableCell - the cell, null to disconnect from treetable cell

    • getTreeTableCell

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

    • isListenerSuppressedIfModelUnchanged

      public boolean isListenerSuppressedIfModelUnchanged()
      Description copied from interface: FxComponent
      Returns whether the ViewToModelListeners should be invoked even if the model's value did not change at all.
      By default, the listener will always be invoked.
      Specified by:
      isListenerSuppressedIfModelUnchanged in interface FxComponent
      Returns:
      true if suppress invocation

    • setListenerSuppressedIfModelUnchanged

      public void setListenerSuppressedIfModelUnchanged(boolean listenerSuppressedIfModelUnchanged)
      Description copied from interface: FxComponent
      Sets whether the ViewToModelListeners should be invoked even if the model's value did not change at all.
      Specified by:
      setListenerSuppressedIfModelUnchanged in interface FxComponent
      Parameters:
      listenerSuppressedIfModelUnchanged - true if suppress invocation

    • isListenerSuppressedIfViewUnchanged

      public boolean isListenerSuppressedIfViewUnchanged()
      Description copied from interface: FxComponent
      Returns whether the ModelToViewListeners should be invoked even if the view's value will not change at all.
      By default, the listener will always be invoked.
      Specified by:
      isListenerSuppressedIfViewUnchanged in interface FxComponent
      Returns:
      true if suppress invocation

    • setListenerSuppressedIfViewUnchanged

      public void setListenerSuppressedIfViewUnchanged(boolean listenerSuppressedIfViewUnchanged)
      Description copied from interface: FxComponent
      Sets whether the ModelToViewListeners should be invoked even if the view's value will not change at all.
      Specified by:
      setListenerSuppressedIfViewUnchanged in interface FxComponent
      Parameters:
      listenerSuppressedIfViewUnchanged - true if suppress invocation