Interface NavigationTab

  • All Superinterfaces:
    ViewerComponent

    public interface NavigationTab
    extends ViewerComponent
    A single navigation tab which can be added to the navigation view of the viewer using addNavigationTab. A navigation tab simply needs to implement these methods, and could be any number of things, like a group tree, a search view, an index view, a bookmark view, etc.
    Since:
    7.0
    See Also:
    NavigationView.addNavigationTab(String, NavigationTab)
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Returns the name given to this NavigationTab, or null if this NavigationTabnone has no name.
      RenderData getReportData()
      Returns the RenderData object of this NavigationTab, that is, the source of the report data
      void init​(RenderData renderData)
      Initializes this navigation tab with the RenderData object needed for the report information
      void reload()
      Reloads the data underlying this navigation tab and renews the display with the new data.
      void showError​(java.lang.Throwable th)
      An error has occurred, deal with it.
    • Method Detail

      • showError

        void showError​(java.lang.Throwable th)
        An error has occurred, deal with it. A typical implementation would pass this error on up to the NavigationView.
        Parameters:
        th - Exception which has occurred.
        Since:
        7.0
        See Also:
        NavigationView.showError(Throwable)
      • getReportData

        RenderData getReportData()
        Returns the RenderData object of this NavigationTab, that is, the source of the report data
        Returns:
        The RenderData object of this NavigationTab, that is, the source of the report data
        Since:
        7.0
      • init

        void init​(RenderData renderData)
        Initializes this navigation tab with the RenderData object needed for the report information
        Parameters:
        renderData - RenderData object
        Since:
        7.0
      • reload

        void reload()
        Reloads the data underlying this navigation tab and renews the display with the new data.
        Since:
        7.0
      • getName

        java.lang.String getName()
        Returns the name given to this NavigationTab, or null if this NavigationTabnone has no name.
        Returns:
        Name given to this NavigationTab
        Since:
        7.0