com.eteks.sweethome3d.viewcontroller
Class HelpController

java.lang.Object
  com.eteks.sweethome3d.viewcontroller.HelpController

All Implemented Interfaces:

Controller

public class HelpController
extends Object
implements Controller

A MVC controller for Sweet Home 3D help view.

Author:

Emmanuel Puybaret

Nested Class Summary

static class

HelpController.Property The properties that may be edited by the view associated to this controller.

Constructor Summary

HelpController(UserPreferences preferences, ViewFactory viewFactory)

Method Summary

void	addPropertyChangeListener(HelpController.Property property, PropertyChangeListener listener) Adds the property change listener in parameter to this controller.
void	displayView() Displays the help view controlled by this controller.
URL	getBrowserPage() Returns the browser page.
URL	getHelpPage() Returns the current page.
HelpView	getView() Returns the view associated with this controller.
boolean	isNextPageEnabled() Returns whether a next page is available or not.
boolean	isPreviousPageEnabled() Returns whether a previous page is available or not.
void	removePropertyChangeListener(HelpController.Property property, PropertyChangeListener listener) Removes the property change listener in parameter from this controller.
void	search(String searchedText) Searches searchedText in help documents and displays the result.
List<com.eteks.sweethome3d.viewcontroller.HelpController.HelpDocument>	searchInHelpDocuments(URL helpIndex, String[] searchedWords) Searches searchedWords in help documents and returns the list of matching documents sorted from the most relevant to the least relevant.
void	showNext() Controls the display of next page.
void	showPage(URL page) Controls the display of the given page.
void	showPrevious() Controls the display of previous page.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpController

public HelpController(UserPreferences preferences,
                      ViewFactory viewFactory)

Method Detail

getView

public HelpView getView()

Returns the view associated with this controller.

Specified by:

getView in interface Controller

displayView

public void displayView()

Displays the help view controlled by this controller.

addPropertyChangeListener

public void addPropertyChangeListener(HelpController.Property property,
                                      PropertyChangeListener listener)

Adds the property change listener in parameter to this controller.

removePropertyChangeListener

public void removePropertyChangeListener(HelpController.Property property,
                                         PropertyChangeListener listener)

Removes the property change listener in parameter from this controller.

getHelpPage

public URL getHelpPage()

Returns the current page.

getBrowserPage

public URL getBrowserPage()

Returns the browser page.

isPreviousPageEnabled

public boolean isPreviousPageEnabled()

Returns whether a previous page is available or not.

isNextPageEnabled

public boolean isNextPageEnabled()

Returns whether a next page is available or not.

showPrevious

public void showPrevious()

Controls the display of previous page.

showNext

public void showNext()

Controls the display of next page.

showPage

public void showPage(URL page)

Controls the display of the given page.

search

public void search(String searchedText)

Searches searchedText in help documents and displays the result.

searchInHelpDocuments

public List<com.eteks.sweethome3d.viewcontroller.HelpController.HelpDocument> searchInHelpDocuments(URL helpIndex,
                                                                                                    String[] searchedWords)

Searches searchedWords in help documents and returns the list of matching documents sorted from the most relevant to the least relevant. This method uses some Swing classes for their HTML parsing capabilities and not to create components.