Package jaxx.runtime.swing.help

Class JAXXHelpBroker

java.lang.Object
jaxx.runtime.swing.help.JAXXHelpBroker
public class JAXXHelpBroker
extends java.lang.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 Description
    class  JAXXHelpBroker.ShowHelpForTrackedComponentAction  

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor Description
    JAXXHelpBroker​(java.lang.String helpsetName, java.lang.String helpKey, java.lang.String defaultID, JAXXHelpUIHandler handler)  
    JAXXHelpBroker​(java.util.Locale locale, java.lang.String helpsetName, java.lang.String helpKey, java.lang.String defaultID, JAXXHelpUIHandler handler)  

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • JAXX_CONTEXT_ENTRY

      public static final java.lang.String JAXX_CONTEXT_ENTRY
      See Also:
      Constant Field Values

    • helpsetName

      protected final java.lang.String helpsetName
      name of helpset

    • defaultID

      protected final java.lang.String defaultID
      default id to use if none given

    • helpKey

      protected final java.lang.String helpKey
      help key

    • helpset

      protected javax.help.HelpSet helpset
      helpset to use

    • helpBroker

      protected javax.help.HelpBroker helpBroker
      help broker

    • locale

      protected java.util.Locale locale
      current locale used

    • cursors

      protected java.util.Hashtable<java.awt.Component,​java.awt.Cursor> cursors
      cache of cursors modified when in context-sensitive mode

    • onItemCursor

      protected java.awt.Cursor onItemCursor
      cursor to use in context-sensitive mode

    • cache

      protected final java.util.Map<java.awt.Component,​java.lang.String> cache
      cache of component which cursor have been modified

    • handler

      protected JAXXHelpUIHandler handler
      help ui handler

  • Constructor Details

    • JAXXHelpBroker

      public JAXXHelpBroker​(java.lang.String helpsetName, java.lang.String helpKey, java.lang.String defaultID, JAXXHelpUIHandler handler)

    • JAXXHelpBroker

      public JAXXHelpBroker​(java.util.Locale locale, java.lang.String helpsetName, java.lang.String helpKey, java.lang.String defaultID, JAXXHelpUIHandler handler)

  • Method Details

    • prepareUI

      public void prepareUI​(JAXXObject c)

    • showHelp

      public void showHelp​(JAXXContext context, java.lang.String helpId)

    • getHandler

      public JAXXHelpUIHandler getHandler()

    • getHelpBroker

      public javax.help.HelpBroker getHelpBroker()

    • getHelpKey

      public java.lang.String getHelpKey()

    • getHelpset

      public javax.help.HelpSet getHelpset()

    • getHelpsetName

      public java.lang.String getHelpsetName()

    • getDefaultID

      public java.lang.String getDefaultID()

    • setLocale

      public void setLocale​(java.util.Locale locale)

    • showHelpSet

      public void showHelpSet()

    • installUI

      public void installUI​(java.awt.Component comp, java.lang.String helpId)

    • getShowHelpButton

      protected javax.swing.AbstractButton getShowHelpButton​(JAXXObject c)

    • getShowHelpAction

      protected java.awt.event.ActionListener getShowHelpAction()

    • getDeppestComponent

      protected java.awt.Component getDeppestComponent​(java.awt.Component mouseComponent, java.awt.event.MouseEvent event)

    • findHelpId

      public java.lang.String findHelpId​(java.awt.Component comp)

    • findExtactHelpId

      protected java.lang.String findExtactHelpId​(java.awt.Component comp)

    • getTopContainers

      protected java.util.Vector<?> getTopContainers​(java.lang.Object source)

    • getRoot

      protected java.awt.Component getRoot​(java.lang.Object comp)

    • setAndStoreCursors

      protected void setAndStoreCursors​(java.awt.Component comp, java.awt.Cursor cursor)

    • resetAndRestoreCursors

      protected void resetAndRestoreCursors​(java.awt.Component comp)

    • getMouseEvent

      public static java.awt.event.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​(java.awt.AWTEvent event)