Package org.eclipse.help.webapp

Class AbstractView

  • public abstract class AbstractView
extends java.lang.Object
    A view which contributes a view to the help webapp
    Since:
    3.5

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractView()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getBasicURL()
      Deprecated.
      Help webapp no longer has basic view.
      abstract java.lang.String getImageURL()  
      abstract char getKey()  
      abstract java.lang.String getName()  
      abstract java.lang.String getTitle​(java.util.Locale locale)
      A user visible title for the view which will appear in the tooltip
      abstract java.lang.String getURL()  
      boolean isDeferred()
      Used to allow for views whose loading is deferred until their contents are visible
      boolean isVisible()  
      boolean isVisibleBasic()
      Deprecated.
      Help webapp no longer has basic view.

      • 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 java.lang.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 java.lang.String getURL()
        Returns:
        a URL path, relative to /help which is the location of the jsp files in the advanced presentation

      • getBasicURL

        @Deprecated
public java.lang.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

        public abstract java.lang.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 java.lang.String getTitle​(java.util.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

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