public class HelpBrowser extends JDialog
Modifier and Type | Class and Description |
---|---|
(package private) static class |
HelpBrowser.BackAction |
(package private) class |
HelpBrowser.EditAction |
(package private) static class |
HelpBrowser.ForwardAction |
(package private) class |
HelpBrowser.HomeAction |
(package private) class |
HelpBrowser.HyperlinkHandler |
(package private) class |
HelpBrowser.OpenInBrowserAction |
(package private) class |
HelpBrowser.ReloadAction |
JDialog.AccessibleJDialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field and Description |
---|---|
private static JosmAction |
focusAction |
private JosmEditorPane |
help
the help browser
|
private HelpBrowserHistory |
history
the help browser history
|
private static HelpBrowser |
instance
the unique instance
|
private HelpContentReader |
reader |
private String |
url
the currently displayed URL
|
private JMenuItem |
windowMenuItem
the menu item in the windows menu.
|
accessibleContext, rootPane, rootPaneCheckingEnabled
DEFAULT_MODALITY_TYPE
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
HelpBrowser()
Constructs a new
HelpBrowser . |
Modifier and Type | Method and Description |
---|---|
protected void |
build() |
protected StyleSheet |
buildStyleSheet()
Builds the style sheet used in the internal help browser
|
protected JToolBar |
buildToolBar() |
static HelpBrowser |
getInstance()
Replies the unique instance of the help browser
|
String |
getUrl()
Replies the current URL
|
protected void |
handleHelpContentReaderException(String relativeHelpTopic,
HelpContentReaderException e)
Displays a error page if a help topic couldn't be loaded because of network or IO error.
|
protected void |
handleMissingHelpContent(String relativeHelpTopic)
Displays a warning page when a help topic doesn't exist yet.
|
static void |
launchBrowser(String helpTopic)
Launches the internal help browser and directs it to the help page for
helpTopic . |
protected void |
loadAbsoluteHelpTopic(String absoluteHelpTopic)
Loads a help topic given by an absolute help topic name, i.e.
|
protected void |
loadRelativeHelpTopic(String relativeHelpTopic)
Loads a help topic given by a relative help topic name (i.e.
|
protected void |
loadTopic(String content) |
void |
openHelpTopic(String relativeHelpTopic)
Loads and displays the help information for a help topic given
by a relative help topic name, i.e.
|
void |
openUrl(String url)
Opens an URL and displays the content.
|
static void |
setUrlForHelpTopic(String helpTopic)
Show the help page for help topic
helpTopic . |
void |
setVisible(boolean visible) |
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
private static HelpBrowser instance
private JMenuItem windowMenuItem
private JosmEditorPane help
private HelpBrowserHistory history
private HelpContentReader reader
private static final JosmAction focusAction
public HelpBrowser()
HelpBrowser
.public static HelpBrowser getInstance()
public static void setUrlForHelpTopic(String helpTopic)
helpTopic
.helpTopic
- the help topicpublic static void launchBrowser(String helpTopic)
helpTopic
.helpTopic
- the help topicprotected StyleSheet buildStyleSheet()
protected JToolBar buildToolBar()
protected void build()
public void setVisible(boolean visible)
setVisible
in class Dialog
protected void handleMissingHelpContent(String relativeHelpTopic)
relativeHelpTopic
- the help topicprotected void handleHelpContentReaderException(String relativeHelpTopic, HelpContentReaderException e)
relativeHelpTopic
- the help topice
- the exceptionprotected void loadRelativeHelpTopic(String relativeHelpTopic)
relativeHelpTopic
- the relative help topicprotected void loadAbsoluteHelpTopic(String absoluteHelpTopic)
absoluteHelpTopic
- the absolute help topic namepublic void openUrl(String url)
url
- the urlpublic void openHelpTopic(String relativeHelpTopic)
relativeHelpTopic
- the relative help topic