Spec-Zone.ru › OpenJDK 25

Класс ToolTipManager

java.lang.Object
java.awt.event.MouseAdapter
javax.swing.ToolTipManager
Все реализуемые интерфейсы:
MouseListener, MouseMotionListener, MouseWheelListener, EventListener
public final class ToolTipManager extends MouseAdapter implements MouseMotionListener
Управляет всеми ToolTips в системе.

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, если этот объект включён.
boolean isLightWeightPopupEnabled()
Возвращает true, если используются легковесные Tooltips (полностью реализованные на Java), или false, если используются тяжеловесные Tooltips (с нативным узлом).
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 ToolTipManager предпочитает использовать легковесный JPanel, если он помещается.
void setReshowDelay(int milliseconds)
Задаёт время ожидания пользователя в initialDelay миллисекунд до отображения подсказки.
static ToolTipManager sharedInstance()
Возвращает общий экземпляр ToolTipManager.
void unregisterComponent(JComponent component)
Удаляет компонент из управления подсказками.

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

mouseClicked, mouseReleased, mouseWheelMoved

Методы, объявленные в классе 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, если используются легковесные Tooltips (полностью реализованные на Java), или false, если используются тяжеловесные 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 — соответствующее событие

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.desktop/javax/swing/ToolTipManager.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API