Класс HTMLEditorKit
- Все реализованные интерфейсы:
-
Serializable,Cloneable,Accessible
public class HTMLEditorKit extends StyledEditorKit implements Accessible
Существует несколько целей, которые преследует предоставленный HTML EditorKit, что влияет на то, как моделируется HTML. Это существенно повлияло на его дизайн.
- Поддержка редактирования
- Может показаться очевидным, что плагин для JEditorPane должен обеспечивать поддержку редактирования, но это имеет несколько аспектов проектирования. Существует значительное количество HTML-документов, которые не полностью соответствуют спецификации HTML. Для их редактирования они должны быть несколько нормализованы в правильную форму. Кроме того, пользователи не хотят видеть избыточное редактирование структуры, поэтому предпочтительнее использовать традиционные жесты редактирования текста, а не точно следовать структуре HTML-документа.
Моделирование HTML обеспечивается классом
HTMLDocument. В его документации описаны подробности моделирования HTML. Поддержка редактирования в значительной степени опирается на пакет text. - Расширяемость/Масштабируемость
- Для максимальной полезности данного набора инструментов, в него вложено много усилий для обеспечения расширяемости. Вот некоторые из его особенностей.
- Парсер заменяемый. По умолчанию используется парсер Hot Java, основанный на DTD. Можно использовать другой DTD или полностью другой парсер. Чтобы изменить парсер, переопределите метод getParser. Парсер по умолчанию динамически загружается при первом запросе, поэтому файлы класса никогда не будут загружены, если используется альтернативный парсер. Парсер по умолчанию находится в отдельном пакете с именем parser ниже этого пакета.
- Парсер управляет ParserCallback, который предоставляется HTMLDocument. Чтобы изменить обработчик, необходимо унаследовать от HTMLDocument и переопределить метод createDefaultDocument для возвращения документа, который создает другой ридер. Ридер контролирует структуру документа. Хотя Document по умолчанию поддерживает HTML, нет ничего, что препятствует поддержке тегов, отличных от HTML, которые приводят к альтернативным структурам элементов.
- Представления по умолчанию моделей предоставляются в виде иерархии реализаций View, поэтому можно легко настроить отображение конкретного элемента или добавить возможности для новых типов элементов, предоставив новые реализации View. Набор представлений по умолчанию предоставляется классом
HTMLFactory. Это можно легко изменить, унаследовав или заменив HTMLFactory и переопределив метод getViewFactory для возвращения альтернативной фабрики. - Реализации 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 в set. |
void |
deinstall |
Вызывается при удалении кита из 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 |
Вставляет HTML в существующий документ. |
void |
install |
Вызывается при установке кита в JEditorPane. |
boolean |
isAutoFormSubmission() |
Указывает, обрабатывается ли отправка HTML-формы автоматически или срабатывает только FormSubmitEvent. |
void |
read |
Вставляет содержимое из заданного потока. |
void |
setAutoFormSubmission |
Определяет, обрабатывается ли отправка HTML-формы автоматически или срабатывает только FormSubmitEvent. |
void |
setDefaultCursor |
Устанавливает курсор по умолчанию. |
void |
setLinkCursor |
Устанавливает курсор, используемый для ссылок. |
void |
setStyleSheet |
Устанавливает набор стилей, используемых для отображения различных HTML-элементов. |
void |
write |
Записывает содержимое документа в заданный поток в формате, соответствующем этому обработчику содержимого. |
Методы, объявленные в классе javax.swing.text.StyledEditorKit
getCharacterAttributeRun
Методы, объявленные в классе javax.swing.text.DefaultEditorKit
createCaret, read, write
Подробное описание полей
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()
Подробное описание методов
getContentType
public String getContentType()
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
- Параметры:
-
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)
- Переопределяет:
-
installв классеStyledEditorKit - Параметры:
-
c- JEditorPane
deinstall
public void deinstall(JEditorPane c)
- Overrides:
-
deinstallв классеStyledEditorKit - Parameters:
-
c- JEditorPane
setStyleSheet
public void setStyleSheet(StyleSheet s)
- Parameters:
-
s- StyleSheet
getStyleSheet
public StyleSheet getStyleSheet()
- 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()
FormSubmitEvent.- Returns:
- true, если отправка HTML-формы обрабатывается автоматически, false в противном случае.
- Since:
- 1.5
- See Also:
setAutoFormSubmission
public void setAutoFormSubmission(boolean isAuto)
FormSubmitEvent. По умолчанию установлено в true.- Parameters:
-
isAuto- еслиtrue, отправка HTML-формы обрабатывается автоматически. - Since:
- 1.5
- See Also:
clone
public Object clone()
- Overrides:
-
cloneв классеStyledEditorKit - Returns:
- копия
- See Also:
getParser
protected HTMLEditorKit.Parser getParser()
- Returns:
- парсер
getAccessibleContext
public AccessibleContext getAccessibleContext()
- 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