public class HelpBrowser extends javax.swing.JFrame implements IHelpBrowser
Modifier and Type | Class and Description |
---|---|
(package private) static class |
HelpBrowser.AbstractBrowserAction |
(package private) static class |
HelpBrowser.BackAction |
(package private) static class |
HelpBrowser.EditAction |
(package private) static class |
HelpBrowser.ForwardAction |
(package private) static class |
HelpBrowser.HomeAction |
(package private) class |
HelpBrowser.HyperlinkHandler |
(package private) static class |
HelpBrowser.OpenInBrowserAction |
(package private) static class |
HelpBrowser.ReloadAction |
javax.swing.JFrame.AccessibleJFrame
java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
Modifier and Type | Field and Description |
---|---|
private static JosmAction |
FOCUS_ACTION |
private JosmEditorPane |
help
the help browser
|
private HelpBrowserHistory |
history
the help browser history
|
private static HelpBrowser |
instance
the unique instance
|
private HelpContentReader |
reader |
private java.lang.String |
url
the currently displayed URL
|
private javax.swing.JMenuItem |
windowMenuItem
the menu item in the windows menu.
|
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
HelpBrowser()
Constructs a new
HelpBrowser . |
Modifier and Type | Method and Description |
---|---|
protected void |
build()
Builds GUI.
|
protected javax.swing.text.html.StyleSheet |
buildStyleSheet()
Builds the style sheet used in the internal help browser
|
protected javax.swing.JToolBar |
buildToolBar()
Builds toolbar.
|
HelpBrowserHistory |
getHistory()
Replies the browser history.
|
static HelpBrowser |
getInstance()
Replies the unique instance of the help browser
|
java.lang.String |
getUrl()
Replies the current URL.
|
protected void |
handleHelpContentReaderException(java.lang.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(java.lang.String relativeHelpTopic)
Displays a warning page when a help topic doesn't exist yet.
|
static void |
launchBrowser(java.lang.String helpTopic)
Launches the internal help browser and directs it to the help page for
helpTopic . |
protected void |
loadAbsoluteHelpTopic(java.lang.String absoluteHelpTopic)
Loads a help topic given by an absolute help topic name, i.e.
|
protected void |
loadRelativeHelpTopic(java.lang.String relativeHelpTopic)
Loads a help topic given by a relative help topic name (i.e.
|
protected void |
loadTopic(java.lang.String content)
Load help topic.
|
void |
openHelpTopic(java.lang.String relativeHelpTopic)
Loads and displays the help information for a help topic given
by a relative help topic name, i.e.
|
void |
openUrl(java.lang.String url)
Opens an URL and displays the content.
|
static void |
setUrlForHelpTopic(java.lang.String helpTopic)
Show the help page for help topic
helpTopic . |
void |
setVisible(boolean visible) |
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated
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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, 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, 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 javax.swing.JMenuItem windowMenuItem
private JosmEditorPane help
private transient HelpBrowserHistory history
private java.lang.String url
private final transient HelpContentReader reader
private static final JosmAction FOCUS_ACTION
public HelpBrowser()
HelpBrowser
.public static HelpBrowser getInstance()
public static void setUrlForHelpTopic(java.lang.String helpTopic)
helpTopic
.helpTopic
- the help topicpublic static void launchBrowser(java.lang.String helpTopic)
helpTopic
.helpTopic
- the help topicprotected javax.swing.text.html.StyleSheet buildStyleSheet()
protected javax.swing.JToolBar buildToolBar()
protected final void build()
public void setVisible(boolean visible)
setVisible
in class java.awt.Window
protected void loadTopic(java.lang.String content)
content
- topic contentspublic java.lang.String getUrl()
IHelpBrowser
getUrl
in interface IHelpBrowser
protected void handleMissingHelpContent(java.lang.String relativeHelpTopic)
relativeHelpTopic
- the help topicprotected void handleHelpContentReaderException(java.lang.String relativeHelpTopic, HelpContentReaderException e)
relativeHelpTopic
- the help topice
- the exceptionprotected void loadRelativeHelpTopic(java.lang.String relativeHelpTopic)
relativeHelpTopic
- the relative help topicprotected void loadAbsoluteHelpTopic(java.lang.String absoluteHelpTopic)
absoluteHelpTopic
- the absolute help topic namepublic void openUrl(java.lang.String url)
IHelpBrowser
openUrl
in interface IHelpBrowser
url
- the urlpublic void openHelpTopic(java.lang.String relativeHelpTopic)
IHelpBrowser
openHelpTopic
in interface IHelpBrowser
relativeHelpTopic
- the relative help topicpublic HelpBrowserHistory getHistory()
IHelpBrowser
getHistory
in interface IHelpBrowser