Package org.eclipse.help.webapp
Class AbstractView
java.lang.Object
org.eclipse.help.webapp.AbstractView
A view which contributes a view to the help webapp
- Since:
- 3.5
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Help webapp no longer has basic view.abstract String
abstract char
getKey()
abstract String
getName()
abstract String
A user visible title for the view which will appear in the tooltipabstract String
getURL()
boolean
Used to allow for views whose loading is deferred until their contents are visibleboolean
boolean
Deprecated.Help webapp no longer has basic view.
-
Constructor Details
-
AbstractView
public AbstractView()
-
-
Method Details
-
getName
- Returns:
- a non translated name which is root name of the View and Toolbar jsp files used in this view. For example if the name is toc the help system will look for the files tocView.jsp and tocToolbar.jsp
-
getURL
- Returns:
- a URL path, relative to /help which is the location of the jsp files in the advanced presentation
-
getBasicURL
Deprecated.Help webapp no longer has basic view.- Returns:
- a URL path, relative to /help which is the location of the jsp files in the basic presentation
-
getImageURL
- Returns:
- a URL relative to /help which is the location of the 16x16 image icon which will appear in the tab
-
getKey
public abstract char getKey()- Returns:
- a character which can be used as an accesskey to navigate directly to this view, or (char)0 if no acceskey is specified
-
isDeferred
public boolean isDeferred()Used to allow for views whose loading is deferred until their contents are visible- Returns:
- true if this view has deferred loading
-
getTitle
A user visible title for the view which will appear in the tooltip- Parameters:
locale
- the locale of the client- Returns:
- the tooltip text to be used in this locale
-
isVisible
public boolean isVisible()- Returns:
- true if the view should be shown in the advanced presentation
-
isVisibleBasic
Deprecated.Help webapp no longer has basic view.- Returns:
- true if the view should be shown in the basic presentation
-