Класс JTextComponent

public static final String FOCUS_ACCELERATOR_KEY

См. также:

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

public static final String DEFAULT_KEYMAP

См. также:

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

public JTextComponent()

public TextUI getUI()

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

getUI в классе JComponent

Возвращает:

фабрику

public void setUI(TextUI ui)

Параметры:

ui - фабрика

public void updateUI()

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

updateUI в классе JComponent

См. также:

• JComponent.setUI(javax.swing.plaf.ComponentUI)
• UIManager.getLookAndFeel()
• UIManager.getUI(javax.swing.JComponent)

public void addCaretListener(CaretListener listener)

Параметры:

listener - добавляемый слушатель

См. также:

• CaretEvent

public void removeCaretListener(CaretListener listener)

Параметры:

listener - удаляемый слушатель

См. также:

• CaretEvent

@BeanProperty(bound=false) public CaretListener[] getCaretListeners()

Возвращает:

все слушатели событий курсора этого компонента или пустой массив, если слушатели событий курсора не зарегистрированы

С:

1.4

См. также:

• addCaretListener(javax.swing.event.CaretListener)
• removeCaretListener(javax.swing.event.CaretListener)

protected void fireCaretUpdate(CaretEvent e)

Параметры:

e - событие

См. также:

• EventListenerList

@BeanProperty(expert=true, description="the text document model") public void setDocument(Document doc)

Параметры:

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

См. также:

• getDocument()

public Document getDocument()

Возвращает:

модель

@BeanProperty(bound=false) public Action[] getActions()

Возвращает:

список команд

@BeanProperty(description="desired space between the border and text area") public void setMargin(Insets m)

Параметры:

m - отступ между границей и текстом

public Insets getMargin()

Возвращает:

отступ

public void setNavigationFilter(NavigationFilter filter)

Параметры:

filter - фильтр

С:

1.4

public NavigationFilter getNavigationFilter()

Возвращает:

NavigationFilter

С:

1.4

public Caret getCaret()

Возвращает:

курсор

@BeanProperty(expert=true, description="the caret used to select/navigate") public void setCaret(Caret c)

Параметры:

c - курсор

См. также:

• getCaret()

public Highlighter getHighlighter()

Возвращает:

выделитель

@BeanProperty(expert=true, description="object responsible for background highlights") public void setHighlighter(Highlighter h)

Параметры:

h - выделитель

См. также:

• getHighlighter()

@BeanProperty(description="set of key event to action bindings to use") public void setKeymap(Keymap map)

Parameters:

map - keymap

See Also:

• getKeymap()

@BeanProperty(bound=false, description="determines whether automatic drag handling is enabled") public void setDragEnabled(boolean b)

Parameters:

b - включить или отключить автоматическую обработку перетаскивания

Throws:

HeadlessException - если b является true и GraphicsEnvironment.isHeadless() возвращает true

Since:

1.4

See Also:

• GraphicsEnvironment.isHeadless()
• getDragEnabled()
• JComponent.setTransferHandler(javax.swing.TransferHandler)
• TransferHandler

public boolean getDragEnabled()

Returns:

значение свойства dragEnabled

Since:

1.4

See Also:

• setDragEnabled(boolean)

public final void setDropMode(DropMode dropMode)

Parameters:

dropMode - режим опускания для использования

Throws:

IllegalArgumentException - если режим опускания не поддерживается или null

Since:

1.6

See Also:

• getDropMode()
• getDropLocation()
• JComponent.setTransferHandler(javax.swing.TransferHandler)
• TransferHandler

public final DropMode getDropMode()

Returns:

режим опускания для этого компонента

Since:

1.6

See Also:

• setDropMode(javax.swing.DropMode)

@BeanProperty(bound=false) public final JTextComponent.DropLocation getDropLocation()

Returns:

расположение опускания

Since:

1.6

See Also:

• setDropMode(javax.swing.DropMode)
• TransferHandler.canImport(TransferHandler.TransferSupport)

public Keymap getKeymap()

Returns:

keymap

public static Keymap addKeymap(String nm, Keymap parent)

Parameters:

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

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

Returns:

keymap

public static Keymap removeKeymap(String nm)

Parameters:

nm - имя keymap для удаления

Returns:

удалённый keymap

public static Keymap getKeymap(String nm)

Parameters:

nm - имя keymap

Returns:

keymap

public static void loadKeymap(Keymap map, JTextComponent.KeyBinding[] bindings, Action[] actions)

   static final JTextComponent.KeyBinding[] defaultBindings = {
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK),
       DefaultEditorKit.copyAction),
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_V, InputEvent.CTRL_MASK),
       DefaultEditorKit.pasteAction),
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_X, InputEvent.CTRL_MASK),
       DefaultEditorKit.cutAction),
   };

   JTextComponent c = new JTextPane();
   Keymap k = c.getKeymap();
   JTextComponent.loadKeymap(k, defaultBindings, c.getActions());

 

Parameters:

map - keymap

bindings - привязки

actions - набор действий

public Color getCaretColor()

Returns:

цвет

@BeanProperty(preferred=true, description="the color used to render the caret") public void setCaretColor(Color c)

Parameters:

c - цвет

See Also:

• getCaretColor()

public Color getSelectionColor()

Returns:

цвет

@BeanProperty(preferred=true, description="color used to render selection background") public void setSelectionColor(Color c)

Parameters:

c - цвет

See Also:

• getSelectionColor()

public Color getSelectedTextColor()

Returns:

цвет

@BeanProperty(preferred=true, description="color used to render selected text") public void setSelectedTextColor(Color c)

Параметры:

c - цвет

См. также:

• getSelectedTextColor()

public Color getDisabledTextColor()

Возвращает:

цвет

@BeanProperty(preferred=true, description="color used to render disabled text") public void setDisabledTextColor(Color c)

Параметры:

c - цвет

См. также:

• getDisabledTextColor()

public void replaceSelection(String content)

Параметры:

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

public String getText(int offs, int len) throws BadLocationException

Параметры:

offs - смещение ≥ 0

len - длина ≥ 0

Возвращает:

текст

Исключения:

BadLocationException - если смещение или длина некорректны

@Deprecated(since="9") public Rectangle modelToView(int pos) throws BadLocationException

Параметры:

pos - позиция ≥ 0

Возвращает:

координаты в виде прямоугольника, где (r.x, r.y) – расположение в системе координат, или null, если у компонента еще нет положительного размера.

Исключения:

BadLocationException - если заданная позиция не представляет допустимое расположение в связанном документе

См. также:

• TextUI.modelToView(javax.swing.text.JTextComponent, int)

public Rectangle2D modelToView2D(int pos) throws BadLocationException

Параметры:

pos - позиция >= 0

Возвращает:

координаты в виде прямоугольника, где (r.x, r.y) – расположение в системе координат, или null, если у компонента еще нет положительного размера.

Исключения:

BadLocationException - если заданная позиция не представляет допустимое расположение в связанном документе

С:

9

См. также:

• TextUI.modelToView2D(javax.swing.text.JTextComponent, int, javax.swing.text.Position.Bias)

@Deprecated(since="9") public int viewToModel(Point pt)

Параметры:

pt - расположение в представлении для преобразования

Возвращает:

смещение ≥ 0 от начала документа, или -1, если у компонента еще нет положительного размера.

См. также:

• TextUI.viewToModel(javax.swing.text.JTextComponent, java.awt.Point)

public int viewToModel2D(Point2D pt)

Параметры:

pt - расположение в представлении для преобразования

Возвращает:

смещение >= 0 от начала документа, или -1, если у компонента еще нет положительного размера.

С:

9

См. также:

• TextUI.viewToModel2D(javax.swing.text.JTextComponent, java.awt.geom.Point2D, javax.swing.text.Position.Bias[])

public void cut()

См. также:

• Toolkit.getSystemClipboard()
• Clipboard

public void copy()

См. также:

• Toolkit.getSystemClipboard()
• Clipboard

public void paste()

См. также:

• replaceSelection(java.lang.String)
• Toolkit.getSystemClipboard()
• Clipboard

public void moveCaretPosition(int pos)

Параметры:

pos - позиция

Исключения:

IllegalArgumentException - если значение, предоставленное для position, меньше нуля или больше длины текста компонента

См. также:

• setCaretPosition(int)

@BeanProperty(description="accelerator character used to grab focus") public void setFocusAccelerator(char aKey)

Параметры:

aKey - клавиша

См. также:

• getFocusAccelerator()

public char getFocusAccelerator()

Returns:

клавишу

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

Parameters:

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

desc - объект, описывающий поток; это может быть строка, файл, URL и т.д. Некоторые типы документов (например, html) могут использовать эту информацию; если не null, добавляется как свойство документа

Throws:

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

See Also:

• EditorKit.createDefaultDocument()
• setDocument(javax.swing.text.Document)
• PlainDocument

public void write(Writer out) throws IOException

Parameters:

out - выходной поток

Throws:

IOException - при любой ошибке ввода-вывода

@BeanProperty(bound=false, description="the caret position") public void setCaretPosition(int position)

Parameters:

position - позиция

Throws:

IllegalArgumentException - если значение, предоставленное для position, меньше нуля или больше длины текста компонента

public int getCaretPosition()

Returns:

положение курсора вставки текста для текстового компонента ≥ 0

@BeanProperty(bound=false, description="the text of this component") public void setText(String t)

Parameters:

t - новый устанавливаемый текст

See Also:

• getText(int, int)
• DefaultCaret

public String getText()

Returns:

текст

Throws:

NullPointerException - если документ null

See Also:

• setText(java.lang.String)

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

Returns:

текст

Throws:

IllegalArgumentException - если выделение не имеет допустимой привязки к документу по какой-либо причине

See Also:

• setText(java.lang.String)

public boolean isEditable()

Returns:

булево значение

See Also:

• setEditable(boolean)

@BeanProperty(description="specifies if the text can be edited") public void setEditable(boolean b)

Parameters:

b - устанавливаемое булево значение

See Also:

• isEditable()

public int getSelectionStart()

Returns:

начальная позиция ≥ 0

@BeanProperty(bound=false, description="starting location of the selection.") public void setSelectionStart(int selectionStart)

Parameters:

selectionStart - начальная позиция текста ≥ 0

public int getSelectionEnd()

Returns:

конечная позиция ≥ 0

@BeanProperty(bound=false, description="ending location of the selection.") public void setSelectionEnd(int selectionEnd)

Parameters:

selectionEnd - конечная позиция текста ≥ 0

public void select(int selectionStart, int selectionEnd)

Parameters:

selectionStart - начальная позиция текста

selectionEnd - конечная позиция текста

See Also:

• setCaretPosition(int)
• moveCaretPosition(int)

public void selectAll()

public String getToolTipText(MouseEvent event)

Overrides:

getToolTipText в классе JComponent

Параметры:

event - событие, о котором идет речь

Возвращает:

строку, используемую в качестве подсказки для event

См. также:

• JComponent.setToolTipText(java.lang.String)
• TextUI.getToolTipText(javax.swing.text.JTextComponent, java.awt.Point)
• ToolTipManager.registerComponent(javax.swing.JComponent)

@BeanProperty(bound=false) public Dimension getPreferredScrollableViewportSize()

Определено в:

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

Возвращает:

предпочтительный размер preferredSize JViewport, чей вид — это данный Scrollable

См. также:

• JComponent.getPreferredSize()

public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)

Определено в:

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

Параметры:

visibleRect - область представления, видимая в области просмотра

orientation - либо SwingConstants.VERTICAL, либо SwingConstants.HORIZONTAL

direction - меньше нуля для прокрутки вверх/влево, больше нуля для вниз/вправо

Возвращает:

шаг прокрутки в указанном направлении

Исключения:

IllegalArgumentException - для неверной ориентации

См. также:

• JScrollBar.setUnitIncrement(int)

public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)

Определено в:

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

Параметры:

visibleRect - область представления, видимая в области просмотра

orientation - либо SwingConstants.VERTICAL, либо SwingConstants.HORIZONTAL

direction - меньше нуля для прокрутки вверх/влево, больше нуля для вниз/вправо

Возвращает:

шаг прокрутки блока в указанном направлении

Исключения:

IllegalArgumentException - для неверной ориентации

См. также:

• JScrollBar.setBlockIncrement(int)

@BeanProperty(bound=false) public boolean getScrollableTracksViewportWidth()

Определено в:

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

Возвращает:

true, если область просмотра должна принудительно изменять ширину Scrollable для соответствия собственной ширине

@BeanProperty(bound=false) public boolean getScrollableTracksViewportHeight()

Определено в:

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

Возвращает:

true, если область просмотра должна принудительно изменять высоту элемента прокрутки для соответствия собственной высоте

public boolean print() throws PrinterException

Возвращает:

true, если пользователь не отменил печать

Исключения:

PrinterException - если ошибка в системе печати приводит к прерыванию задания

С момента:

1.6

См. также:

• print(MessageFormat, MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean)

public boolean print(MessageFormat headerFormat, MessageFormat footerFormat) throws PrinterException

Параметры:

headerFormat - текст, в MessageFormat, используемый в качестве заголовка, или null для отсутствия заголовка

footerFormat - текст, в MessageFormat, используемый в качестве подвала, или null для отсутствия подвала

Возвращает:

true, если пользователь не отменил печать

Исключения:

PrinterException - если ошибка в системе печати приводит к прерыванию задания

С момента:

1.6

См. также:

• print(MessageFormat, MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean)
• MessageFormat

public boolean print(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive) throws PrinterException

 textComponent.print(new MessageFormat("My text component header"),
     new MessageFormat("Footer. Page - {0}"), true, null, null, true);
 

     FutureTask<Boolean> future =
         new FutureTask<Boolean>(
             new Callable<Boolean>() {
                 public Boolean call() {
                     return textComponent.print(.....);
                 }
             });
     executor.execute(future);
 

Parameters:

headerFormat - текст, используемый в качестве заголовка, или null для отсутствия заголовка

footerFormat - текст, используемый в качестве подвала, или null для отсутствия подвала

showPrintDialog - true для отображения диалога печати, false в противном случае

service - начальные PrintService, или null для значения по умолчанию

attributes - атрибуты задания для применения к заданию печати, или null для отсутствия

interactive - выполнить печать в интерактивном режиме

Returns:

true, если печать не была отменена пользователем

Throws:

PrinterException - если ошибка в системе печати приводит к прерыванию задания

Since:

1.6

See Also:

• getPrintable(java.text.MessageFormat, java.text.MessageFormat)
• MessageFormat
• GraphicsEnvironment.isHeadless()
• FutureTask

public Printable getPrintable(MessageFormat headerFormat, MessageFormat footerFormat)

Parameters:

headerFormat - текст, используемый в качестве заголовка, или null для отсутствия заголовка

footerFormat - текст, используемый в качестве подвала, или null для отсутствия подвала

Returns:

a Printable для использования в печати содержимого этого JTextComponent

Since:

1.6

See Also:

• Printable
• PageFormat
• Document.render(java.lang.Runnable)

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

Specified by:

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

Overrides:

getAccessibleContext в классе Component

Returns:

AccessibleJTextComponent, являющийся объектом AccessibleContext этого JTextComponent

protected String paramString()

Overrides:

paramString в классе JComponent

Returns:

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

@BeanProperty(bound=false) public InputMethodRequests getInputMethodRequests()

Overrides:

getInputMethodRequests в классе Component

Returns:

обработчик запросов метода ввода для этого компонента, null по умолчанию

See Also:

• Component.addInputMethodListener(java.awt.event.InputMethodListener)

protected boolean saveComposedText(int pos)

Parameters:

pos - позиция документа для определения местоположения составленного текста

Returns:

true, если составленный текст существует и сохранён, false в противном случае

Since:

1.7

See Also:

• restoreComposedText()

protected void restoreComposedText()

Since:

1.7

See Also:

• saveComposedText(int)