Класс 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, добавлена поддержка долгосрочного хранения всех JavaBeans в пакете java.beans. См. XMLEncoder.

Since:

1.2

См. также:

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

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

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

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

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

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

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

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Поля, объявленные в классе javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе java.awt.image.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)`	Связывает редактор с текстовым документом.

Методы, объявленные в классе javax.swing.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

Методы, объявленные в классе javax.swing.text.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

Методы, объявленные в классе javax.swing.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

Методы, объявленные в классе java.awt.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

Методы, объявленные в классе java.awt.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

Методы, объявленные в классе java.lang.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.

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

© 1993, 2023, 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/21/docs/api/java.desktop/javax/swing/JTextPane.html