org.nuiton.jaxx.runtime.api.swing.help

Class JAXXHelpBroker

java.lang.Object

org.nuiton.jaxx.runtime.api.swing.help.JAXXHelpBroker

public class JAXXHelpBroker
extends Object

La classe pour encapsuler l'aide de l'application.

Since:

1.4

Author:

Tony Chemit - chemit@codelutin.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JAXXHelpBroker.ShowHelpForTrackedComponentAction

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Component,String>	cache cache of component which cursor have been modified
protected Hashtable<Component,Cursor>	cursors cache of cursors modified when in context-sensitive mode
protected String	defaultID default id to use if none given
protected JAXXHelpUIHandler	handler help ui handler
protected javax.help.HelpBroker	helpBroker help broker
protected String	helpKey help key
protected javax.help.HelpSet	helpset helpset to use
protected String	helpsetName name of helpset
static String	JAXX_CONTEXT_ENTRY
protected Locale	locale current locale used
protected Cursor	onItemCursor cursor to use in context-sensitive mode

Constructor Summary

Constructors

Constructor and Description
JAXXHelpBroker(Locale locale, String helpsetName, String helpKey, String defaultID, JAXXHelpUIHandler handler)
JAXXHelpBroker(String helpsetName, String helpKey, String defaultID, JAXXHelpUIHandler handler)

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	dispatchEvent(AWTEvent event)
protected String	findExtactHelpId(Component comp)
String	findHelpId(Component comp)
String	getDefaultID()
protected Component	getDeppestComponent(Component mouseComponent, MouseEvent event)
JAXXHelpUIHandler	getHandler()
javax.help.HelpBroker	getHelpBroker()
String	getHelpKey()
javax.help.HelpSet	getHelpset()
String	getHelpsetName()
static MouseEvent	getMouseEvent() Context Sensitive Event Tracking Creates a new EventDispatchThread from which to dispatch events.
protected Component	getRoot(Object comp)
protected ActionListener	getShowHelpAction()
protected AbstractButton	getShowHelpButton(JAXXObject c)
protected Vector<?>	getTopContainers(Object source)
void	installUI(Component comp, String helpId)
void	prepareUI(JAXXObject c)
protected void	resetAndRestoreCursors(Component comp)
protected void	setAndStoreCursors(Component comp, Cursor cursor)
void	setLocale(Locale locale)
void	showHelp(JAXXContext context, String helpId)
void	showHelpSet()

Methods inherited from class java.lang.Object

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

Field Detail

JAXX_CONTEXT_ENTRY

public static final String JAXX_CONTEXT_ENTRY

See Also:

Constant Field Values

helpsetName

protected final String helpsetName

name of helpset

defaultID

protected final String defaultID

default id to use if none given

helpKey

protected final String helpKey

help key

helpset

protected javax.help.HelpSet helpset

helpset to use

helpBroker

protected javax.help.HelpBroker helpBroker

help broker

locale

protected Locale locale

current locale used

cursors

protected Hashtable<Component,Cursor> cursors

cache of cursors modified when in context-sensitive mode

onItemCursor

protected Cursor onItemCursor

cursor to use in context-sensitive mode

cache

protected final Map<Component,String> cache

cache of component which cursor have been modified

handler

protected JAXXHelpUIHandler handler

help ui handler

Constructor Detail

JAXXHelpBroker

public JAXXHelpBroker(String helpsetName,
              String helpKey,
              String defaultID,
              JAXXHelpUIHandler handler)

JAXXHelpBroker

public JAXXHelpBroker(Locale locale,
              String helpsetName,
              String helpKey,
              String defaultID,
              JAXXHelpUIHandler handler)

Method Detail

prepareUI

public void prepareUI(JAXXObject c)

showHelp

public void showHelp(JAXXContext context,
            String helpId)

getHandler

public JAXXHelpUIHandler getHandler()

getHelpBroker

public javax.help.HelpBroker getHelpBroker()

getHelpKey

public String getHelpKey()

getHelpset

public javax.help.HelpSet getHelpset()

getHelpsetName

public String getHelpsetName()

getDefaultID

public String getDefaultID()

setLocale

public void setLocale(Locale locale)

showHelpSet

public void showHelpSet()

installUI

public void installUI(Component comp,
             String helpId)

getShowHelpButton

protected AbstractButton getShowHelpButton(JAXXObject c)

getShowHelpAction

protected ActionListener getShowHelpAction()

getDeppestComponent

protected Component getDeppestComponent(Component mouseComponent,
                            MouseEvent event)

findHelpId

public String findHelpId(Component comp)

findExtactHelpId

protected String findExtactHelpId(Component comp)

getTopContainers

protected Vector<?> getTopContainers(Object source)

getRoot

protected Component getRoot(Object comp)

setAndStoreCursors

protected void setAndStoreCursors(Component comp,
                      Cursor cursor)

resetAndRestoreCursors

protected void resetAndRestoreCursors(Component comp)

getMouseEvent

public static MouseEvent getMouseEvent()

Context Sensitive Event Tracking

Creates a new EventDispatchThread from which to dispatch events. This method returns when stopModal is invoked.

Returns:

MouseEvent The mouse event occurred. Null if cancelled on an undetermined object.

dispatchEvent

protected static void dispatchEvent(AWTEvent event)