BBJasperTabbedView

```
public class BBJasperTabbedView
```
Displays a JasperReport in a tabbed view

See Also:
[]
Since:
16.0

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjString`	`BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$` Name of STBL key whose value can be set to TRUE create a tab when hyperlink targets are set to parent, otherwise FALSE to create a tab. The default is TRUE.
`static BBjString`	`BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$` Name of STBL key whose value can be set to TRUE create a window when hyperlink targets are set to blank, otherwise FALSE to create a tab. The default is TRUE.
`static BBjString`	`CLOSE_LEFT_TABS_MENU_ITEM_NAME$="BBJVCloseLeftTabsMenuItem"` Close left tabs menu item name
`static BBjString`	`CLOSE_OTHER_TABS_MENU_ITEM_NAME$="BBJVCloseOtherTabsMenuItem"` Close other tabs menu item name
`static BBjString`	`CLOSE_RIGHT_TABS_MENU_ITEM_NAME$="BBJVCloseRightTabsMenuItem"` Close right tabs menu item name
`static BBjString`	`CLOSE_TAB_MENU_ITEM_NAME$="BBJVCloseTabMenuItem"` Close tab menu item name
`static BBjString`	`VIEWS_TAB_CONTROL_NAME$="BBJVViewsTabControl"` Views tab control name

Constructor Summary

Constructors
Constructor and Description
`BBJasperTabbedView(BBJasperViewerControl p_viewerControl!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)` Constructor Constructs a BBJasperTabbedView given a BBJasperViewerControl object, BBjWindow object, control id, control x, control y, control width, control height and fit type
`BBJasperTabbedView(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)` Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
`BBJasperTabbedView(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)` Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type

Method Summary

Methods
Modifier and Type	Method and Description
`BBJasperView`	`addView(BBJasperReport p_report!)` Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport using the report name for the window and tab titles
`BBJasperView`	`addView(BBJasperReport p_report!, BBjString p_windowTitle$, BBjString p_tabTitle$)` Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport
`BBjVector`	`addViews(BBjVector p_reports!)` Adds and returns a vector of BBJasperView objects (tab and child window) for the passed vector of BBJasperReport objects
`void`	`destroy()` destroy Destroys the tabbed view and all contained views
`HashMap`	`getAllControls()` getAllControls Returns a HashMap containg all of the controls
`BBjControl`	`getControl(BBjString p_controlName$)` getControl Returns a control given the control name
`BBjNumber`	`getFitType()` getFitType Returns the fit type of the tabbed view (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
`BBjNumber`	`getHeight()` getHeight Returns the height of the tabbed view
`BBjNumber`	`getID()` getID Returns the ID of the tabbed view
`net.sf.jasperreports.engine.JasperPrint`	`getJasperPrint()` getJasperPrint Returns the JasperPrint of the tabbed view
`BBjNumber`	`getNumViews()` geNumViews Returns the number of views
`BBjWindow`	`getParentWindow()` getParentWindow Returns the parent window that houses the tabbed view
`BBnet.sf.jasperreports.engine.JasperReport`	`getReport()` getReport Returns the report of the tabbed view
`BBjNumber`	`getTabOnParentHyperlinkTarget()` getTabOnParentHyperlinkTarget Returns whether a tab will be created when hyperlink targets are set to parent, otherwise a window will be created
`BBJasperView`	`getView()` getView Returns the current view of the tabbed view
`BBJasperView`	`getViewAt(BBjNumber p_index)` getViewAt Returns a view at a specified index
`BBJasperViewerControl`	`getViewerControl()` getViewerControl Returns the viewer control that houses the tabbed view
`BBjNumber`	`getViewIndex(BBJasperView p_view!)` Returns the view index in the view vector
`BBjVector`	`getViews()` getViews Returns all views in a vector
`BBjNumber`	`getWidth()` getWidth Returns the width of the tabbed view
`BBjNumber`	`getWindowOnBlankHyperlinkTarget()` getWindowOnBlankHyperlinkTarget Returns whether a window will be create when hyperlink targets are set to blank, otherwise a tabe will be created
`BBjNumber`	`getX()` getX Returns the X location of the tabbed view
`BBjNumber`	`getY()` getY Returns the Y location of the tabbed view
`void`	`OnCloseLeftTabs(BBjPopupSelectEvent p_event!)` Called when the close left tabs menu item is selected
`void`	`OnCloseOtherTabs(BBjPopupSelectEvent p_event!)` Called when the close other tabs menu item is selected
`void`	`OnCloseRightTabs(BBjPopupSelectEvent p_event!)` Called when the close right tabs menu item is selected
`void`	`OnCloseTab(BBjPopupSelectEvent p_event!)` Called when the close tab menu item is selected
`void`	`OnReportTabClose(BBjTabCloseEvent p_event!)` Callback method that handles a view tab being close
`void`	`OnReportTabPopup(BBjTabPopupEvent p_event!)` Callback method that handles a view tab popup request
`void`	`OnReportTabSelected(BBjTabSelectedEvent p_event!)` Callback method that handles a view tab being selected
`void`	`selectView(BBJasperView p_view!)` Selects the current view
`void`	`setLocation(BBjNumber p_x, BBjNumber p_x)` setLocation Sets the location of the tabbed view
`void`	`setReportTabSelectedCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)` setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
`void`	`setReportTabSelectedCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)` setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` setSize Sets the size of the tabbed view
`void`	`setTabOnParentHyperlinkTarget(BBjNumber p_tabOnParentHyperlinkTarget)` setTabOnParentHyperlinkTarget Sets whether a tabe will be created when hyperlink targets are set to blank, othwerwise a window will be created
`void`	`setView(BBJasperView p_view!)` Sets the current view
`void`	`setVisible(BBjNumber p_visible)` setVisible Sets the visibility of the tabbed view
`void`	`setWindowOnBlankHyperlinkTarget(BBjNumber p_windowOnBlankHyperlinkTarget)` setWindowOnBlankHyperlinkTarget Sets whether a window will be created when hyperlink targets are set to blank, othwerwise a tab will be created

Field Detail
- BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$
```
public static BBjString BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$
```
  Name of STBL key whose value can be set to TRUE create a tab when hyperlink targets are set to parent, otherwise FALSE to create a tab. The default is TRUE.
- BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$
```
public static BBjString BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$
```
  Name of STBL key whose value can be set to TRUE create a window when hyperlink targets are set to blank, otherwise FALSE to create a tab. The default is TRUE.
- CLOSE_LEFT_TABS_MENU_ITEM_NAME$="BBJVCloseLeftTabsMenuItem"
```
public static BBjString CLOSE_LEFT_TABS_MENU_ITEM_NAME$="BBJVCloseLeftTabsMenuItem"
```
  Close left tabs menu item name
- CLOSE_OTHER_TABS_MENU_ITEM_NAME$="BBJVCloseOtherTabsMenuItem"
```
public static BBjString CLOSE_OTHER_TABS_MENU_ITEM_NAME$="BBJVCloseOtherTabsMenuItem"
```
  Close other tabs menu item name
- CLOSE_RIGHT_TABS_MENU_ITEM_NAME$="BBJVCloseRightTabsMenuItem"
```
public static BBjString CLOSE_RIGHT_TABS_MENU_ITEM_NAME$="BBJVCloseRightTabsMenuItem"
```
  Close right tabs menu item name
- CLOSE_TAB_MENU_ITEM_NAME$="BBJVCloseTabMenuItem"
```
public static BBjString CLOSE_TAB_MENU_ITEM_NAME$="BBJVCloseTabMenuItem"
```
  Close tab menu item name
- VIEWS_TAB_CONTROL_NAME$="BBJVViewsTabControl"
```
public static BBjString VIEWS_TAB_CONTROL_NAME$="BBJVViewsTabControl"
```
  Views tab control name

Constructor Detail
- BBJasperTabbedView
```
public BBJasperTabbedView(BBJasperViewerControl p_viewerControl!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)
```
  Constructor Constructs a BBJasperTabbedView given a BBJasperViewerControl object, BBjWindow object, control id, control x, control y, control width, control height and fit type
  
  Parameters:
  p_viewerControl! A BBJasperViewerControl object
  p_window! A BBjWindow object which will house the tabbed view
  p_id ID for the view
  p_x X location for the view
  p_y Y location for the view
  p_width Width of the view
  p_height Height of the view
  p_fitType Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE
- BBJasperTabbedView
```
public BBJasperTabbedView(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)
```
  Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
  
  Parameters:
  p_report! A BBJasperReport object
  p_window! A BBjWindow object which will house the tabbed view
  p_id ID for the view
  p_x X location for the view
  p_y Y location for the view
  p_width Width of the view
  p_height Height of the view
  p_fitType Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE
- BBJasperTabbedView
```
public BBJasperTabbedView(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)
```
  Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
  
  Parameters:
  p_reports! BBjVector containing BBJasperReport objects
  p_window! A BBjWindow object which will house the tabbed view
  p_id ID for the view
  p_x X location for the view
  p_y Y location for the view
  p_width Width of the view
  p_height Height of the view
  p_fitType Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

- Method Detail
  - addView
```
public BBJasperView addView(BBJasperReport p_report!)
```
    Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport using the report name for the window and tab titles
    
    Parameters:
    p_report! Specifies the BBJasperReport to add a view for
    Returns:
    The added BBJasperView object
  - addView
```
public BBJasperView addView(BBJasperReport p_report!, BBjString p_windowTitle$, BBjString p_tabTitle$)
```
    Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport
    
    Parameters:
    p_report! Specifies the BBJasperReport to add a view for
    p_windowTitle$ Specifies the window title for the view
    p_tabTitle$ Specifies the tab title for the view
    Returns:
    The added BBJasperView object
  - addViews
```
public BBjVector addViews(BBjVector p_reports!)
```
    Adds and returns a vector of BBJasperView objects (tab and child window) for the passed vector of BBJasperReport objects
    
    Parameters:
    p_reports! BBjVector of BBJasperReport object to add views for
    Returns:
    BBjVector of the added BBJasperView objects
  - destroy
```
public void destroy()
```
    destroy Destroys the tabbed view and all contained views
  - getAllControls
```
public HashMap getAllControls()
```
    getAllControls Returns a HashMap containg all of the controls
    
    Returns:
    HashMap containg all of the controls by name
  - getControl
```
public BBjControl getControl(BBjString p_controlName$)
```
    getControl Returns a control given the control name
    
    Parameters:
    p_controlName$ Name of the BBjControl object to obtain
    Returns:
    BBjControl object associated with the passed in name
  - getFitType
```
public BBjNumber getFitType()
```
    getFitType Returns the fit type of the tabbed view (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
    
    Returns:
    Fit type of the tabbed view
  - getHeight
```
public BBjNumber getHeight()
```
    getHeight Returns the height of the tabbed view
    
    Returns:
    Height of the tabbed view
  - getID
```
public BBjNumber getID()
```
    getID Returns the ID of the tabbed view
    
    Returns:
    ID of the tabbed view
  - getJasperPrint
```
public net.sf.jasperreports.engine.JasperPrint getJasperPrint()
```
    getJasperPrint Returns the JasperPrint of the tabbed view
    
    Returns:
    JasperPrint object
  - getNumViews
```
public BBjNumber getNumViews()
```
    geNumViews Returns the number of views
    
    Returns:
    BBjNumber of views
  - getParentWindow
```
public BBjWindow getParentWindow()
```
    getParentWindow Returns the parent window that houses the tabbed view
    
    Returns:
    BBjWindow object
  - getReport
```
public BBnet.sf.jasperreports.engine.JasperReport getReport()
```
    getReport Returns the report of the tabbed view
    
    Returns:
    BBJasperReport object
  - getTabOnParentHyperlinkTarget
```
public BBjNumber getTabOnParentHyperlinkTarget()
```
    getTabOnParentHyperlinkTarget Returns whether a tab will be created when hyperlink targets are set to parent, otherwise a window will be created
    
    Returns:
    Returns TRUE if a tab is to be created when hyperlink targets are set to blank, otherwise FALSE is returned to create a window
  - getView
```
public BBJasperView getView()
```
    getView Returns the current view of the tabbed view
    
    Returns:
    BBJasperView object that is the current view
  - getViewAt
```
public BBJasperView getViewAt(BBjNumber p_index)
```
    getViewAt Returns a view at a specified index
    
    Parameters:
    p_index Index of view to return
    Returns:
    BBJasperView object that is the specified index
  - getViewerControl
```
public BBJasperViewerControl getViewerControl()
```
    getViewerControl Returns the viewer control that houses the tabbed view
    
    Returns:
    BBJasperViewerControl object
  - getViewIndex
```
public BBjNumber getViewIndex(BBJasperView p_view!)
```
    Returns the view index in the view vector
    
    Parameters:
    p_view! BBJasperView which specifies the view to find the index for
  - getViews
```
public BBjVector getViews()
```
    getViews Returns all views in a vector
    
    Returns:
    BBjVector containing the BBJasperView objects
  - getWidth
```
public BBjNumber getWidth()
```
    getWidth Returns the width of the tabbed view
    
    Returns:
    Width of the tabbed view
  - getWindowOnBlankHyperlinkTarget
```
public BBjNumber getWindowOnBlankHyperlinkTarget()
```
    getWindowOnBlankHyperlinkTarget Returns whether a window will be create when hyperlink targets are set to blank, otherwise a tabe will be created
    
    Returns:
    Returns TRUE if a window is to be created when hyperlink targets are set to blank, otherwise FALSE is returned to create a tab
  - getX
```
public BBjNumber getX()
```
    getX Returns the X location of the tabbed view
    
    Returns:
    X location of the tabbed view
  - getY
```
public BBjNumber getY()
```
    getY Returns the Y location of the tabbed view
    
    Returns:
    Y location of the tabbed view
  - OnCloseLeftTabs
```
public void OnCloseLeftTabs(BBjPopupSelectEvent p_event!)
```
    Called when the close left tabs menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnCloseOtherTabs
```
public void OnCloseOtherTabs(BBjPopupSelectEvent p_event!)
```
    Called when the close other tabs menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnCloseRightTabs
```
public void OnCloseRightTabs(BBjPopupSelectEvent p_event!)
```
    Called when the close right tabs menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnCloseTab
```
public void OnCloseTab(BBjPopupSelectEvent p_event!)
```
    Called when the close tab menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnReportTabClose
```
public void OnReportTabClose(BBjTabCloseEvent p_event!)
```
    Callback method that handles a view tab being close
    
    Parameters:
    p_event! BBjTabCloseEvent which contains tab close information
  - OnReportTabPopup
```
public void OnReportTabPopup(BBjTabPopupEvent p_event!)
```
    Callback method that handles a view tab popup request
    
    Parameters:
    p_event! BBjTabPopupEvent which contains tab popup information
  - OnReportTabSelected
```
public void OnReportTabSelected(BBjTabSelectedEvent p_event!)
```
    Callback method that handles a view tab being selected
    
    Parameters:
    p_event! BBjTabSelectedEvent which contains tab select information
  - selectView
```
public void selectView(BBJasperView p_view!)
```
    Selects the current view
    
    Parameters:
    p_view! BBJasperView which specifies the view to select
  - setLocation
```
public void setLocation(BBjNumber p_x, BBjNumber p_x)
```
    setLocation Sets the location of the tabbed view
    
    Parameters:
    p_x X location of the tabbed view
    p_y Y location of the tabbed view
  - setReportTabSelectedCallback
```
public void setReportTabSelectedCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)
```
    setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
    
    Parameters:
    p_eventName$ Event to specify during the callback
    p_callbackRoutine! Callback routine to call
  - setReportTabSelectedCallback
```
public void setReportTabSelectedCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
```
    setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
    
    Parameters:
    p_eventName$ Event to specify during the callback
    p_callbackObject! Callback object to call
    p_callbackRoutine! Callback routine to call
  - setSize
```
public void setSize(BBjNumber p_width, BBjNumber p_height)
```
    setSize Sets the size of the tabbed view
    
    Parameters:
    p_width Width of the tabbed view
    p_height Height of the tabbed view
  - setTabOnParentHyperlinkTarget
```
public void setTabOnParentHyperlinkTarget(BBjNumber p_tabOnParentHyperlinkTarget)
```
    setTabOnParentHyperlinkTarget Sets whether a tabe will be created when hyperlink targets are set to blank, othwerwise a window will be created
    
    Parameters:
    Set to TRUE if a tabe is to be created when hyperlink targets are set to blank, otherwise set to FALSE to create a window
  - setView
```
public void setView(BBJasperView p_view!)
```
    Sets the current view
    
    Parameters:
    p_view! BBJasperView which specifies the current view
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    setVisible Sets the visibility of the tabbed view
    
    Parameters:
    p_visible Specify TRUE (1) to make the tabbed view visible, otherwise FALSE (0)
  - setWindowOnBlankHyperlinkTarget
```
public void setWindowOnBlankHyperlinkTarget(BBjNumber p_windowOnBlankHyperlinkTarget)
```
    setWindowOnBlankHyperlinkTarget Sets whether a window will be created when hyperlink targets are set to blank, othwerwise a tab will be created
    
    Parameters:
    Set to TRUE if a window is to be created when hyperlink targets are set to blank, otherwise set to FALSE to create a tab

Class BBJasperTabbedView

Field Summary

Constructor Summary

Method Summary

Field Detail

BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$

BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$

CLOSE_LEFT_TABS_MENU_ITEM_NAME$="BBJVCloseLeftTabsMenuItem"

CLOSE_OTHER_TABS_MENU_ITEM_NAME$="BBJVCloseOtherTabsMenuItem"

CLOSE_RIGHT_TABS_MENU_ITEM_NAME$="BBJVCloseRightTabsMenuItem"

CLOSE_TAB_MENU_ITEM_NAME$="BBJVCloseTabMenuItem"

VIEWS_TAB_CONTROL_NAME$="BBJVViewsTabControl"

Constructor Detail

BBJasperTabbedView

BBJasperTabbedView

BBJasperTabbedView

Method Detail

addView

addView

addViews

destroy

getAllControls

getControl

getFitType

getHeight

getID

getJasperPrint

getNumViews

getParentWindow

getReport

getTabOnParentHyperlinkTarget

getView

getViewAt

getViewerControl

getViewIndex

getViews

getWidth

getWindowOnBlankHyperlinkTarget

getX

getY

OnCloseLeftTabs

OnCloseOtherTabs

OnCloseRightTabs

OnCloseTab

OnReportTabClose

OnReportTabPopup

OnReportTabSelected

selectView

setLocation

setReportTabSelectedCallback

setReportTabSelectedCallback

setSize

setTabOnParentHyperlinkTarget

setView

setVisible

setWindowOnBlankHyperlinkTarget