Класс 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(ComponentUI)
• UIManager.getLookAndFeel()
• UIManager.getUI(JComponent)

public void addCaretListener(CaretListener listener)

Параметры:

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

См. также:

• CaretEvent

public void removeCaretListener(CaretListener listener)

Параметры:

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

См. также:

• CaretEvent

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

Возвращает:

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

С версии:

1.4

См. также:

• addCaretListener(CaretListener)
• removeCaretListener(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()

Возвращает:

подсветчик (highlighter)

@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)

Параметры:

map - раскладка клавиш

См. также:

• getKeymap()

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

Параметры:

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

Исключения:

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

С версии:

1.4

См. также:

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

public boolean getDragEnabled()

Возвращает:

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

С версии:

1.4

См. также:

• setDragEnabled(boolean)

public final void setDropMode(DropMode dropMode)

Параметры:

dropMode - используемый режим сброса

Исключения:

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

С версии:

1.6

См. также:

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

public final DropMode getDropMode()

Возвращает:

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

С версии:

1.6

См. также:

• setDropMode(DropMode)

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

Возвращает:

место сброса

С версии:

1.6

См. также:

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

public Keymap getKeymap()

Возвращает:

раскладку клавиш

public static Keymap addKeymap(String nm, Keymap parent)

Параметры:

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

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

Возвращает:

раскладку клавиш

public static Keymap removeKeymap(String nm)

Параметры:

nm - имя удаляемой раскладки клавиш

Возвращает:

удаленную раскладку клавиш

public static Keymap getKeymap(String nm)

Параметры:

nm - имя раскладки клавиш

Возвращает:

раскладку клавиш

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());

Параметры:

map - раскладка клавиш

bindings - привязки

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

public Color getCaretColor()

Возвращает:

цвет

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

Параметры:

c - цвет

См. также:

• getCaretColor()

public Color getSelectionColor()

Возвращает:

цвет

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

Параметры:

c - цвет

См. также:

• getSelectionColor()

public Color getSelectedTextColor()

Возвращает:

цвет

@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(JTextComponent, int)

public Rectangle2D modelToView2D(int pos) throws BadLocationException

Параметры:

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

Возвращает:

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

Исключения:

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

С версии:

9

См. также:

• TextUI.modelToView2D(JTextComponent, int, Position.Bias)

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

Параметры:

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

Возвращает:

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

См. также:

• TextUI.viewToModel(JTextComponent, Point)

public int viewToModel2D(Point2D pt)

Параметры:

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

Возвращает:

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

С версии:

9

См. также:

• TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])

public void cut()

См. также:

• Toolkit.getSystemClipboard()
• Clipboard

public void copy()

См. также:

• Toolkit.getSystemClipboard()
• Clipboard

public void paste()

См. также:

• replaceSelection(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()

Возвращает:

клавиша

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

Параметры:

in - поток, из которого производится чтение

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

Исключения:

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

См. также:

• EditorKit.createDefaultDocument()
• setDocument(Document)
• PlainDocument

public void write(Writer out) throws IOException

Параметры:

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

Исключения:

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

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

Параметры:

position - позиция

Исключения:

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

public int getCaretPosition()

Возвращает:

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

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

Параметры:

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

См. также:

• getText(int, int)
• DefaultCaret

public String getText()

Возвращает:

текст

Исключения:

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

См. также:

• setText(String)

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

Возвращает:

текст

Исключения:

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

См. также:

• setText(String)

public boolean isEditable()

Возвращает:

логическое значение

См. также:

• setEditable(boolean)

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

Параметры:

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

См. также:

• isEditable()

public int getSelectionStart()

Возвращает:

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

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

Параметры:

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

public int getSelectionEnd()

Возвращает:

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

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

Параметры:

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

public void select(int selectionStart, int selectionEnd)

Параметры:

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

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

См. также:

• setCaretPosition(int)
• moveCaretPosition(int)

public void selectAll()

public String getToolTipText(MouseEvent event)

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

getToolTipText в классе JComponent

Параметры:

event - рассматриваемое событие

Возвращает:

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

См. также:

• JComponent.setToolTipText(String)
• TextUI.getToolTipText(JTextComponent, Point)
• ToolTipManager.registerComponent(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 - меньше нуля для прокрутки вверх/влево, больше нуля — вниз/вправо

Возвращает:

«единичный» шаг (unit increment) для прокрутки в указанном направлении

Исключения:

IllegalArgumentException - при недопустимой ориентации

См. также:

• JScrollBar.setUnitIncrement(int)

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

Указано в:

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

Параметры:

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

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

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

Возвращает:

«блочный» шаг (block increment) для прокрутки в указанном направлении

Исключения:

IllegalArgumentException - при недопустимой ориентации

См. также:

• JScrollBar.setBlockIncrement(int)

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

Указано в:

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

Возвращает:

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

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

Указано в:

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

Возвращает:

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

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);

Параметры:

headerFormat - текст в формате MessageFormat для использования в качестве верхнего колонтитула или null при отсутствии колонтитула

footerFormat - текст в формате MessageFormat для использования в качестве нижнего колонтитула или null при отсутствии колонтитула

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

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

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

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

Возвращает:

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

Исключения:

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

С версии:

1.6

См. также:

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

public Printable getPrintable(MessageFormat headerFormat, MessageFormat footerFormat)

Параметры:

headerFormat - текст в формате MessageFormat для использования в качестве верхнего колонтитула или null при отсутствии колонтитула

footerFormat - текст в формате MessageFormat для использования в качестве нижнего колонтитула или null при отсутствии колонтитула

Возвращает:

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

С версии:

1.6

См. также:

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

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

Указано в:

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

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

getAccessibleContext в классе Component

Возвращает:

AccessibleJTextComponent, выступающий в качестве AccessibleContext для этого JTextComponent

protected String paramString()

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

paramString в классе JComponent

Возвращает:

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

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

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

getInputMethodRequests в классе Component

Возвращает:

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

См. также:

• Component.addInputMethodListener(InputMethodListener)

protected boolean saveComposedText(int pos)

Параметры:

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

Возвращает:

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

Начиная с:

1.7

См. также:

• restoreComposedText()

protected void restoreComposedText()

Начиная с:

1.7

См. также:

• saveComposedText(int)