Класс HTMLEditorKit
- Все реализованные интерфейсы:
-
Serializable,Cloneable,Accessible
public class HTMLEditorKit extends StyledEditorKit implements Accessible
Существует несколько целей HTML EditorKit, которые влияют на способ моделирования HTML. Они существенно повлияли на его разработку.
- Поддержка редактирования
- Возможно, довольно очевидно, что плагин для JEditorPane должен предоставлять поддержку редактирования, но этот факт имеет несколько соображений по проектированию. Существует значительное количество HTML-документов, которые не полностью соответствуют спецификации 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 |
Файл с таблицей стилей по умолчанию, который настраивает представления тегов. |
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, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, downAction, endAction, endLineAction, 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 |
Копирует пары ключ/значение в AttributeSet 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 -
popDepth- количество ElementSpec.EndTagTypes для генерации перед вставкой -
html- строка HTML -
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)
- Переопределяет:
-
deinstallв классеStyledEditorKit - Параметры:
-
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, 2021, 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/17/docs/api/java.desktop/javax/swing/text/html/HTMLEditorKit.html