Spec-Zone.ru › OpenJDK 21

Класс 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 v1.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()
Возвращает массив всех 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, 2023, 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/21/docs/api/java.desktop/javax/swing/tree/DefaultTreeCellEditor.html

Spec-Zone.ru

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