org.docgene.help.gui.swing

Interface ContentViewer

All Superinterfaces:

HelpContentViewer<javax.swing.JComponent,java.awt.Window>

All Known Implementing Classes:

SwingHelpContentViewer

public interface ContentViewer
extends HelpContentViewer<javax.swing.JComponent,java.awt.Window>

The ContentViewer interface for the Swing helper viewer.

Field Summary

Fields inherited from interface org.docgene.help.HelpContentViewer

HELP_CLIENT_PROPERTY, ICON_BACKWARD, ICON_FORWARD, ICON_GLOSSARY, ICON_HOME

Method Summary

Modifier and Type	Method and Description
void	applyLink(Article article, java.net.URL url, java.lang.String anchor) Apply a link.
javax.swing.JPanel	getRootPane() Return the root pane.
javax.swing.JComponent	getScrollPane() Return the scroll pane.
void	pageLoaded(java.net.URL url) Fired when a page is loaded.
void	selectInTree(Article article) Select an article in the tree.
void	setCurrentArticle(Article article) Set the current article.
void	setCurrentTitle(java.lang.String title) Set the current title.
void	setPreviousPage(java.net.URL url, java.lang.String anchor) Set the previous page.
void	updateUI() Update the UI of the viewer.

Methods inherited from interface org.docgene.help.HelpContentViewer

createContextHelpButton, getArticlesModel, getAutoComplete, getCurrentArticle, getCurrentTitle, getHelpComponent, getHelpWindow, getHistory, getLocale, getLocalization, getStyleSheetThemes, hasStyleSheetTheme, installModel, registerContextHelp, registerContextHelpWindow, reloadPage, resetStyleSheetTheme, setArticleIcon, setClosedChapterIcon, setContextHelpIcon, setContextHelpPointerImage, setDividerLocation, setExpandedChapterIcon, setFullSearchText, setIcon, setLocale, setLocale, setSearchTextHint, setSearchTextIcon, setStyleSheetTheme, showHelpDialog, showHelpDialog, showHelpTopic

Method Detail

setCurrentArticle

void setCurrentArticle(Article article)

Set the current article.

Parameters:

article - the current article

setPreviousPage

void setPreviousPage(java.net.URL url,
                     java.lang.String anchor)

Set the previous page.

Parameters:

url - the previous page URL

anchor - the previous page anchoe( may be null)

setCurrentTitle

void setCurrentTitle(java.lang.String title)

Set the current title.

Parameters:

title - the title

getScrollPane

javax.swing.JComponent getScrollPane()

Return the scroll pane.

Returns:

the scroll pane

getRootPane

javax.swing.JPanel getRootPane()

Return the root pane.

Returns:

the root pane

pageLoaded

void pageLoaded(java.net.URL url)

Fired when a page is loaded.

Parameters:

url - the page URL

selectInTree

void selectInTree(Article article)

Select an article in the tree.

Parameters:

article - the article

applyLink

void applyLink(Article article,
               java.net.URL url,
               java.lang.String anchor)

Apply a link.

Parameters:

article - the article (may be null)

url - the URL

anchor - the anchoe (may be null)

updateUI

void updateUI()

Update the UI of the viewer.