org.docgene.help.gui.swing

Class SwingJFXEngineManager

java.lang.Object

org.docgene.help.gui.swing.AbstractSwingEngineManager

org.docgene.help.gui.swing.SwingJFXEngineManager

All Implemented Interfaces:

EngineManager

public class SwingJFXEngineManager
extends AbstractSwingEngineManager

The JavaFX 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
SwingJFXEngineManager()

Method Summary

Modifier and Type	Method and Description
void	applyAutocomplete(Article article, java.lang.String title, boolean isDifferentArticle)
void	applyFullTextSearchLink(java.lang.String term) Do nothing.
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	invokeBlocking(java.lang.Runnable runnable)
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) Follow a hyperlink
void	update() Update the engine manager.

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

setContentViewer

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

SwingJFXEngineManager

public SwingJFXEngineManager()

Method Detail

getScrollPane

public javax.swing.JComponent getScrollPane()

Return the scroll pane.

Returns:

the scroll pane

back

public void back()

Perform a back action.

applyFullTextSearchLink

public void applyFullTextSearchLink(java.lang.String term)

Do nothing.

Parameters:

term - the term to search for

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)

Follow a hyperlink

Parameters:

url - the URL

Returns:

true if the URL do exist

pageLoaded

public void pageLoaded(java.net.URL url)

Called when a page is loaded.

Parameters:

url - the page URL

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

getPage

public java.net.URL getPage()

Description copied from interface: EngineManager

Return the current page.

Returns:

the current page

create

public void create()

Description copied from interface: EngineManager

Create the engine manager.

invokeBlocking

public boolean invokeBlocking(java.lang.Runnable runnable)

update

public void update()

Description copied from interface: EngineManager

Update the engine manager. Typically you have to call this method if you changed the model with an existing engine manager.

Specified by:

update in interface EngineManager

Overrides:

update in class AbstractSwingEngineManager

applyAutocomplete

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

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