org.docgene.help.gui.swing

Class SwingSwingEngineManager

java.lang.Object

org.docgene.help.gui.swing.AbstractSwingEngineManager

org.docgene.help.gui.swing.SwingSwingEngineManager

All Implemented Interfaces:

EngineManager

public class SwingSwingEngineManager
extends AbstractSwingEngineManager

The Swing engine manager for the Swing help viewer.

Field Summary

Fields inherited from class org.docgene.help.gui.swing.AbstractSwingEngineManager

model, rootPane, viewer, waitForRef

Constructor Summary

Constructors

Constructor and Description
SwingSwingEngineManager()

Method Summary

Modifier and Type	Method and Description
void	applyAutocomplete(Article article, java.lang.String title, boolean isDifferentArticle)
void	applyFullTextSearchLink(java.lang.String term) Fired when applying a full text search.
void	back() Perform a back action.
void	create() Create the engine manager.
java.net.URL	getPage() Return the current page.
javax.swing.JComponent	getScrollPane() Return the scroll pane.
boolean	goTo(Article article, java.lang.String anchor, boolean allowReload) Go to an anchor in a specific article.
boolean	goTo(java.net.URL url, java.lang.String anchor) Go to an anchor in a specific URL.
boolean	loadHTML(java.net.URL url) We show embedded HTML content in a JFXPanel because Swing may not render correctly HTML content by default (for example javadoc).
void	pageLoaded(java.net.URL url) Called when a page is loaded.
java.lang.String	scroll(java.lang.String desc, boolean isNewPage) Scroll to a reference on a page.
boolean	setPage(java.net.URL url) Set the current page.

Methods inherited from class org.docgene.help.gui.swing.AbstractSwingEngineManager

getContentViewer, isShowingSearchExceptions, setContentViewer, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.help.gui.swing.EngineManager

goTo

Constructor Detail

SwingSwingEngineManager

public SwingSwingEngineManager()

Method Detail

getScrollPane

public javax.swing.JComponent getScrollPane()

Return the scroll pane.

Returns:

the scroll pane

create

public void create()

Description copied from interface: EngineManager

Create the engine manager.

pageLoaded

public void pageLoaded(java.net.URL url)

Called when a page is loaded.

Parameters:

url - the page URL

back

public void back()

Perform a back action.

getPage

public java.net.URL getPage()

Return the current page.

Returns:

the current page

applyFullTextSearchLink

public void applyFullTextSearchLink(java.lang.String term)

Fired when applying a full text search.

Parameters:

term - the term to search for

applyAutocomplete

public void applyAutocomplete(Article article,
                              java.lang.String title,
                              boolean isDifferentArticle)

goTo

public boolean goTo(Article article,
                    java.lang.String anchor,
                    boolean allowReload)

Description copied from interface: EngineManager

Go to an anchor in a specific article.

Parameters:

article - the article

anchor - the anchor

allowReload - true if reloading pages is allowed

Returns:

true if the article and the anchor do exist

goTo

public boolean goTo(java.net.URL url,
                    java.lang.String anchor)

Go to an anchor in a specific URL.

Parameters:

url - the URL

anchor - the anchor

Returns:

true if reloading pages is allowed

loadHTML

public boolean loadHTML(java.net.URL url)

We show embedded HTML content in a JFXPanel because Swing may not render correctly HTML content by default (for example javadoc).

Parameters:

url - the URL

Returns:

if the html content could be loaded

setPage

public boolean setPage(java.net.URL url)

Description copied from interface: EngineManager

Set the current page.

Parameters:

url - the current page URL

Returns:

true if the URL do exist

scroll

public java.lang.String scroll(java.lang.String desc,
                               boolean isNewPage)

Description copied from interface: EngineManager

Scroll to a reference on a page.

Parameters:

desc - the reference

isNewPage - if the reference is in a new page

Returns:

the reference f it was possible to scroll, null if not