DockPane

Дескриптор отдельной панели докинга, содержащей виджет содержимого, заголовок вкладки, иконку, признак несохраненных правок и стражи закрытия.

Обзор

DockPane представляет отдельную панель докинга с произвольным содержимым.

Возможности

• Настройка заголовка: Обычный текст, форматированный заголовок RichText и иконка (icon()).
• Признак изменений: dirty(true) отображает индикатор несохраненных правок (точку или маркер).
• Защита от закрытия: onCloseRequested(guard) предотвращает случайное закрытие до подтверждения пользователем.
• Классификация: Настраивается как DOCUMENT или TOOL.

Создание панелей документов и инструментов

DockPane doc = DockPane.document("main-editor", "Main.java", editorWidget)
        .dirty(true)
        .closable(true);

Связанные ссылки

• DockPaneKind: Классификация панели докинга: DOCUMENT (основное содержимое рабочей области) или TOOL (вспомогательное инструментальное окно).
• DockingRoot: Корневой визуальный виджет системы докинга IDE, объединяющий узлы дерева, полосы вкладок, разделители, предпросмотр сброса и отрыв в плавающие окна.

API

DockPane(String, RichText, Widget)

Создает панель докинга с явным идентификатором, форматированным заголовком RichText и содержимым.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	RichText	Форматированный заголовок панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

DockPane(String, String, Widget)

Создает панель с идентификатором, заголовком и виджетом содержимого.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	String	Текст заголовка панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

DockPane(String, Widget)

Создает панель докинга со сгенерированным уникальным идентификатором.

Параметр	Тип	Описание
title	String	Текст заголовка панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

DockPane::autoHide()

Проверяет, включено ли автоматическое сворачивание панели при потере фокуса.

Возвращает boolean: True, если автоскрытие включено..

DockPane::autoHide(boolean)

Настраивает автоматическое сворачивание панели.

Параметр	Тип	Описание
autoHide	boolean	Сворачивается ли панель автоматически при потере фокуса.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::canClose()

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

Возвращает boolean: True, если закрытие одобрено стражем; иначе false..

DockPane::closable()

Проверяет, отображает ли панель кнопку закрытия и разрешено ли ее закрытие.

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

DockPane::closable(boolean)

Настраивает возможность закрытия панели пользователем.

Параметр	Тип	Описание
closable	boolean	Можно ли закрыть панель.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::content()

Возвращает виджет содержимого, размещенный внутри панели.

Возвращает Widget: Виджет, размещенный внутри данной панели..

DockPane::dirty()

Проверяет, содержит ли панель несохраненные изменения данных.

Возвращает boolean: True, если панель содержит несохраненные изменения..

DockPane::dirty(boolean)

Задает признак наличия несохраненных изменений в панели.

Параметр	Тип	Описание
dirty	boolean	Имеет ли панель несохраненные изменения.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::document()

Проверяет, классифицирована ли данная панель как документ рабочей области.

Возвращает boolean: True, если тип панели — DOCUMENT..

DockPane::document(String, RichText, Widget)

Создает документную панель с форматированным заголовком RichText.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	RichText	Форматированный заголовок панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

Возвращает DockPane: Созданный экземпляр панели DockPane..

DockPane::document(String, String, Widget)

Создает документную панель со строковым заголовком.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	String	Текст заголовка панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

Возвращает DockPane: Созданный экземпляр панели DockPane..

DockPane::icon()

Возвращает иконку вкладки панели или null.

Возвращает UiIcon: Иконка в заголовке вкладки или null..

DockPane::icon(UiIcon)

Задает иконку вкладки панели.

Параметр	Тип	Описание
icon	UiIcon	Иконка, отображаемая в заголовке вкладки.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::id()

Возвращает уникальный строковый идентификатор панели.

Возвращает String: Уникальная строка-идентификатор панели..

DockPane::kind()

Возвращает классификацию типа панели (DOCUMENT или TOOL).

Возвращает DockPaneKind: Тип панели (DOCUMENT или TOOL)..

DockPane::kind(DockPaneKind)

Задает классификацию типа панели.

Параметр	Тип	Описание
kind	DockPaneKind	Классификация типа панели (DOCUMENT или TOOL).

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::onCloseRequested(Predicate)

Регистрирует предикат-страж, подтверждающий закрытие панели (например, для проверки несохраненных правок).

Параметр	Тип	Описание
guard	Predicate	Предикат-страж, подтверждающий или отклоняющий закрытие панели.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::pinned()

Проверяет, закреплена ли вкладка панели в начале полосы вкладок.

Возвращает boolean: True, если панель закреплена во вкладках..

DockPane::pinned(boolean)

Настраивает закрепление вкладки панели.

Параметр	Тип	Описание
pinned	boolean	Закреплена ли панель во вкладках.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::richTitle()

Возвращает форматированный заголовок RichText или null.

Возвращает RichText: Форматированный заголовок панели или null..

DockPane::richTitle(RichText)

Задает форматированный заголовок RichText для панели.

Параметр	Тип	Описание
title	RichText	Форматированный заголовок панели.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::title()

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

Возвращает String: Строка текстового заголовка панели..

DockPane::title(String)

Задает обычный строковый заголовок для панели.

Параметр	Тип	Описание
title	String	Текст заголовка панели.

Возвращает DockPane: Данный экземпляр DockPane для цепочки вызовов..

DockPane::tool()

Проверяет, классифицирована ли данная панель как вспомогательный инструмент.

Возвращает boolean: True, если тип панели — TOOL..

DockPane::tool(String, RichText, Widget)

Создает инструментальную панель с форматированным заголовком RichText.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	RichText	Форматированный заголовок панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

Возвращает DockPane: Созданный экземпляр панели DockPane..

DockPane::tool(String, String, Widget)

Создает инструментальную панель со строковым заголовком.

Параметр	Тип	Описание
id	String	Уникальный идентификатор панели.
title	String	Текст заголовка панели.
content	Widget	Виджет содержимого, отображаемый внутри панели.

Возвращает DockPane: Созданный экземпляр панели DockPane..