Class FxTextArea

    • Nested Class Summary

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

        javafx.scene.control.TextInputControl.Content
    • Field Summary

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

        DEFAULT_PREF_COLUMN_COUNT, DEFAULT_PREF_ROW_COUNT
      • 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
      FxTextArea()
      Creates a FxTextArea with empty text content.
      FxTextArea​(java.lang.String text)
      Creates a FxTextArea with initial text 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.
      void autoSelect()
      Selects or deselects all text in the text input.
      javafx.beans.property.ReadOnlyBooleanProperty changeableProperty()
      Gets the changaeble property.
      protected FxTextAreaDelegate createDelegate()
      Creates the delegate.
      FxComponentBinding getBinding()
      Gets the binding.
      java.lang.String getBindingPath()
      Gets the binding path.
      CaseConversion getCaseConversion()
      Gets the case conversion.
      int getColumns()
      Gets the columns.
      java.lang.String getComponentPath()
      Gets the component path.
      FxTextAreaDelegate getDelegate()
      Gets the lazily created component delegate.
      java.lang.String getError()
      Gets the error message.
      java.lang.Integer getErrorOffset()
      Gets the error offset.
      char getFiller()
      Gets the filler character.
      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.
      java.lang.String getInvalidChars()
      Gets invalid characters.
      int getMaxColumns()
      Gets the maximum number of columns.
      FxContainer getParentContainer()
      Gets the parent container.
      java.lang.String getPattern()
      Gets the format pattern.
      java.lang.Object getSavedViewObject()
      Retrieves the view value saved with FxControl.saveView().
      The returned type is the internal native type of the component.
      int getScale()
      Gets the current scale.
      FxTableCell<?,​?> getTableCell()
      Gets the table cell if the component is used as a table cell editor.
      javafx.geometry.Pos getTextAlignment()
      Gets the text alignment.
      java.util.function.Function<java.lang.String,​java.lang.String> getTextConverter()
      Gets the text converter.
      java.lang.Class<?> getType()
      Gets the type this component returns via FxComponent.getViewValue().
      java.lang.String getValidChars()
      Gets allowed characters.
      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.
      void hideErrorPopup()
      Hides the error popup if shown.
      void hideInfoPopup()
      Hides the info popup if shown.
      void invalidateSavedView()
      Invalidates the saved view.
      boolean isAutoSelect()
      Returns whether the auto-select feature is enabled.
      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 isErrorTemporary()
      Returns whether this is a temporary error.
      Temporary errors are set by the value translators typically if some parsing failed.
      boolean isLenient()
      Returns whether parsing to model should be lenient.
      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 isUnsigned()
      Returns whether a numeric field is unsigned or signed.
      boolean isUTC()
      Returns whether this is a UTC timestamp.
      boolean isViewModified()
      Returns whether the user has modified the view since the last FxControl.updateView().
      javafx.beans.property.BooleanProperty mandatoryProperty()
      Gets the mandatory property.
      void mapErrorOffsetToCaretPosition()
      Sets the caret position according to the error offset.
      Does nothing if error offset is null.
      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 setAutoSelect​(boolean autoSelect)
      Sets the auto-select feature.
      A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus.
      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 setCaseConversion​(CaseConversion caseConversion)
      Sets the case conversion.
      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 setColumns​(int columns)
      Sets the number of columns in this component.
      The visible width is adjusted according to the current font.
      void setComponentPath​(java.lang.String componentPath)
      Sets the component path.
      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 setDelegate​(FxTextAreaDelegate 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 setErrorOffset​(java.lang.Integer errorOffset)
      Sets the error offset.
      void setErrorTemporary​(boolean errorTemporary)
      Sets the temporary error flag.
      void setFiller​(char filler)
      Sets the filler character.
      The default is space.
      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 setInvalidChars​(java.lang.String invalidChars)
      Sets invalid characters.
      void setLenient​(boolean lenient)
      Sets whether parsing to model should be lenient.
      void setMandatory​(boolean mandatory)
      Sets the mandatory option.
      Mandatory fields are differently visualized.
      void setMaxColumns​(int maxColumns)
      Sets the maximum number of columns.
      The number of columns will be enforced by the model.
      void setPattern​(java.lang.String pattern)
      Sets the format pattern.
      The format pattern is used to format the view of the data.
      void setScale​(int scale)
      Changes the format according to the given scale.
      void setTableCell​(FxTableCell<?,​?> tableCell)
      Sets the table cell if the component is used as a table cell editor.
      void setTextAlignment​(javafx.geometry.Pos textAlignment)
      Sets the text alignment.
      void setTextConverter​(java.util.function.Function<java.lang.String,​java.lang.String> textConverter)
      Sets a text converter.
      Converts input text to the view's text.
      void setType​(java.lang.Class<?> type)
      Sets the type for this component.
      void setUnsigned​(boolean unsigned)
      Sets whether a numeric field is unsigned or signed.
      void setUTC​(boolean utc)
      Sets whether this is a UTC timestamp.
      void setValidChars​(java.lang.String validChars)
      Sets allowed characters.
      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.TextArea

        createDefaultSkin, getClassCssMetaData, getControlCssMetaData, getParagraphs, getPrefColumnCount, getPrefRowCount, getScrollLeft, getScrollTop, isWrapText, prefColumnCountProperty, prefRowCountProperty, scrollLeftProperty, scrollTopProperty, setPrefColumnCount, setPrefRowCount, setScrollLeft, setScrollTop, setWrapText, wrapTextProperty
      • Methods inherited from class javafx.scene.control.TextInputControl

        anchorProperty, appendText, backward, cancelEdit, caretPositionProperty, clear, commitValue, copy, cut, deleteNextChar, deletePreviousChar, deleteText, deleteText, deselect, editableProperty, end, endOfNextWord, executeAccessibleAction, extendSelection, fontProperty, forward, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, getTextFormatter, home, insertText, isEditable, isRedoable, isUndoable, lengthProperty, nextWord, paste, positionCaret, previousWord, promptTextProperty, queryAccessibleAttribute, redo, redoableProperty, replaceSelection, replaceText, replaceText, selectAll, selectBackward, selectedTextProperty, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectionProperty, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setEditable, setFont, setPromptText, setText, setTextFormatter, textFormatterProperty, textProperty, undo, undoableProperty
      • 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, 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

      • FxTextArea

        public FxTextArea()
        Creates a FxTextArea with empty text content.
      • FxTextArea

        public FxTextArea​(java.lang.String text)
        Creates a FxTextArea with initial text content.

        Parameters:
        text - A string for text content.
    • Method Detail

      • createDelegate

        protected FxTextAreaDelegate createDelegate()
        Creates the delegate.
        Returns:
        the delegate
      • setDelegate

        public void setDelegate​(FxTextAreaDelegate 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
      • setColumns

        public void setColumns​(int columns)
        Description copied from interface: FxTextComponent
        Sets the number of columns in this component.
        The visible width is adjusted according to the current font.
        Specified by:
        setColumns in interface FxTextComponent
        Parameters:
        columns - the number of columns ≥ 0
      • setMaxColumns

        public void setMaxColumns​(int maxColumns)
        Description copied from interface: FxTextComponent
        Sets the maximum number of columns.
        The number of columns will be enforced by the model.
        Specified by:
        setMaxColumns in interface FxTextComponent
        Parameters:
        maxColumns - the maximum number of columns, 0 if unlimited (default)
      • getMaxColumns

        public int getMaxColumns()
        Description copied from interface: FxTextComponent
        Gets the maximum number of columns.
        Specified by:
        getMaxColumns in interface FxTextComponent
        Returns:
        the maximum number of columns, 0 if unlimited (default)
      • setAutoSelect

        public void setAutoSelect​(boolean autoSelect)
        Description copied from interface: FxTextComponent
        Sets the auto-select feature.
        A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus. Useful for numerical fields, for example.
        Specified by:
        setAutoSelect in interface FxTextComponent
        Parameters:
        autoSelect - true if autoselect enabled, false if disabled (default)
      • isAutoSelect

        public boolean isAutoSelect()
        Description copied from interface: FxTextComponent
        Returns whether the auto-select feature is enabled.
        Specified by:
        isAutoSelect in interface FxTextComponent
        Returns:
        true if autoselect enabled, false if disabled (default)
      • setPattern

        public void setPattern​(java.lang.String pattern)
        Description copied from interface: FxTextComponent
        Sets the format pattern.
        The format pattern is used to format the view of the data.
        Specified by:
        setPattern in interface FxTextComponent
        Parameters:
        pattern - the format pattern
      • getPattern

        public java.lang.String getPattern()
        Description copied from interface: FxTextComponent
        Gets the format pattern.
        Specified by:
        getPattern in interface FxTextComponent
        Returns:
        the format pattern
      • isLenient

        public boolean isLenient()
        Description copied from interface: FxTextComponent
        Returns whether parsing to model should be lenient.
        Specified by:
        isLenient in interface FxTextComponent
        Returns:
        true if lenient, false is default
      • setLenient

        public void setLenient​(boolean lenient)
        Description copied from interface: FxTextComponent
        Sets whether parsing to model should be lenient.
        Specified by:
        setLenient in interface FxTextComponent
        Parameters:
        lenient - true if lenient
      • setScale

        public void setScale​(int scale)
        Description copied from interface: FxTextComponent
        Changes the format according to the given scale.
        Specified by:
        setScale in interface FxTextComponent
        Parameters:
        scale - the number of digits after the comma
      • setUnsigned

        public void setUnsigned​(boolean unsigned)
        Description copied from interface: FxTextComponent
        Sets whether a numeric field is unsigned or signed.
        Specified by:
        setUnsigned in interface FxTextComponent
        Parameters:
        unsigned - true if unsigned
      • isUnsigned

        public boolean isUnsigned()
        Description copied from interface: FxTextComponent
        Returns whether a numeric field is unsigned or signed.
        Specified by:
        isUnsigned in interface FxTextComponent
        Returns:
        true if unsigned
      • setUTC

        public void setUTC​(boolean utc)
        Description copied from interface: FxTextComponent
        Sets whether this is a UTC timestamp.
        Specified by:
        setUTC in interface FxTextComponent
        Parameters:
        utc - true if UTC
      • isUTC

        public boolean isUTC()
        Description copied from interface: FxTextComponent
        Returns whether this is a UTC timestamp.
        Specified by:
        isUTC in interface FxTextComponent
        Returns:
        true if UTC
      • setFiller

        public void setFiller​(char filler)
        Description copied from interface: FxTextComponent
        Sets the filler character.
        The default is space.
        Specified by:
        setFiller in interface FxTextComponent
        Parameters:
        filler - the filler
      • setTextAlignment

        public void setTextAlignment​(javafx.geometry.Pos textAlignment)
        Description copied from interface: FxTextComponent
        Sets the text alignment.
        Specified by:
        setTextAlignment in interface FxTextComponent
        Parameters:
        textAlignment - the alignment, null if component's default
      • getTextAlignment

        public javafx.geometry.Pos getTextAlignment()
        Description copied from interface: FxTextComponent
        Gets the text alignment.
        Specified by:
        getTextAlignment in interface FxTextComponent
        Returns:
        the alignment, null if component's default
      • setValidChars

        public void setValidChars​(java.lang.String validChars)
        Description copied from interface: FxTextComponent
        Sets allowed characters.
        Specified by:
        setValidChars in interface FxTextComponent
        Parameters:
        validChars - the valid characters, null = all (default)
      • getValidChars

        public java.lang.String getValidChars()
        Description copied from interface: FxTextComponent
        Gets allowed characters.
        Specified by:
        getValidChars in interface FxTextComponent
        Returns:
        the valid characters, null = all (default)
      • setInvalidChars

        public void setInvalidChars​(java.lang.String invalidChars)
        Description copied from interface: FxTextComponent
        Sets invalid characters.
        Specified by:
        setInvalidChars in interface FxTextComponent
        Parameters:
        invalidChars - the invalid characters, null = none (default)
      • getInvalidChars

        public java.lang.String getInvalidChars()
        Description copied from interface: FxTextComponent
        Gets invalid characters.
        Specified by:
        getInvalidChars in interface FxTextComponent
        Returns:
        the invalid characters, null = none (default)
      • setTextConverter

        public void setTextConverter​(java.util.function.Function<java.lang.String,​java.lang.String> textConverter)
        Description copied from interface: FxTextComponent
        Sets a text converter.
        Converts input text to the view's text.
        Specified by:
        setTextConverter in interface FxTextComponent
        Parameters:
        textConverter - the converter
      • getTextConverter

        public java.util.function.Function<java.lang.String,​java.lang.String> getTextConverter()
        Description copied from interface: FxTextComponent
        Gets the text converter.
        Specified by:
        getTextConverter in interface FxTextComponent
        Returns:
        the converter
      • setErrorOffset

        public void setErrorOffset​(java.lang.Integer errorOffset)
        Description copied from interface: FxTextComponent
        Sets the error offset.
        Specified by:
        setErrorOffset in interface FxTextComponent
        Parameters:
        errorOffset - null to clear
      • getErrorOffset

        public java.lang.Integer getErrorOffset()
        Description copied from interface: FxTextComponent
        Gets the error offset.
        Specified by:
        getErrorOffset in interface FxTextComponent
        Returns:
        the offset, null if no offset
      • mapErrorOffsetToCaretPosition

        public void mapErrorOffsetToCaretPosition()
        Description copied from interface: FxTextComponent
        Sets the caret position according to the error offset.
        Does nothing if error offset is null.
        Specified by:
        mapErrorOffsetToCaretPosition in interface FxTextComponent