Eclipse Platform
Release 3.6

org.eclipse.help.webapp
Class AbstractView

java.lang.Object
  extended by org.eclipse.help.webapp.AbstractView

public abstract class AbstractView
extends Object

A view which contributes a view to the help webapp

Since:
3.5

Constructor Summary
AbstractView()
           
 
Method Summary
 String getBasicURL()
           
abstract  String getImageURL()
           
abstract  char getKey()
           
abstract  String getName()
           
abstract  String getTitle(Locale locale)
          A user visible title for the view which will appear in the tooltip
abstract  String getURL()
           
 boolean isDeferred()
          Used to allow for views whose loading is deferred until their contents are visible
 boolean isVisible()
           
 boolean isVisibleBasic()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractView

public AbstractView()
Method Detail

getName

public abstract String 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

public abstract String getURL()
Returns:
a URL path, relative to /help which is the location of the jsp files in the advanced presentation

getBasicURL

public String getBasicURL()
Returns:
a URL path, relative to /help which is the location of the jsp files in the basic presentation

getImageURL

public abstract String 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

public abstract String getTitle(Locale locale)
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

public boolean isVisibleBasic()
Returns:
true if the view should be shown in the basic presentation

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.