Module org.autogui

Package org.autogui.swing.util

Class PopupExtension

java.lang.Object

org.autogui.swing.util.PopupExtension

All Implemented Interfaces:

ActionListener, KeyListener, MouseListener, EventListener

Direct Known Subclasses:

GuiSwingViewCollectionTable.PopupExtensionCollection, GuiSwingViewCollectionTable.PopupExtensionCollectionColumnHeader, PopupExtensionText

public class PopupExtension
extends Object
implements MouseListener, KeyListener, ActionListener

a popup menu manager. it supports showing the popup menu supplied by menu via the following event listeners:

• MouseListener
• KeyListener with keyMatcher, can be getDefaultKeyMatcher()
• ActionListener caused by getAction()

menuBuilder determines menu items in the popup menu via PopupExtension.PopupMenuBuilder.buildWithClear(PopupExtension.PopupMenuFilter, JPopupMenu).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PopupExtension.DefaultPopupGetter	a default popup-menu factory creating a new popup and setting it to the component
static class	PopupExtension.DefaultPopupMenu	custom popup-menu for fixing display location issue: overriding setLocation
static class	PopupExtension.MenuKeySelector	a menu-selector by incremental key-typing
static class	PopupExtension.PopupCancelChecker	improve default behavior of showing popup menu: clicking a menu button while the menu is visible can hide it
static class	PopupExtension.PopupExtensionDisplayAction	an action for displaying a popup menu
static interface	PopupExtension.PopupMenuBuilder	the interface for constructing menus
static class	PopupExtension.PopupMenuBuilderEmpty	the empty builder
static interface	PopupExtension.PopupMenuFilter	the function interface for menu filtering
static class	PopupExtension.PopupMenuFilterAsIs	a filter for accepting any items as is
static class	PopupExtension.PopupMenuHidingFix	a window-listener and popup-menu listener for fixing the behavior of showing/hiding a popup menu
static class	PopupExtension.PopupMenuListenerForSetup	the menu listener for calling setupMenu()
static class	PopupExtension.PredicateKeyMatcher	keyCode and modifierEx: ALT_DOWN_MASK, ...

Field Summary

Fields

Modifier and Type	Field	Description
protected Action	action
protected PopupExtension.PopupCancelChecker	cancelChecker
protected PopupExtension.PopupMenuFilter	filter
protected Predicate<KeyEvent>	keyMatcher
protected Supplier<JPopupMenu>	menu	the supplier is frequently called and expected to return same menu object
static String	MENU_CATEGORY_EDIT
static String	MENU_CATEGORY_JUMP
static String	MENU_CATEGORY_PREFS
static String	MENU_CATEGORY_SELECT
static String	MENU_CATEGORY_SET
static String	MENU_CATEGORY_TRANSFER
static String	MENU_CATEGORY_UNDO
static String	MENU_CATEGORY_VIEW
static String	MENU_CATEGORY_WINDOW
static PopupExtension.PopupMenuFilterAsIs	MENU_FILTER_IDENTITY
static String	MENU_SUB_CATEGORY_COPY
static String	MENU_SUB_CATEGORY_CUT
static String	MENU_SUB_CATEGORY_DELETE
static String	MENU_SUB_CATEGORY_EXPORT
static String	MENU_SUB_CATEGORY_IMPORT
static String	MENU_SUB_CATEGORY_NEW
static String	MENU_SUB_CATEGORY_PASTE
static String	MENU_SUB_CATEGORY_PREFS_CHANGE
static String	MENU_SUB_CATEGORY_PREFS_WINDOW
static String	MENU_SUB_CATEGORY_REDO
static String	MENU_SUB_CATEGORY_SELECT
static String	MENU_SUB_CATEGORY_UNDO
static String	MENU_SUB_CATEGORY_WINDOW_SELECT
static String	MENU_SUB_CATEGORY_WINDOW_VIEW
protected PopupExtension.PopupMenuBuilder	menuBuilder
protected JComponent	pane

Constructor Summary

Constructors

Constructor	Description
PopupExtension(JComponent pane, Predicate<KeyEvent> keyMatcher, PopupExtension.PopupMenuBuilder menuBuilder)	call PopupExtension(JComponent, Predicate, PopupMenuBuilder, Supplier).
PopupExtension(JComponent pane, Predicate<KeyEvent> keyMatcher, PopupExtension.PopupMenuBuilder menuBuilder, Supplier<JPopupMenu> menu)	add this to pane as KeyListener and MouseListener
PopupExtension(JComponent pane, Predicate<KeyEvent> keyMatcher, PopupExtension.PopupMenuBuilder menuBuilder, JPopupMenu menu)	call PopupExtension(JComponent, Predicate, PopupMenuBuilder, Supplier)
PopupExtension(JComponent pane, PopupExtension.PopupMenuBuilder menuBuilder)	call PopupExtension(JComponent, Predicate, PopupMenuBuilder) with getDefaultKeyMatcher()

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	addListenersTo(JComponent pane)
protected void	addListenersToAsPopupMenuListener(JComponent pane)
void	addListenersToPane()
Action	getAction()
static Predicate<KeyEvent>	getDefaultKeyMatcher()
static KeyStroke	getDefaultKeyStroke()
PopupExtension.PopupMenuFilter	getFilter()
static PopupExtension.PredicateKeyMatcher	getKeyCode(int keyCode, int modifiersEx)
Predicate<KeyEvent>	getKeyMatcher()
static KeyStroke	getKeyStroke(int key, int... mask)
JPopupMenu	getMenu()
PopupExtension.PopupMenuBuilder	getMenuBuilder()
static int	getMenuShortcutKeyMask()
JComponent	getPane()
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)	Note: currently disabled using the mechanism, instead shown by framework original impl.
void	mouseReleased(MouseEvent e)
void	setFilter(PopupExtension.PopupMenuFilter filter)
void	setMenuBuilder(PopupExtension.PopupMenuBuilder menuBuilder)
protected void	setupCancelChecker()
void	setupMenu()
void	show(Component comp)
void	show(Component comp, int x, int y)
void	showByKey(KeyEvent e, Component comp)

Methods inherited from class java.lang.Object

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

Field Details

MENU_CATEGORY_UNDO

public static String MENU_CATEGORY_UNDO

MENU_CATEGORY_EDIT

public static String MENU_CATEGORY_EDIT

MENU_CATEGORY_SET

public static String MENU_CATEGORY_SET

MENU_CATEGORY_JUMP

public static String MENU_CATEGORY_JUMP

MENU_CATEGORY_SELECT

public static String MENU_CATEGORY_SELECT

MENU_CATEGORY_TRANSFER

public static String MENU_CATEGORY_TRANSFER

MENU_CATEGORY_VIEW

public static String MENU_CATEGORY_VIEW

MENU_CATEGORY_PREFS

public static String MENU_CATEGORY_PREFS

MENU_CATEGORY_WINDOW

public static String MENU_CATEGORY_WINDOW

MENU_SUB_CATEGORY_NEW

public static String MENU_SUB_CATEGORY_NEW

MENU_SUB_CATEGORY_UNDO

public static String MENU_SUB_CATEGORY_UNDO

MENU_SUB_CATEGORY_REDO

public static String MENU_SUB_CATEGORY_REDO

MENU_SUB_CATEGORY_CUT

public static String MENU_SUB_CATEGORY_CUT

MENU_SUB_CATEGORY_COPY

public static String MENU_SUB_CATEGORY_COPY

MENU_SUB_CATEGORY_PASTE

public static String MENU_SUB_CATEGORY_PASTE

MENU_SUB_CATEGORY_DELETE

public static String MENU_SUB_CATEGORY_DELETE

MENU_SUB_CATEGORY_SELECT

public static String MENU_SUB_CATEGORY_SELECT

MENU_SUB_CATEGORY_IMPORT

public static String MENU_SUB_CATEGORY_IMPORT

MENU_SUB_CATEGORY_EXPORT

public static String MENU_SUB_CATEGORY_EXPORT

MENU_SUB_CATEGORY_PREFS_CHANGE

public static String MENU_SUB_CATEGORY_PREFS_CHANGE

MENU_SUB_CATEGORY_PREFS_WINDOW

public static String MENU_SUB_CATEGORY_PREFS_WINDOW

MENU_SUB_CATEGORY_WINDOW_VIEW

public static String MENU_SUB_CATEGORY_WINDOW_VIEW

MENU_SUB_CATEGORY_WINDOW_SELECT

public static String MENU_SUB_CATEGORY_WINDOW_SELECT

menu

protected Supplier<JPopupMenu> menu

the supplier is frequently called and expected to return same menu object

filter

protected PopupExtension.PopupMenuFilter filter

pane

protected JComponent pane

keyMatcher

protected Predicate<KeyEvent> keyMatcher

menuBuilder

protected PopupExtension.PopupMenuBuilder menuBuilder

cancelChecker

protected PopupExtension.PopupCancelChecker cancelChecker

action

protected Action action

MENU_FILTER_IDENTITY

public static PopupExtension.PopupMenuFilterAsIs MENU_FILTER_IDENTITY

Constructor Details

PopupExtension

public PopupExtension(JComponent pane,
 Predicate<KeyEvent> keyMatcher,
 PopupExtension.PopupMenuBuilder menuBuilder,
 JPopupMenu menu)

call PopupExtension(JComponent, Predicate, PopupMenuBuilder, Supplier)

Parameters:

pane - the host pane of the popup-menu, can be null

keyMatcher - matching with a key-event for displaying the menu

menuBuilder - a builder for constructing menu-items

menu - the displayed popup-menu, can be null

PopupExtension

public PopupExtension(JComponent pane,
 Predicate<KeyEvent> keyMatcher,
 PopupExtension.PopupMenuBuilder menuBuilder,
 Supplier<JPopupMenu> menu)

add this to pane as KeyListener and MouseListener

Parameters:

pane - the host pane of the popup-menu, can be null

keyMatcher - matching with a key-event for displaying the menu

menuBuilder - a builder for constructing menu-items

menu - the supplier of the displayed popup-menu

PopupExtension

public PopupExtension(JComponent pane,
 Predicate<KeyEvent> keyMatcher,
 PopupExtension.PopupMenuBuilder menuBuilder)

call PopupExtension(JComponent, Predicate, PopupMenuBuilder, Supplier). the menu is supplied by creating a new one and setting it by JComponent.setComponentPopupMenu(JPopupMenu). it also calls PopupExtension.MenuKeySelector.addToMenu(JPopupMenu) for incremental item search while showing the popup menu

Parameters:

pane - the host pane of the popup-menu, can be null

keyMatcher - matching with a key-event for displaying the menu

menuBuilder - a builder for constructing menu-items

PopupExtension

public PopupExtension(JComponent pane,
 PopupExtension.PopupMenuBuilder menuBuilder)

call PopupExtension(JComponent, Predicate, PopupMenuBuilder) with getDefaultKeyMatcher()

Parameters:

pane - the host pane of the popup-menu, can be null

menuBuilder - a builder for constructing menu-items

Method Details

setFilter

public void setFilter(PopupExtension.PopupMenuFilter filter)

getFilter

public PopupExtension.PopupMenuFilter getFilter()

setupCancelChecker

protected void setupCancelChecker()

addListenersToPane

public void addListenersToPane()

addListenersTo

public void addListenersTo(JComponent pane)

addListenersToAsPopupMenuListener

protected void addListenersToAsPopupMenuListener(JComponent pane)

Parameters:

pane - the target pane

Since:

1.3

getDefaultKeyMatcher

public static Predicate<KeyEvent> getDefaultKeyMatcher()

getDefaultKeyStroke

public static KeyStroke getDefaultKeyStroke()

getKeyStroke

public static KeyStroke getKeyStroke(int key,
 int... mask)

getMenuShortcutKeyMask

public static int getMenuShortcutKeyMask()

getKeyCode

public static PopupExtension.PredicateKeyMatcher getKeyCode(int keyCode,
 int modifiersEx)

Parameters:

keyCode - a key code such as KeyEvent.VK_SPACE

modifiersEx - extended modifiers such as KeyEvent.CTRL_DOWN_MASK, or 0

Returns:

a predicate matching with the parameters

getKeyMatcher

public Predicate<KeyEvent> getKeyMatcher()

getMenu

public JPopupMenu getMenu()

getMenuBuilder

public PopupExtension.PopupMenuBuilder getMenuBuilder()

setMenuBuilder

public void setMenuBuilder(PopupExtension.PopupMenuBuilder menuBuilder)

getPane

public JComponent getPane()

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

showByKey

public void showByKey(KeyEvent e,
 Component comp)

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

mousePressed

public void mousePressed(MouseEvent e)

Note: currently disabled using the mechanism, instead shown by framework original impl. Some LAF relies on it.

Specified by:

mousePressed in interface MouseListener

Parameters:

e - the handling event

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

getAction

public Action getAction()

show

public void show(Component comp)

show

public void show(Component comp,
 int x,
 int y)

setupMenu

public void setupMenu()