001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.help;
003
004/**
005 * Help browser super interface.
006 * @since 9644
007 */
008interface IHelpBrowser {
009
010    /**
011     * Replies the current URL.
012     * @return the current URL
013     */
014    String getUrl();
015
016    /**
017     * Replies the browser history.
018     * @return the browser history
019     */
020    HelpBrowserHistory getHistory();
021
022    /**
023     * Loads and displays the help information for a help topic given
024     * by a relative help topic name, i.e. "/Action/New".
025     *
026     * @param relativeHelpTopic the relative help topic
027     */
028    void openHelpTopic(String relativeHelpTopic);
029
030    /**
031     * Opens an URL and displays the content.
032     *
033     * If the URL is the locator of an absolute help topic, help content is loaded from
034     * the JOSM wiki. Otherwise, the help browser loads the page from the given URL.
035     *
036     * @param url the url
037     */
038    void openUrl(String url);
039}