public class SwingNavigationView extends javax.swing.JTabbedPane implements NavigationView
Modifier and Type | Method and Description |
---|---|
void |
addNavigationTab(java.lang.String title,
NavigationTab tab)
Add a new NavigationTab to this NavigationView with a certain title.
|
java.awt.Component |
getComponent()
All public graphical components of the viewer must implement this method, which
returns the actual AWT component so that it can be added to containers, etc.
For example, if you have a "ReportViewer" and would like to add it to your own JFrame, simply call: myFrame.add(viewer.getComponent()) |
NavigationTab |
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(java.lang.String tab_group_tree)
Returns the NavigationTab index of the first found NavigationTab with the given name, or -1 if none is found with this name.
|
int |
getNavigationTabsCount()
Get the amount of navigation tabs in this navigation view - this is also one higher than the allowed index of any navigation tab.
|
RenderData |
getReportData()
Returns the RenderData object of this NavigationView, that is, the source of the report data
|
boolean |
isVisible()
Returns whether this navigation view is set to be visible or not
|
void |
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 |
showError(java.lang.Throwable th)
Called when any error occurs within the navigation view
|
void |
showNavigationTab(int tabIndex)
Causes the navigation tab at the given index to be selected and shown for
this navigation view.
|
public void reload()
reload
in interface NavigationView
public void showError(java.lang.Throwable th)
showError
in interface NavigationView
th
- Exception which has occurred.public RenderData getReportData()
getReportData
in interface NavigationView
public void addNavigationTab(java.lang.String title, NavigationTab tab)
addNavigationTab
in interface NavigationView
title
- Title the navigation tab is to havetab
- NavigationTab to add to the navigation view.public NavigationTab getNavigationTab(int index)
getNavigationTab
in interface NavigationView
index
- Index of NavigationTab to return, 0-basedpublic void removeNavigationTab(int index)
removeNavigationTab
in interface NavigationView
index
- Index of navigation tab to removepublic int getNavigationTabsCount()
int count = getNavigationTabsCount();
for (int i=0; i < count; i++) {
NavigationTab tab = getNavigationTab(i);
...
}
getNavigationTabsCount
in interface NavigationView
public boolean isVisible()
isVisible
in interface NavigationView
isVisible
in class java.awt.Component
public void setVisible(boolean visible)
setVisible
in interface NavigationView
setVisible
in class javax.swing.JComponent
visible
- Show this navigation view or notpublic java.awt.Component getComponent()
myFrame.add(viewer.getComponent())
getComponent
in interface ViewerComponent
public int getNavigationTabIndex(java.lang.String tab_group_tree)
getNavigationTabIndex
in interface NavigationView
tab_group_tree
- Name of NavigationTab for which the index is to be returned.GroupView.TAB_GROUP_TREE
,
SearchView.TAB_SEARCH
public void showNavigationTab(int tabIndex)
showNavigationTab
in interface NavigationView
tabIndex
- Index of navigation tab to select and display.Copyright © 1999-2024 by i-net software GmbH