Package com.inductiveautomation.snap.swing

Class TextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.inductiveautomation.snap.swing.TextComponent

com.inductiveautomation.snap.swing.TextArea

All Implemented Interfaces:

RMTypes, TextTypes, DropTargetListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, CharSequence, EventListener, Scrollable

Direct Known Subclasses:

TextConsole

public class TextArea
extends TextComponent
implements Scrollable, DropTargetListener

A text editor subclass for editing text in a Swing component.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.snap.swing.TextComponent

TextComponent.TextSelection

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Nested classes/interfaces inherited from interface com.inductiveautomation.snap.text.TextTypes

TextTypes.TabType

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface com.inductiveautomation.snap.text.TextTypes

TEXT_CHAR_SPACING, TEXT_COLOR, TEXT_FONT, TEXT_FORMAT, TEXT_LINK, TEXT_OUTLINE, TEXT_SCRIPTING, TEXT_UNDERLINE

Constructor Summary

Constructors

Constructor	Description
TextArea()	Creates a new TextArea.

Method Summary

Modifier and Type	Method	Description
void	append(String aStr)	Append Text.
void	appendln(String aString)	Append Text.
void	dragEnter(DropTargetDragEvent dtde)	DropTargetListener method.
void	dragExit(DropTargetEvent dte)	DropTargetListener method.
void	dragOver(DropTargetDragEvent dtde)	DropTargetListener method.
void	drop(DropTargetDropEvent dtde)	DropTargetListener method.
void	dropActionChanged(DropTargetDragEvent dtde)	DropTargetListener method.
boolean	getLineWrap()	Returns whether to wrap lines to pane width.
Dimension	getPreferredScrollableViewportSize()	Scrollable method.
Dimension	getPreferredSize()	Overrides JComponent method to declare preferred size to be text's preferred size.
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)	Scrollable method.
boolean	getScrollableTracksViewportHeight()	Scrollable method.
boolean	getScrollableTracksViewportWidth()	Scrollable method.
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)	Scrollable method.
void	setLineWrap(boolean aValue)	Sets whether to wrap lines to pane width.
protected void	setTextRect()	Sets the TextEditor.Text.Rect from text area.

Methods inherited from class com.inductiveautomation.snap.swing.TextComponent

calcPrefHeight, calcPrefWidth, charAt, copy, createText, cut, delete, delete, deleteBackward, deleteForward, deleteToLineEnd, getAlignX, getCharIndex, getCharIndex, getCharSpacing, getColor, getInputLine, getInputStyle, getLine, getLineAt, getLineCount, getLineFor, getLineGap, getLineHeightMax, getLineHeightMin, getLineLast, getLineSpacing, getMargin, getPathForChars, getSel, getSelAnchor, getSelColor, getSelEnd, getSelPath, getSelSize, getSelStart, getString, getText, getTextFont, getTokenAt, getUndoer, getUndoSelection, hideCursor, isSelEmpty, isUnderlined, keyPressed, keyReleased, keyTyped, length, mouseDragged, mousePressed, mouseReleased, paintBackground, paintComponent, paintLine, paintText, paintTextSelection, paintToken, paste, processComponentKeyEvent, processFocusEvent, processMouseEvent, processMouseMotionEvent, propertyChange, redo, replace, replace, selectAll, selectBackward, selectDown, selectForward, selectLineEnd, selectLineStart, selectUp, setAlignX, setBounds, setCharSpacing, setColor, setFont, setInputAttribute, setLineGap, setLineHeightMax, setLineHeightMin, setLineSpacing, setMargin, setRenderingHints, setSel, setSel, setSel, setSource, setString, setSubscript, setSuperscript, setText, setTextFont, setUnderlined, showCursor, subSequence, undo, undoerAddPropertyChange, undoerSaveChanges

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processKeyBinding, processKeyEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty, toString

Constructor Details

TextArea

public TextArea()

Creates a new TextArea.

Method Details

setTextRect

protected void setTextRect()

Sets the TextEditor.Text.Rect from text area.

Overrides:

setTextRect in class TextComponent

getLineWrap

public boolean getLineWrap()

Returns whether to wrap lines to pane width.

setLineWrap

public void setLineWrap(boolean aValue)

Sets whether to wrap lines to pane width.

append

public void append(String aStr)

Append Text.

appendln

public void appendln(String aString)

Append Text.

getPreferredSize

public Dimension getPreferredSize()

Overrides JComponent method to declare preferred size to be text's preferred size.

Overrides:

getPreferredSize in class TextComponent

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Scrollable method.

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Scrollable method.

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Scrollable method.

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

getScrollableBlockIncrement

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

Scrollable method.

Specified by:

getScrollableBlockIncrement in interface Scrollable

getScrollableUnitIncrement

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

Scrollable method.

Specified by:

getScrollableUnitIncrement in interface Scrollable

dragEnter

public void dragEnter(DropTargetDragEvent dtde)

DropTargetListener method.

Specified by:

dragEnter in interface DropTargetListener

dragExit

public void dragExit(DropTargetEvent dte)

DropTargetListener method.

Specified by:

dragExit in interface DropTargetListener

dragOver

public void dragOver(DropTargetDragEvent dtde)

DropTargetListener method.

Specified by:

dragOver in interface DropTargetListener

drop

public void drop(DropTargetDropEvent dtde)

DropTargetListener method.

Specified by:

drop in interface DropTargetListener

dropActionChanged

public void dropActionChanged(DropTargetDragEvent dtde)

DropTargetListener method.

Specified by:

dropActionChanged in interface DropTargetListener