processing.app.syntax

Class PdeTextArea

Object

Component

Container

JComponent

JEditTextArea

PdeTextArea

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class PdeTextArea
extends JEditTextArea

Extensions to JEditTextArea to for the PDE. These were moved out of JavaTextArea because they were not Java-specific and would be helpful for other Mode implementations.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static String	BREAK_MARKER
static String	STEP_MARKER

Fields inherited from class JEditTextArea

LEFT_OF_SCROLLBAR, leftHandGutter

Fields inherited from class JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PdeTextArea(TextAreaDefaults defaults, InputHandler inputHandler, Editor editor)

Method Summary

Modifier and Type	Method and Description
int	_offsetToX(int line, int offset) Convert a character offset to a horizontal pixel position inside the text area.
void	clearGutterText() Clear all gutter text.
void	clearGutterText(int lineIdx) Clear the gutter text of a specific line.
Editor	getEditor()
Image	getGutterGradient()
String	getGutterText(int lineIdx) Retrieve the gutter text of a specific line.
void	setGutterText(int lineIdx, String text) Set the gutter text of a specific line.
void	setMode(Mode mode)
int	xToOffset(int line, int x) Convert a horizontal pixel position to a character offset.

Methods inherited from class JEditTextArea

addCaretListener, blinkCaret, copy, copyAsHTML, cut, getBracketLine, getBracketPosition, getCaretLine, getCaretPosition, getDefaults, getDocument, getDocumentLength, getElectricScroll, getFirstLine, getHorizontalOffset, getHorizontalScrollPosition, getInputHandler, getInputMethodRequests, getLastLine, getLineCount, getLineLength, getLineOfOffset, getLineSelectionStopOffset, getLineStartNonWhiteSpaceOffset, getLineStartOffset, getLineStopNonWhiteSpaceOffset, getLineStopOffset, getLineText, getLineText, getMagicCaretPosition, getMarkLine, getMarkPosition, getPainter, getRightClickPopup, getScrollPosition, getSelectedText, getSelectionStart, getSelectionStart, getSelectionStartLine, getSelectionStop, getSelectionStop, getSelectionStopLine, getText, getText, getText, getTextAsHtml, getTokenMarker, getVerticalScrollPosition, getVisibleLines, isCaretBlinkEnabled, isCaretVisible, isEditable, isOverwriteEnabled, isSelectionActive, lineToY, offsetToX, overwriteSetSelectedText, paste, processKeyEvent, recalculateVisibleLines, removeCaretListener, removeNotify, scrollTo, scrollToCaret, select, selectAll, selectNone, setCaretBlinkEnabled, setCaretPosition, setCaretVisible, setDocument, setDocument, setEditable, setElectricScroll, setFirstLine, setHorizontalOffset, setHorizontalScrollPosition, setInputHandler, setMagicCaretPosition, setOrigin, setOverwriteEnabled, setRightClickPopup, setScrollPosition, setSelectedText, setSelectedText, setSelectionEnd, setSelectionStart, setText, setTokenMarker, setVerticalScrollPosition, updateScrollBars, xyToOffset, yToLine

Methods inherited from class JComponent

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

Methods inherited from class Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BREAK_MARKER

public static final String BREAK_MARKER

See Also:

Constant Field Values

STEP_MARKER

public static final String STEP_MARKER

See Also:

Constant Field Values

Constructor Detail

PdeTextArea

public PdeTextArea(TextAreaDefaults defaults,
                   InputHandler inputHandler,
                   Editor editor)

Method Detail

getGutterGradient

public Image getGutterGradient()

setMode

public void setMode(Mode mode)

setGutterText

public void setGutterText(int lineIdx,
                          String text)

Set the gutter text of a specific line.

Parameters:

lineIdx - the line index (0-based)

text - the text

clearGutterText

public void clearGutterText(int lineIdx)

Clear the gutter text of a specific line.

Parameters:

lineIdx - the line index (0-based)

clearGutterText

public void clearGutterText()

Clear all gutter text.

getGutterText

public String getGutterText(int lineIdx)

Retrieve the gutter text of a specific line.

Parameters:

lineIdx - the line index (0-based)

Returns:

the gutter text

_offsetToX

public int _offsetToX(int line,
                      int offset)

Convert a character offset to a horizontal pixel position inside the text area. Overridden to take gutter width into account.

Overrides:

_offsetToX in class JEditTextArea

Parameters:

line - the 0-based line number

offset - the character offset (0 is the first character on a line)

Returns:

the horizontal position

xToOffset

public int xToOffset(int line,
                     int x)

Convert a horizontal pixel position to a character offset. Overridden to take gutter width into account.

Overrides:

xToOffset in class JEditTextArea

Parameters:

line - the 0-based line number

x - the horizontal pixel position

Returns:

he character offset (0 is the first character on a line)

getEditor

public Editor getEditor()