JEditTextArea (ReadyAPI functional (soapui) SDK 3.57.0)

org.syntax.jedit.JEditTextArea

All Implemented Interfaces and Traits:

javax.swing.Scrollable
```
public class JEditTextArea
extends javax.swing.JComponent
implements javax.swing.Scrollable
```
jEdit's text area component. It is more suited for editing program source code than JEditorPane, because it drops the unnecessary features (images, variable-width lines, and so on) and adds a whole bunch of useful goodies such as:
- More flexible key binding scheme
- Supports macro recorders
- Rectangular selection
- Bracket highlighting
- Syntax highlighting
- Command repetition
- Block caret can be enabled
It is also faster and doesn't have as many problems. It can be used in other applications; the only other part of jEdit it depends on is the syntax package.

To use it in your app, treat it like any other component, for example:
```
 JEditTextArea ta = new JEditTextArea();
 ta.setTokenMarker( new JavaTokenMarker() );
 ta.setText( "public class Test {\n" + "    public static void main(String[] args) {\n"
 		+ "        System.out.println(\"Hello World\");\n" + "    }\n" + "}" );
 
```
Version:
\$Id\$

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`LEFT_OF_SCROLLBAR`	Adding components with this name to the text area will place them left of the horizontal scroll bar.

Inherited fields
Fields inherited from class	Fields
`class javax.swing.JComponent`	`WHEN_FOCUSED, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_IN_FOCUSED_WINDOW, UNDEFINED_CONDITION, TOOL_TIP_TEXT_KEY, TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT`

Constructor Summary

Constructors
Constructor and description
`JEditTextArea ()` Creates a new JEditTextArea with the default settings.
`JEditTextArea (TextAreaDefaults defaults)` Creates a new JEditTextArea with the specified settings.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public int`	`_offsetToX(int line, int offset)` Converts an offset in a line into an x co-ordinate.
	`public final void`	`addCaretListener(javax.swing.event.CaretListener listener)` Adds a caret change listener to this text area.
	`public void`	`addNotify()`
	`public final void`	`blinkCaret()` Blinks the caret.
	`public void`	`copy()` Places the selected text into the clipboard.
	`public void`	`cut()` Deletes the selected text from the text area and places it into the clipboard.
	`public final int`	`getBracketLine()` Returns the line of the highlighted bracket (the bracket matching the one before the caret)
	`public final int`	`getBracketPosition()` Returns the position of the highlighted bracket (the bracket matching the one before the caret)
	`public final int`	`getCaretLine()` Returns the caret line.
	`public final int`	`getCaretPosition()` Returns the caret position.
	`public final SyntaxDocument`	`getDocument()` Returns the document this text area is editing.
	`public final int`	`getDocumentLength()` Returns the length of the document.
	`public final int`	`getFirstLine()` Returns the line displayed at the text area's origin.
	`public final InputHandler`	`getInputHandler()` Returns the input handler.
	`public final int`	`getLineCount()` Returns the number of lines in the document.
	`public int`	`getLineEndOffset(int line)` Returns the end offset of the specified line.
	`public int`	`getLineHeight()`
	`public int`	`getLineLength(int line)` Returns the length of the specified line.
	`public final int`	`getLineOfOffset(int offset)` Returns the line containing the specified offset.
	`public int`	`getLineStartOffset(int line)` Returns the start offset of the specified line.
	`public final java.lang.String`	`getLineText(int lineIndex)` Returns the text on the specified line.
	`public final void`	`getLineText(int lineIndex, javax.swing.text.Segment segment)` Copies the text on the specified line into a segment.
	`public final int`	`getMagicCaretPosition()` Returns the `magic' caret position.
	`public final int`	`getMarkLine()` Returns the mark line.
	`public final int`	`getMarkPosition()` Returns the mark position.
	`public int`	`getMaxLineLength()`
	`public java.awt.Dimension`	`getMaximumSize()`
	`public java.awt.Dimension`	`getMinimumSize()`
	`public final TextAreaPainter`	`getPainter()` Returns the object responsible for painting this text area.
	`public java.awt.Dimension`	`getPreferredScrollableViewportSize()`
	`public java.awt.Dimension`	`getPreferredSize()`
	`public final javax.swing.JPopupMenu`	`getRightClickPopup()` Returns the right click popup menu.
	`public int`	`getScrollableBlockIncrement(java.awt.Rectangle arg0, int arg1, int arg2)`
	`public boolean`	`getScrollableTracksViewportHeight()`
	`public boolean`	`getScrollableTracksViewportWidth()`
	`public int`	`getScrollableUnitIncrement(java.awt.Rectangle arg0, int arg1, int arg2)`
	`public final java.lang.String`	`getSelectedText()` Returns the selected text, or null if no selection is active.
	`public final int`	`getSelectionEnd()` Returns the selection end offset.
	`public int`	`getSelectionEnd(int line)` Returns the offset where the selection ends on the specified line.
	`public final int`	`getSelectionEndLine()` Returns the selection end line.
	`public final int`	`getSelectionStart()` Returns the selection start offset.
	`public int`	`getSelectionStart(int line)` Returns the offset where the selection starts on the specified line.
	`public final int`	`getSelectionStartLine()` Returns the selection start line.
	`public int`	`getTabExpandedLineLength(int line)` Returns the length of the specified line.
	`public java.lang.String`	`getText()` Returns the entire text of this text area.
	`public final java.lang.String`	`getText(int start, int len)` Returns the specified substring of the document.
	`public final void`	`getText(int start, int len, javax.swing.text.Segment segment)` Copies the specified substring of the document into a segment.
	`public final TokenMarker`	`getTokenMarker()` Returns the document's token marker.
	`public final int`	`getVisibleLines()` Returns the number of lines visible in this text area.
	`public final boolean`	`isCaretBlinkEnabled()` Returns true if the caret is blinking, false otherwise.
	`public final boolean`	`isCaretVisible()` Returns true if the caret is visible, false otherwise.
	`public final boolean`	`isEditable()` Returns true if this text area is editable, false otherwise.
	`public final boolean`	`isManagingFocus()` Returns if this component can be traversed by pressing the Tab key.
	`public final boolean`	`isOverwriteEnabled()` Returns true if overwrite mode is enabled, false otherwise.
	`public final boolean`	`isSelectionRectangular()` Returns true if the selection is rectangular, false otherwise.
	`public int`	`lineToY(int line)` Converts a line index to a y co-ordinate.
	`public void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e)`
	`public final int`	`offsetToX(int line, int offset)` Converts an offset in a line into an x co-ordinate.
	`public void`	`overwriteSetSelectedText(java.lang.String str)` Similar to `setSelectedText()`, but overstrikes the appropriate number of characters if overwrite mode is enabled.
	`public void`	`paste()` Inserts the clipboard contents into the text.
	`public int`	`pointToOffset(java.awt.Point pt)`
	`public void`	`processKeyEvent(java.awt.event.KeyEvent evt)` Forwards key events directly to the input handler.
	`public final void`	`recalculateVisibleLines()` Recalculates the number of visible lines.
	`public final void`	`removeCaretListener(javax.swing.event.CaretListener listener)` Removes a caret change listener from this text area.
	`public void`	`removeNotify()` Called by the AWT when this component is removed from it's parent.
	`public void`	`scrollTo(int line, int offset)` Ensures that the specified line and offset is visible by scrolling the text area if necessary.
	`public void`	`scrollToCaret()` Ensures that the caret is visible by scrolling the text area if necessary.
	`public void`	`select(int start, int end)` Selects from the start offset to the end offset.
	`public final void`	`selectAll()` Selects all text in the document.
	`public final void`	`selectNone()` Moves the mark to the caret position.
	`public void`	`setCaretBlinkEnabled(boolean caretBlinks)` Toggles caret blinking.
	`public final void`	`setCaretPosition(int caret)` Sets the caret position.
	`public void`	`setCaretVisible(boolean caretVisible)` Sets if the caret should be visible.
	`public void`	`setDocument(SyntaxDocument document)` Sets the document this text area is editing.
	`public void`	`setEditable(boolean editable)` Sets if this component is editable.
	`public void`	`setFirstLine(int firstLine)` Sets the line displayed at the text area's origin without updating the scroll bars.
	`public void`	`setInputHandler(InputHandler inputHandler)` Sets the input handler.
	`public final void`	`setMagicCaretPosition(int magicCaret)` Sets the `magic' caret position.
	`public final void`	`setOverwriteEnabled(boolean overwrite)` Sets if overwrite mode should be enabled.
	`public final void`	`setRightClickPopup(javax.swing.JPopupMenu popup)` Sets the right click popup menu.
	`public void`	`setSelectedText(java.lang.String selectedText)` Replaces the selection with the specified text.
	`public final void`	`setSelectionEnd(int selectionEnd)` Sets the selection end.
	`public final void`	`setSelectionRectangular(boolean rectSelect)` Sets if the selection should be rectangular.
	`public final void`	`setSelectionStart(int selectionStart)` Sets the selection start.
	`public void`	`setText(java.lang.String text)` Sets the entire text of this text area.
	`public final void`	`setTokenMarker(TokenMarker tokenMarker)` Sets the document's token marker.
	`public void`	`updateScrollBars()` Updates the state of the scroll bars.
	`public int`	`xToOffset(int line, int x)` Converts an x co-ordinate to an offset within a line.
	`public int`	`xyToOffset(int x, int y)` Converts a point to an offset, from the start of the text.
	`public int`	`yToLine(int y)` Converts a y co-ordinate to a line index.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class javax.swing.JComponent`	javax.swing.JComponent#updateUI(), javax.swing.JComponent#getUI(), javax.swing.JComponent#getPreferredSize(), javax.swing.JComponent#firePropertyChange(java.lang.String, boolean, boolean), javax.swing.JComponent#firePropertyChange(java.lang.String, int, int), javax.swing.JComponent#firePropertyChange(java.lang.String, char, char), javax.swing.JComponent#repaint(long, int, int, int, int), javax.swing.JComponent#repaint(java.awt.Rectangle), javax.swing.JComponent#getHeight(), javax.swing.JComponent#getClientProperty(java.lang.Object), javax.swing.JComponent#putClientProperty(java.lang.Object, java.lang.Object), javax.swing.JComponent#setVisible(boolean), javax.swing.JComponent#setPreferredSize(java.awt.Dimension), javax.swing.JComponent#getUIClassID(), javax.swing.JComponent#getGraphics(), javax.swing.JComponent#getRootPane(), javax.swing.JComponent#getInheritsPopupMenu(), javax.swing.JComponent#getComponentPopupMenu(), javax.swing.JComponent#isManagingFocus(), javax.swing.JComponent#getDefaultLocale(), javax.swing.JComponent#revalidate(), javax.swing.JComponent#setFont(java.awt.Font), javax.swing.JComponent#isOptimizedDrawingEnabled(), javax.swing.JComponent#isLightweightComponent(java.awt.Component), javax.swing.JComponent#paint(java.awt.Graphics), javax.swing.JComponent#printAll(java.awt.Graphics), javax.swing.JComponent#getBorder(), javax.swing.JComponent#isDoubleBuffered(), javax.swing.JComponent#getNextFocusableComponent(), javax.swing.JComponent#setNextFocusableComponent(java.awt.Component), javax.swing.JComponent#requestFocus(), javax.swing.JComponent#requestFocus(boolean), javax.swing.JComponent#requestFocusInWindow(), javax.swing.JComponent#getFontMetrics(java.awt.Font), javax.swing.JComponent#setMaximumSize(java.awt.Dimension), javax.swing.JComponent#getMaximumSize(), javax.swing.JComponent#setMinimumSize(java.awt.Dimension), javax.swing.JComponent#getMinimumSize(), javax.swing.JComponent#getInsets(java.awt.Insets), javax.swing.JComponent#getInsets(), javax.swing.JComponent#getAlignmentY(), javax.swing.JComponent#getAlignmentX(), javax.swing.JComponent#getInputMap(int), javax.swing.JComponent#getInputMap(), javax.swing.JComponent#getActionMap(), javax.swing.JComponent#registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int), javax.swing.JComponent#registerKeyboardAction(java.awt.event.ActionListener, javax.swing.KeyStroke, int), javax.swing.JComponent#setInputMap(int, javax.swing.InputMap), javax.swing.JComponent#setActionMap(javax.swing.ActionMap), javax.swing.JComponent#getBaseline(int, int), javax.swing.JComponent#getBaselineResizeBehavior(), javax.swing.JComponent#setForeground(java.awt.Color), javax.swing.JComponent#setBackground(java.awt.Color), javax.swing.JComponent#setDefaultLocale(java.util.Locale), javax.swing.JComponent#getToolTipText(), javax.swing.JComponent#getToolTipText(java.awt.event.MouseEvent), javax.swing.JComponent#scrollRectToVisible(java.awt.Rectangle), javax.swing.JComponent#setAutoscrolls(boolean), javax.swing.JComponent#setFocusTraversalKeys(int, java.util.Set), javax.swing.JComponent#reshape(int, int, int, int), javax.swing.JComponent#computeVisibleRect(java.awt.Rectangle), javax.swing.JComponent#addVetoableChangeListener(java.beans.VetoableChangeListener), javax.swing.JComponent#removeVetoableChangeListener(java.beans.VetoableChangeListener), javax.swing.JComponent#getVetoableChangeListeners(), javax.swing.JComponent#addAncestorListener(javax.swing.event.AncestorListener), javax.swing.JComponent#removeAncestorListener(javax.swing.event.AncestorListener), javax.swing.JComponent#getAncestorListeners(), javax.swing.JComponent#addNotify(), javax.swing.JComponent#removeNotify(), javax.swing.JComponent#paintImmediately(int, int, int, int), javax.swing.JComponent#paintImmediately(java.awt.Rectangle), javax.swing.JComponent#setInheritsPopupMenu(boolean), javax.swing.JComponent#setComponentPopupMenu(javax.swing.JPopupMenu), javax.swing.JComponent#isPaintingTile(), javax.swing.JComponent#isPaintingForPrint(), javax.swing.JComponent#setRequestFocusEnabled(boolean), javax.swing.JComponent#isRequestFocusEnabled(), javax.swing.JComponent#grabFocus(), javax.swing.JComponent#setVerifyInputWhenFocusTarget(boolean), javax.swing.JComponent#getVerifyInputWhenFocusTarget(), javax.swing.JComponent#setBorder(javax.swing.border.Border), javax.swing.JComponent#setAlignmentY(float), javax.swing.JComponent#setAlignmentX(float), javax.swing.JComponent#setInputVerifier(javax.swing.InputVerifier), javax.swing.JComponent#getInputVerifier(), javax.swing.JComponent#setDebugGraphicsOptions(int), javax.swing.JComponent#getDebugGraphicsOptions(), javax.swing.JComponent#unregisterKeyboardAction(javax.swing.KeyStroke), javax.swing.JComponent#getRegisteredKeyStrokes(), javax.swing.JComponent#getConditionForKeyStroke(javax.swing.KeyStroke), javax.swing.JComponent#getActionForKeyStroke(javax.swing.KeyStroke), javax.swing.JComponent#resetKeyboardActions(), javax.swing.JComponent#requestDefaultFocus(), javax.swing.JComponent#setToolTipText(java.lang.String), javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent), javax.swing.JComponent#getPopupLocation(java.awt.event.MouseEvent), javax.swing.JComponent#createToolTip(), javax.swing.JComponent#getAutoscrolls(), javax.swing.JComponent#setTransferHandler(javax.swing.TransferHandler), javax.swing.JComponent#getTransferHandler(), javax.swing.JComponent#getVisibleRect(), javax.swing.JComponent#getTopLevelAncestor(), javax.swing.JComponent#isValidateRoot(), javax.swing.JComponent#setDoubleBuffered(boolean), javax.swing.JComponent#update(java.awt.Graphics), javax.swing.JComponent#contains(int, int), javax.swing.JComponent#getBounds(java.awt.Rectangle), javax.swing.JComponent#getLocation(java.awt.Point), javax.swing.JComponent#print(java.awt.Graphics), javax.swing.JComponent#getSize(java.awt.Dimension), javax.swing.JComponent#setOpaque(boolean), javax.swing.JComponent#isOpaque(), javax.swing.JComponent#enable(), javax.swing.JComponent#setEnabled(boolean), javax.swing.JComponent#hide(), javax.swing.JComponent#getListeners(java.lang.Class), javax.swing.JComponent#disable(), javax.swing.JComponent#getWidth(), javax.swing.JComponent#getX(), javax.swing.JComponent#getY(), javax.swing.JComponent#getComponentCount(), javax.swing.JComponent#isFocusCycleRoot(java.awt.Container), javax.swing.JComponent#isFocusCycleRoot(), javax.swing.JComponent#getFocusTraversalPolicy(), javax.swing.JComponent#setFocusTraversalPolicy(java.awt.FocusTraversalPolicy), javax.swing.JComponent#preferredSize(), javax.swing.JComponent#minimumSize(), javax.swing.JComponent#insets(), javax.swing.JComponent#countComponents(), javax.swing.JComponent#getComponentZOrder(java.awt.Component), javax.swing.JComponent#add(java.awt.Component, int), javax.swing.JComponent#add(java.awt.Component, java.lang.Object, int), javax.swing.JComponent#add(java.awt.Component), javax.swing.JComponent#add(java.awt.Component, java.lang.Object), javax.swing.JComponent#add(java.lang.String, java.awt.Component), javax.swing.JComponent#remove(java.awt.Component), javax.swing.JComponent#remove(int), javax.swing.JComponent#list(java.io.PrintStream, int), javax.swing.JComponent#list(java.io.PrintWriter, int), javax.swing.JComponent#validate(), javax.swing.JComponent#removeAll(), javax.swing.JComponent#addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), javax.swing.JComponent#addPropertyChangeListener(java.beans.PropertyChangeListener), javax.swing.JComponent#locate(int, int), javax.swing.JComponent#invalidate(), javax.swing.JComponent#getComponents(), javax.swing.JComponent#getLayout(), javax.swing.JComponent#layout(), javax.swing.JComponent#setLayout(java.awt.LayoutManager), javax.swing.JComponent#getComponent(int), javax.swing.JComponent#isAncestorOf(java.awt.Component), javax.swing.JComponent#doLayout(), javax.swing.JComponent#getComponentAt(int, int), javax.swing.JComponent#getComponentAt(java.awt.Point), javax.swing.JComponent#deliverEvent(java.awt.Event), javax.swing.JComponent#findComponentAt(int, int), javax.swing.JComponent#findComponentAt(java.awt.Point), javax.swing.JComponent#isFocusTraversalPolicyProvider(), javax.swing.JComponent#applyComponentOrientation(java.awt.ComponentOrientation), javax.swing.JComponent#addContainerListener(java.awt.event.ContainerListener), javax.swing.JComponent#setComponentZOrder(java.awt.Component, int), javax.swing.JComponent#paintComponents(java.awt.Graphics), javax.swing.JComponent#printComponents(java.awt.Graphics), javax.swing.JComponent#removeContainerListener(java.awt.event.ContainerListener), javax.swing.JComponent#getContainerListeners(), javax.swing.JComponent#getMousePosition(boolean), javax.swing.JComponent#getFocusTraversalKeys(int), javax.swing.JComponent#areFocusTraversalKeysSet(int), javax.swing.JComponent#isFocusTraversalPolicySet(), javax.swing.JComponent#setFocusCycleRoot(boolean), javax.swing.JComponent#setFocusTraversalPolicyProvider(boolean), javax.swing.JComponent#transferFocusDownCycle(), javax.swing.JComponent#handleEvent(java.awt.Event), javax.swing.JComponent#dispatchEvent(java.awt.AWTEvent), javax.swing.JComponent#setFocusTraversalKeysEnabled(boolean), javax.swing.JComponent#getGraphicsConfiguration(), javax.swing.JComponent#firePropertyChange(java.lang.String, float, float), javax.swing.JComponent#firePropertyChange(java.lang.String, double, double), javax.swing.JComponent#firePropertyChange(java.lang.String, short, short), javax.swing.JComponent#firePropertyChange(java.lang.String, long, long), javax.swing.JComponent#firePropertyChange(java.lang.String, byte, byte), javax.swing.JComponent#repaint(long), javax.swing.JComponent#repaint(int, int, int, int), javax.swing.JComponent#repaint(), javax.swing.JComponent#isVisible(), javax.swing.JComponent#getLocationOnScreen(), javax.swing.JComponent#getAccessibleContext(), javax.swing.JComponent#getForeground(), javax.swing.JComponent#getFont(), javax.swing.JComponent#getTreeLock(), javax.swing.JComponent#getFocusCycleRootAncestor(), javax.swing.JComponent#isDisplayable(), javax.swing.JComponent#nextFocus(), javax.swing.JComponent#requestFocus(java.awt.event.FocusEvent$Cause), javax.swing.JComponent#requestFocusInWindow(java.awt.event.FocusEvent$Cause), javax.swing.JComponent#isPreferredSizeSet(), javax.swing.JComponent#isMaximumSizeSet(), javax.swing.JComponent#isMinimumSizeSet(), javax.swing.JComponent#getBackground(), javax.swing.JComponent#isLightweight(), javax.swing.JComponent#setBounds(int, int, int, int), javax.swing.JComponent#setBounds(java.awt.Rectangle), javax.swing.JComponent#getPropertyChangeListeners(), javax.swing.JComponent#getPropertyChangeListeners(java.lang.String), javax.swing.JComponent#isShowing(), javax.swing.JComponent#getHierarchyBoundsListeners(), javax.swing.JComponent#removeKeyListener(java.awt.event.KeyListener), javax.swing.JComponent#getKeyListeners(), javax.swing.JComponent#removeMouseListener(java.awt.event.MouseListener), javax.swing.JComponent#getMouseListeners(), javax.swing.JComponent#removeMouseMotionListener(java.awt.event.MouseMotionListener), javax.swing.JComponent#getMouseMotionListeners(), javax.swing.JComponent#removeMouseWheelListener(java.awt.event.MouseWheelListener), javax.swing.JComponent#getMouseWheelListeners(), javax.swing.JComponent#removeInputMethodListener(java.awt.event.InputMethodListener), javax.swing.JComponent#getInputMethodListeners(), javax.swing.JComponent#getInputMethodRequests(), javax.swing.JComponent#setFocusable(boolean), javax.swing.JComponent#getFocusTraversalKeysEnabled(), javax.swing.JComponent#transferFocusUpCycle(), javax.swing.JComponent#getComponentOrientation(), javax.swing.JComponent#setMixingCutoutShape(java.awt.Shape), javax.swing.JComponent#getName(), javax.swing.JComponent#add(java.awt.PopupMenu), javax.swing.JComponent#remove(java.awt.MenuComponent), javax.swing.JComponent#toString(), javax.swing.JComponent#size(), javax.swing.JComponent#contains(java.awt.Point), javax.swing.JComponent#list(java.io.PrintStream), javax.swing.JComponent#list(), javax.swing.JComponent#list(java.io.PrintWriter), javax.swing.JComponent#getBounds(), javax.swing.JComponent#bounds(), javax.swing.JComponent#getLocation(), javax.swing.JComponent#getParent(), javax.swing.JComponent#action(java.awt.Event, java.lang.Object), javax.swing.JComponent#setName(java.lang.String), javax.swing.JComponent#location(), javax.swing.JComponent#getSize(), javax.swing.JComponent#resize(java.awt.Dimension), javax.swing.JComponent#resize(int, int), javax.swing.JComponent#move(int, int), javax.swing.JComponent#setSize(java.awt.Dimension), javax.swing.JComponent#setSize(int, int), javax.swing.JComponent#getLocale(), javax.swing.JComponent#isEnabled(), javax.swing.JComponent#enable(boolean), javax.swing.JComponent#setLocale(java.util.Locale), javax.swing.JComponent#isValid(), javax.swing.JComponent#createImage(java.awt.image.ImageProducer), javax.swing.JComponent#createImage(int, int), javax.swing.JComponent#show(), javax.swing.JComponent#show(boolean), javax.swing.JComponent#setLocation(int, int), javax.swing.JComponent#setLocation(java.awt.Point), javax.swing.JComponent#getCursor(), javax.swing.JComponent#isFocusable(), javax.swing.JComponent#isFocusOwner(), javax.swing.JComponent#transferFocus(), javax.swing.JComponent#postEvent(java.awt.Event), javax.swing.JComponent#transferFocusBackward(), javax.swing.JComponent#getMousePosition(), javax.swing.JComponent#getToolkit(), javax.swing.JComponent#getInputContext(), javax.swing.JComponent#getColorModel(), javax.swing.JComponent#createVolatileImage(int, int), javax.swing.JComponent#createVolatileImage(int, int, java.awt.ImageCapabilities), javax.swing.JComponent#prepareImage(java.awt.Image, int, int, java.awt.image.ImageObserver), javax.swing.JComponent#prepareImage(java.awt.Image, java.awt.image.ImageObserver), javax.swing.JComponent#checkImage(java.awt.Image, int, int, java.awt.image.ImageObserver), javax.swing.JComponent#checkImage(java.awt.Image, java.awt.image.ImageObserver), javax.swing.JComponent#inside(int, int), javax.swing.JComponent#mouseEnter(java.awt.Event, int, int), javax.swing.JComponent#mouseExit(java.awt.Event, int, int), javax.swing.JComponent#mouseMove(java.awt.Event, int, int), javax.swing.JComponent#mouseDown(java.awt.Event, int, int), javax.swing.JComponent#mouseDrag(java.awt.Event, int, int), javax.swing.JComponent#mouseUp(java.awt.Event, int, int), javax.swing.JComponent#keyDown(java.awt.Event, int), javax.swing.JComponent#keyUp(java.awt.Event, int), javax.swing.JComponent#gotFocus(java.awt.Event, java.lang.Object), javax.swing.JComponent#lostFocus(java.awt.Event, java.lang.Object), javax.swing.JComponent#isFocusTraversable(), javax.swing.JComponent#hasFocus(), javax.swing.JComponent#removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), javax.swing.JComponent#removePropertyChangeListener(java.beans.PropertyChangeListener), javax.swing.JComponent#addComponentListener(java.awt.event.ComponentListener), javax.swing.JComponent#addFocusListener(java.awt.event.FocusListener), javax.swing.JComponent#addKeyListener(java.awt.event.KeyListener), javax.swing.JComponent#addMouseListener(java.awt.event.MouseListener), javax.swing.JComponent#addMouseMotionListener(java.awt.event.MouseMotionListener), javax.swing.JComponent#addInputMethodListener(java.awt.event.InputMethodListener), javax.swing.JComponent#addHierarchyListener(java.awt.event.HierarchyListener), javax.swing.JComponent#addHierarchyBoundsListener(java.awt.event.HierarchyBoundsListener), javax.swing.JComponent#addMouseWheelListener(java.awt.event.MouseWheelListener), javax.swing.JComponent#setComponentOrientation(java.awt.ComponentOrientation), javax.swing.JComponent#setDropTarget(java.awt.dnd.DropTarget), javax.swing.JComponent#getDropTarget(), javax.swing.JComponent#enableInputMethods(boolean), javax.swing.JComponent#isForegroundSet(), javax.swing.JComponent#isBackgroundSet(), javax.swing.JComponent#isFontSet(), javax.swing.JComponent#setCursor(java.awt.Cursor), javax.swing.JComponent#isCursorSet(), javax.swing.JComponent#paintAll(java.awt.Graphics), javax.swing.JComponent#imageUpdate(java.awt.Image, int, int, int, int, int), javax.swing.JComponent#setIgnoreRepaint(boolean), javax.swing.JComponent#getIgnoreRepaint(), javax.swing.JComponent#removeComponentListener(java.awt.event.ComponentListener), javax.swing.JComponent#getComponentListeners(), javax.swing.JComponent#removeFocusListener(java.awt.event.FocusListener), javax.swing.JComponent#getFocusListeners(), javax.swing.JComponent#removeHierarchyListener(java.awt.event.HierarchyListener), javax.swing.JComponent#getHierarchyListeners(), javax.swing.JComponent#removeHierarchyBoundsListener(java.awt.event.HierarchyBoundsListener), javax.swing.JComponent#wait(long, int), javax.swing.JComponent#wait(), javax.swing.JComponent#wait(long), javax.swing.JComponent#equals(java.lang.Object), javax.swing.JComponent#hashCode(), javax.swing.JComponent#getClass(), javax.swing.JComponent#notify(), javax.swing.JComponent#notifyAll()

- Field Detail
  - public static final java.lang.String LEFT_OF_SCROLLBAR
    
    Adding components with this name to the text area will place them left of the horizontal scroll bar. In jEdit, the status bar is added this way.
- Constructor Detail
  - public JEditTextArea()
    
    Creates a new JEditTextArea with the default settings.
  - public JEditTextArea(TextAreaDefaults defaults)
    
    Creates a new JEditTextArea with the specified settings.
    Parameters:
    defaults - The default settings
- Method Detail
  - public int _offsetToX(int line, int offset)
    
    Converts an offset in a line into an x co-ordinate. This is a fast version that should only be used if no changes were made to the text since the last repaint.
    Parameters:
    line - The line
    offset - The offset, from the start of the line
  - public final void addCaretListener(javax.swing.event.CaretListener listener)
    
    Adds a caret change listener to this text area.
    Parameters:
    listener - The listener
  - @java.lang.Override public void addNotify()
  - public final void blinkCaret()
    
    Blinks the caret.
  - public void copy()
    
    Places the selected text into the clipboard.
  - public void cut()
    
    Deletes the selected text from the text area and places it into the clipboard.
  - public final int getBracketLine()
    
    Returns the line of the highlighted bracket (the bracket matching the one before the caret)
  - public final int getBracketPosition()
    
    Returns the position of the highlighted bracket (the bracket matching the one before the caret)
  - public final int getCaretLine()
    
    Returns the caret line.
  - public final int getCaretPosition()
    
    Returns the caret position. This will either be the selection start or the selection end, depending on which direction the selection was made in.
  - public final SyntaxDocument getDocument()
    
    Returns the document this text area is editing.
  - public final int getDocumentLength()
    
    Returns the length of the document. Equivalent to calling getDocument().getLength().
  - public final int getFirstLine()
    
    Returns the line displayed at the text area's origin.
  - public final InputHandler getInputHandler()
    
    Returns the input handler.
  - public final int getLineCount()
    
    Returns the number of lines in the document.
  - public int getLineEndOffset(int line)
    
    Returns the end offset of the specified line.
    Parameters:
    line - The line
    Returns:
    The end offset of the specified line, or -1 if the line is invalid.
  - public int getLineHeight()
  - public int getLineLength(int line)
    
    Returns the length of the specified line.
    Parameters:
    line - The line
  - public final int getLineOfOffset(int offset)
    
    Returns the line containing the specified offset.
    Parameters:
    offset - The offset
  - public int getLineStartOffset(int line)
    
    Returns the start offset of the specified line.
    Parameters:
    line - The line
    Returns:
    The start offset of the specified line, or -1 if the line is invalid
  - public final java.lang.String getLineText(int lineIndex)
    
    Returns the text on the specified line.
    Parameters:
    lineIndex - The line
    Returns:
    The text, or null if the line is invalid
  - public final void getLineText(int lineIndex, javax.swing.text.Segment segment)
    
    Copies the text on the specified line into a segment. If the line is invalid, the segment will contain a null string.
    Parameters:
    lineIndex - The line
  - public final int getMagicCaretPosition()
    
    Returns the `magic' caret position. This can be used to preserve the column position when moving up and down lines.
  - public final int getMarkLine()
    
    Returns the mark line.
  - public final int getMarkPosition()
    
    Returns the mark position. This will be the opposite selection bound to the caret position.
    See Also:
    getCaretPosition()
  - public int getMaxLineLength()
  - public java.awt.Dimension getMaximumSize()
  - public java.awt.Dimension getMinimumSize()
  - public final TextAreaPainter getPainter()
    
    Returns the object responsible for painting this text area.
  - public java.awt.Dimension getPreferredScrollableViewportSize()
  - public java.awt.Dimension getPreferredSize()
  - public final javax.swing.JPopupMenu getRightClickPopup()
    
    Returns the right click popup menu.
  - public int getScrollableBlockIncrement(java.awt.Rectangle arg0, int arg1, int arg2)
  - public boolean getScrollableTracksViewportHeight()
  - public boolean getScrollableTracksViewportWidth()
  - public int getScrollableUnitIncrement(java.awt.Rectangle arg0, int arg1, int arg2)
  - public final java.lang.String getSelectedText()
    
    Returns the selected text, or null if no selection is active.
  - public final int getSelectionEnd()
    
    Returns the selection end offset.
  - public int getSelectionEnd(int line)
    
    Returns the offset where the selection ends on the specified line.
  - public final int getSelectionEndLine()
    
    Returns the selection end line.
  - public final int getSelectionStart()
    
    Returns the selection start offset.
  - public int getSelectionStart(int line)
    
    Returns the offset where the selection starts on the specified line.
  - public final int getSelectionStartLine()
    
    Returns the selection start line.
  - public int getTabExpandedLineLength(int line)
    
    Returns the length of the specified line.
    Parameters:
    line - The line
  - public java.lang.String getText()
    
    Returns the entire text of this text area.
  - public final java.lang.String getText(int start, int len)
    
    Returns the specified substring of the document.
    Parameters:
    start - The start offset
    len - The length of the substring
    Returns:
    The substring, or null if the offsets are invalid
  - public final void getText(int start, int len, javax.swing.text.Segment segment)
    
    Copies the specified substring of the document into a segment. If the offsets are invalid, the segment will contain a null string.
    Parameters:
    start - The start offset
    len - The length of the substring
    segment - The segment
  - public final TokenMarker getTokenMarker()
    
    Returns the document's token marker. Equivalent to calling getDocument().getTokenMarker().
  - public final int getVisibleLines()
    
    Returns the number of lines visible in this text area.
  - public final boolean isCaretBlinkEnabled()
    
    Returns true if the caret is blinking, false otherwise.
  - public final boolean isCaretVisible()
    
    Returns true if the caret is visible, false otherwise.
  - public final boolean isEditable()
    
    Returns true if this text area is editable, false otherwise.
  - public final boolean isManagingFocus()
    
    Returns if this component can be traversed by pressing the Tab key. This returns false.
  - public final boolean isOverwriteEnabled()
    
    Returns true if overwrite mode is enabled, false otherwise.
  - public final boolean isSelectionRectangular()
    
    Returns true if the selection is rectangular, false otherwise.
  - public int lineToY(int line)
    
    Converts a line index to a y co-ordinate.
    Parameters:
    line - The line
  - public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)
  - public final int offsetToX(int line, int offset)
    
    Converts an offset in a line into an x co-ordinate. This is a slow version that can be used any time.
    Parameters:
    line - The line
    offset - The offset, from the start of the line
  - public void overwriteSetSelectedText(java.lang.String str)
    
    Similar to setSelectedText(), but overstrikes the appropriate number of characters if overwrite mode is enabled.
    Parameters:
    str - The string
    See Also:
    setSelectedText(String)
    isOverwriteEnabled()
  - public void paste()
    
    Inserts the clipboard contents into the text.
  - public int pointToOffset(java.awt.Point pt)
  - public void processKeyEvent(java.awt.event.KeyEvent evt)
    
    Forwards key events directly to the input handler. This is slightly faster than using a KeyListener because some Swing overhead is avoided.
  - public final void recalculateVisibleLines()
    
    Recalculates the number of visible lines. This should not be called directly.
  - public final void removeCaretListener(javax.swing.event.CaretListener listener)
    
    Removes a caret change listener from this text area.
    Parameters:
    listener - The listener
  - public void removeNotify()
    
    Called by the AWT when this component is removed from it's parent. This stops clears the currently focused component.
  - public void scrollTo(int line, int offset)
    
    Ensures that the specified line and offset is visible by scrolling the text area if necessary.
    Parameters:
    line - The line to scroll to
    offset - The offset in the line to scroll to
    Returns:
    True if scrolling was actually performed, false if the line and offset was already visible
  - public void scrollToCaret()
    
    Ensures that the caret is visible by scrolling the text area if necessary.
    Returns:
    True if scrolling was actually performed, false if the caret was already visible
  - public void select(int start, int end)
    
    Selects from the start offset to the end offset. This is the general selection method used by all other selecting methods. The caret position will be start if start < end, and end if end > start.
    Parameters:
    start - The start offset
    end - The end offset
  - public final void selectAll()
    
    Selects all text in the document.
  - public final void selectNone()
    
    Moves the mark to the caret position.
  - public void setCaretBlinkEnabled(boolean caretBlinks)
    
    Toggles caret blinking.
    Parameters:
    caretBlinks - True if the caret should blink, false otherwise
  - public final void setCaretPosition(int caret)
    
    Sets the caret position. The new selection will consist of the caret position only (hence no text will be selected)
    Parameters:
    caret - The caret position
    See Also:
    select(int, int)
  - public void setCaretVisible(boolean caretVisible)
    
    Sets if the caret should be visible.
    Parameters:
    caretVisible - True if the caret should be visible, false otherwise
  - public void setDocument(SyntaxDocument document)
    
    Sets the document this text area is editing.
    Parameters:
    document - The document
  - public void setEditable(boolean editable)
    
    Sets if this component is editable.
    Parameters:
    editable - True if this text area should be editable, false otherwise
  - public void setFirstLine(int firstLine)
    
    Sets the line displayed at the text area's origin without updating the scroll bars.
  - public void setInputHandler(InputHandler inputHandler)
    
    Sets the input handler.
    Parameters:
    inputHandler - The new input handler
  - public final void setMagicCaretPosition(int magicCaret)
    
    Sets the `magic' caret position. This can be used to preserve the column position when moving up and down lines.
    Parameters:
    magicCaret - The magic caret position
  - public final void setOverwriteEnabled(boolean overwrite)
    
    Sets if overwrite mode should be enabled.
    Parameters:
    overwrite - True if overwrite mode should be enabled, false otherwise.
  - public final void setRightClickPopup(javax.swing.JPopupMenu popup)
    
    Sets the right click popup menu.
    Parameters:
    popup - The popup
  - public void setSelectedText(java.lang.String selectedText)
    
    Replaces the selection with the specified text.
    Parameters:
    selectedText - The replacement text for the selection
  - public final void setSelectionEnd(int selectionEnd)
    
    Sets the selection end. The new selection will be the old selection start and the bew selection end.
    Parameters:
    selectionEnd - The selection end
    See Also:
    select(int, int)
  - public final void setSelectionRectangular(boolean rectSelect)
    
    Sets if the selection should be rectangular.
    Parameters:
    overwrite - True if the selection should be rectangular, false otherwise.
  - public final void setSelectionStart(int selectionStart)
    
    Sets the selection start. The new selection will be the new selection start and the old selection end.
    Parameters:
    selectionStart - The selection start
    See Also:
    select(int, int)
  - public void setText(java.lang.String text)
    
    Sets the entire text of this text area.
  - public final void setTokenMarker(TokenMarker tokenMarker)
    
    Sets the document's token marker. Equivalent to caling getDocument().setTokenMarker().
    Parameters:
    tokenMarker - The token marker
  - public void updateScrollBars()
    
    Updates the state of the scroll bars. This should be called if the number of lines in the document changes, or when the size of the text area changes.
  - public int xToOffset(int line, int x)
    
    Converts an x co-ordinate to an offset within a line.
    Parameters:
    line - The line
    x - The x co-ordinate
  - public int xyToOffset(int x, int y)
    
    Converts a point to an offset, from the start of the text.
    Parameters:
    x - The x co-ordinate of the point
    y - The y co-ordinate of the point
  - public int yToLine(int y)
    
    Converts a y co-ordinate to a line index.
    Parameters:
    y - The y co-ordinate

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

ReadyAPI functional (soapui) SDK 3.57.0

[Java] Class JEditTextArea

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String LEFT_OF_SCROLLBAR

Constructor Detail

public JEditTextArea()

public JEditTextArea(TextAreaDefaults defaults)

Method Detail

public int _offsetToX(int line, int offset)

public final void addCaretListener(javax.swing.event.CaretListener listener)

@java.lang.Override public void addNotify()

public final void blinkCaret()

public void copy()

public void cut()

public final int getBracketLine()

public final int getBracketPosition()

public final int getCaretLine()

public final int getCaretPosition()

public final SyntaxDocument getDocument()

public final int getDocumentLength()

public final int getFirstLine()

public final InputHandler getInputHandler()

public final int getLineCount()

public int getLineEndOffset(int line)

public int getLineHeight()

public int getLineLength(int line)

public final int getLineOfOffset(int offset)

public int getLineStartOffset(int line)

public final java.lang.String getLineText(int lineIndex)

public final void getLineText(int lineIndex, javax.swing.text.Segment segment)

public final int getMagicCaretPosition()

public final int getMarkLine()

public final int getMarkPosition()

public int getMaxLineLength()

public java.awt.Dimension getMaximumSize()

public java.awt.Dimension getMinimumSize()

public final TextAreaPainter getPainter()

public java.awt.Dimension getPreferredScrollableViewportSize()

public java.awt.Dimension getPreferredSize()

public final javax.swing.JPopupMenu getRightClickPopup()

public int getScrollableBlockIncrement(java.awt.Rectangle arg0, int arg1, int arg2)

public boolean getScrollableTracksViewportHeight()

public boolean getScrollableTracksViewportWidth()

public int getScrollableUnitIncrement(java.awt.Rectangle arg0, int arg1, int arg2)

public final java.lang.String getSelectedText()

public final int getSelectionEnd()

public int getSelectionEnd(int line)

public final int getSelectionEndLine()

public final int getSelectionStart()

public int getSelectionStart(int line)

public final int getSelectionStartLine()

public int getTabExpandedLineLength(int line)

public java.lang.String getText()

public final java.lang.String getText(int start, int len)

public final void getText(int start, int len, javax.swing.text.Segment segment)

public final TokenMarker getTokenMarker()

public final int getVisibleLines()

public final boolean isCaretBlinkEnabled()

public final boolean isCaretVisible()

public final boolean isEditable()

public final boolean isManagingFocus()

public final boolean isOverwriteEnabled()

public final boolean isSelectionRectangular()

public int lineToY(int line)

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

public final int offsetToX(int line, int offset)

public void overwriteSetSelectedText(java.lang.String str)

public void paste()

public int pointToOffset(java.awt.Point pt)

public void processKeyEvent(java.awt.event.KeyEvent evt)

public final void recalculateVisibleLines()

public final void removeCaretListener(javax.swing.event.CaretListener listener)

public void removeNotify()

public void scrollTo(int line, int offset)

public void scrollToCaret()

public void select(int start, int end)

public final void selectAll()