public class BBJasperViewerControl
BBJasperViewerControl Displays a JasperReport in a child window where the user can view it, perform drill downs, save it to disk in various formats, and print it
In BBj 12.0 the BBJasperViewerControl utility was re-written in BBj native code to enable the ability to be run in BUI
Constructor and Description |
---|
BBJasperViewerControl(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, and control height |
BBJasperViewerControl(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) Constructor Constructs a BBJasperViewerControl given a BBjVector containing BBJasperReport objects, BBjWindow object, control id, control x, control y, control width, and control height |
BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, and control height |
BBJasperViewerControl(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 BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type |
BBJasperViewerControl(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 BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type |
BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type |
BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, 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 BBJasperViewerControl given a BBJasperViewerWindow object, BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type |
BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) Constructor Constructs a BBJasperViewerControl given a BBJasperViewer object, JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type |
Modifier and Type | Method and Description |
---|---|
void | addSaveContributor(BBjNumber p_type) addSaveContributor Adds a save contributor |
BBjToolButton | addToolbarButton(BBjString p_image$, BBjString p_shortCue$) addToolButton Adds a tool button at the end of the tool bar |
BBjToolButton | addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjString p_name$) addToolButton Adds a tool button at the end of the tool bar |
BBjToolButton | addToolbarButton(BBjNumber p_IconImageListIndex, BBjString p_shortCue$, BBjString p_name$) addToolButton Adds a tool button at the end of the tool bar |
BBjToolButton | addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index) addToolButton Adds a tool button to the tool bar at the specified index |
BBjToolButton | addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index, BBjString p_name$) addToolButton Adds a tool button to the tool bar at the specified index |
BBjChildWindow | addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index) addToolbarChildWindow Adds a child window to the tool bar at the specified index |
BBjChildWindow | addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index, BBjString p_name$) addToolbarChildWindow Adds a child window to the tool bar at the specified index |
void | addToolbarSpacer() addToolbarSpacer Adds a tool bar spacer at the end of the tool bar |
void | addToolbarSpacer(BBjNumber p_index) addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar |
void | addToolbarSpacer(BBjNumber p_index, BBjString p_name$) addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar |
void | addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, BBjString p_callbackRoutine!) addToolButton Adds a tool button to the tool bar |
void | addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) addToolButton Adds a tool button to the tool bar |
void | addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index) addToolButton Adds a tool button to the tool bar |
void | addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index, BBjString p_name$) addToolButton Adds a tool button to the tool bar |
void | addViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) addViewerWindow Adds a viewer window to the vector of viewer windows |
void | closeAllViewerWindows() closeAllViewerWindows Closes and destroys all windows that were created from this control |
void | destroy() destroy Destroys the viewer control |
void | destroy(BBjNumber p_closeAllViewerWindows) destroy Destroys the control and optionally all viewer windows that were created by this control |
void | findReport() findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find. |
HashMap | getAllControls() getAllControls Returns a HashMap containg all of the controls |
BBjControl | getControl(BBjString p_controlName$) getControl Returns a control given the control name |
BBJasperCSVExporter | getCSVExporter() getCSVExporter Returns the CSV exporter which contains export options |
BBjNumber | getDefaultSave() getDefaultSave Returns the default save location |
BBJasperDOCXExporter | getDOCXExporter() getDOCXExporter Returns the DOCX exporter which contains export options |
EmailDialog | getEmailDialog() getEmailDialog Returns the EmailDialog object so that it can be customized |
BBjNumber | getFitType() getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE) |
GDocSaveDialog | getGDocSaveDialog() getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized |
BBjNumber | getHeight() getHeight Returns the height of the viewer control |
BBJasperHTMLExporter | getHTMLExporter() getHTMLExporter Returns the HTML exporter which contains export options |
net.sf.jasperreports.engine.JasperPrint | getJasperPrint() getJasperPrint Returns the JasperPrint object |
BBJasperODSExporter | getODSExporter() getODSExporter Returns the ODS exporter which contains export options |
BBJasperODTExporter | getODTExporter() getODTExporter Returns the ODT exporter which contains export options |
BBjNumber | getPage() getPage Return the current page |
BBJasperPDFExporter | getPDFExporter() getPDFExporter Returns the PDF exporter which contains export options |
BBJasperPPTXExporter | getPPTXExporter() getPPTXExporter Returns the PPTX exporter which contains export options |
BBJasperjavax.print.PrintServiceExporter | getPrintServiceExporter() getPrintServiceExporter Returns the PrintService exporter which contains export options |
BBnet.sf.jasperreports.engine.JasperReport | getReport() getReport Returns the BBJasperReport object |
BBjVector | getReports() getReports Returns a BBjVector containing the BBJasperReport objects |
BBJasperRTFExporter | getRTFExporter() getRTFExporter Returns the RTF exporter which contains export options |
BBjPopupMenu | getSavePopupMenu() geSavePopupMenu Returns the save popup menu |
BBjNumber | getShowFileDialogOnInitDefaultSave() getShowFileDialogOnInitDefaultSave Returns if the file save dialog should be shown on the intitial save |
BBjNumber | getShowGoogleDialogOnInitDefaultSave() getShowGoogleDialogOnInitDefaultSave Returns if the Google save dialog should be shown on the intitial save |
BBJasperTabbedView | getTabbedView() getTabbedView Returns the tabbed view |
BBjChildWindow | getToolbar() getToolbar Returns the tool bar |
BBjControl | getToolbarControlAt(BBjNumber p_index) getToolbarControlAt Returns a tool bar control at the specified index |
BBJasperTXTExporter | getTXTExporter() getTXTExporter Returns the TXT exporter which contains export options |
BBJasperView | getView() getView Returns the current view |
BBjNumber | getWidth() getWidth Returns the width of the viewer control |
BBjNumber | getX() getX Returns the X location of the viewer control |
BBJasperXHTMLExporter | getXHTMLExporter() getXHTMLExporter Returns the XHTML exporter which contains export options |
BBJasperXLSExporter | getXLSExporter() getXLSExporter Returns the XLS exporter which contains export options |
BBJasperXLSXExporter | getXLSXExporter() getXLSXExporter Returns the XLSX exporter which contains export options |
BBJasperXMLExporter | getXMLExporter() getXMLExporter Returns the XML exporter which contains export options |
BBjNumber | getY() getY Returns the Y location of the viewer control |
BBjNumber | getZoomLevel() getZoomLevel Returns the current zoom level |
void | OnActualSizeToolButton(BBjToolButtonPushEvent p_event!) OnActualSizeToolButton Callback for when the acutal size tool button is pushed |
void | OnCreateImageToolButton(BBjToolButtonPushEvent p_event!) OnCreateImageToolButton Callback for when the create image tool button is pushed |
void | OnEmailToolButton(BBjToolButtonPushEvent p_event!) OnEmailToolButton Callback for when the email tool button is pushed |
void | OnFindToolButton(BBjToolButtonPushEvent p_event!) OnFindToolButton Callback for when the find tool button is pushed |
void | OnFirstToolButton(BBjToolButtonPushEvent p_event!) OnFirstToolButton Callback for when the first page tool button is pushed |
void | OnFitPageToolButton(BBjToolButtonPushEvent p_event!) OnFitPageToolButton Callback for when the fit to page tool button is pushed |
void | OnFitWidthToolButton(BBjToolButtonPushEvent p_event!) OnFitWidthToolButton Callback for when the fit to width tool button is pushed |
void | OnKeypress(BBjKeypressEvent p_keyPressEvent!) |
void | OnLastToolButton(BBjToolButtonPushEvent p_event!) OnLastToolButton Callback for when the last page tool button is pushed |
void | OnNextToolButton(BBjToolButtonPushEvent p_event!) OnNextToolButton Callback for when the next page tool button is pushed |
void | OnPageNumberEdit(BBjEditModifyEvent p_event!) OnPageNumberEdit Callback for when a key is pressed in the page number inputN |
void | OnPreviousToolButton(BBjToolButtonPushEvent p_event!) OnPreviousToolButton Callback for when the previous page tool button is pushed |
void | OnPrintToolButton(BBjToolButtonPushEvent p_event!) OnPrintToolButton Callback for when the print tool button is pushed |
void | OnReloadToolButton(BBjToolButtonPushEvent p_event!) OnReloadToolButton Callback for when the reload tool button is pushed |
void | OnReportWindowMouseUp(BBjMouseUpEvent p_event!) Called when the mouse is pressed up over the report window |
void | OnSave(BBjSysGuiEvent p_event!) OnSave Callback run when user selects to save the report |
void | OnSaveAs(BBjSysGuiEvent p_event!) OnSaveAs Callback run when user selects to save-as the report |
void | OnSaveGoogleDoc(BBjPopupSelectEvent p_event!) OnSaveGoogleDoc Callback for when the save google doc menu item is selected |
void | OnToolBarWindowMouseUp(BBjMouseUpEvent p_event!) Called when the mouse is pressed up over the tool bar window |
void | OnToolButtonPush(BBjToolButtonPushEvent p_event!) OnToolButtonPush Callback called when a tool button is pushed |
void | OnZoomGainedFocus(BBjGainedFocusEvent p_gainedFocusEvent!) |
void | OnZoomInToolButton(BBjToolButtonPushEvent p_event!) OnZoomInToolButton Callback for when the zoom in tool button is pushed |
void | OnZoomListEditSelect(BBjListSelectEvent p_event!) OnZoomListEditSelect Callback for when a zoom level selection is made |
void | OnZoomLostFocus(BBjLostFocusEvent p_lostFocusEvent!) |
void | OnZoomOutToolButton(BBjToolButtonPushEvent p_event!) OnZoomOutToolButton Callback for when the zoom out tool button is pushed |
void | refresh() refresh Refreshes the image for the current report page and zoom level |
void | refreshToolbar() refreshToolbar Refreshes the toolbar in case controls have been added/removed outside the class |
void | reload() reload Refills the report and refreshes the viewer |
void | removeSaveContributor(BBjNumber p_type) removeSaveContributor Removes a save contributor |
void | removeViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) removeViewerWindow Removes a viewer window from the vector of viewer windows |
void | selectGoogleDefaultType(BBjString p_selectType$) selectGoogleDefaultType Selects the default Google document type |
void | setActualSize() setActualSize Sets the report image to the actual size All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType() |
void | setCSVExporter(BBJasperCSVExporter p_csvExporter!) setCSVExporter Sets the CSV exporter which contains export options |
void | setDefaultSave(BBjNumber p_defaultSave) setDefaultSave Sets the default save location |
void | setDefaultSaveContributor(BBjNumber p_type) setDefaultSaveContributor Sets the default save contributor |
void | setDefaultSaveFile(BBjString p_saveFile$) setDefaultSaveFile Sets the default save file |
void | setDefaultSaveFolder(BBjString p_saveFolder$) setDefaultSaveFolder Sets the default save folder |
void | setDOCXExporter(BBJasperDOCXExporter p_docxExporter!) setDOCXExporter Sets the DOCX exporter which contains export options |
void | setFileSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) setFileSaveCallback Sets a callback routine to call when a file save occurs |
void | setFileSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) setFileSaveCallback Sets a callback routine to call when a file save occurs |
void | setFindCaseSensitivity(BBjNumber p_findCaseSensitivity) |
void | setFindHighlight(BBjNumber p_findHighlight) |
void | setFindMatch(BBjNumber p_findMatch) |
void | setFindScope(BBjNumber p_findScope) |
void | setFindText(BBjString p_findText$) setFindText Sets the find text |
void | setFitPage() setFitPage Sets the report image to the fit the page All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType() |
void | setFitType(BBjNumber p_fitType) setFitType Sets the report image to fit based on the provided fit type The fit type can be set using static field variables like BBJasperViewerControl.getFIT_TYPE_ACTUAL(), BBJasperViewerControl.getFIT_TYPE_WIDTH(), or BBJasperViewerControl.getFIT_TYPE_PAGE() All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType() |
void | setFitWidth() setFitWidth Sets the report image to the fit the width of the container All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType() |
void | setGoogleDefaultDocument(BBjString p_defaultDocument$) setGoogleDefaultDocument Sets the default Google document |
void | setGoogleDefaultFolder(BBjString p_defaultFolder$) setGoogleDefaultFolder Sets the default Google folder |
void | setGoogleDefaultType(BBjString p_defaultType$) setGoogleDefaultType Sets the default Google document type |
void | setGoogleDocSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs |
void | setGoogleDocSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs |
void | setHTMLExporter(BBJasperHTMLExporter p_htmlExporter!) setHTMLExporter Sets the HTML exporter which contains export options |
void | setLocation(BBjNumber p_x, BBjNumber p_y) setLocation Sets the location of the viewer control |
void | setMouseClickCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) setMouseClickCallback Sets a callback routine to call when the mouse is clicked |
void | setMouseClickCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) setMouseClickCallback Sets a callback routine to call when the mouse is clicked |
void | setODSExporter(BBJasperODSExporter p_odsExporter!) setODSExporter Sets the ODS exporter which contains export options |
void | setODTExporter(BBJasperODTExporter p_odtExporter!) setODTExporter Sets the ODT exporter which contains export options |
void | setPage(BBjNumber p_page) setPage Sets the current page |
void | setPDFExporter(BBJasperPDFExporter p_pdfExporter!) setPDFExporter Sets the PDF exporter which contains export options |
void | setPPTXExporter(BBJasperPPTXExporter p_pptxExporter!) setPPTXExporter Sets the PPTX exporter which contains export options |
void | setPrintServiceExporter(BBJasperPrintServiceExporter p_printServiceExporter!) setPrintServiceExporter Sets the PrintService exporter which contains export options |
void | setRTFExporter(BBJasperRTFExporter p_rtfExporter!) setRTFExporter Sets the RTF exporter which contains export options |
void | setShowFileDialogOnInitDefaultSave(BBjNumber p_showFileDialogOnInitDefaultSave) setShowFileDialogOnInitDefaultSave Sets if the file save dialog should be shown on the intitial save |
void | setShowGoogleDialogOnInitDefaultSave(BBjNumber p_showGoogleDialogOnInitDefaultSave) setShowGoogleDialogOnInitDefaultSave Sets if the Google save dialog should be shown on the intitial save |
void | setSize(BBjNumber p_width, BBjNumber p_height) setSize Sets the sizes of the viewer control |
void | setStatusBarText(BBjString p_statusBarText$) setStatusBarText Sets the text in the status bar |
void | setTXTExporter(BBJasperTXTExporter p_txtExporter!) setTXTExporter Sets the TXT exporter which contains export options |
void | setView(BBJasperView p_view!) setView Set the current view for the viewer control |
void | setVisible(BBjNumber p_visible) setVisible Sets the visibility of the viewer control |
void | setXHTMLExporter(BBJasperXHTMLExporter p_xhtmlExporter!) setXHTMLExporter Sets the XHTML exporter which contains export options |
void | setXLSExporter(BBJasperXLSExporter p_xlsExporter!) setXLSExporter Sets the XLS exporter which contains export options |
void | setXLSXExporter(BBJasperXLSXExporter p_xlsxExporter!) setXLSXExporter Sets the XLSX exporter which contains export options |
void | setXMLExporter(BBJasperXMLExporter p_xmlExporter!) setXMLExporter Sets the XML exporter which contains export options |
void | setZoomLevel(BBjNumber p_zoomLevel) setZoomLevel Sets the report image to the specifed zoom level |
void | updateControls() updateControls Updates the controls based on the current view |
void | updateNavButtonControls() updateNavButtons Updates the navigation button to enabled/disabled states |
void | updatePageControls() updatePageControls Updates the page controls |
void | updateZoomControl() updateZoomControl Updates the zoom control to the current report zoom |
public static BBjString ACTUAL_SIZE$=#Translations!.getTranslation("actual.size")
Translated text for actual size
public static BBjString ALL_FILES$=#Translations!.getTranslation("all.files")
Translated text for all files
public static BBjString BBJASPER_TABBED_VIEW_KEY_NAME$="BBJASPER_TABBED_VIEW"
Name of STBL key to globally specify if a tabbed view should be used
public static BBjString CONTROL_CHILD_WINDOW_NAME$="BBJVControlChildWindow"
Viewer control child window name
public static BBjNumber CONTROL_ERROR=502
Constant that represents a control error
public static BBjString CREATE_IMAGE$=#Translations!.getTranslation("create.image")
Translated text for create image
public static BBjString CREATE_IMAGE_TOOL_BUTTON_NAME$="BBJVCreateImageToolButton"
Create imaage tool button name
public static BBjNumber CSV_SAVE_CONTRIBUTOR=BBJasperView.getCSV_SAVE_CONTRIBUTOR()
Constant that represents the CSV save contributor
public static BBjString CUSTOM_ZOOM_RATIO$=#Translations!.getTranslation("custom.zoom")
Translated text for custom zoom
public static BBjNumber DEFAULT_SAVE_DISK=BBJasperView.getDEFAULT_SAVE_DISK()
Constant which represents the default save location as the disk
11.0
public static BBjNumber DEFAULT_SAVE_GOOGLE=BBJasperView.getDEFAULT_SAVE_GOOGLE()
Constant which represents the default save location as Google docs
11.0
public static BBjNumber DOCX_SAVE_CONTRIBUTOR=BBJasperView.getDOCX_SAVE_CONTRIBUTOR()
Constant that represents the DOCX save contributor
public static BBjString EMAIL$=#Translations!.getTranslation("email")
Translated text for email
public static BBjString EMAIL_TOOL_BUTTON_NAME$="BBJVEmailToolButton"
Email tool button name
public static BBjNumber EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR=BBJasperView.getEMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR()
Constant that represents the embedded images XML save contributor
public static BBjString FIND$=#Translations!.getTranslation("find")
Translated text for find
public static BBjNumber FIND_EDIT_BOX_WIDTH
Width of the find edit, the default is 140
public static BBjNumber FIND_STATIC_TEXT_WIDTH
Width of the find static text, the default is 60
public static BBjString FIND_TOOL_BUTTON_NAME$="BBJVFindToolButton"
Find tool button name
public static BBjString FIRST_PAGE$=#Translations!.getTranslation("first.page")
Translated text for first page
public static BBjString FIRST_PAGE_TOOL_BUTTON_NAME$="BBJVFirstPageToolButton"
First page tool button name
public static BBjString FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$="BBJVFitActualSizeToolButton"
Fit actual size tool button name
public static BBjString FIT_PAGE$=#Translations!.getTranslation("fit.page")
Translated text for fit to page
public static BBjString FIT_PAGE_TOOL_BUTTON_NAME$="BBJVFitPageToolButton"
Fit page tool button name
public static BBjNumber FIT_TYPE_ACTUAL=BBJasperView.getFIT_TYPE_ACTUAL()
Constant for fit type actual
public static BBjNumber FIT_TYPE_PAGE=BBJasperView.getFIT_TYPE_PAGE()
Constant for fit type page
public static BBjNumber FIT_TYPE_WIDTH=BBJasperView.getFIT_TYPE_WIDTH()
Constant for fit type width
public static BBjNumber FIT_TYPE_ZOOM=BBJasperView.getFIT_TYPE_ZOOM()
Constant for fit type zoom
public static BBjString FIT_WIDTH$=#Translations!.getTranslation("fit.width")
Translated text for fit to width
public static BBjString FIT_WIDTH_TOOL_BUTTON_NAME$="BBJVFitWidthToolButton"
Fit width tool button name
public static BBjString GO_TO_PAGE$=#Translations!.getTranslation("go.to.page")
Translated text for go to page
public static BBjNumber HTML_SAVE_CONTRIBUTOR=BBJasperView.getHTML_SAVE_CONTRIBUTOR()
Constant that represents the HTML save contributor
public static BBjString LAST_PAGE$=#Translations!.getTranslation("last.page")
Translated text for last page
public static BBjString LAST_PAGE_TOOL_BUTTON_NAME$="BBJVLastPageToolButton"
Last page tool button name
public static BBjNumber MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR=BBJasperView.getMULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR()
Constant that represents the multiple sheet XLS save contributor
public static BBjString NEXT_PAGE$=#Translations!.getTranslation("next.page")
Translated text for next page
public static BBjString NEXT_PAGE_TOOL_BUTTON_NAME$="BBJVNextPageToolButton"
Next page tool button name
public static BBjNumber ODS_SAVE_CONTRIBUTOR=BBJasperView.getODS_SAVE_CONTRIBUTOR()
Constant that represents the ODS save contributor
public static BBjNumber ODT_SAVE_CONTRIBUTOR=BBJasperView.getODT_SAVE_CONTRIBUTOR()
Constant that represents the ODT save contributor
public static BBjNumber PAGE_INPUTN_WIDTH
Width of the page inputn, the default is 40
public static BBjString PAGE_NUMBER_INPUTN_NAME$="BBJVPageNumberInputN"
Page number inputn name
public static BBjString PAGE_STATUS$=#Translations!.getTranslation("page.status")
Translated text for page status
public static BBjNumber PDF_SAVE_CONTRIBUTOR=BBJasperView.getPDF_SAVE_CONTRIBUTOR()
Constant that represents the PDF save contributor
public static BBjString PNG_IMAGE$=#Translations!.getTranslation("png.image")
Translated text for png image
public static BBjNumber PPTX_SAVE_CONTRIBUTOR=BBJasperView.getPPTX_SAVE_CONTRIBUTOR()
Constant that represents the PPTX save contributor
public static BBjString PREVIOUS_PAGE$=#Translations!.getTranslation("previous.page")
Translated text for previous page
public static BBjString PREVIOUS_PAGE_TOOL_BUTTON_NAME$="BBJVPreviousPageToolButton"
Previous page tool button name
public static BBjString PRINT$=#Translations!.getTranslation("print")
Translated text for print
public static BBjNumber PRINT_SAVE_CONTRIBUTOR=BBJasperView.getPRINT_SAVE_CONTRIBUTOR()
Constant that represents the PRINT save contributor
public static BBjString PRINT_TOOL_BUTTON_NAME$="BBJVPrintToolButton"
Print tool button name
public static BBjString RELOAD$=#Translations!.getTranslation("reload")
Translated text for reload
public static BBjString RELOAD_TOOL_BUTTON_NAME$="BBJVReloadToolButton"
Reload tool button name
public static BBjNumber RTF_SAVE_CONTRIBUTOR=BBJasperView.getRTF_SAVE_CONTRIBUTOR()
Constant that represents the RTF save contributor
public static BBjString SAVE$=#Translations!.getTranslation("save")
Translated text for save
public static BBjString SAVE_AS$=#Translations!.getTranslation("save.as")
Translated text for save-as
public static BBjString SAVE_AS_GOOGLE_DOCUMENT$=#Translations!.getTranslation("save.as.google.document")
Translated text for save as google document
public static BBjString SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$="BBJVSaveAsGoogleDocumentMenuItem"
Save as google docment item name
public static BBjString SAVE_AS_MENU_ITEM_NAME$="BBJVSaveAsMenuItem"
Save as menu item name
public static BBjString SAVE_MENU_BUTTON_NAME$="BBJVSaveMenuButton"
Save menu button name
public static BBjNumber SAVE_MENU_BUTTON_WIDTH
Width of the save menu button, the default is 39
public static BBjString SAVE_MENU_ITEM_NAME$="BBJVSaveMenuItem"
Save menu item name
public static BBjNumber SCROLL_BAR_SIZE
Height and width of the scroll bars, the defaults are set the UI
public BBjNumber ShowFileOverwriteMsg
Flag to show overwrite save warning, by default this is TRUE
public static BBjNumber SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR=BBJasperView.getSINGLE_SHEET_XLS_SAVE_CONTRIBUTOR()
Constant that represents the single sheet XLS save contributor
public static BBjNumber STATUS_BAR_HEIGHT
Height of the status bar, the default is 20
public static BBjString STATUS_BAR_NAME$="BBJVStatusBar"
Status bar name
public static BBjString TOOL_BAR_CHILD_WINDOW_NAME$="BBJVToolBarChildWindow"
Tool bar child window name
public static BBjNumber TOOL_BAR_CONTROL_HEIGHT
Height of the tool bar controls, the default is 22
public static BBjNumber TOOL_BAR_CONTROL_INTERSPACE
The space between controls on the tool bar, the default is 2
public static BBjNumber TOOL_BAR_CONTROL_Y
Y location of the tool bar controls, the default is 3
public static BBjNumber TOOL_BAR_HEIGHT
Height of the tool bar, the default is the TOOL_BAR_CONTROL_HEIGHT + 7
public static BBjNumber TOOL_BAR_SPACER_WIDTH
Width of the tool bar spacer, the default is 8
public static BBjNumber TOOL_BUTTON_ERROR=503
Constant that represents a tool button error
public static BBjNumber TOOL_BUTTON_WIDTH
Width of the tool buttons, the default is 22
public static BBjNumber TXT_SAVE_CONTRIBUTOR=BBJasperView.getTXT_SAVE_CONTRIBUTOR()
Constant that represents the TXT save contributor
public BBJasperViewerWindow ViewerWindow!
Viewer window
public static BBjNumber WINDOW_ERROR=501
Constant that represents a window error
public static BBjNumber XLSX_SAVE_CONTRIBUTOR=BBJasperView.getXLSX_SAVE_CONTRIBUTOR()
Constant that represents the multiple sheet XLSX save contributor
public static BBjNumber XML_SAVE_CONTRIBUTOR=BBJasperView.getXML_SAVE_CONTRIBUTOR()
Constant that represents the XML save contributor
public static BBjString ZOOM_IN$=#Translations!.getTranslation("zoom.in")
Translated text for zoom in
public static BBjString ZOOM_IN_TOOL_BUTTON_NAME$="BBJVZoomInToolButton"
Zoom in tool button name
public static BBjNumber ZOOM_LIST_EDIT_BOX_WIDTH
Width of the zoom list edit, the default is 80
public static BBjString ZOOM_LIST_EDIT_NAME$="BBJVZoomListEdit"
Zoom list edit name
public static BBjString ZOOM_OUT$=#Translations!.getTranslation("zoom.out")
Translated text for zoom out
public static BBjString ZOOM_OUT_TOOL_BUTTON_NAME$="BBJVZoomOutToolButton"
Zoom out tool button name
public static BBjString ZOOM_RATIO$=#Translations!.getTranslation("zoom.ratio")
Translated text for zoom ratio
public BBJasperViewerControl(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height)
Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, and control height
p_report!
A BBJasperReport objectp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlpublic BBJasperViewerControl(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height)
Constructor Constructs a BBJasperViewerControl given a BBjVector containing BBJasperReport objects, BBjWindow object, control id, control x, control y, control width, and control height
p_reports!
BBjVector containing BBJasperReport objectsp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer control 16.0
public BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height)
Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, and control height
p_jasperPrint!
A JasperPrint objectp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer control 12.0
public BBJasperViewerControl(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 BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
p_report!
A BBJasperReport objectp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlp_fitType
Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGEpublic BBJasperViewerControl(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 BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
p_reports!
BBjVector that contains BBJasperReport objectsp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlp_fitType
Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE 16.0
public BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)
Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type
p_jasperPrint!
A JasperPrint objectp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlp_fitType
Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE 12.0
public BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, 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 BBJasperViewerControl given a BBJasperViewerWindow object, BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
p_viewerWindow!
A BBJasperViewerWindow objectp_reports!
BBjVector that contains BBJasperReport objectsp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlp_fitType
Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE 16.0
public BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType)
Constructor Constructs a BBJasperViewerControl given a BBJasperViewer object, JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type
p_viewerWindow!
A BBJasperViewer objectp_jasperPrint!
A JasperPrint objectp_window!
A BBjWindow object which will house the controlp_id
ID for the viewer controlp_x
X location for the viewer controlp_y
Y location for the viewer controlp_width
Width of the viewer controlp_height
Height of the viewer controlp_fitType
Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE 16.0
public void addSaveContributor(BBjNumber p_type)
addSaveContributor Adds a save contributor
p_type
Specify one of the following types: PDF_SAVE_CONTRIBUTOR, HTML_SAVE_CONTRIBUTOR, XML_SAVE_CONTRIBUTOR, EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR, SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR, MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR, XLSX_SAVE_CONTRIBUTOR, RTF_SAVE_CONTRIBUTOR, ODT_SAVE_CONTRIBUTOR, CSV_SAVE_CONTRIBUTOR, or PRINT_SAVE_CONTRIBUTORpublic BBjToolButton addToolbarButton(BBjString p_image$, BBjString p_shortCue$)
addToolButton Adds a tool button at the end of the tool bar
p_image$
Image for the tool buttonp_shortCue$
Short cue for the tool buttonpublic BBjToolButton addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjString p_name$)
addToolButton Adds a tool button at the end of the tool bar
p_image$
Image for the tool buttonp_shortCue$
Short cue for the tool buttonp_name$
Name for the tool buttonpublic BBjToolButton addToolbarButton(BBjNumber p_IconImageListIndex, BBjString p_shortCue$, BBjString p_name$)
addToolButton Adds a tool button at the end of the tool bar
p_IconImageListIndex
Image for the tool button indicated by the index in the IconImageListp_shortCue$
Short cue for the tool buttonp_name$
Name for the tool buttonpublic BBjToolButton addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index)
addToolButton Adds a tool button to the tool bar at the specified index
p_image$
Image for the tool buttonp_width
Width of the tool buttonp_height
Height of the tool buttonp_text$
Text of the tool buttonp_id
ID of the tool buttonp_index
Tool bar control index at which to add the tool buttonpublic BBjToolButton addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index, BBjString p_name$)
addToolButton Adds a tool button to the tool bar at the specified index
p_image$
Image for the tool buttonp_width
Width of the tool buttonp_height
Height of the tool buttonp_text$
Text of the tool buttonp_id
ID of the tool buttonp_index
Tool bar control index at which to add the tool buttonp_name$
Name of the tool buttonpublic BBjChildWindow addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index)
addToolbarChildWindow Adds a child window to the tool bar at the specified index
p_width
Width of the child windowp_height
Height of the child windowp_title$
Title of the child windowp_flags$
Flags for the child windowp_index
Tool bar control index at which to add the child windowpublic BBjChildWindow addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index, BBjString p_name$)
addToolbarChildWindow Adds a child window to the tool bar at the specified index
p_width
Width of the child windowp_height
Height of the child windowp_title$
Title of the child windowp_flags$
Flags for the child windowp_index
Tool bar control index at which to add the child windowp_name$
Name for the child windowpublic void addToolbarSpacer()
addToolbarSpacer Adds a tool bar spacer at the end of the tool bar
public void addToolbarSpacer(BBjNumber p_index)
addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar
p_index
Tool bar control index at which to add the spacerpublic void addToolbarSpacer(BBjNumber p_index, BBjString p_name$)
addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar
p_index
Tool bar control index at which to add the spacerp_name$
Name of the spacerpublic void addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, BBjString p_callbackRoutine!)
addToolButton Adds a tool button to the tool bar
p_id
ID of the tool buttonp_text$
Text of the tool buttonp_shortCue$
Short cue for the tool buttonp_image$
Image for the tool buttonp_callbackRoutine!
Routine to callback when the tool button is pressedpublic void addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
addToolButton Adds a tool button to the tool bar
p_id
ID of the tool buttonp_text$
Text of the tool buttonp_shortCue$
Short cue for the tool buttonp_image$
Image for the tool buttonp_callbackObject!
CustomObject to callback when the tool button is pressedp_callbackRoutine!
Routine to callback when the tool button is pressedpublic void addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index)
addToolButton Adds a tool button to the tool bar
p_id
ID of the tool buttonp_text$
Text of the tool buttonp_shortCue$
Short cue for the tool buttonp_image$
Image for the tool buttonp_callbackObject!
CustomObject to callback when the tool button is pressedp_callbackRoutine!
Routine to callback when the tool button is pressedp_width
Width of the tool buttonp_height
Height of the tool buttonp_index
Tool bar control index at which to add the tool button.public void addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index, BBjString p_name$)
addToolButton Adds a tool button to the tool bar
p_id
ID of the tool buttonp_text$
Text of the tool buttonp_shortCue$
Short cue for the tool buttonp_image$
Image for the tool buttonp_callbackObject!
CustomObject to callback when the tool button is pressedp_callbackRoutine!
Routine to callback when the tool button is pressedp_width
Width of the tool buttonp_height
Height of the tool buttonp_index
Tool bar control index at which to add the tool button.p_name
Name of the tool button.public void addViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!)
addViewerWindow Adds a viewer window to the vector of viewer windows
p_bbJasperViewerWindow!
BBJasperViewerWindow object to add to the vector of viewer windowspublic void closeAllViewerWindows()
closeAllViewerWindows Closes and destroys all windows that were created from this control
public void destroy()
destroy Destroys the viewer control
public void destroy(BBjNumber p_closeAllViewerWindows)
destroy Destroys the control and optionally all viewer windows that were created by this control
p_closeAllViewerWindows
Specify TRUE to destroy all viewer window that were created by this control, otherwise FALSEpublic void findReport()
findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find.
public HashMap getAllControls()
getAllControls Returns a HashMap containg all of the controls
public BBjControl getControl(BBjString p_controlName$)
getControl Returns a control given the control name
p_controlName$
Name of the BBjControl object to obtainpublic BBJasperCSVExporter getCSVExporter()
getCSVExporter Returns the CSV exporter which contains export options
11.0
public BBjNumber getDefaultSave()
getDefaultSave Returns the default save location
11.0
public BBJasperDOCXExporter getDOCXExporter()
getDOCXExporter Returns the DOCX exporter which contains export options
11.0
public EmailDialog getEmailDialog()
getEmailDialog Returns the EmailDialog object so that it can be customized
EmailDialog
public BBjNumber getFitType()
getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
public GDocSaveDialog getGDocSaveDialog()
getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized
public BBjNumber getHeight()
getHeight Returns the height of the viewer control
public BBJasperHTMLExporter getHTMLExporter()
getHTMLExporter Returns the HTML exporter which contains export options
11.0
public net.sf.jasperreports.engine.JasperPrint getJasperPrint()
getJasperPrint Returns the JasperPrint object
public BBJasperODSExporter getODSExporter()
getODSExporter Returns the ODS exporter which contains export options
11.0
public BBJasperODTExporter getODTExporter()
getODTExporter Returns the ODT exporter which contains export options
11.0
public BBjNumber getPage()
getPage Return the current page
public BBJasperPDFExporter getPDFExporter()
getPDFExporter Returns the PDF exporter which contains export options
11.0
public BBJasperPPTXExporter getPPTXExporter()
getPPTXExporter Returns the PPTX exporter which contains export options
11.0
public BBJasperjavax.print.PrintServiceExporter getPrintServiceExporter()
getPrintServiceExporter Returns the PrintService exporter which contains export options
11.0
public BBnet.sf.jasperreports.engine.JasperReport getReport()
getReport Returns the BBJasperReport object
public BBjVector getReports()
getReports Returns a BBjVector containing the BBJasperReport objects
public BBJasperRTFExporter getRTFExporter()
getRTFExporter Returns the RTF exporter which contains export options
11.0
public BBjPopupMenu getSavePopupMenu()
geSavePopupMenu Returns the save popup menu
public BBjNumber getShowFileDialogOnInitDefaultSave()
getShowFileDialogOnInitDefaultSave Returns if the file save dialog should be shown on the intitial save
11.0
public BBjNumber getShowGoogleDialogOnInitDefaultSave()
getShowGoogleDialogOnInitDefaultSave Returns if the Google save dialog should be shown on the intitial save
11.0
public BBJasperTabbedView getTabbedView()
getTabbedView Returns the tabbed view
public BBjChildWindow getToolbar()
getToolbar Returns the tool bar
public BBjControl getToolbarControlAt(BBjNumber p_index)
getToolbarControlAt Returns a tool bar control at the specified index
public BBJasperTXTExporter getTXTExporter()
getTXTExporter Returns the TXT exporter which contains export options
11.0
public BBJasperView getView()
getView Returns the current view
public BBjNumber getWidth()
getWidth Returns the width of the viewer control
public BBjNumber getX()
getX Returns the X location of the viewer control
public BBJasperXHTMLExporter getXHTMLExporter()
getXHTMLExporter Returns the XHTML exporter which contains export options
11.0
public BBJasperXLSExporter getXLSExporter()
getXLSExporter Returns the XLS exporter which contains export options
11.0
public BBJasperXLSXExporter getXLSXExporter()
getXLSXExporter Returns the XLSX exporter which contains export options
11.0
public BBJasperXMLExporter getXMLExporter()
getXMLExporter Returns the XML exporter which contains export options
11.0
public BBjNumber getY()
getY Returns the Y location of the viewer control
public BBjNumber getZoomLevel()
getZoomLevel Returns the current zoom level
public void OnActualSizeToolButton(BBjToolButtonPushEvent p_event!)
OnActualSizeToolButton Callback for when the acutal size tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnCreateImageToolButton(BBjToolButtonPushEvent p_event!)
OnCreateImageToolButton Callback for when the create image tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnEmailToolButton(BBjToolButtonPushEvent p_event!)
OnEmailToolButton Callback for when the email tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnFindToolButton(BBjToolButtonPushEvent p_event!)
OnFindToolButton Callback for when the find tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnFirstToolButton(BBjToolButtonPushEvent p_event!)
OnFirstToolButton Callback for when the first page tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnFitPageToolButton(BBjToolButtonPushEvent p_event!)
OnFitPageToolButton Callback for when the fit to page tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnFitWidthToolButton(BBjToolButtonPushEvent p_event!)
OnFitWidthToolButton Callback for when the fit to width tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnKeypress(BBjKeypressEvent p_keyPressEvent!)
public void OnLastToolButton(BBjToolButtonPushEvent p_event!)
OnLastToolButton Callback for when the last page tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnNextToolButton(BBjToolButtonPushEvent p_event!)
OnNextToolButton Callback for when the next page tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnPageNumberEdit(BBjEditModifyEvent p_event!)
OnPageNumberEdit Callback for when a key is pressed in the page number inputN
p_event!
BBjEditModifyEvent objectpublic void OnPreviousToolButton(BBjToolButtonPushEvent p_event!)
OnPreviousToolButton Callback for when the previous page tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnPrintToolButton(BBjToolButtonPushEvent p_event!)
OnPrintToolButton Callback for when the print tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnReloadToolButton(BBjToolButtonPushEvent p_event!)
OnReloadToolButton Callback for when the reload tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnReportWindowMouseUp(BBjMouseUpEvent p_event!)
Called when the mouse is pressed up over the report window
p_event!
BBjMouseUpEvent that contains event informationpublic void OnSave(BBjSysGuiEvent p_event!)
OnSave Callback run when user selects to save the report
p_event!
BBjSysGuiEvent objectpublic void OnSaveAs(BBjSysGuiEvent p_event!)
OnSaveAs Callback run when user selects to save-as the report
p_event!
BBjSysGuiEvent objectpublic void OnSaveGoogleDoc(BBjPopupSelectEvent p_event!)
OnSaveGoogleDoc Callback for when the save google doc menu item is selected
BBjPopupSelectEvent
objectpublic void OnToolBarWindowMouseUp(BBjMouseUpEvent p_event!)
Called when the mouse is pressed up over the tool bar window
p_event!
BBjMouseUpEvent that contains event informationpublic void OnToolButtonPush(BBjToolButtonPushEvent p_event!)
OnToolButtonPush Callback called when a tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnZoomGainedFocus(BBjGainedFocusEvent p_gainedFocusEvent!)
public void OnZoomInToolButton(BBjToolButtonPushEvent p_event!)
OnZoomInToolButton Callback for when the zoom in tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void OnZoomListEditSelect(BBjListSelectEvent p_event!)
OnZoomListEditSelect Callback for when a zoom level selection is made
p_event!
BBjListSelectEvent objectpublic void OnZoomLostFocus(BBjLostFocusEvent p_lostFocusEvent!)
public void OnZoomOutToolButton(BBjToolButtonPushEvent p_event!)
OnZoomOutToolButton Callback for when the zoom out tool button is pushed
p_event!
BBjToolButtonPushEvent objectpublic void refresh()
refresh Refreshes the image for the current report page and zoom level
public void refreshToolbar()
refreshToolbar Refreshes the toolbar in case controls have been added/removed outside the class
public void reload()
reload Refills the report and refreshes the viewer
public void removeSaveContributor(BBjNumber p_type)
removeSaveContributor Removes a save contributor
p_type
Specify one of the following types: PDF_SAVE_CONTRIBUTOR, HTML_SAVE_CONTRIBUTOR, XML_SAVE_CONTRIBUTOR, EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR, SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR, MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR, XLSX_SAVE_CONTRIBUTOR, RTF_SAVE_CONTRIBUTOR, ODT_SAVE_CONTRIBUTOR, CSV_SAVE_CONTRIBUTOR, or PRINT_SAVE_CONTRIBUTORpublic void removeViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!)
removeViewerWindow Removes a viewer window from the vector of viewer windows
p_bbJasperViewerWindow!
BBJasperViewerWindow object to remove from the vector of viewer windowspublic void selectGoogleDefaultType(BBjString p_selectType$)
selectGoogleDefaultType Selects the default Google document type
p_selectType$
Default Google document typepublic void setActualSize()
setActualSize Sets the report image to the actual size
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
public void setCSVExporter(BBJasperCSVExporter p_csvExporter!)
setCSVExporter Sets the CSV exporter which contains export options
p_csvExporter!
BBJasperCSVExporter object which contains export options 11.0
public void setDefaultSave(BBjNumber p_defaultSave)
setDefaultSave Sets the default save location
p_defaultSave
Set to either DEFAULT_SAVE_DISK or DEFAULT_SAVE_GOOGLE. Default is DEFAULT_SAVE_DISK 11.0
public void setDefaultSaveContributor(BBjNumber p_type)
setDefaultSaveContributor Sets the default save contributor
p_type
Specify one of the following types: PDF_SAVE_CONTRIBUTOR, HTML_SAVE_CONTRIBUTOR, XML_SAVE_CONTRIBUTOR, EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR, SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR, MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR, XLSX_SAVE_CONTRIBUTOR, RTF_SAVE_CONTRIBUTOR, ODT_SAVE_CONTRIBUTOR, CSV_SAVE_CONTRIBUTOR, or PRINT_SAVE_CONTRIBUTOR 11.0
public void setDefaultSaveFile(BBjString p_saveFile$)
setDefaultSaveFile Sets the default save file
p_saveFile$
Name of file to set as the default save file 11.0
public void setDefaultSaveFolder(BBjString p_saveFolder$)
setDefaultSaveFolder Sets the default save folder
p_saveFolder$
Name of folder to set as the default save folder 11.0
public void setDOCXExporter(BBJasperDOCXExporter p_docxExporter!)
setDOCXExporter Sets the DOCX exporter which contains export options
p_docxExporter!
BBJasperDOCXExporter object which contains export options 11.0
public void setFileSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)
setFileSaveCallback Sets a callback routine to call when a file save occurs
p_eventName$
Event name to use when calling the callback routinep_callbackRoutine!
Routine to callback when a file save occurspublic void setFileSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
setFileSaveCallback Sets a callback routine to call when a file save occurs
p_eventName$
Event name to use when calling the callback routinep_callbackObject!
CustomObject to callback when a file save occursp_callbackRoutine!
Routine to callback when a file save occurspublic void setFindCaseSensitivity(BBjNumber p_findCaseSensitivity)
public void setFindHighlight(BBjNumber p_findHighlight)
public void setFindMatch(BBjNumber p_findMatch)
public void setFindScope(BBjNumber p_findScope)
public void setFindText(BBjString p_findText$)
setFindText Sets the find text
p_findText$
Text to find forpublic void setFitPage()
setFitPage Sets the report image to the fit the page
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
public void setFitType(BBjNumber p_fitType)
setFitType Sets the report image to fit based on the provided fit type
The fit type can be set using static field variables like BBJasperViewerControl.getFIT_TYPE_ACTUAL(), BBJasperViewerControl.getFIT_TYPE_WIDTH(), or BBJasperViewerControl.getFIT_TYPE_PAGE()
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
p_fitType
Specifies one the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGEpublic void setFitWidth()
setFitWidth Sets the report image to the fit the width of the container
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
public void setGoogleDefaultDocument(BBjString p_defaultDocument$)
setGoogleDefaultDocument Sets the default Google document
p_defaultDocument$
Default Google documentpublic void setGoogleDefaultFolder(BBjString p_defaultFolder$)
setGoogleDefaultFolder Sets the default Google folder
p_defaultFolder$
Default Google folderpublic void setGoogleDefaultType(BBjString p_defaultType$)
setGoogleDefaultType Sets the default Google document type
p_defaultType$
Default Google document typepublic void setGoogleDocSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
p_eventName$
Event to specify during the callbackp_callbackRoutine!
Callback routine to callpublic void setGoogleDocSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
p_eventName$
Event to specify during the callbackp_callbackObject!
Callback object to callp_callbackRoutine!
Callback routine to callpublic void setHTMLExporter(BBJasperHTMLExporter p_htmlExporter!)
setHTMLExporter Sets the HTML exporter which contains export options
p_htmlExporter!
BBJasperHTMLExporter object which contains export options 11.0
public void setLocation(BBjNumber p_x, BBjNumber p_y)
setLocation Sets the location of the viewer control
p_x
X location of the viewer controlp_y
Y location of the viewer controlpublic void setMouseClickCallback(BBjString p_eventName$, BBjString p_callbackRoutine!)
setMouseClickCallback Sets a callback routine to call when the mouse is clicked
p_eventName$
Event name to use when calling the callback routinep_callbackRoutine!
Routine to callback when a file save occurspublic void setMouseClickCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
setMouseClickCallback Sets a callback routine to call when the mouse is clicked
p_eventName$
Event name to use when calling the callback routinep_callbackObject!
CustomObject to callback when a file save occursp_callbackRoutine!
Routine to callback when a file save occurspublic void setODSExporter(BBJasperODSExporter p_odsExporter!)
setODSExporter Sets the ODS exporter which contains export options
p_odsExporter!
BBJasperODSExporter object which contains export options 11.0
public void setODTExporter(BBJasperODTExporter p_odtExporter!)
setODTExporter Sets the ODT exporter which contains export options
p_odtExporter!
BBJasperODTExporter object which contains export options 11.0
public void setPage(BBjNumber p_page)
setPage Sets the current page
p_page
Specifies the report page to make currentpublic void setPDFExporter(BBJasperPDFExporter p_pdfExporter!)
setPDFExporter Sets the PDF exporter which contains export options
p_pdfExporter!
BBJasperPDFExporter object which contains export options 11.0
public void setPPTXExporter(BBJasperPPTXExporter p_pptxExporter!)
setPPTXExporter Sets the PPTX exporter which contains export options
p_pptxExporter!
BBJasperPPTXExporter object which contains export options 11.0
public void setPrintServiceExporter(BBJasperPrintServiceExporter p_printServiceExporter!)
setPrintServiceExporter Sets the PrintService exporter which contains export options
p_printServiceExporter!
BBJasperPrintServiceExporter object which contains export options 11.0
public void setRTFExporter(BBJasperRTFExporter p_rtfExporter!)
setRTFExporter Sets the RTF exporter which contains export options
p_rtfExporter!
BBJasperRTFExporter object which contains export options 11.0
public void setShowFileDialogOnInitDefaultSave(BBjNumber p_showFileDialogOnInitDefaultSave)
setShowFileDialogOnInitDefaultSave Sets if the file save dialog should be shown on the intitial save
p_showFileDialogOnInitDefaultSave
Set to TRUE if the file save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE 11.0
public void setShowGoogleDialogOnInitDefaultSave(BBjNumber p_showGoogleDialogOnInitDefaultSave)
setShowGoogleDialogOnInitDefaultSave Sets if the Google save dialog should be shown on the intitial save
p_showGoogleDialogOnInitDefaultSave
Set to TRUE if the Google save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE 11.0
public void setSize(BBjNumber p_width, BBjNumber p_height)
setSize Sets the sizes of the viewer control
p_width
Width of the viewer controlp_height
Height of the viewer controlpublic void setStatusBarText(BBjString p_statusBarText$)
setStatusBarText Sets the text in the status bar
p_statusBarText$
Text to display in the status barpublic void setTXTExporter(BBJasperTXTExporter p_txtExporter!)
setTXTExporter Sets the TXT exporter which contains export options
p_txtExporter!
BBJasperTXTExporter object which contains export options 11.0
public void setView(BBJasperView p_view!)
setView Set the current view for the viewer control
p_view!
BBJasperView object that will be the current viewpublic void setVisible(BBjNumber p_visible)
setVisible Sets the visibility of the viewer control
p_visible
Specify TRUE (1) to make the viewer control visible, otherwise FALSE (0)public void setXHTMLExporter(BBJasperXHTMLExporter p_xhtmlExporter!)
setXHTMLExporter Sets the XHTML exporter which contains export options
p_xhtmlExporter!
BBJasperXHTMLExporter object which contains export options 11.0
public void setXLSExporter(BBJasperXLSExporter p_xlsExporter!)
setXLSExporter Sets the XLS exporter which contains export options
p_xlsExporter!
BBJasperXLSExporter object which contains export options 11.0
public void setXLSXExporter(BBJasperXLSXExporter p_xlsxExporter!)
setXLSXExporter Sets the XLSX exporter which contains export options
p_xlsxExporter!
BBJasperXLSXExporter object which contains export options 11.0
public void setXMLExporter(BBJasperXMLExporter p_xmlExporter!)
setXMLExporter Sets the XML exporter which contains export options
p_xmlExporter!
BBJasperXMLExporter object which contains export options 11.0
public void setZoomLevel(BBjNumber p_zoomLevel)
setZoomLevel Sets the report image to the specifed zoom level
p_zoomLevel
Specifies the zoom levelpublic void updateControls()
updateControls Updates the controls based on the current view
public void updateNavButtonControls()
updateNavButtons Updates the navigation button to enabled/disabled states
public void updatePageControls()
updatePageControls Updates the page controls
public void updateZoomControl()
updateZoomControl Updates the zoom control to the current report zoom