Spec-Zone.ru › OpenJDK 24

Класс HTMLEditorKit

java.lang.Object
javax.swing.text.EditorKit
javax.swing.text.DefaultEditorKit
javax.swing.text.StyledEditorKit
javax.swing.text.html.HTMLEditorKit
Все реализованные интерфейсы:
Serializable, Cloneable, Accessible
public class HTMLEditorKit extends StyledEditorKit implements Accessible
Компонент Swing JEditorPane поддерживает различные типы содержимого через механизм подключаемых модулей, называемый EditorKit. Поскольку HTML — очень популярный формат содержимого, для него предусмотрена некоторая поддержка по умолчанию. Эта поддержка предоставляется данным классом, который поддерживает HTML версии 3.2 (с некоторыми расширениями) и переходит к версии 4.0. Тег <applet> не поддерживается, но предоставляется некоторая поддержка для тега <object>.

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

Поддержка редактирования
Может показаться очевидным, что плагин для JEditorPane должен обеспечивать поддержку редактирования, но это имеет несколько аспектов проектирования. Существует значительное количество HTML-документов, которые не полностью соответствуют спецификации HTML. Для их редактирования они должны быть несколько нормализованы в правильную форму. Кроме того, пользователи не хотят видеть избыточное редактирование структуры, поэтому предпочтительнее использовать традиционные жесты редактирования текста, а не точно следовать структуре HTML-документа.

Моделирование HTML обеспечивается классом HTMLDocument. В его документации описаны подробности моделирования HTML. Поддержка редактирования в значительной степени опирается на пакет text.

Расширяемость/Масштабируемость
Для максимальной полезности данного набора инструментов, в него вложено много усилий для обеспечения расширяемости. Вот некоторые из его особенностей.
  1. Парсер заменяемый. По умолчанию используется парсер Hot Java, основанный на DTD. Можно использовать другой DTD или полностью другой парсер. Чтобы изменить парсер, переопределите метод getParser. Парсер по умолчанию динамически загружается при первом запросе, поэтому файлы класса никогда не будут загружены, если используется альтернативный парсер. Парсер по умолчанию находится в отдельном пакете с именем parser ниже этого пакета.
  2. Парсер управляет ParserCallback, который предоставляется HTMLDocument. Чтобы изменить обработчик, необходимо унаследовать от HTMLDocument и переопределить метод createDefaultDocument для возвращения документа, который создает другой ридер. Ридер контролирует структуру документа. Хотя Document по умолчанию поддерживает HTML, нет ничего, что препятствует поддержке тегов, отличных от HTML, которые приводят к альтернативным структурам элементов.
  3. Представления по умолчанию моделей предоставляются в виде иерархии реализаций View, поэтому можно легко настроить отображение конкретного элемента или добавить возможности для новых типов элементов, предоставив новые реализации View. Набор представлений по умолчанию предоставляется классом HTMLFactory. Это можно легко изменить, унаследовав или заменив HTMLFactory и переопределив метод getViewFactory для возвращения альтернативной фабрики.
  4. Реализации View в основном работают с атрибутами CSS, которые хранятся в представлениях. Это позволяет иметь несколько представлений, отображаемых на одной модели, которые выглядят существенно по-разному. Это особенно полезно для печати. Для большинства атрибутов HTML атрибуты HTML преобразуются в атрибуты CSS для отображения. Это помогает сделать реализации View более универсальными.
Асинхронная загрузка
Большие документы включают много парсинга и требуют некоторого времени для загрузки. По умолчанию этот набор инструментов создает документы, которые будут загружаться асинхронно, если они загружаются с помощью JEditorPane.setPage. Это контролируется свойством в документе. Метод createDefaultDocument можно переопределить для изменения этого. Упаковку работ выполняет класс HTMLDocument.HTMLReader. Фактическая работа выполняется классами DefaultStyledDocument и AbstractDocument в пакете text.
Настройка текущего LAF
HTML предоставляет хорошо известный набор функций без точного указания характеристик отображения. Swing имеет механизм темы для своих реализаций внешнего вида и ощущения. Желательно, чтобы внешний вид и ощущения передавали характеристики отображения в HTML-представления. Пользователь с плохим зрением, например, захочет высокой контрастности и шрифтов, больших, чем обычно.

Поддержка этого обеспечивается классом StyleSheet. Отображение HTML сильно зависит от значения свойства StyleSheet в EditorKit.

Без потерь
EditorKit имеет возможность чтения и сохранения документов. Обычно для пользователей предпочтительно, если при этих операциях нет потери данных. Политика HTMLEditorKit будет заключаться в хранении не распознаваемых или не обязательно видимых вещей, чтобы они могли быть впоследствии записаны. Модель HTML-документа, следовательно, должна содержать всю информацию, обнаруженную при чтении документа. Это ограничено некоторыми способами необходимостью поддержки редактирования (т.е. иногда некорректные документы должны быть нормализованы). Руководящий принцип заключается в том, что информация не должна теряться, но некоторые из нее могут быть синтезированы для создания более корректной модели или перегруппированы.

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

Модификатор и тип Класс Описание
static class  HTMLEditorKit.HTMLFactory
Фабрика для создания представлений HTML.
static class  HTMLEditorKit.HTMLTextAction
Абстрактное действие, предоставляющее удобные методы для вставки HTML в существующий документ.
static class  HTMLEditorKit.InsertHTMLTextAction
InsertHTMLTextAction может быть использован для вставки произвольной строки HTML в существующий HTML-документ.
static class  HTMLEditorKit.LinkController
Класс для отслеживания связанного компонента и срабатывания событий гиперссылок при необходимости.
static class  HTMLEditorKit.Parser
Интерфейс, который должен поддерживаться анализатором.
static class  HTMLEditorKit.ParserCallback
Результат парсинга вызывает эти методы обратного вызова.

Вложенные классы/интерфейсы, объявленные в классе javax.swing.text.StyledEditorKit

StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.StyledTextAction, StyledEditorKit.UnderlineAction

Вложенные классы/интерфейсы, объявленные в классе javax.swing.text.DefaultEditorKit

DefaultEditorKit.BeepAction, DefaultEditorKit.CopyAction, DefaultEditorKit.CutAction, DefaultEditorKit.DefaultKeyTypedAction, DefaultEditorKit.InsertBreakAction, DefaultEditorKit.InsertContentAction, DefaultEditorKit.InsertTabAction, DefaultEditorKit.PasteAction

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

Модификатор и тип Поле Описание
static final String BOLD_ACTION
Идентификатор действия «жирный»
static final String COLOR_ACTION
Идентификатор действия выбора цвета. Цвет передаётся в качестве аргумента
static final String DEFAULT_CSS
Файл по умолчанию таблицы стилей Cascading Style Sheets, настраивающий представления тегов.
static final String FONT_CHANGE_BIGGER
Идентификатор действия увеличения размера шрифта на следующую величину
static final String FONT_CHANGE_SMALLER
Идентификатор действия уменьшения размера шрифта на следующую величину
static final String IMG_ALIGN_BOTTOM
Выравнивание изображений по нижнему краю.
static final String IMG_ALIGN_MIDDLE
Выравнивание изображений по центру.
static final String IMG_ALIGN_TOP
Выравнивание изображений по верхнему краю.
static final String IMG_BORDER
Выравнивание изображений по границам.
static final String ITALIC_ACTION
Идентификатор действия «курсив»
static final String LOGICAL_STYLE_ACTION
Идентификатор действия выбора логического стиля. Логический стиль передаётся в качестве аргумента
static final String PARA_INDENT_LEFT
Идентификатор действия отступа абзаца слева
static final String PARA_INDENT_RIGHT
Идентификатор действия отступа абзаца справа

Поля, объявленные в классе javax.swing.text.DefaultEditorKit

backwardAction, beepAction, beginAction, beginLineAction, beginLineUpAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, downAction, endAction, endLineAction, endLineDownAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction

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

Конструктор Описание
HTMLEditorKit()
Создаёт HTMLEditorKit, создаёт StyleContext и загружает таблицу стилей.

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

Модификатор и тип Метод Описание
Object clone()
Создаёт копию редактора.
Document createDefaultDocument()
Создаёт модель хранилища текста без инициализации, подходящую для этого типа редактора.
protected void createInputAttributes(Element element, MutableAttributeSet set)
Копирует пары ключ/значение из набора атрибутов element в set.
void deinstall(JEditorPane c)
Вызывается при удалении кита из JEditorPane.
AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим редактором.
Action[] getActions()
Получает список команд для редактора.
String getContentType()
Получает MIME-тип данных, для которых поддерживается этот кит.
Cursor getDefaultCursor()
Возвращает курсор по умолчанию.
MutableAttributeSet getInputAttributes()
Получает атрибуты ввода, используемые для действий стилизованного редактирования.
Cursor getLinkCursor()
Возвращает курсор, используемый для гиперссылок.
protected HTMLEditorKit.Parser getParser()
Получает анализатор для чтения потоков HTML.
StyleSheet getStyleSheet()
Получает набор стилей, используемых для отображения HTML-элементов.
ViewFactory getViewFactory()
Получает фабрику, подходящую для создания представлений любых моделей, созданных этим китом.
void insertHTML(HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag)
Вставляет HTML в существующий документ.
void install(JEditorPane c)
Вызывается при установке кита в JEditorPane.
boolean isAutoFormSubmission()
Указывает, обрабатывается ли отправка HTML-формы автоматически или срабатывает только FormSubmitEvent.
void read(Reader in, Document doc, int pos)
Вставляет содержимое из заданного потока.
void setAutoFormSubmission(boolean isAuto)
Определяет, обрабатывается ли отправка HTML-формы автоматически или срабатывает только FormSubmitEvent.
void setDefaultCursor(Cursor cursor)
Устанавливает курсор по умолчанию.
void setLinkCursor(Cursor cursor)
Устанавливает курсор, используемый для ссылок.
void setStyleSheet(StyleSheet s)
Устанавливает набор стилей, используемых для отображения различных HTML-элементов.
void write(Writer out, Document doc, int pos, int len)
Записывает содержимое документа в заданный поток в формате, соответствующем этому обработчику содержимого.

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

getCharacterAttributeRun

Методы, объявленные в классе javax.swing.text.DefaultEditorKit

createCaret, read, write

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

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

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

DEFAULT_CSS

public static final String DEFAULT_CSS
Файл стилей по умолчанию, который настраивает представления тегов.
См. также:
  • Значения константных полей

BOLD_ACTION

public static final String BOLD_ACTION
Идентификатор действия «жирный шрифт»
См. также:
  • Значения константных полей

ITALIC_ACTION

public static final String ITALIC_ACTION
Идентификатор действия «курсив»
См. также:
  • Значения константных полей

PARA_INDENT_LEFT

public static final String PARA_INDENT_LEFT
Идентификатор действия отступа абзаца влево
См. также:
  • Значения константных полей

PARA_INDENT_RIGHT

public static final String PARA_INDENT_RIGHT
Идентификатор действия отступа абзаца вправо
См. также:
  • Значения константных полей

FONT_CHANGE_BIGGER

public static final String FONT_CHANGE_BIGGER
Идентификатор действия увеличения размера шрифта до следующего значения
См. также:
  • Значения константных полей

FONT_CHANGE_SMALLER

public static final String FONT_CHANGE_SMALLER
Идентификатор действия уменьшения размера шрифта до следующего значения
См. также:
  • Значения константных полей

COLOR_ACTION

public static final String COLOR_ACTION
Идентификатор действия выбора цвета. Цвет передаётся в качестве аргумента.
См. также:
  • Значения константных полей

LOGICAL_STYLE_ACTION

public static final String LOGICAL_STYLE_ACTION
Идентификатор действия выбора логического стиля. Логический стиль передаётся в качестве аргумента.
См. также:
  • Значения константных полей

IMG_ALIGN_TOP

public static final String IMG_ALIGN_TOP
Выравнивание изображений по верху.
См. также:
  • Значения константных полей

IMG_ALIGN_MIDDLE

public static final String IMG_ALIGN_MIDDLE
Выравнивание изображений по центру.
См. также:
  • Значения константных полей

IMG_ALIGN_BOTTOM

public static final String IMG_ALIGN_BOTTOM
Выравнивание изображений по низу.
См. также:
  • Значения константных полей

IMG_BORDER

public static final String IMG_BORDER
Выравнивание изображений по границе.
См. также:
  • Значения константных полей

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

HTMLEditorKit

public HTMLEditorKit()
Создаёт HTMLEditorKit, создаёт StyleContext и загружает таблицу стилей.

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

getContentType

public String getContentType()
Получить MIME-тип данных, поддерживаемый этим набором инструментов. Этот набор инструментов поддерживает тип text/html.
Переопределяет:
getContentType в классе DefaultEditorKit
Возвращает:
тип

getViewFactory

public ViewFactory getViewFactory()
Получить фабрику, подходящую для создания представлений любых моделей, создаваемых этим набором инструментов.
Переопределяет:
getViewFactory в классе StyledEditorKit
Возвращает:
фабрику

createDefaultDocument

public Document createDefaultDocument()
Создаёт неинициализированную модель хранилища текста, подходящую для этого типа редактора.
Переопределяет:
createDefaultDocument в классе StyledEditorKit
Возвращает:
модель

read

public void read(Reader in, Document doc, int pos) throws IOException, BadLocationException
Вставляет содержимое из заданного потока. Если doc является экземпляром HTMLDocument, это будет читать текст HTML 3.2. Вставка HTML в непустой документ должна происходить внутри элемента body. Если вставка не происходит в элемент body, будет выброшено исключение. При вставке в непустой документ все теги вне body (head, title) будут удалены.
Переопределяет:
read в классе DefaultEditorKit
Параметры:
in - поток для чтения
doc - место назначения вставки
pos - положение в документе для размещения содержимого
Исключения:
IOException - при любой ошибке ввода-вывода
BadLocationException - если pos представляет недопустимое положение в документе
RuntimeException - (в конечном итоге BadLocationException) если pos недопустимо

insertHTML

public void insertHTML(HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag) throws BadLocationException, IOException
Вставляет HTML в существующий документ.
Параметры:
doc - документ для вставки
offset - смещение для вставки HTML
html - строка HTML
popDepth - количество ElementSpec.EndTagTypes для генерации перед вставкой
pushDepth - количество ElementSpec.StartTagTypes с направлением ElementSpec.JoinNextDirection, которое должно быть сгенерировано перед вставкой, но после генерации тегов закрытия
insertTag - первый тег для начала вставки в документ
Исключения:
BadLocationException - если offset недопустимо
IOException - при ошибке ввода-вывода
RuntimeException - (в конечном итоге BadLocationException) если pos недопустимо

write

public void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException
Записать содержимое из документа в заданный поток в формате, подходящем для этого обработчика содержимого.
Переопределяет:
write в классе DefaultEditorKit
Параметры:
out - поток для записи
doc - источник для записи
pos - положение в документе для извлечения содержимого
len - количество для записи
Исключения:
IOException - при любой ошибке ввода-вывода
BadLocationException - если pos представляет недопустимое положение в документе

install

public void install(JEditorPane c)
Вызывается при установке набора инструментов в JEditorPane.
Переопределяет:
install в классе StyledEditorKit
Параметры:
c - JEditorPane
END_OF_DOCUMENT_MARKER

deinstall

public void deinstall(JEditorPane c)
Вызывается при удалении комплекта из JEditorPane. Используется для отмены регистрации любых слушателей, которые были подключены.
Overrides:
deinstall в классе StyledEditorKit
Parameters:
c - JEditorPane

setStyleSheet

public void setStyleSheet(StyleSheet s)
Устанавливает набор стилей, используемых для отображения различных HTML-элементов. Эти стили задаются в терминах спецификаций CSS. Каждый документ, созданный комплектом, будет иметь копию листа, к которой можно добавить стили, специфичные для документа. По умолчанию указанный StyleSheet используется всеми экземплярами HTMLEditorKit. Это следует переопределить для обеспечения более тонкой настройки, если это необходимо.
Parameters:
s - StyleSheet

getStyleSheet

public StyleSheet getStyleSheet()
Получить набор стилей, которые в настоящее время используются для отображения HTML-элементов. По умолчанию загружается ресурс, указанный в DEFAULT_CSS, и он используется всеми экземплярами HTMLEditorKit.
Returns:
StyleSheet

getActions

public Action[] getActions()
Извлекает список команд для редактора. Это список команд, поддерживаемых суперклассом, дополненный набором команд, определенных локально для операций со стилями.
Overrides:
getActions в классе StyledEditorKit
Returns:
список команд

createInputAttributes

protected void createInputAttributes(Element element, MutableAttributeSet set)
Копирует пары ключ/значение в element AttributeSet в set. Это не копирует атрибуты компонента, значка или имени элемента. Подклассы могут пожелать уточнить, что копируется, а что нет. Но сначала убедитесь, что все атрибуты, которые находятся в set, удалены.

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

Overrides:
createInputAttributes в классе StyledEditorKit
Parameters:
element - элемент
set - атрибуты

getInputAttributes

public MutableAttributeSet getInputAttributes()
Получает атрибуты ввода, используемые для действий по стилизованному редактированию.
Overrides:
getInputAttributes в классе StyledEditorKit
Returns:
набор атрибутов

setDefaultCursor

public void setDefaultCursor(Cursor cursor)
Устанавливает курсор по умолчанию.
Parameters:
cursor - курсор
Since:
1.3

getDefaultCursor

public Cursor getDefaultCursor()
Возвращает курсор по умолчанию.
Returns:
курсор
Since:
1.3

setLinkCursor

public void setLinkCursor(Cursor cursor)
Устанавливает курсор для использования над ссылками.
Parameters:
cursor - курсор
Since:
1.3

getLinkCursor

public Cursor getLinkCursor()
Возвращает курсор для использования над гиперссылками.
Returns:
курсор
Since:
1.3

isAutoFormSubmission

public boolean isAutoFormSubmission()
Указывает, обрабатывается ли отправка HTML-формы автоматически или только FormSubmitEvent.
Returns:
true, если отправка HTML-формы обрабатывается автоматически, false в противном случае.
Since:
1.5
See Also:
  • setAutoFormSubmission(boolean)

setAutoFormSubmission

public void setAutoFormSubmission(boolean isAuto)
Указывает, обрабатывается ли отправка HTML-формы автоматически или только FormSubmitEvent. По умолчанию установлено в true.
Parameters:
isAuto - если true, отправка HTML-формы обрабатывается автоматически.
Since:
1.5
See Also:
  • isAutoFormSubmission()
  • FormSubmitEvent

clone

public Object clone()
Создает копию редактора комплекта.
Overrides:
clone в классе StyledEditorKit
Returns:
копия
See Also:
  • Cloneable

getParser

protected HTMLEditorKit.Parser getParser()
Получение парсера для чтения потоков HTML. Это можно переопределить для использования другого парсера. По умолчанию реализация загружается динамически, чтобы избежать накладных расходов при загрузке парсера по умолчанию, если он не используется. Парсер по умолчанию — это парсер HotJava, использующий HTML 3.2 DTD.
Returns:
парсер

getAccessibleContext

public AccessibleContext getAccessibleContext()
возвращает AccessibleContext, связанный с этим редактором комплекта
Specified by:
getAccessibleContext в интерфейсе Accessible
Returns:
AccessibleContext, связанный с этим редактором комплекта
Since:
1.4

© 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/text/html/HTMLEditorKit.html

Spec-Zone.ru

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