BBJasperTabbedView

java.lang.Object
- BBJasper.BBJasperTabbedView

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

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.
`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.
`static BBjString`	`CLOSE_LEFT_TABS_MENU_ITEM_NAME$` Close left tabs menu item name
`static BBjString`	`CLOSE_OTHER_TABS_MENU_ITEM_NAME$` Close other tabs menu item name
`static BBjString`	`CLOSE_RIGHT_TABS_MENU_ITEM_NAME$` Close right tabs menu item name
`static BBjString`	`CLOSE_TAB_MENU_ITEM_NAME$` Close tab menu item name
`static BBjString`	`VIEWS_TAB_CONTROL_NAME$` Views tab control name

Constructor Summary

Constructors
Constructor and Description
`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)` Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
`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)` Constructs a BBJasperTabbedView given a BBJasperViewerControl 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)` Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BBJasperView`	`addView(BBJasperReport p_report!)` BBJasperReport using the report name for the window and tab titles
`BBJasperView`	`addView(BBJasperReport p_report!, BBjString p_windowTitle$, BBjString p_tabTitle$)` BBJasperReport
`BBjVector`	`addViews(BBjVector p_reports!)` BBJasperReport objects
`void`	`destroy()` Destroys the tabbed view and all contained views
`HashMap`	`getAllControls()` Returns a HashMap containg all of the controls
`BBjControl`	`getControl(BBjString p_controlName$)` Returns a control given the control name
`BBjNumber`	`getFitType()` Returns the fit type of the tabbed view (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
`BBjNumber`	`getHeight()` Returns the height of the tabbed view
`BBjNumber`	`getID()` Returns the ID of the tabbed view
`JasperPrint`	`getJasperPrint()` Returns the JasperPrint of the tabbed view
`BBjNumber`	`getNumViews()` Returns the number of views
`BBjWindow`	`getParentWindow()` Returns the parent window that houses the tabbed view
`BBJasperReport`	`getReport()` Returns the report of the tabbed view
`BBjNumber`	`getTabOnParentHyperlinkTarget()` Returns whether a tab will be created when hyperlink targets are set to parent, otherwise a window will be created
`BBJasperView`	`getView()` Returns the current view of the tabbed view
`BBJasperView`	`getViewAt(BBjNumber p_index)` Returns a view at a specified index
`BBJasperViewerControl`	`getViewerControl()` Returns the viewer control that houses the tabbed view
`BBjNumber`	`getViewIndex(BBJasperView p_view!)`
`BBjVector`	`getViews()` Returns all views in a vector
`BBjNumber`	`getWidth()` Returns the width of the tabbed view
`BBjNumber`	`getWindowOnBlankHyperlinkTarget()` Returns whether a window will be create when hyperlink targets are set to blank, otherwise a tabe will be created
`BBjNumber`	`getX()` Returns the X location of the tabbed view
`BBjNumber`	`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!)`
`void`	`OnReportTabPopup(BBjTabPopupEvent p_event!)`
`void`	`OnReportTabSelected(BBjTabSelectedEvent p_event!)`
`void`	`selectView(BBJasperView p_view!)`
`void`	`setLocation(BBjNumber p_x, BBjNumber p_x)` Sets the location of the tabbed view
`void`	`setReportTabSelectedCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)` Sets a callback routine to call when a Report Tab is selected
`void`	`setReportTabSelectedCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)` Sets a callback routine to call when a Report Tab is selected
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` Sets the size of the tabbed view
`void`	`setTabOnParentHyperlinkTarget(BBjNumber p_tabOnParentHyperlinkTarget)` 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!)`
`void`	`setVisible(BBjNumber p_visible)` Sets the visibility of the tabbed view
`void`	`setWindowOnBlankHyperlinkTarget(BBjNumber p_windowOnBlankHyperlinkTarget)` Sets whether a window will be created when hyperlink targets are set to blank, othwerwise a tab will be created

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VIEWS_TAB_CONTROL_NAME$
```
public static BBjString VIEWS_TAB_CONTROL_NAME$
```
    Views tab control name
  - 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.
  - 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.
  - CLOSE_TAB_MENU_ITEM_NAME$
```
public static BBjString CLOSE_TAB_MENU_ITEM_NAME$
```
    Close tab menu item name
  - CLOSE_OTHER_TABS_MENU_ITEM_NAME$
```
public static BBjString CLOSE_OTHER_TABS_MENU_ITEM_NAME$
```
    Close other tabs menu item name
  - CLOSE_LEFT_TABS_MENU_ITEM_NAME$
```
public static BBjString CLOSE_LEFT_TABS_MENU_ITEM_NAME$
```
    Close left tabs menu item name
  - CLOSE_RIGHT_TABS_MENU_ITEM_NAME$
```
public static BBjString CLOSE_RIGHT_TABS_MENU_ITEM_NAME$
```
    Close right tabs menu item 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)
```
    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)
```
    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)
```
    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
  - addViews
```
public BBjVector addViews(BBjVector p_reports!)
```
    BBJasperReport objects
    
    Parameters:
    
    p_reports! - BBjVector of BBJasperReport object to add views for
    
    Returns:
    
    BBjVector of the added BBJasperView objects
  - addView
```
public BBJasperView addView(BBJasperReport p_report!)
```
    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$)
```
    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
  - OnReportTabSelected
```
public void OnReportTabSelected(BBjTabSelectedEvent p_event!)
```
    Parameters:
    
    p_event! - BBjTabSelectedEvent which contains tab select information
  - setReportTabSelectedCallback
```
public void setReportTabSelectedCallback(BBjString p_eventName$,
BBjString p_callbackRoutine!)
```
    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!)
```
    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
  - OnReportTabClose
```
public void OnReportTabClose(BBjTabCloseEvent p_event!)
```
    Parameters:
    
    p_event! - BBjTabCloseEvent which contains tab close information
  - OnReportTabPopup
```
public void OnReportTabPopup(BBjTabPopupEvent p_event!)
```
    Parameters:
    
    p_event! - BBjTabPopupEvent which contains tab popup 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
  - 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
  - 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
  - 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
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Sets the visibility of the tabbed view
    
    Parameters:
    
    p_visible - Specify TRUE (1) to make the tabbed view visible, otherwise FALSE (0)
  - setSize
```
public void setSize(BBjNumber p_width,
BBjNumber p_height)
```
    Sets the size of the tabbed view
    
    Parameters:
    
    p_width - Width of the tabbed view
    
    p_height - Height of the tabbed view
  - setLocation
```
public void setLocation(BBjNumber p_x,
BBjNumber p_x)
```
    Sets the location of the tabbed view
    
    Parameters:
    
    p_x - X location of the tabbed view
    
    p_y - Y location of the tabbed view
  - setView
```
public void setView(BBJasperView p_view!)
```
    Parameters:
    
    p_view! - BBJasperView which specifies the current view
  - selectView
```
public void selectView(BBJasperView p_view!)
```
    Parameters:
    
    p_view! - BBJasperView which specifies the view to select
  - getViewIndex
```
public BBjNumber getViewIndex(BBJasperView p_view!)
```
    Parameters:
    
    p_view! - BBJasperView which specifies the view to find the index for
  - getParentWindow
```
public BBjWindow getParentWindow()
```
    Returns the parent window that houses the tabbed view
    
    Returns:
    
    BBjWindow object
  - getID
```
public BBjNumber getID()
```
    Returns the ID of the tabbed view
    
    Returns:
    
    ID of the tabbed view
  - getX
```
public BBjNumber getX()
```
    Returns the X location of the tabbed view
    
    Returns:
    
    X location of the tabbed view
  - getY
```
public BBjNumber getY()
```
    Returns the Y location of the tabbed view
    
    Returns:
    
    Y location of the tabbed view
  - getWidth
```
public BBjNumber getWidth()
```
    Returns the width of the tabbed view
    
    Returns:
    
    Width of the tabbed view
  - getHeight
```
public BBjNumber getHeight()
```
    Returns the height of the tabbed view
    
    Returns:
    
    Height of the tabbed view
  - getFitType
```
public BBjNumber 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
  - getViewerControl
```
public BBJasperViewerControl getViewerControl()
```
    Returns the viewer control that houses the tabbed view
    
    Returns:
    
    BBJasperViewerControl object
  - getReport
```
public BBJasperReport getReport()
```
    Returns the report of the tabbed view
    
    Returns:
    
    BBJasperReport object
  - getJasperPrint
```
public JasperPrint getJasperPrint()
```
    Returns the JasperPrint of the tabbed view
    
    Returns:
    
    JasperPrint object
  - getView
```
public BBJasperView getView()
```
    Returns the current view of the tabbed view
    
    Returns:
    
    BBJasperView object that is the current view
  - getViewAt
```
public BBJasperView getViewAt(BBjNumber p_index)
```
    Returns a view at a specified index
    
    Parameters:
    
    p_index - Index of view to return
    
    Returns:
    
    BBJasperView object that is the specified index
  - getViews
```
public BBjVector getViews()
```
    Returns all views in a vector
    
    Returns:
    
    BBjVector containing the BBJasperView objects
  - getNumViews
```
public BBjNumber getNumViews()
```
    Returns the number of views
    
    Returns:
    
    BBjNumber of views
  - getControl
```
public BBjControl getControl(BBjString p_controlName$)
```
    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
  - getAllControls
```
public HashMap getAllControls()
```
    Returns a HashMap containg all of the controls
    
    Returns:
    
    HashMap containg all of the controls by name
  - getWindowOnBlankHyperlinkTarget
```
public BBjNumber 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
  - getTabOnParentHyperlinkTarget
```
public BBjNumber 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
  - setWindowOnBlankHyperlinkTarget
```
public void setWindowOnBlankHyperlinkTarget(BBjNumber p_windowOnBlankHyperlinkTarget)
```
    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
  - setTabOnParentHyperlinkTarget
```
public void setTabOnParentHyperlinkTarget(BBjNumber p_tabOnParentHyperlinkTarget)
```
    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
  - destroy
```
public void destroy()
```
    Destroys the tabbed view and all contained views

Class BBJasperTabbedView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VIEWS_TAB_CONTROL_NAME$

BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$

BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$

CLOSE_TAB_MENU_ITEM_NAME$

CLOSE_OTHER_TABS_MENU_ITEM_NAME$

CLOSE_LEFT_TABS_MENU_ITEM_NAME$

CLOSE_RIGHT_TABS_MENU_ITEM_NAME$

Constructor Detail

BBJasperTabbedView

BBJasperTabbedView

BBJasperTabbedView

Method Detail

addViews

addView

addView

OnReportTabSelected

setReportTabSelectedCallback

setReportTabSelectedCallback

OnReportTabClose

OnReportTabPopup

OnCloseTab

OnCloseOtherTabs

OnCloseLeftTabs

OnCloseRightTabs

setVisible

setSize

setLocation

setView

selectView

getViewIndex

getParentWindow

getID

getX

getY

getWidth

getHeight

getFitType

getViewerControl

getReport

getJasperPrint

getView

getViewAt

getViews

getNumViews

getControl

getAllControls

getWindowOnBlankHyperlinkTarget

getTabOnParentHyperlinkTarget

setWindowOnBlankHyperlinkTarget

setTabOnParentHyperlinkTarget

destroy