Класс 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()

Возвращает:

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

С версии:

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

Возвращает:

средство выделения

@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 — значение меньше нуля для прокрутки вверх/влево, больше нуля — вниз/вправо

Возвращает:

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

Исключения:

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

Параметры:

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)