Class KeyTipManager

java.lang.Object

org.pushingpixels.radiance.component.internal.utils.KeyTipManager

public class KeyTipManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	KeyTipManager.HasNextKeyTipChain	Annotation to mark a command button that shows UI content with associated keytips on clicking its action area.
static class	KeyTipManager.KeyTipChain
static class	KeyTipManager.KeyTipEvent
static class	KeyTipManager.KeyTipLink
static interface	KeyTipManager.KeyTipLinkTraversal
static interface	KeyTipManager.KeyTipListener
private class	KeyTipManager.ProcessingThread

Field Summary

Fields

Modifier and Type	Field	Description
private Component	focusOwner
private static final KeyTipManager	instance
private List<KeyTipManager.KeyTipChain>	keyTipChains
private List<KeyTipManager.KeyTipListener>	listenerList
private BlockingQueue<Character>	processingQueue
private JRibbonFrame	rootOwner

Constructor Summary

Constructors

Modifier	Constructor	Description
private	KeyTipManager()

Method Summary

Modifier and Type	Method	Description
private void	addCommandButtonLinks(JCommandButton commandButton, KeyTipManager.KeyTipChain chain)
void	addKeyTipListener(KeyTipManager.KeyTipListener keyTipListener)
static KeyTipManager	defaultManager()
private void	fireKeyTipsHidden(JRibbonFrame ribbonFrame)
private void	fireKeyTipsShown(JRibbonFrame ribbonFrame)
private KeyTipManager.KeyTipLink	getCommandButtonActionLink(JCommandButton cb)
private KeyTipManager.KeyTipLink	getCommandButtonPopupLink(JCommandButton cb)
KeyTipManager.KeyTipChain	getCurrentlyShownKeyTipChain()
Collection<KeyTipManager.KeyTipLink>	getCurrentlyShownKeyTips()
private KeyTipManager.KeyTipLink	getRibbonComponentLink(JRibbonComponent rc)
void	handleKeyPress(char keyChar)
void	hideAllKeyTips()
boolean	isShowingKeyTips()
private void	populateChain(Component c, KeyTipManager.KeyTipChain chain)
private void	processNextKeyPress(char keyChar)
void	refreshCurrentChain()
void	removeKeyTipListener(KeyTipManager.KeyTipListener keyTipListener)
private void	repaintWindows()
void	showPreviousChain()
void	showRootKeyTipChain(JRibbonFrame ribbonFrame)
private void	tryRestoringFocusOwner()

Methods inherited from class Object

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

Field Details

keyTipChains

private List<KeyTipManager.KeyTipChain> keyTipChains

listenerList

private List<KeyTipManager.KeyTipListener> listenerList

processingQueue

private BlockingQueue<Character> processingQueue

rootOwner

private JRibbonFrame rootOwner

focusOwner

private Component focusOwner

instance

private static final KeyTipManager instance

Constructor Details

KeyTipManager

private KeyTipManager()

Method Details

defaultManager

public static KeyTipManager defaultManager()

isShowingKeyTips

public boolean isShowingKeyTips()

hideAllKeyTips

public void hideAllKeyTips()

tryRestoringFocusOwner

private void tryRestoringFocusOwner()

showRootKeyTipChain

public void showRootKeyTipChain(JRibbonFrame ribbonFrame)

getCurrentlyShownKeyTips

public Collection<KeyTipManager.KeyTipLink> getCurrentlyShownKeyTips()

getCurrentlyShownKeyTipChain

public KeyTipManager.KeyTipChain getCurrentlyShownKeyTipChain()

showPreviousChain

public void showPreviousChain()

addCommandButtonLinks

private void addCommandButtonLinks(JCommandButton commandButton,
 KeyTipManager.KeyTipChain chain)

populateChain

private void populateChain(Component c,
 KeyTipManager.KeyTipChain chain)

getCommandButtonActionLink

private KeyTipManager.KeyTipLink getCommandButtonActionLink(JCommandButton cb)

getRibbonComponentLink

private KeyTipManager.KeyTipLink getRibbonComponentLink(JRibbonComponent rc)

getCommandButtonPopupLink

private KeyTipManager.KeyTipLink getCommandButtonPopupLink(JCommandButton cb)

handleKeyPress

public void handleKeyPress(char keyChar)

processNextKeyPress

private void processNextKeyPress(char keyChar)

repaintWindows

private void repaintWindows()

addKeyTipListener

public void addKeyTipListener(KeyTipManager.KeyTipListener keyTipListener)

removeKeyTipListener

public void removeKeyTipListener(KeyTipManager.KeyTipListener keyTipListener)

fireKeyTipsShown

private void fireKeyTipsShown(JRibbonFrame ribbonFrame)

fireKeyTipsHidden

private void fireKeyTipsHidden(JRibbonFrame ribbonFrame)

refreshCurrentChain

public void refreshCurrentChain()