Класс DefaultTreeCellEditor

java.lang.Object

javax.swing.tree.DefaultTreeCellEditor

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

public class DefaultTreeCellEditor extends Object implements ActionListener, TreeCellEditor, TreeSelectionListener

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

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

См. также:

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

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

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

Модификатор и тип	Поле	Описание
`protected Color`	`borderSelectionColor`	Значение true означает, что цвет выделения рамки следует отображать.
`protected boolean`	`canEdit`	Начиная с платформы Java 2 версии 1.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`.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удален в будущей версии. Метод завершения устарел и может быть удален в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

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

Значение true означает, что цвет выделения рамки следует отображать.

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

public Font getFont()

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

Возвращает:

шрифт для редактирования 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, если редактирование можно начать

См. также:

shouldSelectCell

public boolean shouldSelectCell(EventObject event)

Запрашивает у realEditor значение результата.

Определено в:

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

Параметры:

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

Возвращает:

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

См. также:

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()

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

Возвращает:: все добавленные CellEditorListener или пустой массив, если слушатели не добавлены
Начиная с версии:: 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.

Параметры:: event — проверяемое событие
Возвращает:: следует ли event запустить таймер редактирования

startEditingTimer

protected void startEditingTimer()

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

canEditImmediately

protected boolean canEditImmediately(EventObject event)

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

Параметры:: event — проверяемое событие
Возвращает:: можно ли начать редактирование для данного event

inHitRegion

protected boolean inHitRegion(int x, int y)

Возвращает true, если переданное местоположение является допустимым местом щелчка мышью для начала редактирования. Реализация возвращает false, если x меньше или равен ширине значка и промежутка между значками, отображаемых средством отрисовки. Иными словами, метод возвращает true, если пользователь щелкнул по тексту, отображаемому средством отрисовки, и false в противном случае.

Параметры:: x — координата x точки; y — координата y точки
Возвращает:: true, если переданное местоположение является допустимым местом щелчка мышью

determineOffset

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

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

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

prepareForEditing

protected void prepareForEditing()

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

createContainer

protected Container createContainer()

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

Возвращает:: новый объект Container

createTreeCellEditor

protected TreeCellEditor createTreeCellEditor()

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

Возвращает:: новый редактор TextField

© 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.