Класс JTextPane

public class JTextPane
extends JEditorPane

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

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

Новые строки

Подробное описание обработки новых строк см. в DefaultEditorKit.

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

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

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

JTextPane

public JTextPane()

Создаёт новый JTextPane. Создаётся и устанавливается новый экземпляр StyledEditorKit, и модель документа устанавливается в null.

JTextPane

public JTextPane(StyledDocument doc)

Создаёт новый JTextPane, с указанной моделью документа. Создаётся и устанавливается новый экземпляр javax.swing.text.StyledEditorKit.

Параметры:

doc - модель документа

Методы

getUIClassID

public String getUIClassID()

Возвращает идентификатор класса пользовательского интерфейса.

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

getUIClassID в классе JEditorPane

Возвращает:

строку "TextPaneUI"

См. также:

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

setDocument

public void setDocument(Document doc)

Связывает редактор с текстовым документом. Это должен быть StyledDocument.

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

setDocument в классе JTextComponent

Параметры:

doc - документ для отображения/редактирования

Исключения:

IllegalArgumentException - если doc нельзя сузить до StyledDocument, который является требуемым типом модели для этого текстового компонента

См. также:

JTextComponent.getDocument()

setStyledDocument

public void setStyledDocument(StyledDocument doc)

Связывает редактор с текстовым документом. Текущий зарегистрированный фабрика используется для создания представления документа, которое отображается редактором.

Параметры:

doc - документ для отображения/редактирования

getStyledDocument

public StyledDocument getStyledDocument()

Извлекает модель, связанную с редактором.

Возвращает:

модель

replaceSelection

public void replaceSelection(String content)

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

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

replaceSelection в классе JEditorPane

Параметры:

content - содержимое для замены выделения

insertComponent

public void insertComponent(Component c)

Параметры:

c - компонент для вставки

insertIcon

public void insertIcon(Icon g)

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

Параметры:

g - значок для вставки

См. также:

Icon

addStyle

public Style addStyle(String nm,
                      Style parent)

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

Параметры:

nm - имя стиля (должно быть уникальным в наборе именованных стилей). Имя может быть null если стиль безымянный, но вызывающий объект отвечает за управление ссылкой, так как безымянный стиль не может быть получен по имени. Безымянный стиль может быть полезен для таких вещей, как переопределения атрибутов символов, как в стиле пробега.

parent - родительский стиль. Это может быть null если атрибуты, не определённые явно, не должны быть разрешены в другом стиле.

Возвращает:

новый Style

removeStyle

public void removeStyle(String nm)

Удаляет именованный не-null стиль, ранее добавленный в документ.

Параметры:

nm - имя стиля для удаления

getStyle

public Style getStyle(String nm)

Извлекает именованный не-null стиль, ранее добавленный.

Параметры:

nm - имя стиля

Возвращает:

стиль Style

setLogicalStyle

public void setLogicalStyle(Style s)

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

Параметры:

s - логический стиль для назначения абзацу, или null для отсутствия стиля

getLogicalStyle

public Style getLogicalStyle()

Извлекает логический стиль, назначенный абзацу, представленному текущей позицией курсора, или null.

Возвращает:

Style

getCharacterAttributes

public AttributeSet getCharacterAttributes()

Извлекает атрибуты символов, действующие в текущем месте курсора, или null.

Возвращает:

атрибуты, или null

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attr,
                                   boolean replace)

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

Параметры:

attr - атрибуты

replace - если true, то сначала заменить существующие атрибуты

getParagraphAttributes

public AttributeSet getParagraphAttributes()

Извлекает текущие атрибуты абзаца, действующие в месте курсора, или null если их нет.

Возвращает:

атрибуты

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attr,
                                   boolean replace)

Применяет заданные атрибуты к абзацам. Если есть выделение, атрибуты применяются к абзацам, пересекающим выделение. Если выделения нет, атрибуты применяются к абзацу в текущей позиции курсора.

Параметры:

attr - атрибуты, не являющиеся null

replace - если true, заменить существующие атрибуты сначала

getInputAttributes

public MutableAttributeSet getInputAttributes()

Получает атрибуты ввода для панели.

Возвращает:

атрибуты

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit()

Получает набор инструментов редактора.

Возвращает:

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

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

Создаёт EditorKit по умолчанию. Это реализовано для возвращения javax.swing.text.StyledEditorKit.

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

createDefaultEditorKit в классе JEditorPane

Возвращает:

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

setEditorKit

public final void setEditorKit(EditorKit kit)

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

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

setEditorKit в классе JEditorPane

Параметры:

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

Исключения:

IllegalArgumentException - если набор инструментов не StyledEditorKit

См. также:

JEditorPane.getEditorKit()

paramString

protected String paramString()

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

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

paramString в классе JEditorPane

Возвращает:

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