JasperViewerWidget

java.lang.Object
- Dashboard.BaseWidget
- - Dashboard.JasperViewerWidget

All Implemented Interfaces:

RefreshableWidget, Widget
```
public class JasperViewerWidget
extends BaseWidget
implements RefreshableWidget
```
A Dashboard Utility Widget that displays JasperReport where the user can view, perform drill downs, print and save reports to disk in various formats

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjString`	`ACTUAL_SIZE_MENU_ITEM_NAME$` Actual size menu item name
`BBjNumber`	`ActualSize` Actual size
`static BBjString`	`CONTROL_CHILD_WINDOW_NAME$` Viewer control child window name
`static BBjString`	`CREATE_IMAGE_TOOL_BUTTON_NAME$` Create imaage tool button name
`static BBjString`	`CUSTOM_PAGE_MENU_ITEM_NAME$` Custom page menu item name
`static BBjString`	`CUSTOM_ZOOM_MENU_ITEM_NAME$` Custom zoom menu item name
`BBjNumber`	`DefaultSaveContributor` Contributor that will be used by default on a save
`BBjString`	`DefaultSaveFile!` File that will be used by default on a save
`BBjString`	`DefaultSaveFolder!` Folder that will be used by default on a save
`static BBjString`	`EMAIL_MENU_ITEM_NAME$` Email menu item name
`static BBjString`	`EMAIL_TOOL_BUTTON_NAME$` Email tool button name
`static BBjString`	`FILE_SAVE_NAME$` File save name
`static BBjString`	`FIND_MENU_ITEM_NAME$` Find menu item name
`static BBjString`	`FIND_NEXT_MENU_ITEM_NAME$` Find next menu item name
`static BBjString`	`FIND_PREVIOUS_MENU_ITEM_NAME$` Find previous menu item name
`static BBjString`	`FIND_TOOL_BUTTON_NAME$` Find tool button name
`static BBjString`	`FIRST_PAGE_MENU_ITEM_NAME$` First page menu item name
`static BBjString`	`FIRST_PAGE_TOOL_BUTTON_NAME$` First page tool button name
`static BBjString`	`FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$` Fit actual size tool button name
`static BBjString`	`FIT_PAGE_MENU_ITEM_NAME$` Fit page menu item name
`static BBjString`	`FIT_PAGE_TOOL_BUTTON_NAME$` Fit page tool button name
`static BBjString`	`FIT_WIDTH_MENU_ITEM_NAME$` Fit width menu item name
`static BBjString`	`FIT_WIDTH_TOOL_BUTTON_NAME$` Fit width tool button name
`BBjNumber`	`FitPage` Fit page
`BBjNumber`	`FitWidth` Fit width
`static BBjString`	`GOOGLE_DOC_SAVE_NAME$` Google Doc save notify name
`BBjString`	`GoogleDefaultDocument!` Document that will be used by default on a google doc save
`BBjString`	`GoogleDefaultFolder!` Folder that will be used by default on a google doc save
`BBjString`	`GoogleDefaultType!` Type that will be used by default on a google doc save
`BBjNumber`	`Height` Height
`static BBjString`	`LAST_PAGE_MENU_ITEM_NAME$` Last page menu item name
`static BBjString`	`LAST_PAGE_TOOL_BUTTON_NAME$` Last page tool button name
`static BBjString`	`NEXT_PAGE_MENU_ITEM_NAME$` Next page menu item name
`static BBjString`	`NEXT_PAGE_TOOL_BUTTON_NAME$` Next page tool button name
`static BBjNumber`	`ON_FILE_SAVE_NOTIFY` File save notify event
`static BBjNumber`	`ON_GOOGLE_DOC_SAVE_NOTIFY` Google Doc save notify event
`BBjNumber`	`Page` Page to display
`static BBjString`	`PAGE_NUMBER_INPUTN_NAME$` Page number inputn name
`static BBjString`	`PREVIOUS_PAGE_MENU_ITEM_NAME$` Previous page menu item name
`static BBjString`	`PREVIOUS_PAGE_TOOL_BUTTON_NAME$` Previous page tool button name
`static BBjString`	`PRINT_MENU_ITEM_NAME$` Print menu item name
`static BBjString`	`PRINT_TOOL_BUTTON_NAME$` Print tool button name
`static BBjString`	`RELOAD_MENU_ITEM_NAME$` Reload menu item name
`static BBjString`	`RELOAD_TOOL_BUTTON_NAME$` Reload tool button name
`static BBjString`	`SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$` Save as google docment item name
`static BBjString`	`SAVE_AS_MENU_ITEM_NAME$` Save as menu item name
`static BBjString`	`SAVE_IMAGE_MENU_ITEM_NAME$` Find previous menu item name
`static BBjString`	`SAVE_MENU_BUTTON_NAME$` Save menu button name
`static BBjString`	`SAVE_MENU_ITEM_NAME$` Save menu item name
`static BBjString`	`STATUS_BAR_NAME$` Status bar name
`static BBjString`	`TOOL_BAR_CHILD_WINDOW_NAME$` Tool bar child window name
`BBjNumber`	`Width` Width
`static BBjString`	`ZOOM_IN_MENU_ITEM_NAME$` Zoom in menu item name
`static BBjString`	`ZOOM_IN_TOOL_BUTTON_NAME$` Zoom in tool button name
`static BBjString`	`ZOOM_LIST_EDIT_NAME$` Zoom list edit name
`static BBjString`	`ZOOM_OUT_MENU_ITEM_NAME$` Zoom out menu item name
`static BBjString`	`ZOOM_OUT_TOOL_BUTTON_NAME$` Zoom out tool button name
`BBjNumber`	`ZoomLevel` Zoom level

Fields inherited from class Dashboard.BaseWidget
BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION_KEY_NAME$, CachedImage!, DashboardWidget!, FillErrorAction, ON_FILL_ERROR_IGNORE, ON_FILL_ERROR_STOP, ON_FILL_ERROR_WARN, UserData!

Constructor Summary

Constructors
Constructor and Description
`JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$)` Constructs a JasperViewerWidget given a name, preview text, preview image, but without a BBJasperReport object.
`JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!)` Constructs a JasperViewerWidget given a name, preview text, preview image, and a BBJasperReport object
`JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!)` Constructs a JasperViewerWidget given a name, preview text, preview image, and parameters so that the Dashboard Utility can create and fill the report before it displays the widget

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JasperViewerWidget`	`clone()` An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
`void`	`create(BBjChildWindow p_widgetControlWindow!)` Creates the JasperViewerWidget
`void`	`destroy()` Destroys the JasperViewerWidget
`void`	`display(BBjNumber p_display)` Sets the widget's visibility
`BBjNumber`	`getFitType()` Returns the FitType for the report (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
`BBjNumber`	`getHasToolBar()` Returns whether the widget is using a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
`BBJasperReport`	`getReport()` Returns the BBJasperReport for the widget
`BBJasperView`	`getView()` Returns the BBJasperView for the widget
`BBJasperViewerControl`	`getViewerControl()` Returns the BBJasperViewerControl for the widget
`BBjNumber`	`isDestroyed()` Returns if the JasperViewerWidget is destroyed
`void`	`OnViewerControlEvent(BBjSysGuiEvent p_event!)` An internal method that is called when the user initiates an event on a JasperViewerWidget's control for which a callback event has been registered
`void`	`refresh()` Refreshes the widget's underlying BBJasperView control
`void`	`resize(BBjNumber p_width, BBjNumber p_height)` Resizes the widget using the provided with and height
`void`	`setCallback(BBjString p_name$, BBjNumber p_event, BBjString p_callbackRoutine$)` Sets a callback for the widget, given a control name, control event, and a callback routine
`void`	`setCallback(BBjString p_name$, BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine$)` Sets a callback for the widget, given a control name, control event, callback object, and a callback routine
`void`	`setFitType(BBjNumber p_fitType)` Sets the report image to fit the widget based on the provided fit type
`void`	`setHasToolBar(BBjNumber p_showToolBar)` Sets whether the widget should use a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
`void`	`setReport(BBJasperReport p_report!)` Sets the BBJasperReport for the widget

Methods inherited from class Dashboard.BaseWidget
active, getClientSlash, getFillError, getFillErrorDesc, getImage, getImage, imageFileSaveDialog, logError, name, previewImage, previewText, setActive, setFillErrorDisplayImage, setFillErrorDisplayText, setLastSaveDir, spacesValid, title

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

- Field Detail
  - Width
```
public BBjNumber Width
```
    Width
  - Height
```
public BBjNumber Height
```
    Height
  - ZoomLevel
```
public BBjNumber ZoomLevel
```
    Zoom level
  - ActualSize
```
public BBjNumber ActualSize
```
    Actual size
  - FitPage
```
public BBjNumber FitPage
```
    Fit page
  - FitWidth
```
public BBjNumber FitWidth
```
    Fit width
  - Page
```
public BBjNumber Page
```
    Page to display
  - DefaultSaveFolder!
```
public BBjString DefaultSaveFolder!
```
    Folder that will be used by default on a save
  - DefaultSaveFile!
```
public BBjString DefaultSaveFile!
```
    File that will be used by default on a save
  - DefaultSaveContributor
```
public BBjNumber DefaultSaveContributor
```
    Contributor that will be used by default on a save
  - GoogleDefaultFolder!
```
public BBjString GoogleDefaultFolder!
```
    Folder that will be used by default on a google doc save
  - GoogleDefaultDocument!
```
public BBjString GoogleDefaultDocument!
```
    Document that will be used by default on a google doc save
  - GoogleDefaultType!
```
public BBjString GoogleDefaultType!
```
    Type that will be used by default on a google doc save
  - CONTROL_CHILD_WINDOW_NAME$
```
public static BBjString CONTROL_CHILD_WINDOW_NAME$
```
    Viewer control child window name
  - TOOL_BAR_CHILD_WINDOW_NAME$
```
public static BBjString TOOL_BAR_CHILD_WINDOW_NAME$
```
    Tool bar child window name
  - STATUS_BAR_NAME$
```
public static BBjString STATUS_BAR_NAME$
```
    Status bar name
  - SAVE_MENU_BUTTON_NAME$
```
public static BBjString SAVE_MENU_BUTTON_NAME$
```
    Save menu button name
  - SAVE_MENU_ITEM_NAME$
```
public static BBjString SAVE_MENU_ITEM_NAME$
```
    Save menu item name
  - SAVE_AS_MENU_ITEM_NAME$
```
public static BBjString SAVE_AS_MENU_ITEM_NAME$
```
    Save as menu item name
  - SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$
```
public static BBjString SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$
```
    Save as google docment item name
  - PAGE_NUMBER_INPUTN_NAME$
```
public static BBjString PAGE_NUMBER_INPUTN_NAME$
```
    Page number inputn name
  - ZOOM_LIST_EDIT_NAME$
```
public static BBjString ZOOM_LIST_EDIT_NAME$
```
    Zoom list edit name
  - CREATE_IMAGE_TOOL_BUTTON_NAME$
```
public static BBjString CREATE_IMAGE_TOOL_BUTTON_NAME$
```
    Create imaage tool button name
  - PRINT_TOOL_BUTTON_NAME$
```
public static BBjString PRINT_TOOL_BUTTON_NAME$
```
    Print tool button name
  - EMAIL_TOOL_BUTTON_NAME$
```
public static BBjString EMAIL_TOOL_BUTTON_NAME$
```
    Email tool button name
  - RELOAD_TOOL_BUTTON_NAME$
```
public static BBjString RELOAD_TOOL_BUTTON_NAME$
```
    Reload tool button name
  - FIRST_PAGE_TOOL_BUTTON_NAME$
```
public static BBjString FIRST_PAGE_TOOL_BUTTON_NAME$
```
    First page tool button name
  - PREVIOUS_PAGE_TOOL_BUTTON_NAME$
```
public static BBjString PREVIOUS_PAGE_TOOL_BUTTON_NAME$
```
    Previous page tool button name
  - NEXT_PAGE_TOOL_BUTTON_NAME$
```
public static BBjString NEXT_PAGE_TOOL_BUTTON_NAME$
```
    Next page tool button name
  - LAST_PAGE_TOOL_BUTTON_NAME$
```
public static BBjString LAST_PAGE_TOOL_BUTTON_NAME$
```
    Last page tool button name
  - FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$
```
public static BBjString FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$
```
    Fit actual size tool button name
  - FIT_PAGE_TOOL_BUTTON_NAME$
```
public static BBjString FIT_PAGE_TOOL_BUTTON_NAME$
```
    Fit page tool button name
  - FIT_WIDTH_TOOL_BUTTON_NAME$
```
public static BBjString FIT_WIDTH_TOOL_BUTTON_NAME$
```
    Fit width tool button name
  - ZOOM_IN_TOOL_BUTTON_NAME$
```
public static BBjString ZOOM_IN_TOOL_BUTTON_NAME$
```
    Zoom in tool button name
  - ZOOM_OUT_TOOL_BUTTON_NAME$
```
public static BBjString ZOOM_OUT_TOOL_BUTTON_NAME$
```
    Zoom out tool button name
  - FIND_TOOL_BUTTON_NAME$
```
public static BBjString FIND_TOOL_BUTTON_NAME$
```
    Find tool button name
  - PRINT_MENU_ITEM_NAME$
```
public static BBjString PRINT_MENU_ITEM_NAME$
```
    Print menu item name
  - EMAIL_MENU_ITEM_NAME$
```
public static BBjString EMAIL_MENU_ITEM_NAME$
```
    Email menu item name
  - RELOAD_MENU_ITEM_NAME$
```
public static BBjString RELOAD_MENU_ITEM_NAME$
```
    Reload menu item name
  - FIRST_PAGE_MENU_ITEM_NAME$
```
public static BBjString FIRST_PAGE_MENU_ITEM_NAME$
```
    First page menu item name
  - PREVIOUS_PAGE_MENU_ITEM_NAME$
```
public static BBjString PREVIOUS_PAGE_MENU_ITEM_NAME$
```
    Previous page menu item name
  - NEXT_PAGE_MENU_ITEM_NAME$
```
public static BBjString NEXT_PAGE_MENU_ITEM_NAME$
```
    Next page menu item name
  - LAST_PAGE_MENU_ITEM_NAME$
```
public static BBjString LAST_PAGE_MENU_ITEM_NAME$
```
    Last page menu item name
  - CUSTOM_PAGE_MENU_ITEM_NAME$
```
public static BBjString CUSTOM_PAGE_MENU_ITEM_NAME$
```
    Custom page menu item name
  - ACTUAL_SIZE_MENU_ITEM_NAME$
```
public static BBjString ACTUAL_SIZE_MENU_ITEM_NAME$
```
    Actual size menu item name
  - FIT_PAGE_MENU_ITEM_NAME$
```
public static BBjString FIT_PAGE_MENU_ITEM_NAME$
```
    Fit page menu item name
  - FIT_WIDTH_MENU_ITEM_NAME$
```
public static BBjString FIT_WIDTH_MENU_ITEM_NAME$
```
    Fit width menu item name
  - ZOOM_IN_MENU_ITEM_NAME$
```
public static BBjString ZOOM_IN_MENU_ITEM_NAME$
```
    Zoom in menu item name
  - ZOOM_OUT_MENU_ITEM_NAME$
```
public static BBjString ZOOM_OUT_MENU_ITEM_NAME$
```
    Zoom out menu item name
  - CUSTOM_ZOOM_MENU_ITEM_NAME$
```
public static BBjString CUSTOM_ZOOM_MENU_ITEM_NAME$
```
    Custom zoom menu item name
  - FIND_MENU_ITEM_NAME$
```
public static BBjString FIND_MENU_ITEM_NAME$
```
    Find menu item name
  - FIND_NEXT_MENU_ITEM_NAME$
```
public static BBjString FIND_NEXT_MENU_ITEM_NAME$
```
    Find next menu item name
  - FIND_PREVIOUS_MENU_ITEM_NAME$
```
public static BBjString FIND_PREVIOUS_MENU_ITEM_NAME$
```
    Find previous menu item name
  - SAVE_IMAGE_MENU_ITEM_NAME$
```
public static BBjString SAVE_IMAGE_MENU_ITEM_NAME$
```
    Find previous menu item name
  - FILE_SAVE_NAME$
```
public static BBjString FILE_SAVE_NAME$
```
    File save name
  - GOOGLE_DOC_SAVE_NAME$
```
public static BBjString GOOGLE_DOC_SAVE_NAME$
```
    Google Doc save notify name
  - ON_FILE_SAVE_NOTIFY
```
public static BBjNumber ON_FILE_SAVE_NOTIFY
```
    File save notify event
  - ON_GOOGLE_DOC_SAVE_NOTIFY
```
public static BBjNumber ON_GOOGLE_DOC_SAVE_NOTIFY
```
    Google Doc save notify event
- Constructor Detail
  - JasperViewerWidget
```
public JasperViewerWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)
```
    Constructs a JasperViewerWidget given a name, preview text, preview image, but without a BBJasperReport object. You can call the setReport() method later to set the BBJasperReport for this widget.
    
    Parameters:
    
    p_name$ - Unique name of the widget
    
    p_title$ - Title which will display in the title bar
    
    p_previewText$ - Preview text
    
    p_previewImage$ - Preview image
    
    See Also:
    
    BBJasperReport for information on creating a BBJasperReport
  - JasperViewerWidget
```
public JasperViewerWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBJasperReport p_report!)
```
    Constructs a JasperViewerWidget given a name, preview text, preview image, and a BBJasperReport object
    This constructor is less efficient than the versions that take a report file, connection string, and parameter list as your code must create and fill the report before displaying the dashboard. Constructing the widget with this method also requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.
    
    Parameters:
    
    p_name$ - Unique name of the widget
    
    p_title$ - Title which will display in the title bar
    
    p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title
    
    p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created
    
    p_report! - BBJasperReport object
    
    See Also:
    
    BBJasperReport for information on creating a BBJasperReport
  - JasperViewerWidget
```
public JasperViewerWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_reportFile$,
BBjString p_connectString$,
HashMap p_params!)
```
    Constructs a JasperViewerWidget given a name, preview text, preview image, and parameters so that the Dashboard Utility can create and fill the report before it displays the widget
    This constructor is more efficient than the versions that take a BBJasperReport object as the Dashboard Utility will create and fill the report just before displaying the widget. The other methods require that you create and fill the report before the dashboard is displayed, even if the widget is not on the first tab and will never be displayed. Additionally, creating the widget with this constructor will refill the report automatically whenever the widget is refreshed. Constructing the widget with the BBJasperReport object requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.
    
    Parameters:
    
    p_name$ - Unique name of the widget
    
    p_title$ - Title which will display in the title bar
    
    p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title
    
    p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created
    
    p_reportFile$ - The path to a jrxml or jasper report file
    
    p_connectString$ - JDBC connect string used to connect to the database
    
    p_params! - A HashMap containing parameters for the report which may be set to null() if the report doesn't require parameters
    
    Since:
    
    BBj 18.20
    
    See Also:
    
    BBJasperReport for information on creating a BBJasperReport
- Method Detail
  - create
```
public void create(BBjChildWindow p_widgetControlWindow!)
```
    Creates the JasperViewerWidget
    
    Specified by:
    
    create in interface Widget
    
    Parameters:
    
    p_widgetControlWindow! - The BBjChildWindow that will contain the widget
  - OnViewerControlEvent
```
public void OnViewerControlEvent(BBjSysGuiEvent p_event!)
```
    An internal method that is called when the user initiates an event on a JasperViewerWidget's control for which a callback event has been registered
  - clone
```
public JasperViewerWidget clone()
```
    An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
    
    Specified by:
    
    clone in interface Widget
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A cloned version of the original widget
  - resize
```
public void resize(BBjNumber p_width,
BBjNumber p_height)
```
    Resizes the widget using the provided with and height
    
    Specified by:
    
    resize in interface Widget
    
    Parameters:
    
    p_width - Width of the widget
    
    p_height - Height of the widget
  - destroy
```
public void destroy()
```
    Destroys the JasperViewerWidget
    
    Specified by:
    
    destroy in interface Widget
    
    Overrides:
    
    destroy in class BaseWidget
  - isDestroyed
```
public BBjNumber isDestroyed()
```
    Returns if the JasperViewerWidget is destroyed
    
    Specified by:
    
    isDestroyed in interface Widget
    
    Overrides:
    
    isDestroyed in class BaseWidget
    
    Returns:
    
    Returns 1 if destroyed, otherwise 0 is returned
  - display
```
public void display(BBjNumber p_display)
```
    Sets the widget's visibility
    
    Specified by:
    
    display in interface Widget
    
    Parameters:
    
    p_display - TRUE (1) to make the widget visible, FALSE (0) to hide it
  - setCallback
```
public void setCallback(BBjString p_name$,
BBjNumber p_event,
BBjString p_callbackRoutine$)
```
    Sets a callback for the widget, given a control name, control event, and a callback routine
    
    Parameters:
    
    p_name$ - Control name
    
    p_event - Control event that will trigger the callback
    
    p_callbackRoutine$ - Routine name to callback when the event occurs on the control
  - setCallback
```
public void setCallback(BBjString p_name$,
BBjNumber p_event,
CustomObject p_callbackObject!,
BBjString p_callbackRoutine$)
```
    Sets a callback for the widget, given a control name, control event, callback object, and a callback routine
    
    Parameters:
    
    p_name$ - Control name
    
    p_event - Control event that will trigger the callback
    
    p_callbackObject - Object to callback when the event occurs on the control
    
    p_callbackRoutine$ - Routine name to callback when the event occurs on the control
  - setReport
```
public void setReport(BBJasperReport p_report!)
```
    Sets the BBJasperReport for the widget
    
    Parameters:
    
    p_report! - The BBJasperReport that contains report information for the widget
    
    See Also:
    
    BBJasperReport for information on the BBJasperReport
  - getReport
```
public BBJasperReport getReport()
```
    Returns the BBJasperReport for the widget
    This method is typically used in custom callback code as a result of a refresh or a filter selection event on the DashboardWidget. Your callback code can get the DashboardWidget from the custom event and get the JasperViewerWidget from that. Calling this method gives you the underlying BBJasperReport, from which you can get/set the report's parameters to modify what the report displays or export the report to a variety of different formats.
    
    Returns:
    
    The widget's BBJasperReport
    
    See Also:
    
    BBJasperReport for information on the BBJasperReport and its methods
  - getFitType
```
public BBjNumber getFitType()
```
    Returns the FitType for the report (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
    
    Returns:
    
    The report's FitType
    
    Since:
    
    BBj 18.20
    
    See Also:
    
    BBJasperViewerControl::getFitType() for information on the fit type options
  - setFitType
```
public void setFitType(BBjNumber p_fitType)
```
    Sets the report image to fit the widget based on the provided fit type
    The fit type can be set using static field variables like BBJasperViewerControl.getFIT_TYPE_ACTUAL(), BBJasperViewerControl.getFIT_TYPE_PAGE(), or BBJasperViewerControl.getFIT_TYPE_WIDTH().
    
    Parameters:
    
    p_fitType - Specifies one the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE
    
    Since:
    
    BBj 18.20
    
    See Also:
    
    BBJasperViewerControl::setFitType() for information on the fit type options
  - getViewerControl
```
public BBJasperViewerControl getViewerControl()
```
    Returns the BBJasperViewerControl for the widget
    As of BBj 18.20, the JasperViewerWidget may not contain a toolbar when the widget is very small, which indicates that it's implemented using a BBJasperView instead of a BBJasperViewerControl. Therefore, it may be more desireable to use the getView() method which returns the BBJasperView that's always available, regardless of the internal implementation.
    
    Returns:
    
    BBJasperViewerControl for the widget
    
    See Also:
    
    BBJasperViewerControl for information on the BBJasperViewerControl and its methods
  - getHasToolBar
```
public BBjNumber getHasToolBar()
```
    Returns whether the widget is using a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
    
    Returns:
    
    A number acting as a boolean that determines whether the toolbar is present (0 = Widget does NOT have Jasper ToolBar, 1 = widget DOES have Jasper ToolBar)
    
    Since:
    
    18.20
    
    See Also:
    
    BBJasperView for information on the BBJasperView and its methods
  - setHasToolBar
```
public void setHasToolBar(BBjNumber p_showToolBar)
```
    Sets whether the widget should use a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
    
    Parameters:
    
    p_showToolBar - A number acting as a boolean that determines whether the toolbar is present (0 = Widget does NOT have Jasper ToolBar, 1 = widget DOES have Jasper ToolBar)
    
    Since:
    
    18.20
    
    See Also:
    
    BBJasperView for information on the BBJasperView and its methods
  - getView
```
public BBJasperView getView()
```
    Returns the BBJasperView for the widget
    
    Returns:
    
    BBJasperView for the widget
    
    Since:
    
    18.20
    
    See Also:
    
    BBJasperView for information on the BBJasperView and its methods
  - refresh
```
public void refresh()
```
    Refreshes the widget's underlying BBJasperView control
    If the JasperViewerWidget was constructed with a BBJasperReport object, then the report will not be refilled. If you created the widget with a BBJasperReport you must register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.
    If the widget was constructed with a report file, connection string, and parameter list then the widet will refill the report automatically whenever the widget is refreshed.
    
    Specified by:
    
    refresh in interface RefreshableWidget
    
    See Also:
    
    BBJasperViewerControl for information on the BBJasperViewerControl and its methods

Class JasperViewerWidget

Field Summary

Fields inherited from class Dashboard.BaseWidget

Constructor Summary

Method Summary

Methods inherited from class Dashboard.BaseWidget

Methods inherited from class java.lang.Object

Field Detail

Width

Height

ZoomLevel

ActualSize

FitPage

FitWidth

Page

DefaultSaveFolder!

DefaultSaveFile!

DefaultSaveContributor

GoogleDefaultFolder!

GoogleDefaultDocument!

GoogleDefaultType!

CONTROL_CHILD_WINDOW_NAME$

TOOL_BAR_CHILD_WINDOW_NAME$

STATUS_BAR_NAME$

SAVE_MENU_BUTTON_NAME$

SAVE_MENU_ITEM_NAME$

SAVE_AS_MENU_ITEM_NAME$

SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$

PAGE_NUMBER_INPUTN_NAME$

ZOOM_LIST_EDIT_NAME$

CREATE_IMAGE_TOOL_BUTTON_NAME$

PRINT_TOOL_BUTTON_NAME$

EMAIL_TOOL_BUTTON_NAME$

RELOAD_TOOL_BUTTON_NAME$

FIRST_PAGE_TOOL_BUTTON_NAME$

PREVIOUS_PAGE_TOOL_BUTTON_NAME$

NEXT_PAGE_TOOL_BUTTON_NAME$

LAST_PAGE_TOOL_BUTTON_NAME$

FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$

FIT_PAGE_TOOL_BUTTON_NAME$

FIT_WIDTH_TOOL_BUTTON_NAME$

ZOOM_IN_TOOL_BUTTON_NAME$

ZOOM_OUT_TOOL_BUTTON_NAME$

FIND_TOOL_BUTTON_NAME$

PRINT_MENU_ITEM_NAME$

EMAIL_MENU_ITEM_NAME$

RELOAD_MENU_ITEM_NAME$

FIRST_PAGE_MENU_ITEM_NAME$

PREVIOUS_PAGE_MENU_ITEM_NAME$

NEXT_PAGE_MENU_ITEM_NAME$

LAST_PAGE_MENU_ITEM_NAME$

CUSTOM_PAGE_MENU_ITEM_NAME$

ACTUAL_SIZE_MENU_ITEM_NAME$

FIT_PAGE_MENU_ITEM_NAME$

FIT_WIDTH_MENU_ITEM_NAME$

ZOOM_IN_MENU_ITEM_NAME$

ZOOM_OUT_MENU_ITEM_NAME$

CUSTOM_ZOOM_MENU_ITEM_NAME$

FIND_MENU_ITEM_NAME$

FIND_NEXT_MENU_ITEM_NAME$

FIND_PREVIOUS_MENU_ITEM_NAME$

SAVE_IMAGE_MENU_ITEM_NAME$

FILE_SAVE_NAME$

GOOGLE_DOC_SAVE_NAME$

ON_FILE_SAVE_NOTIFY

ON_GOOGLE_DOC_SAVE_NOTIFY

Constructor Detail

JasperViewerWidget

JasperViewerWidget

JasperViewerWidget

Method Detail

create

OnViewerControlEvent

clone

resize

destroy

isDestroyed

display

setCallback

setCallback