Class LabelTips

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.Label
com.imyeyu.fx.ui.components.LabelTips
All Implemented Interfaces:
TimiFXUI.Colorful, javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class LabelTips extends javafx.scene.control.Label implements TimiFXUI.Colorful
提示标签，可以临时显示提示内容，经过指定时间后自动恢复原内容。

此组件是线程安全的，可以从任意线程调用 tips(String) 方法。 如果在提示期间再次调用 tips 方法，会重置计时器并显示新的提示内容， 恢复时仍然恢复为最初的原始内容。 

LabelTips label = new LabelTips("默认内容");
label.tips("操作成功！");           // 使用默认 3 秒
label.tips("保存完成！", 5000);     // 指定 5 秒
Since:
2025-01-14
Author:
夜雨

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.LongProperty
    duration
    获取持续时间属性

    Properties inherited from class javafx.scene.control.Label

    labelFor

    Properties inherited from class javafx.scene.control.Labeled

    alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, textTruncated, 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
    Modifier and Type
    Field
    Description
    static final long
    DEFAULT_DURATION
    默认提示持续时间（毫秒）
    protected javafx.beans.property.LongProperty
    duration
    提示持续时间（毫秒）
    static final javafx.scene.paint.Paint
    ERROR_TEXT_FILL
    错误提示颜色
    static final javafx.scene.paint.Paint
    INFO_TEXT_FILL
    信息提示颜色
    static final javafx.scene.paint.Paint
    WARN_TEXT_FILL
    警告提示颜色

    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

    Fields inherited from interface TimiFXUI.Colorful

    BLACK, BLUE, BORDER, BROWN, DARK_GRAY, DARK_GREEN, FOCUSED_DARK, FOCUSED_DEFAULT, FOCUSED_LIGHT, GRAY, GRAY_WHITE, GREEN, ICON, ICON_DISABLED, ICON_HOVER, LIGHT_BLUE, LIGHT_GRAY, ORANGE, PINK, RED, TRANSPARENT, WHITE, YELLOW

  • Constructor Summary

    Constructors
    Constructor
    Description
    LabelTips()
    默认构造器
    LabelTips(String text)
    标准构造器

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.LongProperty
    durationProperty()
    获取持续时间属性
    void
    error(String content)
    显示错误提示内容，使用默认持续时间
    void
    error(String content, long millis)
    显示错误提示内容，指定持续时间
    void
    error(String content, javafx.util.Duration duration)
    显示错误提示内容，指定持续时间
    long
    getDuration()
    获取默认提示持续时间
    void
    info(String content)
    显示信息提示内容，使用默认持续时间
    void
    info(String content, long millis)
    显示信息提示内容，指定持续时间
    void
    info(String content, javafx.util.Duration duration)
    显示信息提示内容，指定持续时间
    boolean
    isTipping()
    检查当前是否正在显示提示
    void
    restore()
    立即恢复原始内容，取消正在进行的提示
    void
    setDuration(long millis)
    设置默认提示持续时间
    void
    tips(String content)
    显示提示内容，使用默认持续时间
    void
    tips(String content, long millis)
    显示提示内容，指定持续时间
    void
    tips(String content, javafx.util.Duration duration)
    显示提示内容，指定持续时间
    void
    tips(String content, javafx.util.Duration duration, javafx.scene.paint.Paint textFill)
    显示提示内容，指定持续时间与颜色
    void
    warn(String content)
    显示警告提示内容，使用默认持续时间
    void
    warn(String content, long millis)
    显示警告提示内容，指定持续时间
    void
    warn(String content, javafx.util.Duration duration)
    显示警告提示内容，指定持续时间

    Methods inherited from class javafx.scene.control.Label

    createDefaultSkin, getInitialFocusTraversable, getLabelFor, labelForProperty, setLabelFor

    Methods inherited from class javafx.scene.control.Labeled

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

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, 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, requestFocusTraversal, 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 Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • duration

      public javafx.beans.property.LongProperty durationProperty
      获取持续时间属性
      See Also:

  • Field Details

    • DEFAULT_DURATION

      public static final long DEFAULT_DURATION
      默认提示持续时间（毫秒）
      See Also:

    • INFO_TEXT_FILL

      public static final javafx.scene.paint.Paint INFO_TEXT_FILL
      信息提示颜色

    • WARN_TEXT_FILL

      public static final javafx.scene.paint.Paint WARN_TEXT_FILL
      警告提示颜色

    • ERROR_TEXT_FILL

      public static final javafx.scene.paint.Paint ERROR_TEXT_FILL
      错误提示颜色

    • duration

      protected javafx.beans.property.LongProperty duration
      提示持续时间（毫秒）

  • Constructor Details

    • LabelTips

      public LabelTips()
      默认构造器

    • LabelTips

      public LabelTips(String text)
      标准构造器
      Parameters:
      text - 标签初始文本

  • Method Details

    • tips

      public void tips(String content)
      显示提示内容，使用默认持续时间
      Parameters:
      content - 提示内容

    • tips

      public void tips(String content, long millis)
      显示提示内容，指定持续时间
      Parameters:
      content - 提示内容
      millis - 持续时间（毫秒）

    • tips

      public void tips(String content, javafx.util.Duration duration)
      显示提示内容，指定持续时间
      Parameters:
      content - 提示内容
      duration - 持续时间

    • tips

      public void tips(String content, javafx.util.Duration duration, javafx.scene.paint.Paint textFill)
      显示提示内容，指定持续时间与颜色
      Parameters:
      content - 提示内容
      duration - 持续时间
      textFill - 文本颜色

    • info

      public void info(String content)
      显示信息提示内容，使用默认持续时间
      Parameters:
      content - 提示内容

    • info

      public void info(String content, long millis)
      显示信息提示内容，指定持续时间
      Parameters:
      content - 提示内容
      millis - 持续时间（毫秒）

    • info

      public void info(String content, javafx.util.Duration duration)
      显示信息提示内容，指定持续时间
      Parameters:
      content - 提示内容
      duration - 持续时间

    • warn

      public void warn(String content)
      显示警告提示内容，使用默认持续时间
      Parameters:
      content - 提示内容

    • warn

      public void warn(String content, long millis)
      显示警告提示内容，指定持续时间
      Parameters:
      content - 提示内容
      millis - 持续时间（毫秒）

    • warn

      public void warn(String content, javafx.util.Duration duration)
      显示警告提示内容，指定持续时间
      Parameters:
      content - 提示内容
      duration - 持续时间

    • error

      public void error(String content)
      显示错误提示内容，使用默认持续时间
      Parameters:
      content - 提示内容

    • error

      public void error(String content, long millis)
      显示错误提示内容，指定持续时间
      Parameters:
      content - 提示内容
      millis - 持续时间（毫秒）

    • error

      public void error(String content, javafx.util.Duration duration)
      显示错误提示内容，指定持续时间
      Parameters:
      content - 提示内容
      duration - 持续时间

    • restore

      public void restore()
      立即恢复原始内容，取消正在进行的提示

    • isTipping

      public boolean isTipping()
      检查当前是否正在显示提示
      Returns:
      如果正在显示提示返回 true

    • getDuration

      public long getDuration()
      获取默认提示持续时间
      Returns:
      持续时间（毫秒），默认 5000L

    • setDuration

      public void setDuration(long millis)
      设置默认提示持续时间
      Parameters:
      millis - 持续时间（毫秒）

    • durationProperty

      public javafx.beans.property.LongProperty durationProperty()
      获取持续时间属性
      Returns:
      持续时间属性