Класс JEditorPane

Компонент для редактирования различных типов контента. Информацию и примеры использования редакторов вы найдете в разделе Использование текстовых компонентов учебника Java.

Этот компонент использует реализации EditorKit для достижения своего поведения. Он эффективно преобразуется в соответствующий вид текстового редактора для заданного типа контента. Тип контента, к которому привязан редактор в данный момент, определяется установленным EditorKit. Если контент установлен на новую URL, то тип URL используется для определения EditorKit, который должен использоваться для загрузки контента.

По умолчанию известны следующие типы контента:

text/plain

Простой текст, который является значением по умолчанию, если тип не распознан. Используемый набор инструментов в этом случае является расширением DefaultEditorKit, который создает вид обернутого простого текста.

text/html

Текст HTML. В этом случае используется класс javax.swing.text.html.HTMLEditorKit, который предоставляет поддержку HTML 3.2.

text/rtf

Текст RTF. В этом случае используется класс javax.swing.text.rtf.RTFEditorKit, который предоставляет ограниченную поддержку формата Rich Text.

Существует несколько способов загрузки контента в этот компонент.

1. Метод setText может использоваться для инициализации компонента из строки. В этом случае будет использоваться текущий EditorKit, и ожидается, что тип контента будет этого типа.
2. Метод read может использоваться для инициализации компонента из Reader. Обратите внимание, что если тип контента HTML, относительные ссылки (например, для изображений) не могут быть разрешены, если не используется тег <base> или свойство Base у HTMLDocument. В этом случае будет использоваться текущий EditorKit, и ожидается, что тип контента будет этого типа.
3. Метод setPage может использоваться для инициализации компонента из URL. В этом случае тип контента будет определен из URL, и зарегистрированный EditorKit для этого типа контента будет установлен.

Некоторые типы контента могут предоставлять поддержку гиперссылок, генерируя события гиперссылок. HTML EditorKit будет генерировать события гиперссылок, если JEditorPane является нередактируемым (был вызван JEditorPane.setEditable(false);). Если в документе встроены HTML-фреймы, типичный ответ будет состоять в изменении части текущего документа. Следующий фрагмент кода представляет собой возможную реализацию обработчика гиперссылок, которая обрабатывает события HTML-фреймов специальным образом и просто отображает любые другие активированные гиперссылки.

     class Hyperactive implements HyperlinkListener {
 
         public void hyperlinkUpdate(HyperlinkEvent e) {
             if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
                 JEditorPane pane = (JEditorPane) e.getSource();
                 if (e instanceof HTMLFrameHyperlinkEvent) {
                     HTMLFrameHyperlinkEvent  evt = (HTMLFrameHyperlinkEvent)e;
                     HTMLDocument doc = (HTMLDocument)pane.getDocument();
                     doc.processHTMLFrameHyperlinkEvent(evt);
                 } else {
                     try {
                         pane.setPage(e.getURL());
                     } catch (Throwable t) {
                         t.printStackTrace();
                     }
                 }
             }
         }
     }

Для получения информации о настройке рендеринга text/html см. W3C_LENGTH_UNITS и HONOR_DISPLAY_PROPERTIES

Информация, зависящая от культуры в некоторых документах, обрабатывается с помощью механизма, называемого кодировкой символов. Кодировка символов — это однозначное отображение членов набора символов (букв, идеограмм, цифр, символов или управляющих функций) на определенные числовые значения кодов. Она представляет собой способ хранения файла. Примеры кодировок символов: ISO-8859-1, ISO-8859-5, Shift-jis, Euc-jp и UTF-8. При передаче файла в пользовательский агент (JEditorPane) он преобразуется в набор символов документа (ISO-10646, известный как Unicode).

Существует несколько способов обеспечить отображение кодировки символов с JEditorPane.

1. Один из способов — указать кодировку символов в качестве параметра MIME-типа. Это будет установлено вызовом метода setContentType. Если контент загружается методом setPage, тип контента будет установлен в соответствии с указанием URL. Если файл загружается напрямую, ожидается, что тип контента будет установлен до загрузки.
2. Другой способ указания кодировки символов — в самом документе. Это требует прочтения документа до определения желаемой кодировки символов. Для этого ожидается, что операция EditorKit.read сгенерирует ChangedCharSetException, которая будет перехвачена. Затем чтение перезапускается с новым ридером, который использует кодировку символов, указанную в ChangedCharSetException (это IOException).

Новые строки

Обсуждение обработки новых строк см. в DefaultEditorKit.

Предупреждение: Swing не потокобезопасен. Дополнительную информацию см. в Политике потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, работающими с той же версией Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. См. XMLEncoder.

Поля

W3C_LENGTH_UNITS

public static final String W3C_LENGTH_UNITS

С тех пор:

1.5

См. также:

Значения константных полей

HONOR_DISPLAY_PROPERTIES

public static final String HONOR_DISPLAY_PROPERTIES

С тех пор:

1.5

См. также:

Значения константных полей

Конструкторы

JEditorPane

public JEditorPane()

Создаёт новый JEditorPane. Модель документа установлена в null.

JEditorPane

public JEditorPane(URL initialPage)
            throws IOException

Создаёт JEditorPane на основе указанного URL для ввода.

Параметры:

initialPage - URL

Исключения:

IOException - если URL null или недоступен

JEditorPane

public JEditorPane(String url)
            throws IOException

Создаёт JEditorPane на основе строки, содержащей спецификацию URL.

Параметры:

url - URL

Исключения:

IOException - если URL null или недоступен

JEditorPane

public JEditorPane(String type,
                   String text)

Создаёт JEditorPane, инициализированный заданным текстом. Это удобный конструктор, вызывающий методы setContentType и setText.

Параметры:

type - тип MIME заданного текста

text - текст для инициализации; может быть null

Исключения:

NullPointerException - если параметр type null

Методы

addHyperlinkListener

public void addHyperlinkListener(HyperlinkListener listener)

Добавляет слушателя гиперссылок для уведомлений о любых изменениях, например, при выборе и вводе ссылки.

Параметры:

listener - слушатель

removeHyperlinkListener

public void removeHyperlinkListener(HyperlinkListener listener)

Удаляет слушателя гиперссылок.

Параметры:

listener - слушатель

getHyperlinkListeners

public HyperlinkListener[] getHyperlinkListeners()

Возвращает массив всех HyperLinkListener добавленных в этот JEditorPane с помощью addHyperlinkListener().

Возвращает:

все добавленные HyperLinkListener или пустой массив, если слушатели не добавлены

С тех пор:

1.4

fireHyperlinkUpdate

public void fireHyperlinkUpdate(HyperlinkEvent e)

Уведомляет всех слушателей, которые зарегистрировали интерес к уведомлению об этом типе события. Обычно это вызывается текущим установленным EditorKit если текущий тип контента поддерживает гиперссылки и была активность со ссылкой. Список слушателей обрабатывается в обратном порядке.

Параметры:

e - событие

См. также:

EventListenerList

setPage

public void setPage(URL page)
             throws IOException

Document doc = jEditorPane.getDocument();
   doc.putProperty(Document.StreamDescriptionProperty, null);

Параметры:

page - URL страницы

Исключения:

IOException - для null или некорректной спецификации страницы, или исключения из потока чтения

См. также:

getPage()

read

public void read(InputStream in,
                 Object desc)
          throws IOException

Этот метод инициализирует из потока. Если набор инструментов установлен в тип HTMLEditorKit, и параметр desc — HTMLDocument, он вызовет HTMLEditorKit для запуска чтения. В противном случае вызывается метод суперкласса, который загружает модель как обычный текст.

Параметры:

in - поток для чтения

desc - объект, описывающий поток

Исключения:

IOException - как вызвано потоком, используемым для инициализации

См. также:

JTextComponent.read(java.io.Reader, java.lang.Object), JTextComponent.setDocument(javax.swing.text.Document)

getStream

protected InputStream getStream(URL page)
                         throws IOException

Параметры:

page - URL страницы

Исключения:

IOException

scrollToReference

public void scrollToReference(String reference)

Прокручивает представление до заданного местоположения ссылки (то есть значения, возвращаемого методом UL.getRef для отображаемого URL). По умолчанию этот метод знает только как найти ссылку в HTMLDocument. Реализация вызывает метод scrollRectToVisible для выполнения фактической прокрутки. Если для типов документов, отличных от HTML, требуется прокрутка к местоположению ссылки, этот метод следует переопределить. Этот метод не будет иметь эффекта, если компонент не отображается.

Параметры:

reference - имя местоположения для прокрутки

getPage

public URL getPage()

Получает текущий отображаемый URL. Если URL не был указан при создании документа, возвращается null, и относительные URL не будут разрешены.

Возвращает:

URL или null если нет

setPage

public void setPage(String url)
             throws IOException

Устанавливает текущий отображаемый URL.

Параметры:

url - URL для отображения

Исключения:

IOException - для null или некорректной спецификации URL

getUIClassID

public String getUIClassID()

Получает идентификатор класса UI.

Переопределяет:

getUIClassID в классе JComponent

Возвращает:

строку "EditorPaneUI"

См. также:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

Создаёт набор инструментов по умолчанию (PlainEditorKit) для момента первого создания компонента.

Возвращает:

набор инструментов

getEditorKit

public EditorKit getEditorKit()

Получает текущий установленный набор инструментов для обработки содержимого. createDefaultEditorKit вызывается для настройки по умолчанию, если необходимо.

Возвращает:

набор инструментов

getContentType

public final String getContentType()

Получает тип содержимого, с которым в настоящее время работает этот редактор. Это определено как тип, связанный с текущим установленным EditorKit.

Возвращает:

тип содержимого, null если набор инструментов не установлен

setContentType

public final void setContentType(String type)

Parameters:

type - не-null MIME-тип для поддержки редактирования содержимого

Throws:

NullPointerException - если параметр type равен null

See Also:

getContentType()

setEditorKit

public void setEditorKit(EditorKit kit)

Parameters:

kit - желаемое поведение редактора

See Also:

getEditorKit()

getEditorKitForContentType

public EditorKit getEditorKitForContentType(String type)

Parameters:

type - не-null тип содержимого

Returns:

набор редакторов

setEditorKitForContentType

public void setEditorKitForContentType(String type,
                                       EditorKit k)

Непосредственно устанавливает набор редакторов для использования с данным типом. Реализация внешнего вида может использовать это в сочетании с createEditorKitForContentType, чтобы установить обработчики для типов содержимого с предпочтениями внешнего вида.

Parameters:

type - не-null тип содержимого

k - устанавливаемый набор редакторов

replaceSelection

public void replaceSelection(String content)

Заменяет текущее выделенное содержимое новым содержимым, представленным заданной строкой. Если выделения нет, это эквивалентно вставке заданного текста. Если текста для замены нет (то есть строка содержимого пуста или null), это эквивалентно удалению текущего выделения. Текст замены будет иметь атрибуты, которые в настоящее время определены для ввода. Если компонент не редактируемый, издаётся звуковой сигнал и возвращается значение.

Overrides:

replaceSelection в классе JTextComponent

Parameters:

content - содержимое для замены выделенного. Это значение может быть null

createEditorKitForContentType

public static EditorKit createEditorKitForContentType(String type)

Parameters:

type - тип содержимого

Returns:

набор редакторов или null если для данного типа ничего не зарегистрировано

registerEditorKitForContentType

public static void registerEditorKitForContentType(String type,
                                                   String classname)

Устанавливает стандартные связи type с classname. Класс будет динамически загружен позже, когда это действительно потребуется, и его можно безопасно изменить перед использованием, чтобы избежать загрузки нежелательных классов. Прототип EditorKit будет загружен с Class.forName при регистрации с помощью этого метода.

Parameters:

type - не-null тип содержимого

classname - класс для последующей загрузки

registerEditorKitForContentType

public static void registerEditorKitForContentType(String type,
                                                   String classname,
                                                   ClassLoader loader)

Устанавливает стандартные связи type с classname. Класс будет динамически загружен позже, когда это действительно потребуется, используя указанный ClassLoader, и его можно безопасно изменить перед использованием, чтобы избежать загрузки нежелательных классов.

Parameters:

type - не-null тип содержимого

classname - класс для последующей загрузки

loader - ClassLoader для использования при загрузке имени

getEditorKitClassNameForContentType

public static String getEditorKitClassNameForContentType(String type)

Возвращает текущее зарегистрированное имя класса EditorKit для типа type.

Parameters:

type - не-null тип содержимого

Since:

1.3

getPreferredSize

public Dimension getPreferredSize()

Возвращает предпочтительный размер для JEditorPane. Предпочтительный размер для JEditorPane немного отличается от предпочтительного размера базового класса. Если размер области просмотра стал меньше минимального размера компонента, определение scrollable для отслеживания ширины или высоты станет ложным. Стандартная компоновка области просмотра вернёт предпочтительный размер, а это нежелательно в случае отслеживания scrollable. В этом случае предпочтительный размер изменяется на минимальный размер. Это позволяет таким элементам, как HTML-таблицы, сжиматься до минимального размера, а затем размещаться в минимальном размере, отказываясь от дальнейшего сжатия.

Overrides:

getPreferredSize в классе JComponent

Returns:

объект Dimension, содержащий предпочтительный размер

See Also:

JComponent.setPreferredSize(java.awt.Dimension), ComponentUI

setText

public void setText(String t)

Overrides:

setText в классе JTextComponent

Parameters:

t - новый текст для установки; если null, старый текст будет удалён

See Also:

getText()

getText

public String getText()

Возвращает текст, содержащийся в этом TextComponent, в терминах типа содержимого этого редактора. Если при попытке извлечения текста произойдёт исключение, возвращается null. Этот метод реализован для вызова JTextComponent.write с StringWriter.

Overrides:

getText в классе JTextComponent

Returns:

текст

See Also:

setText(java.lang.String)

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Возвращает true, если область просмотра должна всегда принудительно устанавливать ширину этого Scrollable в соответствие с шириной области просмотра.

Specified by:

getScrollableTracksViewportWidth в интерфейсе Scrollable

Overrides:

getScrollableTracksViewportWidth в классе JTextComponent

Returns:

true, если область просмотра должна принудительно устанавливать ширину Scrollables в соответствие со своей собственной шириной, false в противном случае

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Возвращает true, если область просмотра должна всегда принудительно устанавливать высоту этого Scrollable в соответствие с высотой области просмотра.

Specified by:

getScrollableTracksViewportHeight в интерфейсе Scrollable

Overrides:

getScrollableTracksViewportHeight в классе JTextComponent

Returns:

true, если область просмотра должна принудительно установить высоту Scrollable в соответствие со своей собственной высотой, false в противном случае

paramString

protected String paramString()

Возвращает строковое представление этого JEditorPane. Этот метод предназначен только для отладки, и содержимое и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не может быть null.

Переопределяет:

paramString в классе JTextComponent

Возвращает:

строковое представление этого JEditorPane

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этим JEditorPane. Для редакторов области, AccessibleContext принимает форму AccessibleJEditorPane. Новый экземпляр AccessibleJEditorPane создается при необходимости.

Указано в:

getAccessibleContext в интерфейсе Accessible

Переопределяет:

getAccessibleContext в классе JTextComponent

Возвращает:

AccessibleJEditorPane, который служит AccessibleContext этого JEditorPane