Класс JTextPane

javax.swing.JTextPane

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

@JavaBean(description="A text component that can be marked up with attributes that are graphically represented.") public class JTextPane extends JEditorPane

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

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

Символы новой строки: Обсуждение обработки символов новой строки см. в разделе DefaultEditorKit.

Предупреждение: Swing не является потокобезопасной библиотекой. Дополнительные сведения см. в разделе Политика Swing в отношении потоков.

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

Начиная с версии:

1.2

См. также:

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

Вложенные классы и интерфейсы, объявленные в классе JEditorPane

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

Вложенные классы и интерфейсы, объявленные в классе JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

Вложенные классы и интерфейсы, объявленные в классе JComponent

JComponent.AccessibleJComponent

Вложенные классы и интерфейсы, объявленные в классе Container

Container.AccessibleAWTContainer

Вложенные классы и интерфейсы, объявленные в классе Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

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

Поля, объявленные в классе JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Поля, объявленные в классе JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Поля, объявленные в классе JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Поля, объявленные в классе Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

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

Конструктор	Описание
`JTextPane()`	Создает новый объект `JTextPane`.
`JTextPane(StyledDocument doc)`	Создает новый объект `JTextPane` с указанной моделью документа.

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

Модификатор и тип	Метод	Описание
`Style`	`addStyle(String nm, Style parent)`	Добавляет новый стиль в иерархию логических стилей.
`protected EditorKit`	`createDefaultEditorKit()`	Создает `EditorKit`, используемый по умолчанию.
`AttributeSet`	`getCharacterAttributes()`	Получает атрибуты символов, действующие в текущей позиции каретки, или `null`.
`MutableAttributeSet`	`getInputAttributes()`	Получает входные атрибуты панели.
`Style`	`getLogicalStyle()`	Получает логический стиль, назначенный абзацу, соответствующему текущей позиции каретки, или `null`.
`AttributeSet`	`getParagraphAttributes()`	Получает текущие атрибуты абзаца, действующие в позиции каретки, или `null`, если они отсутствуют.
`Style`	`getStyle(String nm)`	Получает ранее добавленный именованный стиль, отличный от `null`.
`StyledDocument`	`getStyledDocument()`	Получает модель, связанную с редактором.
`protected final StyledEditorKit`	`getStyledEditorKit()`	Получает набор средств редактора.
`String`	`getUIClassID()`	Возвращает идентификатор класса пользовательского интерфейса.
`void`	`insertComponent(Component c)`	Вставляет компонент в документ вместо текущего выделенного содержимого.
`void`	`insertIcon(Icon g)`	Вставляет значок в документ вместо текущего выделенного содержимого.
`protected String`	`paramString()`	Возвращает строковое представление этого объекта `JTextPane`.
`void`	`removeStyle(String nm)`	Удаляет ранее добавленный в документ именованный стиль, отличный от `null`.
`void`	`replaceSelection(String content)`	Заменяет текущее выделенное содержимое новым содержимым, представленным заданной строкой.
`void`	`setCharacterAttributes(AttributeSet attr, boolean replace)`	Применяет указанные атрибуты к содержимому символов.
`void`	`setDocument(Document doc)`	Связывает редактор с текстовым документом.
`final void`	`setEditorKit(EditorKit kit)`	Задает установленный в данный момент набор средств для обработки содержимого.
`void`	`setLogicalStyle(Style s)`	Задает логический стиль для абзаца в текущей позиции каретки.
`void`	`setParagraphAttributes(AttributeSet attr, boolean replace)`	Применяет указанные атрибуты к абзацам.
`void`	`setStyledDocument(StyledDocument doc)`	Связывает редактор с текстовым документом.

Методы, объявленные в классе JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

Методы, объявленные в классе JTextComponent

addCaretListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, viewToModel2D, write

Методы, объявленные в классе JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Методы, объявленные в классе Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Методы, объявленные в классе Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

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

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

JTextPane

public JTextPane()

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

JTextPane

public JTextPane(StyledDocument doc)

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

Параметры:: doc — модель документа

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

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

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

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

getUIClassID в классе JEditorPane

Возвращает:

строку "TextPaneUI"

См. также:

setDocument

public void setDocument(Document doc)

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

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

setDocument в классе JTextComponent

Параметры:

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

Вызывает исключение:

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

См. также:

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)

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

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

Компонент размещается относительно базовой линии текста в соответствии со значением, возвращаемым Component.getAlignmentY. Для компонентов Swing это значение можно удобно задать с помощью метода JComponent.setAlignmentY. Например, значение 0.75 приведет к тому, что 75 процентов компонента окажутся выше базовой линии, а 25 процентов — ниже нее.

Параметры:: c — вставляемый компонент

insertIcon

public void insertIcon(Icon g)

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

Параметры:

g — вставляемый значок

См. также:

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

@BeanProperty(bound=false) public AttributeSet getCharacterAttributes()

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

Возвращает:: атрибуты или null

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attr, boolean replace)

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

Параметры:: attr — атрибуты; replace — если значение равно true, сначала заменяются существующие атрибуты

getParagraphAttributes

@BeanProperty(bound=false) public AttributeSet getParagraphAttributes()

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

Возвращает:: атрибуты

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attr, boolean replace)

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

Параметры:: attr — атрибуты, отличные от null; replace — если значение равно true, сначала заменяются существующие атрибуты

getInputAttributes

@BeanProperty(bound=false) 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

См. также:

paramString

protected String paramString()

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

Переопределяет:: paramString в классе JEditorPane
Возвращает:: строковое представление этого объекта JTextPane

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/JTextPane.html