org.docgene.help.gui.swing

Interface EngineManager

All Known Implementing Classes:

AbstractSwingEngineManager, SwingJFXEngineManager, SwingSwingEngineManager

public interface EngineManager

The Engine manager interface.

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.
ContentViewer	getContentViewer() Return the content viewer.
java.net.URL	getPage() Return the current page.
javax.swing.JComponent	getScrollPane() Return the scroll pane.
default boolean	goTo(Article article, java.lang.String anchor) Go to an anchor in a specific article.
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.
void	setContentViewer(ContentViewer viewer) Set the ContentViewer
boolean	setPage(java.net.URL url) Set the current page.
void	update() Update the engine manager.

Method Detail

getContentViewer

ContentViewer getContentViewer()

Return the content viewer.

Returns:

the content viewer

back

void back()

Perform a back action.

goTo

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

Go to an anchor in a specific article.

Parameters:

article - the article

anchor - the anchor

Returns:

true if the article and the anchor do exist

goTo

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

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

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

applyFullTextSearchLink

void applyFullTextSearchLink(java.lang.String term)

Fired when applying a full text search.

Parameters:

term - the term to search for

getPage

java.net.URL getPage()

Return the current page.

Returns:

the current page

setPage

boolean setPage(java.net.URL url)

Set the current page.

Parameters:

url - the current page URL

Returns:

true if the URL do exist

create

void create()

Create the engine manager.

update

void update()

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

setContentViewer

void setContentViewer(ContentViewer viewer)

Set the ContentViewer

Parameters:

viewer - the ContentViewer.

getScrollPane

javax.swing.JComponent getScrollPane()

Return the scroll pane.

Returns:

the scroll pane

loadHTML

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

applyAutocomplete

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

pageLoaded

void pageLoaded(java.net.URL url)

Called when a page is loaded.

Parameters:

url - the page URL

scroll

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

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