Class AbstractView

java.lang.Object
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 Details Link icon

    • AbstractView Link icon

      public AbstractView()
  • Method Details Link icon

    • getName Link icon

      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 Link icon

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

      @Deprecated public String 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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      public boolean isVisible()
      Returns:
      true if the view should be shown in the advanced presentation
    • isVisibleBasic Link icon

      @Deprecated public boolean isVisibleBasic()
      Deprecated.
      Help webapp no longer has basic view.
      Returns:
      true if the view should be shown in the basic presentation