Всплывающие подсказки в JavaFX

Накопилась куча материала (кое-что годится на полноценную статью, а что-то просто может забиться).

Буду понемногу выкладывать, чтобы не хранить на бумаге.
Итак, всплывающие подсказки в JavaFx.
В давние времена, когда приложения оставались десктопными, окошечки под Win­dows было удобней всего рисовать с помощью библиотеки VCL, той самой, которая жила внутри Del­phi. Конечно, кто-то писал на MFC в тогда ещё доисторической Visu­al Stu­dio, кто-то был вынужден поддерживать проекты на OWL, а отдельные маньяки — даже на голом WinAPI, но их мы трогать не будем. И ещё не будем трогать тех, кто писал на VCL для Unix-ов (помните Kylix? А он был!)
Итак, внутри Del­phi жил VCL. Если вы писали на C++Builder, он там тоже был. И дополнял C++ своей уникальной String, а также списками, которые начинались с 1.
И почти у всех визуальных компонент были свойства ShowHint и Hint. В Hint писался текст подсказки, а ShowHint мог её отключить. А более прокачанные даже знали, что можно сделать расширенный вариант подсказки. Если написать “Нажми меня|Кнопка просит, чтобы вы её нажали”, то левая часть всплывёт, а правая будет передана сообщением, которое можно перехватить и вывести, например, в Sta­tus Bar.
Но пришла новая эра, VCL ушёл в историю, а у нас теперь, к примеру, кроссплатформенный JavaFX. И никакого свойства Hint у его компонентов нет. И sta­tus bar-а среди компонентов тоже нет. Такие дела.
Что же делать?
Для подсказок всплывающих есть невидимый для SceneB­uilder компонент Tooltip, который отвечает за всплывающие подсказки. Если его создать, а потом привязать через set­Tooltip, то при наведении курсора мы и правда увидим подсказку (на чёрном фоне, но так надо).
Но при этом свойство Tooltip (и соответствующие методы) есть только у наследников класса javafx.scene.control.Control. А все панели и прочие области наследуются от javafx.scene.layout.Region. И никаких подсказок на них всплывать не может.
К тому же, разумеется, мы по прежнему не приблизились к Sta­tus­Bar-у. Придётся писать всё своими руками.
Сначала класс привязки, который хранит ссылку на элемент управления и текст, который к нему относится:
ATooltipHintItem.java
import javafx.scene.Node;

/**
* Базовый класс для элемента подсказки. Связывает вместе компонент и
* текст подсказки.
*
* Cre­at­ed by a.teut on 18.03.15.
*/
pub­lic abstract class ATooltipHintItem<N> {
pri­vate N attachedNode;
pro­tect­ed void setAttachedNode(N node) {
attachedNode = node;
}
pub­lic N getAt­tachedNode() {
return attachedNode;
}

pri­vate String sta­tus­BarHint;
pro­tect­ed void setStatusBarHint(String hint){
sta­tus­BarHint = hint;
}
pub­lic String get­Sta­tus­BarHint(){
return sta­tus­BarHint;
}

pri­vate ITooltipHint­Con­troller tooltipHint­Con­troller;
pub­lic ITooltipHint­Con­troller get­TooltipHint­Con­troller() {
return tooltipHint­Con­troller;
}

pub­lic void show­Sta­tus­BarHint(){
tooltipHintController.setStatusBarText(statusBarHint);
}

pub­lic ATooltipHintItem(N attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint) {
this.attachedNode = attachedNode;
this.tooltipHintController = tooltipHint­Con­troller;

if(statusBarHint != null && sta­tus­BarHint != “”){
init­Sta­tus­Bar();
this.setStatusBarHint(statusBarHint);
}
}

pri­vate void init­Sta­tus­Bar() {
getAttachedNode().setOnMouseEntered(observableValue -> {
this.showStatusBarHint();
});

getAttachedNode().setOnMouseExited(observableValue -> {
getTooltipHintController().setDefaultStatusBarText();
});
}
}

Теперь реализация для Region:

TooltipHintRegionItem.java

import javafx.scene.layout.Region;

/**
* Реализация для компонент, унаследованных от Region. Всплывающие подсказки
* прицепить нельзя.
*
* Cre­at­ed by a.teut on 18.03.15.
*/
pub­lic final class TooltipHin­tRe­gion­Item extends ATooltipHintItem<Region>{
pub­lic TooltipHintRegionItem(Region attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint) {
super(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint);
}
}

А у Con­trol могут быть Tooltip-ы:

TooltipHintRegionItem.java

import javafx.scene.control.Control;
import javafx.scene.control.Tooltip;
import javafx.scene.image.Image;
import javafx.scene.image.ImageView;

/**
* Реализация для компонент, унаследованных от Con­trol. Можно делать и всплывающие подсказки.
*
* Cre­at­ed by a.teut on 18.03.15.
*/

/**
* Реализация для компонент, унаследованных от Con­trol. Можно делать и всплывающие подсказки.
*
* Cre­at­ed by a.teut on 18.03.15.
*/
pub­lic final class TooltipHint­Con­tro­lItem extends ATooltipHintItem<Control> {
pri­vate Tooltip tooltip;
pub­lic Tooltip get­Tooltip() {
return tooltip;
}

pri­vate String tooltipHint;
pub­lic TooltipHint­Con­tro­lItem setTooltipHint(String hint){
tooltipHint = hint;
if(tooltip == null) {
init­Tooltip();
}
tooltip.setText(hint);
return this;
}
pub­lic String get­TooltipHint(){
return tooltipHint;
}

pri­vate Image tooltip­Im­age;
pub­lic TooltipHint­Con­tro­lItem setTooltipImage(Image image){
tooltip­Im­age = image;
tooltip.setGraphic((image != null) ? new ImageView(image) : null);
return this;
}
pub­lic Image get­Tooltip­Im­age(){
return tooltip­Im­age;
}

pub­lic TooltipHintControlItem(Control attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint, String tooltipHint, Image image­Hint) {
super(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint);
if(tooltipHint != null && tooltipHint != “”){
init­Tooltip();
}
setTooltipHint(tooltipHint);

if(imageHint == null) {
setTooltipImage(imageHint);
}
}

pub­lic TooltipHintControlItem(Control attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint, String tooltipHint) {
this(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint, tooltipHint, null);
}

pub­lic TooltipHintControlItem(Control attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint) {
this(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint, null, null);
}

pri­vate void init­Tooltip() {
tooltip = new Tooltip();
getAttachedNode().setTooltip(tooltip);
}
pub­lic Image get­Tooltip­Im­age(){
return tooltip­Im­age;
}

pub­lic TooltipHintControlItem(Control attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint, String tooltipHint) {
super(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint);
if(tooltipHint != null && tooltipHint != “”){
init­Tooltip();
}
setTooltipHint(tooltipHint);
}

pub­lic TooltipHintControlItem(Control attachedNode, ITooltipHint­Con­troller tooltipHint­Con­troller, String sta­tus­BarHint) {
this(attachedNode, tooltipHint­Con­troller, sta­tus­BarHint, null);
}

pri­vate void init­Tooltip() {
tooltip = new Tooltip();
getAttachedNode().setTooltip(tooltip);
}
}

Теперь распишем интерфейс, который их вызывает:
ITooltipHintController.java

/**
 * Функции контроллера, которые вызывают сами элементы привязок.
 *
 * Created by a.teut on 18.03.15.
 */
public interface ITooltipHintController {
    void setStatusBarText(String text);
    String getStatusBarText();
    void setDefaultStatusBarText();
}

И, наконец, контроллер:

TooltipHintController.java

import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.scene.Node;
import javafx.scene.control.Control;
import javafx.scene.control.Labeled;
import javafx.scene.image.Image;
import javafx.scene.layout.Region;

import java.util.ArrayList;
import java.util.Iterator;

/**
* Контроллер подсказок. Хранит привязки подсказок к компонентом и, если нужно,
* всплывающие подсказки.
*
* Как правило, один на всё приложение.
*
* Cre­at­ed by a.teut on 18.03.15.
*/
pub­lic final class TooltipHint­Con­troller imple­ments ITooltipHint­Con­troller {
pri­vate final String Default­Sta­tus­Bar­Text = “”;
pri­vate final Labeled sta­tus­Bar­Con­trol;
pri­vate final ObservableList<ATooltipHintItem> tooltipHin­tItems;

pri­vate boolean isSta­tus­Bar­Locked = false;
pub­lic boolean getIs­Sta­tus­Bar­Locked() {
return isSta­tus­Bar­Locked;
}
pub­lic void setIsStatusBarLocked(boolean isSta­tus­Bar­Locked) {
this.isStatusBarLocked = isSta­tus­Bar­Locked;
}

pub­lic Labeled get­Sta­tus­Bar­Con­trol() {
return this.statusBarControl;
}

pub­lic void setStatusBarTextForce(String text) {
statusBarControl.setText(text);
}
@Override
pub­lic void setStatusBarText(String text) {
if(!isStatusBarLocked){
setStatusBarTextForce(text);
}
}
@Override
pub­lic String get­Sta­tus­Bar­Text() {
return statusBarControl.getText();
}
@Override
pub­lic void set­De­fault­Sta­tus­Bar­Text(){
setStatusBarTextForce(DefaultStatusBarText);
}

//тут есть дублирование кода, но пока ничего серьёзного
pub­lic void addTooltipHint(Region region, String sta­tus­BarHint){
// Tooltip нас не интересует — у регионов в JavaFX не бывает всплывающих подсказок
ATooltipHin­tItem tooltipHin­tItem = findTooltipHint(region);
if(tooltipHintItem == null) {
tooltipHin­tItem = new TooltipHintRegionItem(region, this, sta­tus­BarHint);
tooltipHintItems.add(tooltipHintItem);
} else {
TooltipHint­Con­tro­lItem tooltipHint­Con­tro­lItem = (TooltipHintControlItem)tooltipHintItem;
if(statusBarHint != null && tooltipHintControlItem.getStatusBarHint() == null)
tooltipHintControlItem.setStatusBarHint(statusBarHint);
}
}

pub­lic void addTooltipHint(Control con­trol, String sta­tus­BarHint){
addTooltipHint(control, sta­tus­BarHint, null, null);
}

pub­lic void addTooltipHint(Control con­trol, String sta­tus­BarHint, String tooltipHint){
addTooltipHint(control, sta­tus­BarHint, tooltipHint, null);
}

pub­lic void addTooltipHint(Control con­trol, String sta­tus­BarHint, String tooltipHint, Image image){
ATooltipHin­tItem tooltipHin­tItem = findTooltipHint(control);
if(tooltipHintItem == null) {
tooltipHin­tItem = new TooltipHintControlItem(control, this, sta­tus­BarHint, tooltipHint, image);
tooltipHintItems.add(tooltipHintItem);
} else {
TooltipHint­Con­tro­lItem tooltipHint­Con­tro­lItem = (TooltipHintControlItem)tooltipHintItem;
if(statusBarHint != null && tooltipHintControlItem.getStatusBarHint() == null)
tooltipHintControlItem.setStatusBarHint(statusBarHint);

if(tooltipHint != null && tooltipHintControlItem.getTooltipHint() == null)
tooltipHintControlItem.setTooltipHint(tooltipHint);

if(image != null && tooltipHintControlItem.getTooltipImage() == null)
tooltipHintControlItem.setTooltipImage(image);
}
}

pub­lic void removeTooltipHint(Node con­trol){
ATooltipHin­tItem tooltipHin­tItem = null;
Iterator<ATooltipHintItem> iter­a­tor­TooltipHin­tItems = tooltipHintItems.iterator();
while(iteratorTooltipHintItems.hasNext()){
tooltipHin­tItem = iteratorTooltipHintItems.next();
if(tooltipHintItem.getAttachedNode() == con­trol){
tooltipHintItems.remove(tooltipHintItem);
break;
}
}
}

pub­lic ATooltipHin­tItem findTooltipHint(Node con­trol){
for(ATooltipHintItem tooltipHin­tItem : tooltipHin­tItems)
if(tooltipHintItem.getAttachedNode() == con­trol)
return tooltipHin­tItem;
return null;
}

/**
* При создании нужно привязать контроллер к компоненту, который будет
* показывать подсказки.
*
* @param sta­tus­Bar­Con­trol Компонент для подсказок
*/

pub­lic TooltipHintController(Labeled sta­tus­Bar­Con­trol){
if(statusBarControl == null) {
throw new NullPointerException(“Unable to cre­ate TooltipHint­Con­troller. sta­tus­Bar­Con­trol can’t be null.”);
}

this.statusBarControl = sta­tus­Bar­Con­trol;
tooltipHin­tItems = FXCollections.observableList(new ArrayList<>());
}

pri­vate sta­t­ic TooltipHint­Con­troller main­In­stance;
pub­lic sta­t­ic TooltipHint­Con­troller get­Main­In­stance() {
if(mainInstance == null){
throw new NullPointerException(“Main instance of TooltipHint­Con­troller isn’t ini­tialised.”);
}

return main­In­stance;
}
pub­lic sta­t­ic void setMainInstance(TooltipHintController tooltipHint­Con­troller) {
main­In­stance = tooltipHint­Con­troller;
}
}

Чтобы заработало, надо инициализировать контроллер тем самым элементом, в который надо отображать подсказки:

TooltipHintController.setMainInstance(new TooltipHintController(labelStatusBar));

И привязываем к компонентам:

TooltipHintController.getMainInstance().addTooltipHint(buttonStart, "Нажми меня", "Нажми эту кнопку");
TooltipHintController.getMainInstance().addTooltipHint(paneButtons, "Здесь нажимают");

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *