Module org.autogui

Package org.autogui.swing.util

Class PopupExtensionText

java.lang.Object

org.autogui.swing.util.PopupExtension

org.autogui.swing.util.PopupExtensionText

All Implemented Interfaces:

ActionListener, FocusListener, KeyListener, MouseListener, EventListener

public class PopupExtensionText
extends PopupExtension
implements FocusListener

default popup menu support for text components. The default impl. can be set by installDefault(JTextComponent) which supplies PopupExtension.getDefaultKeyMatcher() and getServiceDefaultMenu(JTextComponent). The method calls putInputEditActions(JTextComponent) which instruments additional key-actions regarding deleting.

the default items flow:

1. PopupExtensionText.TextServiceDefaultMenu.initEditActions(JTextComponent) ->
2. PopupExtensionText.TextServiceDefaultMenu.getActionsInInitEditActions(JTextComponent) ->
3. getEditActions(JTextComponent)

Note putUnregisteredEditActions(JTextComponent) is not called automatically.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PopupExtensionText.TextAbstractHistoryAction	an abstract action for interacting with the history-buffer (kill-buffer)
static class	PopupExtensionText.TextClearAction	action for clearing the field
static class	PopupExtensionText.TextCopyAction	a copy action
static class	PopupExtensionText.TextCopyAllAction	a copy-all action: copying all text in a text-component
static class	PopupExtensionText.TextCutAction	a cut action
static class	PopupExtensionText.TextDeleteNextWordAction	a delete-next-word action
static class	PopupExtensionText.TextDeletePreviousWordAction	a delete-previous-word action
static class	PopupExtensionText.TextDeleteToLineEndAction	a delete-to-line-end action
static class	PopupExtensionText.TextInputEdit	an edit in the history buffer
static class	PopupExtensionText.TextInputHistory	a history buffer (kill buffer)
static class	PopupExtensionText.TextLoadAction	a file loading action
static class	PopupExtensionText.TextOpenBrowserAction	the action for opening selection as a URL in a browser
static class	PopupExtensionText.TextPasteAction	a paste action
static class	PopupExtensionText.TextPasteAllAction	a paste-all action: replacing entire text with the clipboard contents
static class	PopupExtensionText.TextPasteHistoryAction	a paste the history-buffer action (yank)
static class	PopupExtensionText.TextSaveAction	a file saving action
static class	PopupExtensionText.TextSelectAllAction	a select-all action
static class	PopupExtensionText.TextServiceDefaultMenu	a PopupExtension.PopupMenuBuilder which has typical actions for the text component

Nested classes/interfaces inherited from class org.autogui.swing.util.PopupExtension

PopupExtension.DefaultPopupGetter, PopupExtension.DefaultPopupMenu, PopupExtension.MenuKeySelector, PopupExtension.PopupCancelChecker, PopupExtension.PopupExtensionDisplayAction, PopupExtension.PopupMenuBuilder, PopupExtension.PopupMenuBuilderEmpty, PopupExtension.PopupMenuFilter, PopupExtension.PopupMenuFilterAsIs, PopupExtension.PopupMenuHidingFix, PopupExtension.PopupMenuListenerForSetup, PopupExtension.PredicateKeyMatcher

Field Summary

Fields

Modifier and Type	Field	Description
static PopupExtensionText.TextInputHistory	defaultHistory
protected int	documentLength
protected static JComponent	encodingPane
static Charset	selectedCharset
protected int	selectionEnd
protected int	selectionStart

Fields inherited from class org.autogui.swing.util.PopupExtension

action, cancelChecker, filter, keyMatcher, menu, MENU_CATEGORY_EDIT, MENU_CATEGORY_JUMP, MENU_CATEGORY_PREFS, MENU_CATEGORY_SELECT, MENU_CATEGORY_SET, MENU_CATEGORY_TRANSFER, MENU_CATEGORY_UNDO, MENU_CATEGORY_VIEW, MENU_CATEGORY_WINDOW, MENU_FILTER_IDENTITY, MENU_SUB_CATEGORY_COPY, MENU_SUB_CATEGORY_CUT, MENU_SUB_CATEGORY_DELETE, MENU_SUB_CATEGORY_EXPORT, MENU_SUB_CATEGORY_IMPORT, MENU_SUB_CATEGORY_NEW, MENU_SUB_CATEGORY_PASTE, MENU_SUB_CATEGORY_PREFS_CHANGE, MENU_SUB_CATEGORY_PREFS_WINDOW, MENU_SUB_CATEGORY_REDO, MENU_SUB_CATEGORY_SELECT, MENU_SUB_CATEGORY_UNDO, MENU_SUB_CATEGORY_WINDOW_SELECT, MENU_SUB_CATEGORY_WINDOW_VIEW, menuBuilder, pane

Constructor Summary

Constructors

Constructor	Description
PopupExtensionText(JTextComponent textComponent, Predicate<KeyEvent> keyMatcher, PopupExtension.PopupMenuBuilder builder)

Method Summary

Modifier and Type	Method	Description
void	addListenersTo(JComponent pane)
protected void	error(Exception ex)
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
static List<Action>	getEditActions(JTextComponent textComponent)	JDK has standard implementations for cut, copy and paste as DefaultEditorKit.
static JComponent	getEncodingPane()
static List<Action>	getInputEditActions(JTextComponent component)
static PopupExtensionText.TextServiceDefaultMenu	getServiceDefaultMenu(JTextComponent component)
JTextComponent	getTextComponent()
static PopupExtensionText	installDefault(JTextComponent textComponent)
static void	putInputEditActions(JTextComponent component)
static void	putInputEditActionsToKeys(InputMap map, JTextComponent component)
static void	putInputEditActionsToMap(ActionMap map, JTextComponent component)
static void	putUnregisteredEditActions(JTextComponent component)	usually, it will register "Copy Value" and "Paste Value"
void	showByKey(KeyEvent e, Component comp)	call PopupExtension.show(Component, int, int) with the bottom right position of the current text selection start
static Rectangle	textComponentModelToView(JTextComponent textComponent, int sel)
static int	textComponentViewToModel(JTextComponent textComponent, Point p)

Methods inherited from class org.autogui.swing.util.PopupExtension

actionPerformed, addListenersToAsPopupMenuListener, addListenersToPane, getAction, getDefaultKeyMatcher, getDefaultKeyStroke, getFilter, getKeyCode, getKeyMatcher, getKeyStroke, getMenu, getMenuBuilder, getMenuShortcutKeyMask, getPane, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, setFilter, setMenuBuilder, setupCancelChecker, setupMenu, show, show

Methods inherited from class java.lang.Object

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

Field Details

selectionStart

protected int selectionStart

selectionEnd

protected int selectionEnd

documentLength

protected int documentLength

defaultHistory

public static PopupExtensionText.TextInputHistory defaultHistory

selectedCharset

public static Charset selectedCharset

encodingPane

protected static JComponent encodingPane

Constructor Details

PopupExtensionText

public PopupExtensionText(JTextComponent textComponent,
 Predicate<KeyEvent> keyMatcher,
 PopupExtension.PopupMenuBuilder builder)

Method Details

installDefault

public static PopupExtensionText installDefault(JTextComponent textComponent)

getTextComponent

public JTextComponent getTextComponent()

addListenersTo

public void addListenersTo(JComponent pane)

Overrides:

addListenersTo in class PopupExtension

showByKey

public void showByKey(KeyEvent e,
 Component comp)

call PopupExtension.show(Component, int, int) with the bottom right position of the current text selection start

Overrides:

showByKey in class PopupExtension

Parameters:

e - the key-event

comp - the target component

textComponentModelToView

public static Rectangle textComponentModelToView(JTextComponent textComponent,
 int sel)
                                          throws BadLocationException

Throws:

BadLocationException

textComponentViewToModel

public static int textComponentViewToModel(JTextComponent textComponent,
 Point p)

error

protected void error(Exception ex)

getServiceDefaultMenu

public static PopupExtensionText.TextServiceDefaultMenu getServiceDefaultMenu(JTextComponent component)

getEditActions

public static List<Action> getEditActions(JTextComponent textComponent)

JDK has standard implementations for cut, copy and paste as DefaultEditorKit. However, those actions take the target from event source, and do not have user-friendly name

Parameters:

textComponent - the target component

Returns:

list of actions for the component: cut, copy, copy-all, paste, paste-all, select-all, load, save, and open-browser

getInputEditActions

public static List<Action> getInputEditActions(JTextComponent component)

Parameters:

component - optional component

Returns:

list of actions of additional edit-actions: delete-next-word, delete-previous-word, delete-to-line-end, and paste-history

putInputEditActions

public static void putInputEditActions(JTextComponent component)

putInputEditActionsToMap

public static void putInputEditActionsToMap(ActionMap map,
 JTextComponent component)

putInputEditActionsToKeys

public static void putInputEditActionsToKeys(InputMap map,
 JTextComponent component)

putUnregisteredEditActions

public static void putUnregisteredEditActions(JTextComponent component)

usually, it will register "Copy Value" and "Paste Value"

Parameters:

component - the host of action- and input-map

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

getEncodingPane

public static JComponent getEncodingPane()