Класс HTMLEditorKit.InsertHTMLTextAction

javax.swing.text.html.HTMLEditorKit.InsertHTMLTextAction

Все реализуемые интерфейсы:: ActionListener, Serializable, Cloneable, EventListener, Action

Внешний класс:: HTMLEditorKit

public static class HTMLEditorKit.InsertHTMLTextAction extends HTMLEditorKit.HTMLTextAction

InsertHTMLTextAction можно использовать для вставки произвольной строки HTML в существующий HTML-документ. Необходимо указать как минимум два HTML.Tag. Первый тег, parentTag, определяет родительский элемент документа, в который будут добавлены элементы. Второй тег, addTag, определяет первый тег, который следует добавить в документ, как он представлен в строке HTML. Важно помнить, что анализатор создаст все соответствующие теги, даже если их нет в переданной строке HTML.

Например, предположим, что вы хотите создать действие для вставки таблицы в тело документа. В качестве parentTag следует указать HTML.Tag.BODY, в качестве addTag — HTML.Tag.TABLE, а строка может выглядеть так: <table><tr><td></td></tr></table>.

Также можно указать альтернативные parentTag и addTag. Они будут проверены, если по указанному смещению отсутствует parentTag.

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

Модификатор и тип	Поле	Описание
`protected HTML.Tag`	`addTag`	Тег в HTML, с которого начинается добавление тегов.
`protected HTML.Tag`	`alternateAddTag`	Альтернативный тег в HTML, с которого начинается добавление тегов, если parentTag не найден, а alternateParentTag найден.
`protected HTML.Tag`	`alternateParentTag`	Альтернативный тег для поиска в документе, если parentTag не найден.
`protected String`	`html`	HTML-код для вставки.
`protected HTML.Tag`	`parentTag`	Тег для поиска в документе.

Поля, объявленные в классе AbstractAction

changeSupport, enabled

Модификатор и тип	Поле	Описание
`protected SwingPropertyChangeSupport`	`changeSupport`	Если зарегистрированы какие-либо `PropertyChangeListeners`, поле `changeSupport` содержит сведения о них.
`protected boolean`	`enabled`	Определяет, включено ли действие; значение по умолчанию — true.

Поля, объявленные в интерфейсе Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Модификатор и тип	Поле	Описание
`static final String`	`ACCELERATOR_KEY`	Ключ для хранения `KeyStroke`, используемого в качестве клавиши быстрого доступа к действию.
`static final String`	`ACTION_COMMAND_KEY`	Ключ для определения команды `String` для `ActionEvent`, которая будет создана, когда о `Action` будет отправлено уведомление в результате его нахождения в `Keymap`, связанном с `JComponent`.
`static final String`	`DEFAULT`	В настоящее время не используется.
`static final String`	`DISPLAYED_MNEMONIC_INDEX_KEY`	Ключ для хранения `Integer`, соответствующего индексу в тексте (определяемому свойством `NAME`), в котором следует отобразить оформление мнемоники.
`static final String`	`LARGE_ICON_KEY`	Ключ для хранения `Icon`.
`static final String`	`LONG_DESCRIPTION`	Ключ для хранения более подробного `String` описания действия; может использоваться для контекстной справки.
`static final String`	`MNEMONIC_KEY`	Ключ для хранения `Integer`, соответствующего одному из кодов клавиш `KeyEvent`.
`static final String`	`NAME`	Ключ для хранения `String` имени действия, используемого для меню или кнопки.
`static final String`	`SELECTED_KEY`	Ключ для хранения `Boolean`, соответствующего выбранному состоянию.
`static final String`	`SHORT_DESCRIPTION`	Ключ для хранения краткого `String` описания действия, используемого в качестве текста всплывающей подсказки.
`static final String`	`SMALL_ICON`	Ключ для хранения небольшого `Icon`, например `ImageIcon`.

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

Конструктор	Описание
`InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag)`	Создает новый InsertHTMLTextAction.
`InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag, HTML.Tag alternateParentTag, HTML.Tag alternateAddTag)`	Создает новый InsertHTMLTextAction.

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

Модификатор и тип	Метод	Описание
`void`	`actionPerformed(ActionEvent ae)`	Вставляет HTML-код в документ.
`protected void`	`insertAtBoundary(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag)`	Вызывается при вставке на границе.
`protected void`	`insertAtBoundry(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag)`	Устарело. Начиная с платформы Java 2 v1.3 используйте insertAtBoundary
`protected void`	`insertHTML(JEditorPane editor, HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag addTag)`	Обертка для HTMLEditorKit.insertHTML.

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

elementCountToTag, findElementMatchingTag, getElementsAt, getHTMLDocument, getHTMLEditorKit

Модификатор и тип	Метод	Описание
`protected int`	`elementCountToTag(HTMLDocument doc, int offset, HTML.Tag tag)`	Возвращает количество элементов, начиная с самого глубокого листового элемента, необходимое для получения элемента, представляющего `tag`.
`protected Element`	`findElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag)`	Возвращает самый глубокий элемент в `offset`, соответствующий `tag`.
`protected Element[]`	`getElementsAt(HTMLDocument doc, int offset)`	Возвращает массив элементов, содержащих `offset`.
`protected HTMLDocument`	`getHTMLDocument(JEditorPane e)`	Возвращает `HTMLDocument` заданного `JEditorPane`.
`protected HTMLEditorKit`	`getHTMLEditorKit(JEditorPane e)`	Возвращает `HTMLEditorKit` заданного `JEditorPane`.

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

getEditor, getStyledDocument, getStyledEditorKit, setCharacterAttributes, setParagraphAttributes

Модификатор и тип	Метод	Описание
`protected final JEditorPane`	`getEditor(ActionEvent e)`	Возвращает целевой редактор для действия.
`protected final StyledDocument`	`getStyledDocument(JEditorPane e)`	Возвращает документ, связанный с панелью редактора.
`protected final StyledEditorKit`	`getStyledEditorKit(JEditorPane e)`	Возвращает набор редактора, связанный с панелью редактора.
`protected final void`	`setCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace)`	Применяет заданные атрибуты к символьному содержимому.
`protected final void`	`setParagraphAttributes(JEditorPane editor, AttributeSet attr, boolean replace)`	Применяет заданные атрибуты к абзацам.

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

augmentList, getFocusedComponent, getTextComponent

Модификатор и тип	Метод	Описание
`static final Action[]`	`augmentList(Action[] list1, Action[] list2)`	Дополняет один список команд другим списком команд.
`protected final JTextComponent`	`getFocusedComponent()`	Получает текстовый компонент, который в данный момент находится в фокусе.
`protected final JTextComponent`	`getTextComponent(ActionEvent e)`	Определяет компонент, используемый для действия.

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

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Модификатор и тип	Метод	Описание
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`	Добавляет `PropertyChangeListener` в список слушателей.
`protected Object`	`clone()`	Клонирует абстрактное действие.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)`	Поддерживает уведомление об изменениях связанных свойств.
`Object[]`	`getKeys()`	Возвращает массив `Object`, являющихся ключами, для которых заданы значения в этом `AbstractAction`, или `null`, если значения не заданы ни для одного ключа.
`PropertyChangeListener[]`	`getPropertyChangeListeners()`	Возвращает массив всех `PropertyChangeListener`, добавленных в этот AbstractAction с помощью addPropertyChangeListener().
`Object`	`getValue(String key)`	Получает `Object`, связанное с указанным ключом.
`boolean`	`isEnabled()`	Возвращает true, если действие включено.
`void`	`putValue(String key, Object newValue)`	Задает `Value`, связанное с указанным ключом.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`	Удаляет `PropertyChangeListener` из списка слушателей.
`void`	`setEnabled(boolean newValue)`	Задает, включено ли `Action`.

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

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

Модификатор и тип	Метод	Описание
`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, либо до истечения заданного промежутка реального времени.

Методы, объявленные в интерфейсе Action

accept

Модификатор и тип	Метод	Описание
`default boolean`	`accept(Object sender)`	Определяет, следует ли выполнить действие с указанным объектом-отправителем.

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

html

protected String html

HTML-код для вставки.

parentTag

protected HTML.Tag parentTag

Тег для поиска в документе.

addTag

protected HTML.Tag addTag

Тег в HTML, с которого начинается добавление тегов.

alternateParentTag

protected HTML.Tag alternateParentTag

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

alternateAddTag

protected HTML.Tag alternateAddTag

Альтернативный тег в HTML, с которого начинается добавление тегов, если parentTag не найден, а alternateParentTag найден.

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

InsertHTMLTextAction

public InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag)

Создает новый InsertHTMLTextAction.

Параметры:: name — имя действия; html — строка HTML; parentTag — родительский тег; addTag — первый тег, с которого начинается вставка в документ

InsertHTMLTextAction

public InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag, HTML.Tag alternateParentTag, HTML.Tag alternateAddTag)

Создает новый InsertHTMLTextAction.

Параметры:: name — имя действия; html — строка HTML; parentTag — родительский тег; addTag — первый тег, с которого начинается вставка в документ; alternateParentTag — альтернативный родительский тег; alternateAddTag — альтернативный тег

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

insertHTML

protected void insertHTML(JEditorPane editor, HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag addTag)

Обертка для HTMLEditorKit.insertHTML. Если возникает исключение, оно оборачивается в RuntimeException и выбрасывается.

Параметры:: editor — экземпляр JEditorPane; doc — документ, в который выполняется вставка; offset — смещение, в котором следует вставить HTML-код; html — строка HTML; popDepth — количество ElementSpec.EndTagTypes, создаваемых перед вставкой; pushDepth — количество ElementSpec.StartTagTypes с направлением ElementSpec.JoinNextDirection, которые следует создать перед вставкой, но после создания закрывающих тегов; addTag — первый тег, с которого начинается вставка в документ

insertAtBoundary

protected void insertAtBoundary(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag)

Вызывается при вставке на границе. Определяет количество операций извлечения, а затем количество операций добавления, которые необходимо выполнить, после чего вызывает insertHTML.

Параметры:: editor — экземпляр JEditorPane; doc — экземпляр HTMLDocument; offset — начальное смещение; insertElement — экземпляр Element; html — строка HTML; parentTag — родительский тег; addTag — первый тег, с которого начинается вставка в документ
Начиная с:: 1.3

insertAtBoundry

@Deprecated protected void insertAtBoundry(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag)

Устарело.

Начиная с платформы Java 2 v1.3 используйте insertAtBoundary

Параметры:: editor — экземпляр JEditorPane; doc — экземпляр HTMLDocument; offset — начальное смещение; insertElement — экземпляр Element; html — строка HTML; parentTag — родительский тег; addTag — первый тег, с которого начинается вставка в документ

actionPerformed

public void actionPerformed(ActionEvent ae)

Вставляет HTML-код в документ.

Параметры:: ae — событие

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