Класс DefaultTreeCellEditor

java.lang.Object

javax.swing.tree.DefaultTreeCellEditor

Все реализованные интерфейсы:: ActionListener, EventListener, CellEditor, TreeSelectionListener, TreeCellEditor

public class DefaultTreeCellEditor extends Object implements ActionListener, TreeCellEditor, TreeSelectionListener

Редактор ячеек дерева по умолчанию. Вам необходимо предоставить экземпляр DefaultTreeCellRenderer, чтобы получить иконки. Вы можете необязательно предоставить TreeCellEditor, который будет размещен в соответствии с иконкой в DefaultTreeCellRenderer. Если вы не предоставите TreeCellEditor, будет использован TextField. Редактирование начинается при тройном щелчке или после щелчка, паузы, щелчка и задержки в 1200 миллисекунд.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans добавлена в пакет java.beans. См. XMLEncoder.

См. также:

JTree

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

Модификатор и тип	Класс	Описание
`class`	`DefaultTreeCellEditor.DefaultTextField`	`TextField` используется, когда редактор не указан.
`class`	`DefaultTreeCellEditor.EditorContainer`	Контейнер, отвечающий за размещение `editingComponent`.

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

Модификатор и тип	Поле	Описание
`protected Color`	`borderSelectionColor`	Истина, если должна быть нарисована граница выделения.
`protected boolean`	`canEdit`	С версии Java 2 платформы v1.4 это поле больше не должно использоваться.
`protected Component`	`editingComponent`	Компонент, используемый при редактировании, полученный из `editingContainer`.
`protected Container`	`editingContainer`	Контейнер редактирования, будет содержать `editorComponent`.
`protected Icon`	`editingIcon`	Иконка, используемая при редактировании.
`protected Font`	`font`	Шрифт для рисования, `null` указывает на использование шрифта рендерера.
`protected TreePath`	`lastPath`	Последний путь, который был выбран.
`protected int`	`lastRow`	Строка, которая была последней передана в `getTreeCellEditorComponent`.
`protected int`	`offset`	Используется при редактировании.
`protected TreeCellEditor`	`realEditor`	Редактор, обрабатывающий редактирование.
`protected DefaultTreeCellRenderer`	`renderer`	Рендерер, используемый для получения границы и смещений.
`protected Timer`	`timer`	Используется перед началом сессии редактирования.
`protected JTree`	`tree`	`JTree` экземпляр, который также прослушивает.

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

Конструктор	Описание
`DefaultTreeCellEditor(JTree tree, DefaultTreeCellRenderer renderer)`	Создаёт объект `DefaultTreeCellEditor` для JTree с указанным рендерером и редактором по умолчанию.
`DefaultTreeCellEditor(JTree tree, DefaultTreeCellRenderer renderer, TreeCellEditor editor)`	Создаёт объект `DefaultTreeCellEditor` для `JTree` с указанным рендерером и указанным редактором.

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

Модификатор и тип	Метод	Описание
`void`	`actionPerformed(ActionEvent e)`	Вызывается при срабатывании таймера, это инициирует сессию редактирования.
`void`	`addCellEditorListener(CellEditorListener l)`	Добавляет `CellEditorListener`.
`void`	`cancelCellEditing()`	Отправляет сообщение `cancelCellEditing` в `realEditor` и удаляет его из этого экземпляра.
`protected boolean`	`canEditImmediately(EventObject event)`	Возвращает true, если `event` является `null`, или это `MouseEvent` со счётчиком щелчков > 2 и `inHitRegion` возвращает true.
`protected Container`	`createContainer()`	Создаёт контейнер для управления размещением `editingComponent`.
`protected TreeCellEditor`	`createTreeCellEditor()`	Вызывается, если в конструкторе не предоставлен `TreeCellEditor`.
`protected void`	`determineOffset(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)`	Определяет смещение.
`Color`	`getBorderSelectionColor()`	Возвращает цвет, которым нарисована граница.
`CellEditorListener[]`	`getCellEditorListeners()`	Возвращает массив всех `CellEditorListener` объектов, добавленных в этот DefaultTreeCellEditor с помощью addCellEditorListener().
`Object`	`getCellEditorValue()`	Возвращает значение, которое сейчас редактируется.
`Font`	`getFont()`	Получает шрифт, используемый для редактирования.
`Component`	`getTreeCellEditorComponent(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)`	Настраивает редактор.
`protected boolean`	`inHitRegion(int x, int y)`	Возвращает true, если переданное местоположение является допустимым местоположением для начала редактирования.
`boolean`	`isCellEditable(EventObject event)`	Если `realEditor` возвращает true для этого сообщения, `prepareForEditing` получает сообщение и возвращается true.
`protected void`	`prepareForEditing()`	Вызывается непосредственно перед началом редактирования.
`void`	`removeCellEditorListener(CellEditorListener l)`	Удаляет ранее добавленный `CellEditorListener`.
`void`	`setBorderSelectionColor(Color newColor)`	Устанавливает цвет для использования в границе.
`void`	`setFont(Font font)`	Устанавливает шрифт для редактирования.
`protected void`	`setTree(JTree newTree)`	Устанавливает дерево, для которого выполняется редактирование.
`boolean`	`shouldSelectCell(EventObject event)`	Отправляет сообщение `realEditor` для возвращаемого значения.
`protected boolean`	`shouldStartEditingTimer(EventObject event)`	Возвращает true, если `event` является `MouseEvent` и счётчик щелчков равен 1.
`protected void`	`startEditingTimer()`	Запускает таймер редактирования.
`boolean`	`stopCellEditing()`	Если `realEditor` разрешит остановку редактирования, `realEditor` удаляется, и возвращается true, иначе — false.
`void`	`valueChanged(TreeSelectionEvent e)`	Сбрасывает `lastPath`.

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

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

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

realEditor

protected TreeCellEditor realEditor

Редактор, обрабатывающий редактирование.

renderer

protected DefaultTreeCellRenderer renderer

Рендерер, используемый для получения границ и смещений.

editingContainer

protected Container editingContainer

Контейнер редактирования, будет содержать editorComponent.

editingComponent

protected transient Component editingComponent

Компонент, используемый при редактировании, полученный из editingContainer.

canEdit

protected boolean canEdit

Начиная с платформы Java 2 версии 1.4, это поле больше не должно использоваться. Если вы хотите обеспечить аналогичное поведение, вы должны напрямую переопределить isCellEditable.

offset

protected transient int offset

Используется при редактировании. Указывает позицию x для размещения editingComponent.

tree

protected transient JTree tree

JTree экземпляр, за которым также ведётся наблюдение.

lastPath

protected transient TreePath lastPath

Последний выбранный путь.

timer

protected transient Timer timer

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

lastRow

protected transient int lastRow

Строка, которая была последней передана в getTreeCellEditorComponent.

borderSelectionColor

protected Color borderSelectionColor

Истина, если должна быть нарисована граница выделения.

editingIcon

protected transient Icon editingIcon

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

font

protected Font font

Шрифт для рисования, null указывает, что следует использовать шрифт рендерера.

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

DefaultTreeCellEditor

public DefaultTreeCellEditor(JTree tree, DefaultTreeCellRenderer renderer)

Создаёт объект DefaultTreeCellEditor для JTree, используя указанный рендерер и редактор по умолчанию. (Используйте этот конструктор для обычного редактирования.)

Параметры:: tree - объект JTree; renderer - объект DefaultTreeCellRenderer

DefaultTreeCellEditor

public DefaultTreeCellEditor(JTree tree, DefaultTreeCellRenderer renderer, TreeCellEditor editor)

Создаёт объект DefaultTreeCellEditor для JTree, используя указанный рендерер и указанный редактор. (Используйте этот конструктор для специализированного редактирования.)

Параметры:: tree - объект JTree; renderer - объект DefaultTreeCellRenderer; editor - объект TreeCellEditor

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

setBorderSelectionColor

public void setBorderSelectionColor(Color newColor)

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

Параметры:: newColor - новый цвет границы

getBorderSelectionColor

public Color getBorderSelectionColor()

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

Возвращает:: цвет границы выделения

setFont

public void setFont(Font font)

Устанавливает шрифт для редактирования. null указывает, что следует использовать шрифт рендерера. Это НЕ переопределит шрифт, который вы установили в редакторе, с которым был создан получатель. Если null для редактора был передан в качестве параметра, будет создан редактор по умолчанию, который подберет этот шрифт.

Параметры:

font - редактируемый Font

См. также:

getFont()

getFont

public Font getFont()

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

Возвращает:

редактируемый Font

См. также:

setFont(java.awt.Font)

getTreeCellEditorComponent

public Component getTreeCellEditorComponent(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)

Настраивает редактор. Передаётся в realEditor.

Определяется в:: getTreeCellEditorComponent в интерфейсе TreeCellEditor
Параметры:: tree - JTree, запрашивающий редактор для редактирования; этот параметр может быть null; value - значение ячейки, подлежащей редактированию; isSelected - true, если ячейка должна отображаться с выделением выделения; expanded - true, если узел раскрыт; leaf - true, если узел является листом; row - индекс строки редактируемого узла
Возвращает:: компонент для редактирования

getCellEditorValue

public Object getCellEditorValue()

Возвращает значение, которое в настоящее время редактируется.

Определяется в:: getCellEditorValue в интерфейсе CellEditor
Возвращает:: значение, которое в настоящее время редактируется

isCellEditable

public boolean isCellEditable(EventObject event)

Если realEditor возвращает true для этого сообщения, prepareForEditing отправляется сообщение, и возвращается true.

Определяется в:

isCellEditable в интерфейсе CellEditor

Параметры:

event - событие, которое редактор должен использовать для определения, следует ли начинать редактирование или нет

Возвращает:

true, если редактирование можно начать

См. также:

CellEditor.shouldSelectCell(java.util.EventObject)

shouldSelectCell

public boolean shouldSelectCell(EventObject event)

Отправляет сообщение realEditor для получения возвращаемого значения.

Определяется в:

shouldSelectCell в интерфейсе CellEditor

Параметры:

event - событие, которое редактор должен использовать для начала редактирования

Возвращает:

true, если редактор хочет, чтобы ячейка редактирования была выбрана; в противном случае возвращается false

См. также:

CellEditor.isCellEditable(java.util.EventObject)

stopCellEditing

public boolean stopCellEditing()

Если realEditor позволит остановить редактирование, realEditor удаляется, и возвращается true, в противном случае - false.

Определяется в:: stopCellEditing в интерфейсе CellEditor
Возвращает:: true, если редактирование было остановлено; в противном случае - false

cancelCellEditing

public void cancelCellEditing()

Отправляет сообщение cancelCellEditing в realEditor и удаляет его из этого экземпляра.

Определяется в:: cancelCellEditing в интерфейсе CellEditor

addCellEditorListener

public void addCellEditorListener(CellEditorListener l)

Добавляет CellEditorListener.

Определяется в:: addCellEditorListener в интерфейсе CellEditor
Параметры:: l - добавляемый слушатель

removeCellEditorListener

public void removeCellEditorListener(CellEditorListener l)

Удаляет ранее добавленного CellEditorListener.

Определяется в:: removeCellEditorListener в интерфейсе CellEditor
Параметры:: l - удаляемый слушатель

getCellEditorListeners

public CellEditorListener[] getCellEditorListeners()

Возвращает массив всех CellEditorListeners, добавленных в этот DefaultTreeCellEditor с помощью addCellEditorListener().

Возвращает:: все добавленные CellEditorListeners или пустой массив, если слушатели не были добавлены
С момента:: 1.4

valueChanged

public void valueChanged(TreeSelectionEvent e)

Сбрасывает lastPath.

Определяется в:: valueChanged в интерфейсе TreeSelectionListener
Параметры:: e - событие, характеризующее изменение.

actionPerformed

public void actionPerformed(ActionEvent e)

Отправляется сообщение при срабатывании таймера, это запустит сеанс редактирования.

Определяется в:: actionPerformed в интерфейсе ActionListener
Параметры:: e - событие для обработки

setTree

protected void setTree(JTree newTree)

Устанавливает дерево, которое в настоящее время редактируется. Это необходимо для добавления слушателя выбора.

Параметры:: newTree - новое редактируемое дерево

shouldStartEditingTimer

protected boolean shouldStartEditingTimer(EventObject event)

Возвращает true, если event является MouseEvent и количество кликов равно 1.

Parameters:: event - событие, которое изучается
Returns:: должен ли event начать таймер редактирования

startEditingTimer

protected void startEditingTimer()

Запускает таймер редактирования.

canEditImmediately

protected boolean canEditImmediately(EventObject event)

Возвращает true, если event является null, или это MouseEvent с количеством кликов > 2 и inHitRegion возвращает true.

Parameters:: event - событие, которое изучается
Returns:: можно ли начать редактирование для данного event

inHitRegion

protected boolean inHitRegion(int x, int y)

Возвращает true, если переданное расположение является допустимым местом для щелчка мыши для начала редактирования. Это реализовано так, чтобы возвращать false, если x меньше или равно ширине значка и промежутка между значками, отображаемыми рендерером. Другими словами, это возвращает true, если пользователь нажимает на текстовую часть, отображаемую рендерером, и false в противном случае.

Parameters:: x - координата x точки; y - координата y точки
Returns:: true, если переданное расположение является допустимым местом для щелчка мыши

determineOffset

protected void determineOffset(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)

Определяет смещение.

Parameters:: tree - объект JTree; value - значение; isSelected - статус выделения; expanded - статус раскрытия; leaf - статус листа; row - текущая строка

prepareForEditing

protected void prepareForEditing()

Вызывается непосредственно перед началом редактирования. Добавит editingComponent к editingContainer.

createContainer

protected Container createContainer()

Создаёт контейнер для управления размещением editingComponent.

Returns:: новый объект Container

createTreeCellEditor

protected TreeCellEditor createTreeCellEditor()

Вызывается, если TreeCellEditor не указан в конструкторе. Возвращает редактор TextField.

Returns:: новый редактор TextField

© 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/tree/DefaultTreeCellEditor.html