Класс 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 Tutorial.

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

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

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

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

С тех пор как:
1.2
См. также:
StyledEditorKit, Сериализованная форма

Вложенные классы

Вложенные классы/интерфейсы, объявленные в классе 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 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)

Связывает редактор с текстовым документом.
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, 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, 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, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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"
См. также:
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)

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

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

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

Параметры:
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

@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
См. также:
JEditorPane.getEditorKit()

paramString

protected String paramString()

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

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

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

Spec-Zone .ru
спецификации, руководства, описания, API