Package com.inet.viewer
Interface NavigationView
- All Superinterfaces:
ViewerComponent
- All Known Implementing Classes:
SwingNavigationView
The navigation view is responsible for the group tree, the search view, and any other navigation tabs needed by the application. These
navigation tabs are displayed as individual tabs, that is, the user can switch between them.
The typical use of a NavigationView would be a holder for a group tree to the left of the report scroll view, however it
can be used in any other manner as well.
- Since:
- 7.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addNavigationTab
(String title, NavigationTab tab) Add a new NavigationTab to this NavigationView with a certain title.getNavigationTab
(int index) Returns the navigation tab at the specified index - the index is 0-based and is determined by when the navigation tabs were added to the navigation view.int
getNavigationTabIndex
(String tabName) Returns the NavigationTab index of the first found NavigationTab with the given name, or -1 if none is found with this name.int
Get the amount of navigation tabs in this navigation view - this is also one higher than the allowed index of any navigation tab.Returns the RenderData object of this NavigationView, that is, the source of the report databoolean
Returns whether this navigation view is set to be visible or notvoid
reload()
Reloads the data underlying this navigation view and renews the display with the new data.void
removeNavigationTab
(int index) Removes the navigation tab at the specified index and causes the navigation view to be refreshed without this navigation tab.void
setVisible
(boolean visible) Shows or hides this navigation view.void
Called when any error occurs within the navigation viewvoid
showNavigationTab
(int tabIndex) Causes the navigation tab at the given index to be selected and shown for this navigation view.Methods inherited from interface com.inet.viewer.ViewerComponent
getComponent
-
Method Details
-
showError
Called when any error occurs within the navigation view- Parameters:
th
- Exception which has occurred.- Since:
- 7.0
-
getReportData
RenderData getReportData()Returns the RenderData object of this NavigationView, that is, the source of the report data- Returns:
- The RenderData object of this NavigationView, that is, the source of the report data
- Since:
- 7.0
-
isVisible
boolean isVisible()Returns whether this navigation view is set to be visible or not- Returns:
- Whether this navigation view is set to be visible or not
- Since:
- 7.0
-
setVisible
void setVisible(boolean visible) Shows or hides this navigation view.- Parameters:
visible
- Show this navigation view or not- Since:
- 7.0
-
reload
void reload()Reloads the data underlying this navigation view and renews the display with the new data. Reload will be called whenever the ReportView is reloaded in order to prevent two different states between the ReportView and the NavigationView. It will be passed on to all navigation tabs in this navigation view.- Since:
- 7.0
-