Documentation Overview

Packages 
Package Description
BBJSONResolver
Allows BBj to easily access data within a JSON document with the use of dot-delimited paths. @since 18.0
BBJasper
Provides BBj access to run, view, export, and print JasperReports @since 9.0
BBTranslator
The BBTranslator utility is a BBj CustomObject that utilizes a translation bundle for localization support. @author: bhipple @since BBj 9.00
BBUtils
In BBj 12.0 and higher, the BBUtils utility is a generalized utility that provides information and interactivity with the Jetty web server, registers BUI applications, and more. @authors: bhipple, rlance, ndecker @since BBj 12.00
BBWebClient
Provides BBj a way to communicate with web servers @since 18.0
BBXImage
In BBj 9.00 and higher, the BBXImage is a BBj Custom Class that aids in image manipulation including the ability to resize, rotate, adjust opacity, add borders, drop shadows, reflections, and more.

THROWn Error Codes:

  • 313: Invalid color string provided.
  • 400: Invalid image source provided.
@author Nick Decker @version 1.5 @since BBj 9.00 (2008-28-01)
BBjBUIDialChart
In BBj 20.00 and higher, the BBjBUIDialChart is a BBj Custom Class to help build dial charts more easily by acting as a proxy between a BBj program that wants to use a dial chart and the underlying JFreeChart. Because all of the charting is done on the server and the client window is updated with a snapshot of the server-side chart, no client objects are used in this class and it may be used in both BUI or GUI deployments. @author: ndecker @since BBj 20.00
BBjCalendarWidget
BBjCalendarWidget @author ndecker The BBjCalendarWidget is a BBj Interface that serves as a plug-in to the FullCalendar JavaScript-based calendar control. For the full copyright and license information, please see the LICENSE.txt files distributed with this source code in the appropriate lib directory. @see FullCalendar for further information on the underlying JavaScript-based calendar. @since BBj 21.00
BBjDialChartProgress
In BBj 20.00 and higher, the BBjDialChartProgress is a BBj Custom Class to help build dial charts for displaying progress (instead of a typical progress bar) more easily by acting as a proxy between a BBj program that wants to use a dial chart and the underlying JFreeChart. Because all of the charting is done on the server and the client window is updated with a snapshot of the server-side chart, no client objects are used in this class and it may be used in both BUI or GUI deployments. @author: ndecker @since BBj 20.00
BBjGridExWidget
The package exports a few helper classes along with the BBjGridExWidget class which is the entry point of the plugin. Most of the time you only need to use the BBjGridExWidget class from it
Colors
Colors In BBj 20.10 and higher, Colors is a BBj Custom Class that provides commonly-used routines to convert and format colors in a variety of models including Java Color, BBjColor, and RGB, HSL, and hexadecimal representation.

@author ndecker @since BBj 20.10

Dashboard
A Dashboard utility that facilitates the visualization of data via widgets that may contain various types of charts, grids, images, reports, and rich text. @authors: ndecker, bhipple @since BBj 14.00
DemoUtils
DemoUtils In BBj 20.01 and higher, the DemoUtils is a BBj Custom Class that provides commonly-used routines for demo programs

There are a variety of methods that provide useful functionality, such as getting a file's contents, copying files, stripping directories from a file's path, reading/writing application preferences, etc.

THROWn Error Codes:

  • 700: Missing file. The specified file does not exist.
  • 705: Error during file operation, such as reading in a source file to copy to target file.
  • 710: Invalid BBjControl. The BBjControl is null(), invalid, does not exist, or does not implement required method.
  • 715: Invalid control/object provided. The control or object is null(), invalid, does not exist, or is empty.
  • 720: Error reading or writing a cookie. The get/setUserProperty() method failed with the provided error information.
  • 725: Error getting the BBjThinClient.
  • 730: Invalid directory provided. The provided path does not reference a directory
@author ndecker @since BBj 20.01
DialogWizard
Wizard which creates dialogs iteratively from application resource files @see Overview @since 12.0
Email
Provides BBj access to email functionality @since 10.0
GoldMineIntegration
goldMineWebService.bbj @author ndecker @since BBj 16.00
GxCellEditors
The package contains the classes of all supported CellEditor components
GxClientEvents
The package exports a collection of classes which describe The client events as BBj models
GxClientModels
The package exports a collection of classes which describe the client models in BBj.
GxColumns
The package exports all the required classes to create new columns and column groups
GxContextMenu
The package exports a collection of classes to manipulate the grid's context menu
GxExpressions
The package exports a collection of predefined expression which can be used directly in columns.
GxFilters
The package contains the classes for all the supported Filter components
GxOptions
The package exports a collection of option interfaces which are used to configure the grid and the columns
GxRenderers
The package contains the classes of all supported CellRenderer components
GxSidebar
The package contains a collection of classes to manipulate the grid's sidebar
GxStatusBar
The module contains a collection of classes to manipulate the grid's statusbar
QVGrid
QuickView Grid (QVGrid) The QuickView Grid utility class is a BBj custom object that implements grid paging for SQL based queries. It handles the vertical scrolling through the result set and coordination with user actions to load at most the number of visible grid rows at any one time. This reduces the load that the grid has to manage, thus increasing display speed, especially for larger data sets. The main program makes the SQL (JDBC) connection and issues the SELECT command to generate the initial SQL ResultSet object that is then used to populate the new BASIS Components ResultSet (BCRS). The BCRS is modelled closely after the Java SQL ResultSet, but is 0-based and does not require the connection to stay active. The developer has the choice of letting the result set metadata be automatically built from the SQL result set or setting the metadata specifically, including custom attributes picked up by the QVGrid using helper methods found in the BCRS class. The prepared BCRS object is registered with the QVGrid object. The QVGrid uses a BBjStandardGrid and provides all non-editing related BBj grid methods, either handling the action itself or relaying it to the underlying BBj grid. There is a provision for certain "shared" actions, such as selecting a grid row, that is handled by the QVGrid first and then relayed as a "process event" to the main program. This allows the QVGrid to be used as an alternative to the BBjStandardGrid. The QVGrid also offers a "RowListener" interface, that when implemented and registered with the QVGrid object, allows for the main program to interact when the data rows are being processed on their way to the grid. This can be used to set particular grid row and/or cell attributes based on the data, or whether the data row should be included in the grid at all. An accompanying test program under utils/qvgrid/qvgridtest.bbj, is the best source for a practical example of using the new class. @since BBj 16.00
ScreenCapture
screencapture.bbj @since BBj 14.00
gappsv3
GCalendarAPI.bbj @authors shaney, bhipple @since BBj 14.00