Класс ToolTipManager

java.lang.Object

java.awt.event.MouseAdapter

javax.swing.ToolTipManager

Все реализованные интерфейсы:: MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class ToolTipManager extends MouseAdapter implements MouseMotionListener

Управляет всеми всплывающими подсказками в системе.

ToolTipManager содержит множество свойств для настройки того, сколько времени потребуется, чтобы всплывающие подсказки стали видимыми, и сколько времени они будут отображаться. Рассмотрим компонент, у которого есть разные всплывающие подсказки в зависимости от положения курсора, например, JTree. Когда курсор попадает в JTree и на область, для которой определена валидная подсказка, подсказка станет видимой через initialDelay миллисекунд. После dismissDelay миллисекунд подсказка будет скрыта. Если курсор находится над областью, для которой определена валидная подсказка, и подсказка в данный момент видна, при перемещении курсора в область, для которой нет валидной подсказки, подсказка будет скрыта. Если затем курсор вернётся в область, для которой определена валидная подсказка в течение reshowDelay миллисекунд, подсказка будет показана немедленно, в противном случае подсказка будет показана снова через initialDelay миллисекунд.

С:

1.2

См. также:

JComponent.createToolTip()

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`ToolTipManager.insideTimerAction`	Действие внутри таймера.
`protected class`	`ToolTipManager.outsideTimerAction`	Действие вне таймера.
`protected class`	`ToolTipManager.stillInsideTimerAction`	Все еще внутри действия таймера.

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected boolean`	`heavyWeightPopupEnabled`	Всплывающие подсказки с тяжелым весом включены.
`protected boolean`	`lightWeightPopupEnabled`	Всплывающие подсказки со светлым весом включены.

Краткое описание методов

Модификатор и тип	Метод	Описание
`int`	`getDismissDelay()`	Возвращает значение задержки скрытия.
`int`	`getInitialDelay()`	Возвращает значение начальной задержки.
`int`	`getReshowDelay()`	Возвращает свойство задержки повторного показа.
`boolean`	`isEnabled()`	Возвращает true, если этот объект включён, иначе false.
`boolean`	`isLightWeightPopupEnabled()`	Возвращает true, если используются лёгкие (полностью Java) всплывающие подсказки, или false, если используются тяжёлые (нативные) всплывающие подсказки.
`void`	`mouseDragged(MouseEvent event)`	Вызывается при нажатии и перетаскивании мыши.
`void`	`mouseEntered(MouseEvent event)`	Вызывается при входе курсора в область компонента.
`void`	`mouseExited(MouseEvent event)`	Вызывается при выходе курсора из области компонента.
`void`	`mouseMoved(MouseEvent event)`	Вызывается при перемещении мыши.
`void`	`mousePressed(MouseEvent event)`	Вызывается при нажатии кнопки мыши.
`void`	`registerComponent(JComponent component)`	Регистрирует компонент для управления всплывающими подсказками.
`void`	`setDismissDelay(int milliseconds)`	Устанавливает значение задержки скрытия.
`void`	`setEnabled(boolean flag)`	Включает или отключает всплывающую подсказку.
`void`	`setInitialDelay(int milliseconds)`	Устанавливает значение начальной задержки.
`void`	`setLightWeightPopupEnabled(boolean aFlag)`	При отображении всплывающей подсказки, `JToolTip` выбирает использовать лёгкую `JPanel` подсказку, если это возможно.
`void`	`setReshowDelay(int milliseconds)`	Используется для указания времени ожидания перед отображением подсказки через `initialDelay` миллисекунд.
`static ToolTipManager`	`sharedInstance()`	Возвращает общий экземпляр `ToolTipManager`.
`void`	`unregisterComponent(JComponent component)`	Удаляет компонент из управления всплывающими подсказками.

Методы, объявленные в классе java.awt.event.MouseAdapter

mouseClicked, mouseReleased, mouseWheelMoved

Методы, объявленные в классе java.lang.Object

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

Подробное описание полей

lightWeightPopupEnabled

protected boolean lightWeightPopupEnabled

Включено лёгкое всплывающее окно.

heavyWeightPopupEnabled

protected boolean heavyWeightPopupEnabled

Включено тяжёлое всплывающее окно.

Подробное описание методов

setEnabled

public void setEnabled(boolean flag)

Включает или отключает подсказку.

Параметры:: flag - true для включения подсказки, иначе false

isEnabled

public boolean isEnabled()

Возвращает true, если объект включён.

Возвращает:: true, если объект включён, иначе false

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean aFlag)

При отображении JToolTip, ToolTipManager выбирает использование лёгкого JPanel если это подходит. Этот метод позволяет отключить эту функцию. Вам нужно отключить её, если ваше приложение смешивает лёгкие и тяжёлые компоненты.

Параметры:: aFlag - true, если требуется лёгкий компонент, иначе false

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()

Возвращает true, если используются лёгкие (все-Java) Tooltips или false, если используются тяжёлые (родной peer) Tooltips.

Возвращает:: true, если используются лёгкие ToolTips

setInitialDelay

public void setInitialDelay(int milliseconds)

Устанавливает значение начальной задержки.

Параметры:

milliseconds - количество миллисекунд задержки (после паузы курсора) перед отображением подсказки

См. также:

getInitialDelay()

getInitialDelay

public int getInitialDelay()

Возвращает значение начальной задержки.

Возвращает:

целое число, представляющее значение начальной задержки в миллисекундах

См. также:

setInitialDelay(int)

setDismissDelay

public void setDismissDelay(int milliseconds)

Устанавливает значение задержки скрытия.

Параметры:

milliseconds - количество миллисекунд задержки перед скрытием подсказки

См. также:

getDismissDelay()

getDismissDelay

public int getDismissDelay()

Возвращает значение задержки скрытия.

Возвращает:

целое число, представляющее значение задержки скрытия в миллисекундах

См. также:

setDismissDelay(int)

setReshowDelay

public void setReshowDelay(int milliseconds)

Устанавливает значение задержки повторного показа подсказки. Указывает время, после которого пользователь должен подождать initialDelay миллисекунд, прежде чем подсказка будет показана. То есть, если подсказка скрыта, а пользователь переходит в область того же компонента, имеющего допустимую подсказку в течение milliseconds миллисекунд, подсказка будет показана сразу. В противном случае, если пользователь переходит в область с допустимой подсказкой после milliseconds миллисекунд, пользователь должен будет подождать дополнительные initialDelay миллисекунд, прежде чем подсказка будет показана снова.

Параметры:

milliseconds - время в миллисекундах

См. также:

getReshowDelay()

getReshowDelay

public int getReshowDelay()

Возвращает свойство задержки повторного показа.

Возвращает:

свойство задержки повторного показа

См. также:

setReshowDelay(int)

sharedInstance

public static ToolTipManager sharedInstance()

Возвращает общий экземпляр ToolTipManager.

Возвращает:: объект общего экземпляра ToolTipManager

registerComponent

public void registerComponent(JComponent component)

Регистрирует компонент для управления подсказками.

Это зарегистрирует сочетания клавиш для отображения и скрытия текста подсказки только в том случае, если component имеет сочетания клавиш для фокуса. Это делается для того, чтобы компоненты, которые обычно не являются доступными для перехода по фокусу, такие как JLabel, не делались доступными для перехода по фокусу в результате вызова этого метода.

Параметры:

component - объект JComponent для добавления

См. также:

Component.isFocusTraversable()

unregisterComponent

public void unregisterComponent(JComponent component)

Удаляет компонент из управления подсказками.

Параметры:: component - объект JComponent для удаления

mouseEntered

public void mouseEntered(MouseEvent event)

Вызывается при входе мыши в область компонента. Это определяет, следует ли отображать подсказку.

Определено в:: mouseEntered в интерфейсе MouseListener
Параметры:: event - соответствующее событие

mouseExited

public void mouseExited(MouseEvent event)

Вызывается при выходе мыши из области компонента. Любая отображаемая подсказка должна быть скрыта.

Определено в:: mouseExited в интерфейсе MouseListener
Параметры:: event - соответствующее событие

mousePressed

public void mousePressed(MouseEvent event)

Вызывается при нажатии кнопки мыши. Любая отображаемая подсказка должна быть скрыта.

Определено в:: mousePressed в интерфейсе MouseListener
Параметры:: event - соответствующее событие

mouseDragged

public void mouseDragged(MouseEvent event)

Вызывается при нажатии и перетаскивании мыши. Ничего не делает.

Определено в:: mouseDragged в интерфейсе MouseMotionListener
Переопределяет:: mouseDragged в классе MouseAdapter
Параметры:: event - соответствующее событие

mouseMoved

public void mouseMoved(MouseEvent event)

Вызывается при перемещении мыши. Определяет, следует ли отображать подсказку.

Определено в:: mouseMoved в интерфейсе MouseMotionListener
Переопределяет:: mouseMoved в классе MouseAdapter
Параметры:: event - соответствующее событие

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/ToolTipManager.html