Module org.autogui

Package org.autogui.swing.util

Class PopupExtension.MenuKeySelector

java.lang.Object

org.autogui.swing.util.PopupExtension.MenuKeySelector

All Implemented Interfaces:

EventListener, MenuKeyListener, PopupMenuListener

Enclosing class:

PopupExtension

public static class PopupExtension.MenuKeySelector
extends Object
implements MenuKeyListener, PopupMenuListener

a menu-selector by incremental key-typing

     new MenuKeySelector().addToMenu(popupMenu);
 

select menu items by key types

• any displayable key : put it into the buffer and select a next item. if no item is found, search from the top
• backspace, delete: clear the buffer
• tab: no change for the buffer and search a next item
• newline, arrow-keys, ... : no consumption of the key event

The order of the search is children of the current item, rest sibling items, children of rest sibling items (recursion) ... , upper rest items, children of upper rest items (recursion), ...

Matching : it uses startsWith for JMenuItem's getText()

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	buffer

Constructor Summary

Constructors

Constructor	Description
MenuKeySelector()

Method Summary

Modifier and Type	Method	Description
void	addToMenu(JPopupMenu menu)
void	clearBuffer()
boolean	match(MenuElement e, String str)
boolean	matchText(String text, String str)
void	menuKeyPressed(MenuKeyEvent e)
void	menuKeyReleased(MenuKeyEvent e)
void	menuKeyTyped(MenuKeyEvent e)
void	popupMenuCanceled(PopupMenuEvent e)
void	popupMenuWillBecomeInvisible(PopupMenuEvent e)
void	popupMenuWillBecomeVisible(PopupMenuEvent e)
void	processFound(MenuSelectionManager manager, MenuElement[] found, String str)
boolean	processKeyInput(MenuKeyEvent e)
void	processTarget(MenuSelectionManager manager, String str)
void	run(MenuKeyEvent e)
MenuElement[]	searchDown(MenuElement[] path, MenuElement[] children, MenuElement stopAt, String str)
MenuElement[]	searchUp(MenuElement[] path, String str)

Methods inherited from class java.lang.Object

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

Field Details

buffer

protected StringBuilder buffer

Constructor Details

MenuKeySelector

public MenuKeySelector()

Method Details

addToMenu

public void addToMenu(JPopupMenu menu)

popupMenuWillBecomeVisible

public void popupMenuWillBecomeVisible(PopupMenuEvent e)

Specified by:

popupMenuWillBecomeVisible in interface PopupMenuListener

popupMenuWillBecomeInvisible

public void popupMenuWillBecomeInvisible(PopupMenuEvent e)

Specified by:

popupMenuWillBecomeInvisible in interface PopupMenuListener

popupMenuCanceled

public void popupMenuCanceled(PopupMenuEvent e)

Specified by:

popupMenuCanceled in interface PopupMenuListener

menuKeyTyped

public void menuKeyTyped(MenuKeyEvent e)

Specified by:

menuKeyTyped in interface MenuKeyListener

menuKeyReleased

public void menuKeyReleased(MenuKeyEvent e)

Specified by:

menuKeyReleased in interface MenuKeyListener

menuKeyPressed

public void menuKeyPressed(MenuKeyEvent e)

Specified by:

menuKeyPressed in interface MenuKeyListener

clearBuffer

public void clearBuffer()

run

public void run(MenuKeyEvent e)

processKeyInput

public boolean processKeyInput(MenuKeyEvent e)

processTarget

public void processTarget(MenuSelectionManager manager,
 String str)

processFound

public void processFound(MenuSelectionManager manager,
 MenuElement[] found,
 String str)

searchDown

public MenuElement[] searchDown(MenuElement[] path,
 MenuElement[] children,
 MenuElement stopAt,
 String str)

searchUp

public MenuElement[] searchUp(MenuElement[] path,
 String str)

match

public boolean match(MenuElement e,
 String str)

matchText

public boolean matchText(String text,
 String str)