[Java] Class TextEditor

groovy.console.ui.text.TextEditor

All Implemented Interfaces and Traits:: Pageable, Printable

public class TextEditor
extends JTextPane
implements Pageable, Printable

A simple text pane that is printable and wrapping is optional.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`AUTO_INDENT`
`static String`	`FIND`
`static String`	`FIND_NEXT`
`static String`	`FIND_PREVIOUS`
`static String`	`REPLACE`

Inherited fields
Fields inherited from class	Fields
`class JTextPane`	`W3C_LENGTH_UNITS, HONOR_DISPLAY_PROPERTIES, FOCUS_ACCELERATOR_KEY, DEFAULT_KEYMAP, 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
`TextEditor ()` Creates a new instance of TextEditor
`TextEditor (boolean tabsAsSpaces)` Creates a new instance of TextEditor
`TextEditor (boolean tabsAsSpaces, boolean multiLineTab)` Creates a new instance of TextEditor
`TextEditor (boolean tabsAsSpaces, boolean multiLineTab, boolean unwrapped)` Creates a new instance of TextEditor

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addNotify()`
	`public int`	`getNumberOfPages()`
	`public PageFormat`	`getPageFormat(int pageIndex)`
	`public Printable`	`getPrintable(int param)`
	`public boolean`	`getScrollableTracksViewportWidth()`
	`public boolean`	`isMultiLineTabbed()` Whether using the tab key indents the selected lines of code
	`public void`	`isMultiLineTabbed(boolean multiLineTab)` Parameters: `multiLineTab` - the new multiLine tab value
	`public static boolean`	`isOvertypeMode()` Returns: true if overtype mode is active, false for insert mode
	`public boolean`	`isTabsAsSpaces()` Returns: true if tabs are converted to spaces upon typing
	`public void`	`isTabsAsSpaces(boolean tabsAsSpaces)` Parameters: `tabsAsSpaces` - whether tabs are converted to spaces
	`public boolean`	`isUnwrapped()` Returns: true if text wrapping is disabled
	`public void`	`mouseEntered(MouseEvent me)`
	`public void`	`mouseExited(MouseEvent me)`
	`public int`	`print(Graphics graphics, PageFormat pageFormat, int page)`
	`protected void`	`processKeyEvent(KeyEvent e)`
	`public void`	`removeNotify()`
	`public void`	`replaceSelection(String text)`
	`public void`	`setBounds(int x, int y, int width, int height)`
	`public void`	`setOvertypeMode(boolean isOvertypeMode)` Set the caret to use depending on overtype/insert mode
	`public void`	`setUnwrapped(boolean unwrapped)` Parameters: `unwrapped` - the new unwrapped value

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class JTextPane`	getUIClassID, getStyle, setDocument, setStyledDocument, getStyledDocument, replaceSelection, insertComponent, insertIcon, addStyle, removeStyle, setLogicalStyle, getLogicalStyle, getCharacterAttributes, setCharacterAttributes, getParagraphAttributes, setParagraphAttributes, getInputAttributes, setEditorKit, read, getContentType, setContentType, setText, getAccessibleContext, getPreferredSize, getText, getEditorKitClassNameForContentType, setEditorKitForContentType, getEditorKit, addHyperlinkListener, removeHyperlinkListener, getHyperlinkListeners, fireHyperlinkUpdate, setPage, setPage, scrollToReference, getPage, getEditorKitForContentType, createEditorKitForContentType, registerEditorKitForContentType, registerEditorKitForContentType, getScrollableTracksViewportWidth, getScrollableTracksViewportHeight, write, read, getActions, print, print, print, copy, isEditable, setUI, updateUI, getUI, getUI, setEditable, select, getText, setMargin, getMargin, getToolTipText, removeNotify, getSelectedText, getCaret, selectAll, cut, paste, addInputMethodListener, getInputMethodRequests, setComponentOrientation, getCaretPosition, getSelectionStart, getSelectionEnd, modelToView, setCaretPosition, addCaretListener, removeCaretListener, getCaretListeners, setNavigationFilter, getNavigationFilter, setCaret, getHighlighter, setHighlighter, setKeymap, getKeymap, getKeymap, addKeymap, removeKeymap, loadKeymap, getCaretColor, setCaretColor, getSelectionColor, setSelectionColor, getSelectedTextColor, setSelectedTextColor, getDisabledTextColor, setDisabledTextColor, modelToView2D, viewToModel, viewToModel2D, moveCaretPosition, setFocusAccelerator, getFocusAccelerator, setSelectionStart, setSelectionEnd, setDragEnabled, getDragEnabled, setDropMode, getDropMode, getDropLocation, getPreferredScrollableViewportSize, getScrollableUnitIncrement, getScrollableBlockIncrement, getPrintable, getDocument, update, contains, getLocation, print, getSize, setOpaque, isOpaque, setEnabled, getBounds, addAncestorListener, firePropertyChange, firePropertyChange, firePropertyChange, getListeners, getClientProperty, setInheritsPopupMenu, getInheritsPopupMenu, setComponentPopupMenu, getComponentPopupMenu, paint, printAll, isPaintingTile, isPaintingForPrint, isManagingFocus, setNextFocusableComponent, getNextFocusableComponent, setRequestFocusEnabled, isRequestFocusEnabled, requestFocus, requestFocus, requestFocusInWindow, grabFocus, setVerifyInputWhenFocusTarget, getVerifyInputWhenFocusTarget, getFontMetrics, setPreferredSize, setMaximumSize, getMaximumSize, setMinimumSize, getMinimumSize, setBorder, getBorder, getInsets, getInsets, getAlignmentY, setAlignmentY, getAlignmentX, setAlignmentX, setInputVerifier, getInputVerifier, getGraphics, setDebugGraphicsOptions, getDebugGraphicsOptions, registerKeyboardAction, registerKeyboardAction, unregisterKeyboardAction, getRegisteredKeyStrokes, getConditionForKeyStroke, getActionForKeyStroke, resetKeyboardActions, setInputMap, enable, getInputMap, getInputMap, setActionMap, getActionMap, getBaseline, getBaselineResizeBehavior, requestDefaultFocus, setForeground, setBackground, setFont, getDefaultLocale, setDefaultLocale, setToolTipText, getToolTipText, getToolTipLocation, getPopupLocation, createToolTip, scrollRectToVisible, setAutoscrolls, getAutoscrolls, setTransferHandler, getTransferHandler, putClientProperty, setFocusTraversalKeys, isLightweightComponent, reshape, getX, getY, getWidth, getHeight, computeVisibleRect, getVisibleRect, addVetoableChangeListener, removeVetoableChangeListener, getVetoableChangeListeners, getTopLevelAncestor, removeAncestorListener, getAncestorListeners, addNotify, repaint, repaint, isValidateRoot, isOptimizedDrawingEnabled, paintImmediately, paintImmediately, setDoubleBuffered, isDoubleBuffered, getRootPane, hide, disable, setVisible, revalidate, add, add, add, add, add, remove, remove, list, list, validate, removeAll, invalidate, locate, layout, preferredSize, minimumSize, insets, getComponent, addPropertyChangeListener, addPropertyChangeListener, isFocusCycleRoot, isFocusCycleRoot, getFocusTraversalPolicy, setFocusTraversalPolicy, countComponents, setComponentZOrder, getComponentZOrder, setLayout, doLayout, paintComponents, printComponents, addContainerListener, removeContainerListener, getContainerListeners, deliverEvent, getMousePosition, findComponentAt, findComponentAt, isAncestorOf, getFocusTraversalKeys, areFocusTraversalKeysSet, isFocusTraversalPolicySet, setFocusCycleRoot, setFocusTraversalPolicyProvider, isFocusTraversalPolicyProvider, transferFocusDownCycle, applyComponentOrientation, getLayout, getComponents, getComponentCount, getComponentAt, getComponentAt, add, remove, toString, getName, contains, list, list, list, size, getParent, getLocation, setName, action, location, getSize, resize, resize, setSize, setSize, move, setLocale, isValid, bounds, getLocale, getBounds, isEnabled, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener, requestFocus, requestFocusInWindow, dispatchEvent, enable, setLocation, setLocation, repaint, repaint, repaint, nextFocus, getForeground, getFont, getTreeLock, getFocusCycleRootAncestor, isDisplayable, isPreferredSizeSet, isMaximumSizeSet, isMinimumSizeSet, getBackground, isLightweight, setBounds, setBounds, getPropertyChangeListeners, getPropertyChangeListeners, isShowing, getMousePosition, getGraphicsConfiguration, isFocusable, isFocusOwner, transferFocus, postEvent, transferFocusBackward, setDropTarget, getDropTarget, getToolkit, enableInputMethods, handleEvent, isVisible, show, show, isForegroundSet, isBackgroundSet, isFontSet, getColorModel, getLocationOnScreen, setCursor, getCursor, isCursorSet, paintAll, imageUpdate, createImage, createImage, createVolatileImage, createVolatileImage, prepareImage, prepareImage, checkImage, checkImage, setIgnoreRepaint, getIgnoreRepaint, inside, addComponentListener, removeComponentListener, getComponentListeners, addFocusListener, removeFocusListener, getFocusListeners, addHierarchyListener, removeHierarchyListener, getHierarchyListeners, addHierarchyBoundsListener, removeHierarchyBoundsListener, getHierarchyBoundsListeners, addKeyListener, removeKeyListener, getKeyListeners, addMouseListener, removeMouseListener, getMouseListeners, addMouseMotionListener, removeMouseMotionListener, getMouseMotionListeners, addMouseWheelListener, removeMouseWheelListener, getMouseWheelListeners, removeInputMethodListener, getInputMethodListeners, getInputContext, mouseDown, mouseDrag, mouseUp, mouseMove, mouseEnter, mouseExit, keyDown, keyUp, gotFocus, lostFocus, isFocusTraversable, setFocusable, setFocusTraversalKeysEnabled, getFocusTraversalKeysEnabled, transferFocusUpCycle, hasFocus, getComponentOrientation, setMixingCutoutShape, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

Field Detail

public static final String AUTO_INDENT

public static final String FIND

public static final String FIND_NEXT

public static final String FIND_PREVIOUS

public static final String REPLACE

Constructor Detail

public TextEditor()

Creates a new instance of TextEditor

public TextEditor(boolean tabsAsSpaces)

Creates a new instance of TextEditor

public TextEditor(boolean tabsAsSpaces, boolean multiLineTab)

Creates a new instance of TextEditor

public TextEditor(boolean tabsAsSpaces, boolean multiLineTab, boolean unwrapped)

Creates a new instance of TextEditor

Method Detail

public void addNotify()

public int getNumberOfPages()

public PageFormat getPageFormat(int pageIndex)

public Printable getPrintable(int param)

public boolean getScrollableTracksViewportWidth()

public boolean isMultiLineTabbed()

Whether using the tab key indents the selected lines of code

Returns:: true if multiline tabbing is active

public void isMultiLineTabbed(boolean multiLineTab)

Parameters:: multiLineTab - the new multiLine tab value

public static boolean isOvertypeMode()

Returns:: true if overtype mode is active, false for insert mode

public boolean isTabsAsSpaces()

Returns:: true if tabs are converted to spaces upon typing

public void isTabsAsSpaces(boolean tabsAsSpaces)

Parameters:: tabsAsSpaces - whether tabs are converted to spaces

public boolean isUnwrapped()

Returns:: true if text wrapping is disabled

public void mouseEntered(MouseEvent me)

public void mouseExited(MouseEvent me)

public int print(Graphics graphics, PageFormat pageFormat, int page)

protected void processKeyEvent(KeyEvent e)

public void removeNotify()

public void replaceSelection(String text)

public void setBounds(int x, int y, int width, int height)

public void setOvertypeMode(boolean isOvertypeMode)

Set the caret to use depending on overtype/insert mode

Parameters:: isOvertypeMode - the new mode; true = overtype

public void setUnwrapped(boolean unwrapped)

Parameters:: unwrapped - the new unwrapped value

© 2003-2020 The Apache Software Foundation
Licensed under the Apache license.
https://docs.groovy-lang.org/3.0.7/html/gapi/groovy/console/ui/text/TextEditor.html