Translated text for find results
Translated text for found
Translated text for not found
Translated text for selected
Translated text for default find text
A keypress model which is received from the client.
Note The the key model is available for the following grid events only
ON_GRID_CELL_CLICK
and ON_GRID_CELL_DOUBLE_CLICK
. In all other cases , it will be null()
Set to true to specify that the sort should take into account accented characters, if this feature is turned on the sort will perform slower.
#Configuration
#GridRenderer
Used to accept or reject the value that the user has just entered into the grid control Note: The QVGrid is not editable, so this method has no effect.
Activate or deactivates the widget control by setting its visibility and creating the Widget if necessary
Activates/Deactivates the dashboard widget control
Sets the active dashboard widget control that is part of the dashboard category control
Active status attribute
Returns the active status of the widget
Translated text for actual size
Translated text for actual size
Actual size menu item name
Actual size menu item name
Actual size
Add new column sorting to the model
Add new row
Add Language File This method can be used for new languages, or to overrule the default translation file that is shipped with the grid plugin
An array of rows to add
or relocating.)
Align the current grid with the passed one
Aligning two or more grids means columns will be kept aligned in all grids. In other words, column changes to one grid (column width, column order, column visibility etc) are reflected in the other grid. This is useful if you have two grids, one above the other such that their columns are vertically aligned, and you want to keep the columns aligned.
Adds the contents of the file represented by p_file$, with the MIME type p_mimetype$, to the set of static resources in the BBjAppServer.
If the resource already exists, the existing version will be returned.
This method allows you to add various resources, including the following mime types which are defined as constants:
Example
BBUtils.addAppServerResource(myPngFilePath$, BBUtils.getMIME_TYPE_PNG())
Creates and returns an AreaChartWidget
dashboard widget
Creates and returns an AreaChartWidget
dashboard widget
Creates and returns an AreaChartWidget
dashboard widget
Creates and returns an AreaChartWidget
dashboard widget
Add one participant to the list of people who are attending the meeting.
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
addBcc Sets the first recipient or an additional recipient to the blind carbon copy field in an email's header before the email is sent. This value specifies the email address to receive a copy of the message. Other recipients of the message will not be able to see that the email was sent to the specified recipient.
Each invocation of this method takes one email address. Calling this method multiple times will construct a list of addresses to receive a copy of the message.
Adding a recipient to the "bcc" field is not the same as adding them to the "to" field as all other recipients, including those in the "to" and "cc" fields, will not see the entries in the "bcc" field.
addBcc Adds recipients to the "bcc" field in an email's header before the email is sent.
Add Calendar. (Not implemented. Subject to removal or relocating.)
addCc Sets the first recipient or adds an additional recipient to the "cc" field in an email's header before the email is sent. This value specifies the email addresses to receive a copy of the message.
Each invocation of this method takes one email address. Calling this method multiple times will construct a list of addresses to receive a copy of the message.
Adding a recipient to the "cc"" field is the same as adding it to the "to" field. Adding the recipient in the "cc" field rather than the "to" field indicates that the message is relevant to them, but is not a direct correspondence with them.
addCc Adds recipients to the "cc" field in an email's header before the email is sent.
Adds a CSS style name to a grid cell
Adds a threshold marker for the chart's domain (markers are typically added to plots to highlight or draw attention to specific values) - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis.
This method allows you to add multiple domain markers to a chart while specifying the label text and position. In contrast, the setChartDomainMarker() methods only allow to you specify a single marker and does not include a label for the marker.
Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer. Note that this does not apply to charts without a domain, such as a PieChart or RingChart.
The rectangle anchor will typically be a value like RectangleAnchor.TOP, RectangleAnchor.CENTER, RectangleAnchor.TOP_LEFT, RectangleAnchor.BOTTOM_RIGHT.
The text anchor will typically be a value like TextAnchor.TOP, TextAnchor.CENTER, TextAnchor.CENTER_LEFT, TextAnchor.CENTER_RIGHT, TextAnchor.TOP_LEFT, TextAnchor.BOTTOM_RIGHT.
Adds a threshold marker for the chart's range (markers are typically added to plots to highlight or draw attention to specific values) - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis.
This method allows you to add multiple range markers to a chart while specifying the label text and position. In contrast, the setChartRangeMarker() methods only allow to you specify a single marker and does not include a label for the marker.
Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer. Note that this does not apply to charts without a range, such as a PieChart or RingChart.
The rectangle anchor will typically be a value like RectangleAnchor.TOP, RectangleAnchor.CENTER, RectangleAnchor.TOP_LEFT, RectangleAnchor.BOTTOM_RIGHT.
The text anchor will typically be a value like TextAnchor.TOP, TextAnchor.CENTER, TextAnchor.CENTER_LEFT, TextAnchor.CENTER_RIGHT, TextAnchor.TOP_LEFT, TextAnchor.BOTTOM_RIGHT.
Note that the range marker label will not display in a 3DLineChart due to a limitation in the underlying JFreeCharts libary. The range marker will still be rendered, but the label will be absent unless it's a different type of category chart.
Enable a chart toolbar item
#Enterprise
#Configuration
#API
Adds a child translation to the translations
Adds the provided class name string (or CSS style) such as "myclass1"
to the entry's vector of class names.
This method can be used in place of the setClassNames()
method as it adds the provided class name to the entry's vector of
class names. It may be easier to call this method if you only need to set a few tags, as the setClassNames()
method requires
you to create and populate a BBjVector (unless you use the version that takes a comma-delimited string).
Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS()
method to affect a calendar entry's display:
rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!)
rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
Method to overlay the BBXImage with a BBjColor (which usually has an alpha component)
Method to overlay the BBXImage with a color (which usually has an alpha component)
addColumn Adds a column given just its name
addColumn Adds a column with all of its attributes
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Group Vector of Columns
#Configuration
#ColumnsRenderer
Group Vector of Columns
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Adds a CSS style name to a grid column
Add statusbar component
Adds a dashboard category, which is used to group widgets, to the dashboard
Creates an active DashboardWidget
based on the provided widget and adds it to the current category
Creates an active or inactive DashboardWidget
based on the provided widget and adds it to the current category
Adds a dashboard widget to the end of the dashboard category
addData Adds data to the body of the message allowing the mime type to be specified.
May be called once or multiple times to add data to the body of the email message. Data will be added cumulatively
addData Adds data to the body of the message allowing the mime type to be specified.
May be called once or multiple times to add data to the body of the email message. Data will be added cumulatively
addEmailAddress Adds an email address to the appropriate list
addEmailAddress Adds an email address to the appropriate list
addEmailAttachment Adds a file as an email attachment
addEmailContact Adds an email contact to the contact list
addEmailContact Adds an email contact to the appropriate list
addEmailContacts Adds email contacts to the contact list
addEmailContacts Adds email contacts to the appropriate list
Adds an embedded widget to the embbeded widget set
Adds several JsonObject entries in a JsonArray to the calendar at once for improved performance.
Note: Adding multiple entries to the calendar via this method will not trigger the
CalendarAPI.ON_CALENDAR_ENTRY_ADD()
event.
Adds several entries of type CalendarEntry
to the calendar at once for improved performance.
Note: Adding multiple entries to the calendar via this method will not trigger the
CalendarAPI.ON_CALENDAR_ENTRY_ADD()
event.
Adds an entry to the calendar given a JsonObject representation of the calendar entry.
Note: Adding entries to the calendar via this method will trigger the
CalendarAPI.ON_CALENDAR_ENTRY_ADD()
event.
Adds an entry to the calendar given a CalendarEntry
object.
Note: Adding entries to the calendar via this method will trigger the
CalendarAPI.ON_CALENDAR_ENTRY_ADD()
event.
Adds entries to the calendar from a CalendarEntrySource
.
Add an event to the calendar.
Adds the provided extended property to the entry's HashMap of extended properties given the property key and value.
Note that this method simply puts the provide key/value pair in the extended properties HashMap. If an entry in the HashMap already existed with that particular key, then it will be updated with the provided value.
This method can be used in place of the setExtendedProperties()
method as it adds the provided property to the entry's HashMap of extended properties. It may
be easier to call this method if you only need to set a few extended properties, as the setExtendedProperties()
method requires you to create and
populate a HashMap.
addField Adds a field to the database fields vector
addFile Adds a file attachment to the email message
May be called once or multiple times to add file attachments to the email message.
addFile Adds a file attachment to the email message
May be called once or multiple times to add file attachments to the email message.
addFile Adds a file attachment to the email message
May be called once or multiple times to add file attachments to the email message.
If the mime type is an empty string, then Apache Tika will be applied to try to detect the mime type.
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a BBjListButton type of filter to the widget and fills it with the supplied vector items
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a specified type of filter to the widget and fills it with the supplied vector items
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a BBjListButton type of filter to the widget and fills it with the supplied LinkedHashMap keys and values
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a specified type of filter to the widget and fills it with the supplied LinkedHashMap keys and values
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
Adds a filter to the dashboard control to filter values
Creates and returns a GridWidget
dashboard widget
Creates and returns a GridWidget
dashboard widget
Creates and returns a GridWidget
dashboard widget
Creates and returns a GridWidget
dashboard widget
Creates and returns a GridWidget
dashboard widget
Creates and returns an empty GridWidget
dashboard widget
Creates and returns a GridExWidget
dashboard widget based on a BASIS Components ResultSet that contains the data for the widget
Creates and returns a GridExWidget
dashboard widget using the BASIS Components to build a ResultSet based off of a data file, string template, and filter
Creates and returns a GridExWidget
dashboard widget using a connection string and SQL query
Creates and returns a GridExWidget
dashboard widget using a connection string, SQL query, and mode
Creates and returns a GridExWidget
dashboard widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data
Creates and returns a GridExWidget
dashboard widget using BBjVectors for the column header data and row data
addGroup Adds a group given just its column name (ie. group has to be a column)
Adds the specified header to the request.
Creates and returns an HtmlViewWidget
dashboard widget
Creates and returns an HtmlViewWidget
dashboard widget
Creates and returns an ImageWidget
dashboard widget
Creates and returns an ImageWidget
dashboard widget
Creates and returns an ImageWidget
dashboard widget
addImageInline Adds an image to the email in such a way that it can be inlined into the HTML content.
Index for rows to add
add a new suggestion item
Add a new suggestion item
Add a new suggestion item
Add new context menu item
Add a predefined context menu item
Creates and returns a JasperViewerWidget
dashboard widget based the provided BBJasperReport
This method of creating a JasperViewerWidget is less efficient than the version that takes a report file, connection string, and parameter list as your code must create and fill the report before displaying the dashboard. Creating 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.
Creates and returns a JasperViewerWidget
dashboard widget with parameters so that the Dashboard Utility can create and fill the report before it displays the widget
This method is more efficient than the version that take a BBJasperReport object as the Dashboard Utility will create and fill the report just before displaying the widget. The other method requires 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 method 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.
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates a DashboardWidgetLink, adds it to the specified DashboardWidget, then returns the newly-created link object
Use this method to create a DashboardWidgetLink object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetLink object, which instructs the WidgetControl to execute your custom code when the user clicks the link.
Adds a link that can be used to invoke a URL for the dashboard control
Creates a DashboardWidgetMenu, adds it to the specified DashboardWidget, then returns the newly-created menu object
Use this method to create a DashboardWidgetMenu object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetMenu object, which instructs the WidgetControl to execute your custom code when the user selects a menu item from the DashboardWidgetMenu's popup menu.
addParameter Adds a ProcedureParam object to the procedure parameters vector
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a PieChartWidget
dashboard widget with an empty dataset
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Enable pivot for columns
#Enterprise
#Configuration
#API
Adds a popup menu to the grid control
addPrintAttribute Adds a print attribute
Clear already created charts. Note that this method does not clear user created charts
#API
Add new range selection
#API
Add new range selection
#API
Add new range selection
#API
Add new range selection
#API
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a RingChartWidget
dashboard widget with an empty dataset
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Add new row
#API
Add new row at the beginning of the grid
#API
Enable row grouping for columns
#Enterprise
#Configuration
#API
Adds a CSS style name to a grid row
addSaveContributor Adds a save contributor
addSaveContributor Adds a save contributor
Creates and returns a StackedAreaChartWidget
dashboard widget
Creates and returns a StackedAreaChartWidget
dashboard widget
Creates and returns a StackedAreaChartWidget
dashboard widget
Creates and returns a StackedAreaChartWidget
dashboard widget
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Adds a CSS style name to the grid control
Adds the provided CSS style name to the widget.
Add Style block
#API
Add Style block
#API
Adds the provided tag to the entry's vector of tags.
This method can be used in place of the setTags()
method as it adds the provided tag to the entry's vector of tags. It may
be easier to call this method if you only need to set a few tags, as the setTags()
method requires you to create and
populate a BBjVector or a comma-delimited string.
addText Sets the text for the body of the email message represented by the email object
May be called once or multiple times to add plain text to the body of the email message. Text will be added cumulatively
addTo Sets the first recipient or adds an additional recipient to the "to" field in an email's header before the email is sent. This value specifies the email addresses to which the message will be delivered.
Each invocation of this method takes one email address. Calling this method multiple times will construct a list of addresses that the message will be sent to.
addTo Adds recipients to the "to" field in an email's header before the email is sent.
addToolButton Adds a tool button at the end of the tool bar
addToolButton Adds a tool button at the end of the tool bar
addToolButton Adds a tool button at the end of the tool bar
addToolButton Adds a tool button to the tool bar at the specified index
addToolButton Adds a tool button to the tool bar at the specified index
addToolbarChildWindow Adds a child window to the tool bar at the specified index
addToolbarChildWindow Adds a child window to the tool bar at the specified index
addToolbarSpacer Adds a tool bar spacer at the end of the tool bar
addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar
addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar
addToolButton Adds a tool button to the tool bar
addToolButton Adds a tool button to the tool bar
addToolButton Adds a tool button to the tool bar
addToolButton Adds a tool button to the tool bar
Method addToPgmCallbacks: Add event to program callbacks, if not already existing
Adds a translation to the translations given a key and value
Adds a translation to the translations given a key and value, optionally skipping existing keys
Adds the translations provided in the passed hash map to the translations
Adds the translations provided in the passed hash map to the translations, optionally skipping existing entries
Enable value for columns
#Enterprise
#Configuration
#API
Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport using the report name for the window and tab titles
Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport
addViewerWindow Adds a viewer window to the vector of viewer windows
addViewerWindow Adds a viewer window to the vector of viewer windows
Adds and returns a vector of BBJasperView objects (tab and child window) for the passed vector of BBJasperReport objects
Adds a widget
Adds a widget
Creates and returns an XYChartWidget
dashboard widget
Creates and returns an XYChartWidget
dashboard widget
Creates and returns an XYChartWidget
dashboard widget
Creates and returns an XYChartWidget
dashboard widget
Lighten or Darken a Color by a specified amount
Sets the opacity for a Color to a specified amount
Saturate or Desaturate a Color by a specified amount
Lighten or Darken every color in the vector by a specified amount
Increase or decrease the opacity for every color in the vector to a specified amount
Sets the opacity to a fixed amount for every color in the vector
Saturate or Desaturate every color in the vector by a specified amount
Adjusts, for a given column, the spaces contained in data before displaying within a cell
Adjusts, for a given column, the spaces the user entered before returning it to the program
The default admin password which is needed to publish the service.
Name of function to use for aggregation. One of [sum, min, max, first, last].
#Configuration
#ColumnsRenderer
agg functions to show on the panel. possible values are: 'count', 'sum', 'min', 'max', 'avg'
When set to true, series values will be summed for each category before charting.
A constant value that's used to denote bottom vertical alignment
A constant value that's used to denote center horizontal alignment
Constant specifying that the DashboardWidget's title should be aligned in the center.
A constant value that's used to denote left horizontal alignment
Constant specifying that the DashboardWidget's title should be aligned left.
A constant value that's used to denote middle vertical alignment
A constant value that's used to denote right horizontal alignment
Constant specifying that the DashboardWidget's title should be aligned right.
A constant value that's used to denote top vertical alignment
The component alignment
Translated text for all files
Translated text for all files
A number that acts as a boolean, determining whether the grid should configure all columns to be sortable
When true , then input values which are not part of the suggestion list will be accepted , rejected otherwise
Aggregation functions allowed on this column eg ['sum', 'avg'].
#Configuration
#ColumnsRenderer
When true then accepts direct user's input from the input field.
Translated text for alt
Filter for getEvents() method: Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. If null(), value defaults to False. (boolean)
Set to true to always show the vertical scrollbar.
#Configuration
#GridRenderer
Set to true to enable Row Animation.
#Configuration
#GridRenderer
appendReport Appends the passed BBJasperReport to the current report
Apply the filter
This method will only compose the model and send it to the client in case send!
is true.
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Sets the custom CSS for the specified BUI app.
This is similar to the setBUICSS() method.
Set to true to apply the Set Filter immediately when the user is typing in the Mini Filter. Default: false
Area chart widget type constant
AreaChartWidget A Dashboard Utility Widget that displays an area chart which is similar to a filled Line Chart
Create an empty Area Chart specifying all parameters to be filled after creation with setDataSetValue()
Create an SQL-based Area Chart specifying all parameters
Create a BBjRecordSet-based Area Chart specifying all parameters
Create an SQL-based Area Chart specifying all parameters
Convert the client row to a DataRow
Executes the specified JavaScript in this BBjHtmlView control and returns immediately
An authorization token obtained via Google OAuth 2.0
Allows specifying the group 'auto column' if you are not happy with the default.
If grouping, this column def is included as the first column definition in the grid.
If not grouping, this column is not included.
#Configuration
#GridRenderer
Set to true to have the grid calculate height of row based on contents of this column.
#Configuration
#ColumnsRenderer
Auto refresh enabled
Auto refresh rate
Auto refresh unit
AutoRefreshUnit Data class for an auto refresh unit
The AutoRefreshUnit is used with DashboardWidgets that contain a refreshable widget. The DashboardWidget has a setAutoRefreshUnit() method that takes an AutoRefreshUnit as a parameter.
A number acting as a boolean that determines whether the grid should size its columns to fit the widget. Setting AutoResizeColumns sizes the grid and columns to fit in the widget, potentially truncating the data if the widget is small. The default is 1.
A number acting as a boolean that determines whether the grid should size its columns to fit its data. Setting AutoResizeGrid sizes the grid and columns fit the data, potentially making it necessary to scroll the grid to see all the data. The default is 0.
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
How many pixels to add to a column width after the auto-sizing calculation. The default is 4 pixels. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
#Configuration
#GridRenderer
Directory to store aux files such as images for exports
Bar chart widget type constant
BarChartWidget A Dashboard Utility Widget that displays a bar chart that can display multiple groups of bars by providing a rowKey, colKey, and value for each dataset entry
Create an empty Bar Chart specifying all parameters to be filled after creation with setDataSetValue()
Create an SQL-based Bar Chart specifying all parameters
Create a BBjRecordSet-based Bar Chart specifying all parameters
Create an SQL-based Bar Chart specifying all parameters
BaseWidget Creates a widget base class that implements the Widget interface
Name of STBL key whose value can be set to determine how widgets react to fill errors, overriding the default value. See the FillErrorAction field variable for more information on handling widget fill errors.
Name of STBL key whose value can be set to the desired device pixel ratio, overriding the dynamically determined default value.
The numeric value may be set as desired to any real number, although a minimum of 1 and maximum of 4 will be enforced by the utility to avoid
rendering enormous images that consume a huge amount of memory. Note that you may also set the "BASIS_UTILITY_DEVICE_PIXEL_RATIO" global
string entry either via code or in a configuration file in order to control the pixel ratio used when generating images, such as charts or reports.
Here are two examples:
1) Setting the global string entry in code, before creating any widgets or reports:
temp$ = STBL("BASIS_UTILITY_DEVICE_PIXEL_RATIO", "2")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_UTILITY_DEVICE_PIXEL_RATIO=2
Name of STBL key whose value can be set to the desired device pixel ratio, overriding the dynamically determined default value.
The numeric value may be set as desired to any real number, although a minimum of 0.5 and maximum of 4 will be enforced by the utility to avoid
rendering enormous images that consume a huge amount of memory. Note that you may also set the "BASIS_UTILITY_DEVICE_PIXEL_RATIO" global
string entry either via code or in a configuration file in order to control the pixel ratio used when generating images, such as charts or reports.
Here are two examples:
1) Setting the global string entry in code, before creating any widgets or reports:
temp$ = STBL("BASIS_UTILITY_DEVICE_PIXEL_RATIO", "2")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_UTILITY_DEVICE_PIXEL_RATIO=2
BBDialog
Base Class for General Dialog Handler
An HTTP Request header, which consists of a name/value pair. For example: name="Content-Type" value="text/html"
Constructor
Provides utility functions for BBJasper modules
Name of STBL key whose value can be set to TRUE create a tab when hyperlink targets are set to parent, otherwise FALSE to create a tab. The default is TRUE.
Name of STBL key to globally specify if a tabbed view should be used
Name of STBL key whose value can be set to TRUE create a window when hyperlink targets are set to blank, otherwise FALSE to create a tab. The default is TRUE.
BBJasperColumnarTemplate class
Lays out the report in a columnar fashion.
Constructor Constructs a BBJasperColumnarTemplate based on the 'basis_columnar.jrxml' template file
Constructor Constructs a BBJasperColumnarTemplate using a specific template file
Provides BBJasper CSV exporter operations
Constructor Constructs a empty BBJasperCSVExporter object
A BBj wrapper class for designing a dynamic BBJasper report.
There is also a CALL interface using ::bbjasperdesigner.bbj::generateReport with the following ENTER parameters: p_report! : (out) The generated JasperReport Object p_baseTemplate$: (in) Template file path used to generate the JRXML file p_jrxmlFile$ : (in) Name of the JRXML file to be generated (defaults to 'SampleDesign.jrxml') p_reportName$ : (in) The name of the report (defaults to 'SampleDesign') p_colMapVec! : (in) Vector of column hashmaps, each containing the column's attributes (NAME, LABEL, LENGTH, TYPE, MASK, JUSTIFICATION, EXPRESSION) p_templateType$: (in) Type of template, where P=Portrait tabular, L=Landscape tabular, C=Columnar, defaulting to 'P'
Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate
Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string and SQL query
Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string, SQL query and fields vector
Simple example of a dynamic BBJasper report designer.
Constructor Constructs a BBJasperDesigner
Constructor Constructs a BBJasperDesigner using the given user name and password. Defaults to host 'localhost' and port 2001
Constructor Constructs a BBJasperDesigner using the given host, post, user name and password
Provides BBJasper DOCX exporter operations
Constructor Constructs a empty BBJasperDOCXExporter object
Provides more granular control of BBJasper export operations
Constructor Creates a empty BBJasperExporter object
Provides control of BBJasper exporter paramter operations. Replaces net.sf.jasperreports.engine.JRExporterParameter
Fills a JasperReport with data
Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters
Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters
Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters
Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters
Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters
Provides BBJasper HTML exporter operations
Constructor Constructs a empty BBJasperHTMLExporter object
Provides BBJasper ODS exporter operations
Constructor Constructs a empty BBJasperODSExporter object
Provides BBJasper ODT exporter operations
Constructor Constructs a empty BBJasperODTExporter object
Provides BBJasper PDF exporter operations
Constructor Constructs a empty BBJasperPDFExporter object
Provides BBJasper PPTX exporter operations
Constructor Constructs a empty BBJasperPPTXExporter object
Provides methods to print and export both server and client JasperPrint objects
Provides print chromaticity operations
Constructor Constructs a BBJasperPrintChromaticity object given a Chromaticity object
Provides for print media size operations
Constructor Constructs a BBJasperMediaSizeName given a MediaSizeName object
Constructor Constructs a BBJasperMediaSizeName given an x, y, and units
Provides print media tray operations
Constructor Constructs a BBJasperPrintMediaTray object given a MediaTray object
Provides print orientation operations
Constructor Constructs a BBJasperPrintOrientation object given a OrientationRequested object
Provides print quality operations
Constructor Constructs a BBJasperPrintQuality object given a PrintQuality object
Provides for print service export operations
Constructor Creates a empty BBJasperPrintServiceExporter object
Provides control of BBJasper print server exporter paramter operations. Replaces net.sf.jasperreports.engine.export.JRPrintServiceExporterParameter
Provides print sides operations
Constructor Constructs a BBJasperPrintSides object given a Sides object
Shows a cancelable progress window while a JasperReport is being filled with data
Constructor Constructs a BBJasperProgress object given a report name and a progress key
Creates a JasperReport to view, print, or save to file in various formats.
To determine which Jaspersoft Studio version is supported in BBj, check the version number that is included in the name of the {bbj install dir}/lib/jasperreports-javaflow-*.jar. For example, jasperreports-javaflow-6.1.0.jar means that this installed version of BBj is compatible with the 6.1.0 version of Jaspersoft Studio.
Constructor Constructs a BBJasperReport given a report file and connect string
Constructor Constructs a BBJasperReport given a report file and result set
Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
Constructor Constructs a BBJasperReport given a report file, connect string, and report parameters
Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
Constructor Constructs a BBJasperReport given a report file, connect string, report parameters, and locale
Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale
Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale
Constructor Constructs a BBJasperReport given a report file, JRDataSource, report parameters, and locale
Provides BBJasper RTF exporter operations
Constructor Constructs a empty BBJasperRTFExporter object
Displays a JasperReport in a tabbed view
Constructor Constructs a BBJasperTabbedView given a BBJasperViewerControl object, BBjWindow object, control id, control x, control y, control width, control height and fit type
Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
BBJasperTabularLandscapeTemplate class
Lays out the report in a landscape tabular fashion.
Constructor Constructs a BBJasperTabularLandscapeTemplate based on the 'basis_landscape.jrxml' template file
Constructor Constructs a BBJasperTabularLandscapeTemplate using a specific template file
BBJasperTabularTemplate class
Lays out the report in a portrait tabular fashion.
Constructor Constructs a BBJasperTabularTemplate based on the 'basis.jrxml' template file
Constructor Constructs a BBJasperTabularTemplate using a specific template file
BBJasperTemplate base class
A template is a .jrxml file which is used as a layout basis for further report design.
Constructor Constructs a BBJasperTemplate object using a given template file path
Provides BBJasper TXT exporter operations
Constructor Constructs a empty BBJasperTXTExporter object
Displays a JasperReport in a view
Constructor Constructs a BBJasperView given a BBJasperReport and BBJasperViewerControl objects
Constructor Constructs a BBJasperView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
Constructor Constructs a BBJasperView given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type
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 Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, and control height
Constructor Constructs a BBJasperViewerControl given a BBjVector containing BBJasperReport objects, BBjWindow object, control id, control x, control y, control width, and control height
Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, and control height
Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type
Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type
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
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
Displays a JasperReport in a window where the user can view it, save it to disk in various formats, and print it
Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object
Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects
Constructor Constructs a BBJasperViewerWindow given a JasperPrint object
Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object and a window title
Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects and a window title
Constructor Constructs a BBJasperViewerWindow given a JasperPrint object and a window title
Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, window flags, and fit type
Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, window flags, and fit type
Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type
Constructor Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags
Constructor Constructs a BBJasperViewerWindow given a parent JasperViewerControl object, JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type
Provides BBJasper XHTML exporter operations
Constructor Constructs a empty BBJasperXHTMLExporter object
Provides BBJasper XLS exporter operations
Constructor Constructs a empty BBJasperXLSExporter object
Provides BBJasper XLSX exporter operations
Constructor Constructs a empty BBJasperXLSXExporter object
Provides BBJasper XML exporter operations
Constructor Constructs a empty BBJasperXMLExporter object
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.
BBjBUIDialChart constructor that creates the object with default values
BBjBUIDialChart constructor that creates the object with a custom background image
BBjBUIDialChart constructor that creates the object with a custom background image and a number indicating whether the dial should be initially visible
BBjBUIDialChart constructor that creates the object with a custom title string and value
BBjBUIDialChart constructor that creates the object with all available parameters
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 view the LICENSE file that was distributed with this source code.
THROW
n Error Codes:
500
: The calendar is not ready for interaction. Setting a callback for the
CalendarAPI.ON_CALENDAR_READY
event
will result in your application getting a CalendarReadyEvent
event signaling that the calendar is ready for interaction.510
: Invalid theme specified. The specified theme file does not exist.
See the getThemes()
method for more
information on installing and getting valid theme names.512
: Invalid parameter. The parameter provided to a method is null() or invalid. The error message may indicate which method call failed.514
: Invalid configuration. The specified object has not been configured correctly or is missing required properties.530
: Invalid date or time specified. The specified date or time string is not valid or cannot be parsed.700
: Missing file. The specified file does not exist. This may occur when the library attempts to read in an HTML, CSS, JavaScript, or theme file.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.
The file includes a small sample program at the top of the file that demonstrates using the custom class.
THROW
n Error Codes:
700
: Missing background image file. The specified file does not exist.BBjDialChartProgress constructor that creates the object with defaults
Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution
Note 2: if the calling program has an active PROCESS_EVENTS
loop, then it will be possible for the user to drag and reposition the progress window
BBjDialChartProgress
constructor that creates the object with a custom background image
Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution
Note 2: You can use an image with the @2x
suffix to indicate a HiDPI image, as in "myDialBackground@2x.png"
Note 3: if the calling program has an active PROCESS_EVENTS
loop, then it will be possible for the user to drag and reposition the progress window
The Grid Core Class.This class works as a columns manager and api provider. It contains a big number of methods and properties to configure the column from A..Z. Every property and method has one or more tag attached.
The following is the meaning for each tag :
Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
disabled default constructor
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget on wnd!
The constructor that creates the widget on wnd!
The constructor that creates the widget on wnd!
The constructor that creates the widget on wnd!
The BBjJavaScriptExecutor
is a BBj Custom Class that manages JavaScript code execution in a BBjHtmlView control, providing the ability to queue and debounce JavaScript execution.
- Debouncing: instead of immediately firing off several events in quick succession, if you choose to debounce the scripts then they will be batched together to improve performance.
The batch size depends on how many scripts are enqueued, the amount of time that passes between their enqueing, and the defined Rate. Do NOT debounce scripts from which you are expecting
a return value, as the return value will be associated with the entire batch, not an individual line of JavaScript. If you do need a valid return value, use the executeImmediately()
methods.
- Rate: the number of milliseconds that must expire without enqueing any more scripts before the executor flushes the enqueued scripts on the client. The default Rate is 200ms, although you can override this by using the constructor that specifies a Rate time.
- Execute Key: The script's unique id. If you attempt to queue two scripts with the same key then the second script will overwrite the first and the first script will not be executed. You do not have to specify a key value with several of the execute() methods. The main point of the key is that if you think that you may be executing the exact same script several times, then reusing the same key is a way to have only the last instance of the script be executed. For example, if you execute a redraw() JavaScript function whenever the user resizes a window, then using the script as the key ensures that it won't get called dozens of times sequentially as the user is resizing the window.
- Execute Priority: The script's priority in the queue, starting from 0 and incrementing by ones. If you specify a priority, it will be used as the script's index in the queue (a ListOrderedMap). This MUST start at 0 and increment, or you will get an indexing error on the queue. If you use an execute() method that does not specify a priority, then the scripts will be added sequentually to the queue and executed in the order in which they were added.
Although this class offers several execute() methods for the most flexibility, the most common usage will be the execute(BBjString script!, BBjNumber debounced!)
signature, as
it reuses the provided script for the key, you can control debouncing, and sequential execution is desired (without having to keep track of priority levels).
If scripts are queued for execution, they will eventually be executed in the BBjHtmlView control either when the widget code explicitly calls the executor's flush() method, or after the Rate timer has expired, which is 200 milliseconds by default. The executor will continue to flush the queue whenever it is needed.
Note that every time you queue a new script it will reset the Rate timer. That means that if you are queueing up scripts for execution in quick succession, then they will all be executed in a batch after the last script is queued. If you are queueing up scripts occasionally, meaning longer than the Rate timer, then each script will end up being executed before the next one has been queued.
Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects.
Example use cases:
Since this class is meant to be used with a BBjWidget, then it will automatically queue up scripts if the BBjWidget's getIsReady() returns false.
rem Create a new executor object specifying the rate time of 200ms where #this! is an rem instance of the custom class (assuming the application is object-oriented) executor! = new BBjJavaScriptExecutor(#this!, 200) rem Have the executor enqueue then execute the JavaScript stored in the script! variable. rem The "1" indicates that it should be debounced, or batched. executor!.execute(script!, 1) rem Have the executor immediately execute the provided JavaScript and return the result rem in a BBjString or Object viewType! = executor!.executeImmediately("window.calendar.view.type;")
A constructor that creates a new BBjJavaScriptExecutor object to be used with a BBj plug-in that extends the BBjWidget plug-in class, specifying the BBjWidget and taking the default flush rate of 200ms.
A constructor that creates a new BBjJavaScriptExecutor object to be used with a BBj plug-in that extends the BBjWidget plug-in class, specifying the BBjWidget and the flush rate in milliseconds.
The BBjMouseUp event that triggered this event
The BBjMouseUp event that triggered this event
The BBjMouseUp event that triggered this event
The BBjPopupSelectEvent event that triggered this event
Utility class for extracting values from a JSON document given a dot-delimited path.
BBjWidget Creates a widget that is implemented as a BBjControl
BBTranslationBundle The BBTranslationBundle class is a BBj CustomObject used to get and add translations with backend Java properties files for localization support.
BBTranslations The BBTranslations class is a BBj CustomObject that gets and adds translations for localization support.
BBTranslations constructor
BBTranslator The BBTranslator utility is a BBj CustomObject that utilizes a translation bundle for localization support
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.
A simple class for retrieving content from web servers. A Wrapper for Apache's HttpClient class
Object containing the necessary information for a web request, including URL, method, authorization, and headers.
A response to a web request, which includes a status code, a reason phrase, body, and headers.
Constructor Generally, rather than invoking this constructor directly, you can get BBWebResponse by sending a request with BBWebClient.send()
BBXImage
utility provides an object-oriented way to manipulate an image in a variety of ways.
Obtain the BBXImage
from a BBjImage, from a file on the server, or from a URL such as an HTTP URL that retrieves an image from the Internet.
You can then modify the BBXImage
in a number of ways and affect its scale (as a percentage or proportional to width or height),
rotation, and opacity. It is also possible to add borders, drop shadows, reflections, and even crop the corners of the image.
After manipulating the BBXImage
, the class offers methods to save it in a variety of image formats such as a PNG or JPG file with a configurable compression percentage.
In BBj 15.0 and higher, the
BBXImage
Utility provides filtering methods to
In BBj 16.0 and higher, the BBXImage
Utility provides methods to
In BBj 17.0 and higher, the BBXImage
Utility provides a method to
In BBj 18.0 and higher, the BBXImage
Utility provides methods to
In BBj 19.0 and higher, the BBXImage
Utility provides methods to
In BBj 21.12 and higher, the BBXImage
Utility has been updated with the following features:
BBXImage
. This makes it possible to chain multiple method calls, as in:
xImage!.scale(100, 100).rotate(90).saveAsPNG("myScaledAndRotatedeImage.png")
drawText()
method allows you to draw single or multiline text on the BBXImage
providing values for foreground/background color, font, alignment, and offsets.
<bbjhome>/utils/
directory is in your prefix. The BBXImage.bbj
source program is located there,
so if that directory is in your prefix then the utility will be accessible in your applications.USE
statement for the utility so that your application can reference the custom class and provide code completion for its methods.
The USE
statement should look like this:USE ::BBXImage.bbj::BBXImage
BBXImage
class in your application, the process goes something like this:
BBXImage
object from something like a BBjImage, a Java Image or ImageIcon, URL, etc:
declare BBXImage xImage!
xImage! = new BBXImage(mySource!)
xImage!.scaleProportionally(maxWidth, maxHeight)
myImageCtrl!.setImage(xImage!.getBBjImage())
xImage!.saveAsJPG(fullPathToJpgFile$, compressionLevel75)
313
: Invalid color specified. The specified string for a hex color description was invalid. It should in a format like #fafbfc
or #f0c
.400
: Invalid image source provided or missing file.BBXImage Constructor specifying another BBXImage for the source image
BBXImage Constructor specifying an ImageIcon for the source image
BBXImage Constructor specifying a Java Image object for the source image
BBXImage Constructor specifying a Java URL object for the source image
BBXImage Constructor specifying a Java File object for the source image's file path
BBXImage Constructor specifying a string for the source image's file path
BBXImage Constructor specifying a BBjImage for the source image
BBXImage Constructor that creates a BBXImage object by drawing text on a graphics context. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.
In BBj 9.00 and higher, the BBXImageFactory
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.
Border color of the dashboard widget
Border color of a dashboard widget when it is selected
Indicates if the link should be browsed to when selected
Buffer size use to read in jrxml and jasper report files, default is 10 K
A field variable that defines the buffer size
A constant to define the maximum buffer size when copying files to the Web Server
Build the column definitions from the passed ResultSet
Method buildDialogProperties: Create property files given a BBTranslator object and a set of controls
Constructs grid based on the current resultset metadata. Handles optional column-level attributes that have been set in the metadata, including: HIDE - if 1, then doesn't add this column to the grid NOTITLE - if 1, then suppresses the column title MASK - Sets the column mask with the string value ALIGN - Sets the column header cell alignement with the numeric value STYLE - Sets the column style with the numeric value BACKCOLOR - Sets the column background color to the color name FORECOLOR - Sets the column foreground color to the color name
Saves out the last known good state of the widget into a BBjImage for use later on when loading the widget/dashboard
A constant value that defines the entry's display style as 'auto' (the default display value).
When in daygrid view, it renders the entry as a solid rectangle if it is all-day or multi-day. If it's a timed entry, it renders the entry as a colored a dot. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'auto' (the default display value).
When in daygrid view, it renders the entry as a solid rectangle if it is all-day or multi-day. If it's a timed entry, it renders the entry as a colored a dot. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'background' to highlight the entry's background.
This modifies the background of the entry's date/time frame in the calendar.
A constant value that defines the entry's display style as 'background' to highlight the entry's background.
This modifies the background of the entry's date/time frame in the calendar.
A constant value that defines the entry's display style as 'block'
When in daygrid view, it renders the entry as a solid rectangle. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'block'
When in daygrid view, it renders the entry as a solid rectangle. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'inverse-background' to inversely highlight the entry's background.
This inversely modifies the background of the entry's date/time frame in the calendar.
A constant value that defines the entry's display style as 'inverse-background' to inversely highlight the entry's background.
This inversely modifies the background of the entry's date/time frame in the calendar.
A constant value that defines the entry's display style as 'list-item'
When in daygrid view, it renders the entry as a colored dot. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'list-item'
When in daygrid view, it renders the entry as a colored dot. When in other views, the entry will render normally.
A constant value that defines the entry's display style as 'none' prevent the entry from being displayed.
This hides the entry on the calendar.
A constant value that defines the entry's display style as 'none' prevent the entry from being displayed.
This hides the entry on the calendar.
A constant value that's used with the CalendarToolbarSection constructor that indicates the center section of the toolbar to be defined.
A constant value that's used with the CalendarToolbarSection
constructor that indicates the center section of the toolbar to be defined.
A constant value that's used with the CalendarToolbarSection constructor that indicates the ending, or right, section of the toolbar to be defined.
A constant value that's used with the CalendarToolbarSection
constructor that indicates the ending, or right, section of the toolbar to be defined.
A constant value that's used with the CalendarToolbarSection constructor that indicates the starting, or left, section of the toolbar to be defined.
A constant value that's used with the CalendarToolbarSection
constructor that indicates the starting, or left, section of the toolbar to be defined.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'day' toolbar button.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'day' toolbar button .
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'list' toolbar button.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'list' toolbar button .
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'month' toolbar button.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'month' toolbar button .
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'today' toolbar button.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'today' toolbar button .
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'week' toolbar button.
A constant value that's used with the CalendarOptions::setButtonText()
method that uniquely identifies the 'week' toolbar button .
A constant value for the toolbar's next button object that's used for moving the calendar forward one month/week/day.
A constant value for the toolbar's next button object that's used for moving the calendar forward one month/week/day.
A constant value for the toolbar's next year button object that's used for moving the calendar forward one year.
A constant value for the toolbar's next year button object that's used for moving the calendar forward one year.
A constant value for the toolbar's previous button object that's used for moving the calendar back one month/week/day.
A constant value for the toolbar's previous button object that's used for moving the calendar back one month/week/day.
A constant value for the toolbar's previous year button object that's used for moving the calendar back one year.
A constant value for the toolbar's previous year button object that's used for moving the calendar back one year.
A constant value for the toolbar's title object that contains the current month/week/day, which is the default content for the center toolbar section.
A constant value for the toolbar's title object that contains the current month/week/day.
A constant value for the toolbar's today button object that moves the calendar to the current month/week/day.
A constant value for the toolbar's today button object that moves the calendar to the current month/week/day.
A constant value that's used with the setPosition() method that indicates that the toolbar should be below the calendar.
A constant value that's used with the setPosition()
method that indicates that the toolbar should be below the calendar.
A constant value that's used with the setPosition() method that indicates that the toolbar should be above the calendar.
A constant value that's used with the setPosition()
method that indicates that the toolbar should be above the calendar.
A constant value that defines the dayGridMonth
(grid view for the month) calendar view.
A constant value that defines the dayGridMonth
(grid view for the month) calendar view.
A constant value that defines the dayGridWeek
(grid view for the week) calendar view.
A constant value that defines the dayGridWeek
(grid view for the week) calendar view.
A constant value that defines the listDay
(agenda for the day) calendar view.
A constant value that defines the listDay
(agenda for the day) calendar view.
A constant value that defines the listMonth
(agenda for the month) calendar view.
A constant value that defines the listMonth
(agenda for the month) calendar view.
A constant value that defines the listWeek
(agenda for the week) calendar view.
A constant value that defines the listWeek
(agenda for the week) calendar view.
A constant value that defines the listYear
(agenda for the year) calendar view.
A constant value that defines the listYear
(agenda for the year) calendar view.
A constant value that defines the timeGridDay
(time grid view for the day) calendar view.
A constant value that defines the timeGridDay
(time grid view for the day) calendar view.
A constant value that defines the timeGridWeek
(time grid view for the week) calendar view.
A constant value that defines the timeGridWeek
(time grid view for the week) calendar view.
The CalendarAPI
is a BBj Custom Class that facilitates creating calendar objects, accessing constants, and is used in combination with the BBjCalendarWidget
.
The Java Google Calendar API Object for direct access to the API.
CalendarDateClickEvent
is a BBj Interface that contains event information after the user clicks on a date or time.
This data class will be made available to your custom callback routine after the user clicks on a date or time and
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_DATE_CLICK
event.
CalendarDatesSetEvent
is a BBj Interface that contains event information after the calendar's date range
has been initially set or changed in some way and the DOM has been updated. The dates can also change when the
current-date is manipulated via the API, such as when gotoDate is called.
This data class will be made available to your custom callback routine after the user clicks the prev/next buttons, changes the view, clicks a navlink, etc.
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_DATES_SET
event.
CalendarEntriesSetEvent
is a BBj Interface that contains event information after the calendar's entry data
has been initially set or changed in some way.
This data class will be made available to your custom callback routine after the user clicks the prev/next buttons, changes the view, adds events, clicks a navlink, etc.
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_ENTRIES_SET
event.
CalendarEntry
is a BBj Interface that contains information for a BBjCalendarWidget's entry (event, appointment, etc.).
Note: The values for date/time parameters should be in ISO 8601 format as in:
YYYY-MM-DD
, e.g. "1997-07-16" for dates.YYYY-MM-DDThh:mm:ss
, e.g. "1997-07-16T19:20:00" for dates and times.YYYY-MM-DDThh:mm:ssZ
, e.g. "1997-07-16T19:20:00-06:00" for dates and times with timezone information.Note: All ending date/time parameters are exclusive. For example, an event with the end of 2018-09-03 will appear to span through 2018-09-02 but end before the start of 2018-09-03.
CalendarEntryAddEvent
is a BBj Interface that contains event information for when a single entry (not an event source) has
been added to the calendar via the BBjCalendarWidget::addEntry()
method. This data class will be made available to your
custom callback routine after mouses over a calendar entry if you have previously executed the
BBjCalendarWidget::setCallback()
method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_ADD
event.
CalendarEntryChangeEvent
is a BBj Interface that contains event information for when a calendar entry has been changed.
This data class will be made available to your custom callback routine after the user changes calendar entry if you have previously executed
the BBjCalendarWidget::setCallback()
method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_CHANGE
event.
CalendarEntryClickEvent
is a BBj Interface that contains event information for a calendar's entry click.
This data class will be made available to your custom callback routine after the user executes a click on a calendar entry
if you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_ENTRY_CLICK
event.
CalendarEntryDropEvent
is a BBj Interface that contains event information for a calendar's entry drop event.
This data class will be made available to your custom callback routine after the user finishes repositioning a calendar entry
if you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_ENTRY_DROP()
event.
CalendarEntryEvent
is a BBj Interface that contains event information for a calendar's entry
(appointment, event, etc.) object. It's the base class for several calendar events that deal with the calendar's
entries (appointments, events, etc.) including the CalendarEntryClickEvent
,
CalendarEntryMouseEnterEvent
, and CalendarEntryMouseLeaveEvent
.
CalendarEntryModificationEvent
is a BBj Interface that contains event information for a calendar's
entry (appointment, event, etc.) object. It's never instantiated as it's the base class for several calendar
events that deal with the calendar's entries (appointments, events, etc.) including the CalendarEntryAddEvent
,
CalendarEntryRemoveEvent
, and CalendarEntryChangeEvent
.
CalendarEntryMouseEnterEvent
is a BBj Interface that contains event information for a calendar's entry mouse enter event.
This data class will be made available to your custom callback routine after mouses over a calendar entry if you have previously executed
the BBjCalendarWidget::setCallback()
method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER
event.
CalendarEntryMouseLeaveEvent
is a BBj Interface that contains event information for a calendar's entry mouse leave event.
This data class will be made available to your custom callback routine after mouses out of a calendar entry if you have previously executed
the BBjCalendarWidget::setCallback()
method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE
event.
CalendarEntryRemoveEvent
is a BBj Interface that contains event information when an entry has been removed from the calendar.
This data class will be made available to your custom callback routine after mouses over a calendar entry if you have previously executed
the BBjCalendarWidget::setCallback()
method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_REMOVE
event.
CalendarEntryResizeEvent
is a BBj Interface that contains event information for a calendar's entry resize event.
This data class will be made available to your custom callback routine after the user finishes resizing a calendar entry
if you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_ENTRY_RESIZE()
event.
CalendarEntrySource
is a BBj Custom Class that defines entry feeds for the BBjCalendarWidget
and
serves as a base class for more specific entry sources such as the CalendarEntrySourceGoogle
and
CalendarEntrySourceiCalendar
classes.
Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
CalendarEntrySourceFailureEvent
is a BBj Interface that contains event information for the case where fetching a CalendarEntrySource
failed.
This data class will be made available to your custom callback routine after fetching the entry source failed if you have previously executed
the BBjCalendarWidget::setCallback() method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE
event.
CalendarEntrySource
is a BBj Interface that defines entry feeds for the BBjCalendarWidget
in the Google Calendar
format.
Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
CalendarEntrySourceiCalendar
is a BBj Interface that defines entry feeds for the BBjCalendarWidget
in the iCalendar
format.
Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
Note that iCalendar feeds will be queried upon calendar load and will not be queried after. Unlike a JSON or Google feed,
the URL will not be queried when the user navigates forward or backward in time. However, calling the calendar's
refetchEntrySource()
or
refetchAllEntrySources()
or
methods will cause the source feed to be requeried.
CalendarEntrySourceSuccessEvent
is a BBj Interface that contains event information for the case where fetching a CalendarEntrySource
succeeded.
This data class will be made available to your custom callback routine after the entry source was successfully queried if you have previously executed
the BBjCalendarWidget::setCallback() method to
register for the CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS
event.
CalendarEvent
is a BBj Interface that contains event information for
a BBjCalendarWidget. This is
the base class for all BBjCalendarWidget
events.
CalendarEventWithJavaScriptEvent
is a BBj Interface that contains event information for
a BBjCalendarWidget. This is
the base class for all BBjCalendarWidget
events that also contain the underlying native JavaScript event object.
This interface that provides methods that simplify retreiving useful information from the underly native JavaScript event object. For example,
it gives developers easy access to mouse coordinates for events that have a native JavaScript event (see the hyperlinked list of qualifying events below).
The data in this class is technically available in the JavaScript JSON event object if you call the getJsEvent()
method and parse the resultant JSON for the desired coordinates.
The purpose of this class is to simplify getting the mouse coordinates from the CalendarEvent
instead of having to parse them out of the native JavaScript event.
This makes it much easier to display a popup menu as a result of a user clicking on the calendar or a calendar entry, as you would usually call the
BBjPopupMenu::show() method which takes a control (the calendar's control) and X and Y coordinates that are relative to the control. For example:
rem Display the popup menu based on the calendar control and the mouse's X and Y positions myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
This class provides the X/Y coordinates of the user's mouse for calendar events that contain such information, namely:
CalendarSelectEvent
CalendarUnselectEvent
CalendarDateClickEvent
CalendarEntryEvent and the classes that extend it:
The class parses out X/Y coordinates from the native JavaScript event for the screenX, screenY, clientX, and clientY values. It also provides computed coordinates called calendarX and calendarY. This values are relative to the calendar control, and they are determined by taking the mouse's clientX value and subtracting the calendar's X coordinate. This makes the X/Y values relative to the calendar control instead of the screen or client area of the browser.
The CalendarOptions
is a BBj Interface that defines the options, or configuration parameters, for the calendar.
Note: There are several available options that affect the user's ability to edit/modify calendar entries, some of which are related to one another and some that override other options. The table below lists all the options associated with editability along with their default values.
Option | Default | Overview |
---|---|---|
EnableEditable | 0 | Entries may be dragged and resized, meaning that their starting date/time and duration may be changed. This enables/disables both capabilities at the same time. If you don't want both, use the more specific EnableEntryStartEditable and EnableEntryDurationEditable instead. |
EnableEntryStartEditable | 1 | Entry start times may be modified by dragging the entire entry, meaning that the user can effectively reschedule the entry by changing its starting date/time |
EnableEntryResizableFromStart | 0 | Entry start times may be modified by dragging their starting edge, meaning that the user can change the entry's starting date/time which affects its duration |
EnableEntryDurationEditable | 1 | Entry end times may be modified by dragging their ending edge, meaning that the user can change the entry's ending date/time which affects its duration |
CalendarReadyEvent
is a BBj Interface that contains event information when the calendar has been initialized and may be interacted with.
This data class will be made available to your custom callback routine after the calendar has initialized and
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_READY
event.
CalendarSelectEvent
is a BBj Interface that contains event information after the user selects a date and/or time.
This data class will be made available to your custom callback routine after the user clicks on a date or time and
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_SELECT
event.
The CalendarToolbar
is a BBj Custom Class that defines the toolbar for the calendar that can
be positioned on the top or bottom and contains three sections: start, center, and end. Each section is defined
by a CalendarToolbarSection
object that by default displays:
Location | Constant | Displays | Example |
---|---|---|---|
start | CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START() | date navigation buttons | [today] [previous year][previous][next][next year] |
center | CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER() | title | "December 2020" |
end | CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END() | view type buttons | [month][week][day][list] |
Note that it's possible to add both a header and footer toolbar to the calendar.
The CalendarToolbarSection
is a BBj Custom Class that defines a section (start, center, end)
of the CalendarToolbar
. There are three possible alignments, or positions, for the section that include:
CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START()
- The left-most section of the toolbar (in LeftToRight mode).CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER()
- The center section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END()
- The right-most section of the toolbar (in LeftToRight mode).CalendarUnselectEvent
is a BBj Interface that contains event information after the user deselects a
previously-selected date and/or time. This data class will be made available to your custom callback routine after the
user clears their date/time selection if you have previously executed the
BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_UNSELECT
event.
The CalendarView
is a BBj Interface that defines different calendar views and is used in combination with the BBjCalendarWidget
.
CalendarViewChangeEvent
is a BBj Interface that contains event information for a calendar's view change event.
This data class will be made available to your custom callback routine after the user changes the calendar's view type and
you have previously executed the BBjCalendarWidget::setCallback()
method to register for the CalendarAPI.ON_CALENDAR_VIEW_CHANGE
event.
Constant which represents the fill operation has been canceled
Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog
Method capture: Capture entire screen directly to the given client file path, without the file save dialog
Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog
Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog
Method capture: Capture entire screen to the given file path, optionally showing the file save dialog
Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog
Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog
Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog
Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog
Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog
Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog
Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog
Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog
Method capture: Capture a MDI, defaulting the file path, without showing the save dialog
Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog
Translated text for case
Set to true to make text filtering case sensitive, otherwise the filtering will be case insensitive
Category attribute
CategoryDataItem A CategoryDataItem extends the base DataItem class and is used for various charts including BarCharts, LineCharts, and AreaCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity.
A CategoryDataItem describes a dataset with one or more series and values associated with categories.
The data for these charts will be in the format of:
You can chart multiple categories by specifying unique values for the row keys and column keys. When the data is plotted
in a bar chart, for example, the parameters are used as follows:
Contructs a CategoryDataItem
The current cell where the context menu is triggered
A constant to define grid column style, used in conjunction with the setColumnStyle() method
A constant to define grid column style, used in conjunction with the setColumnStyle() method
A constant to define grid column style, used in conjunction with the setColumnStyle() method
A constant to define grid column style, used in conjunction with the setColumnStyle() method
A constant to define grid column style, used in conjunction with the setColumnStyle() method
A constant to define grid column style, used in conjunction with the setColumnStyle() method
CSS class(es) to use for the cell.
#Configuration
#ColumnsRenderer
Rules which can be applied to include certain CSS classes. These rules are provided as a map where the keys are the class names and the values are expressions that if evaluated to true, the class gets used. An expression is evaluated by the grid by executing the string as if it were a Javascript expression.
#Configuration
#ColumnsRenderer.
The expression has the following attributes available to it.
x | Mapped from cell value |
rowIndex | Maps the current row index |
data | Mapped from the DataRow |
ctx | The grid client context |
CellEditor to use for this column
#Configuration
#ColumnsRenderer
Provide a cell renderer for each value
A cellRenderer to use for this column
#Configuration
#ColumnsRenderer
Provide a cell renderer for each value
A map of css values.
#Configuration
#ColumnsRenderer
center Centers the viewer window on either the MDI window or client desktop
centerWindow Centers the passed window on either the MDI window or client desktop
centerWindow Centers the passed window on either the MDI window, client desktop, or optionally on the active window (if there is one)
Character encoding for authentication requests. Default is UTF-8.
Constant value which defines that chart toolbar data item
Constant value which defines that chart toolbar download item
Constant value which defines that chart toolbar format item
Constant value which defines that chart toolbar settings item
A constant which defines column chart category
A constant which defines column chart excluded, columns which set chart type to excluded will be excluded from charts
A constant which defines column chart series
Color Theme Index for Charts
FontFile attribute
FontScalingFactor attribute
Defines the chart data type that should be used for a column. There are two types of charting ranges; a category range that is highlighted in green and a series range that is highlighted in blue. A category range can only contain cells from a single column, whereas a series range can contain values from many columns. Columns can be explicitly configured or left for the grid to infer the type based on the data contained in the cells where columns containing string values will map to 'categories' and columns containing number values will map to 'series' charting columns.
#Configuration
#ColumnsRenderer.
ChartWidget The base chart class that all the other charts extend. The ChartWidget allows you to set various properties that apply to all or most chart types. It also offers utility methods to set colors, pick color themes, and manipulate colors' saturation, lightness, opacity, and more.
checkAvailablePrinters Determines if there are avialable printers
When true enable checkbox selection, disable otherwise
Set to true to render a selection checkbox in the column.
#Configuration
#ColumnsRenderer
Method checkFile: Validity check for a given file path
The row child index.
if the childIndex is -1
then the row is pinned to top or bottom
cleanupVirtualization Removes temporary files that are created when virtualization is used.
Translated text for clear find text
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Clears the namespace cache used by the BBTranslator
Unregisters the callback routine for a specified event
Removes the callback given the callback number.
Remove callback
Clears CSS styles from a grid cell
Clear already created chart by its id
#API
Note that this method does not clear user created charts
Clear already created charts. Note that this method does not clear user created charts
#API
Alias for resetAllColumns()
#Configuration
#ColumnsRenderer
Clears CSS styles from a grid column
Clears the grid widget's column width percentages HashMap
Clear row data (Empty the grid )
#API
Clears the widget's underlying dataset
Clears the widget's underlying dataset
Clears the widget's underlying dataset
Clears the pie chart's underlying dataset. This is typically done in response to a refresh event, where the dataset is cleared and then repopulated with up-to-date data (via fill() or setDataSetValue().
Clears the bar chart's underlying dataset. This is typically done in response to a refresh event, where the dataset is cleared and then repopulated with up-to-date data (via fill() or setDataSetValue().
Clears the line chart's underlying dataset. This is typically done in response to a refresh event, where the dataset is cleared and then repopulated with up-to-date data (via fill() or setDataSetValue().
Clears the XY chart's underlying dataset. This is typically done in response to a refresh event, where the dataset is cleared and then repopulated with up-to-date data (via fill() or setSeriesXYValue().
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear all active filters on columns
#API
Removes all data from the cells
Removes all data from the main grid cells, leaving headers intact
Unregisters the custom event callback routine for a specified 'processing' event
Clears the selected range.
#API
Clear row data (Empty the grid )
#API
Clears CSS styles from a grid row
Clears CSS styles from the grid control
Clears all the CSS styles from the widget.
A constant to define where the user clicked on the grid.
A constant to define where the user clicked on the grid.
A constant to define where the user clicked on the grid. Top left corner adjacent to column and row headers.
A constant to define where the user clicked on the grid.
A constant to define where the user clicked on the grid. This is currently only valid in BUI.
A number representing where the user last clicked on the GridWidget. This method can be used to tell if the user clicked on a grid cell, header, scrollbar, or corner component of the grid. It's possible to use this information to do different actions, for example a click on a cell can be used to cause the widget to drill down based on the selected cell, but a click on the header can be used to refresh the grid.
Property name for the client file for exports
Constant value that represents a client object error
A json object which is used as context to configure the grid and it various components on the client
clientFileExists Determines is a client file exists or not
Property for the application client id. In the case of several applications using OAuth, this property can be overridden to look for a different property in BBj.properties. Note: This is the name of the property for the client id, not the value of the client id itself. One should configure their application so it does not allow the user to drop to console. This way, they can not readily capture the client id.
Locale of the client
The client row data as JsonObject.
Property for the application client secret. In the case of several applications using OAuth, this property can be overridden to look for a different property in BBj.properties. Note: This is the name of the property for the client secret, not the value of the client secret itself. One should configure their application so it does not allow the user to drop to console. This way, they can not readily capture the client secret.
Method to get a copy of the BBXImage
Clones the DashboardWidget
Creates and returns a clone of the DashboardWidgetFilter
Creates and returns a clone of the DashboardWidgetMenu
Creates and returns a clone of the DashboardWidgetLink
Creates and returns a clone of the widget
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
clone Creates and returns a copy of the current BBJasperReport object
A method used internally to propagate a chart widget's properties to a cloned version of the chart
Specifies whether the DashboardWidget is cloned. DashboardWidgets are cloned when they are popped out or displayed in the Customize screen. By executing the DashboardWidget::getClonedState() method in response to a DashboardEvent, you can determine whether your code is dealing with the original or popped out dashboard widget.
Explicitly closes the response once necessary information has been retrieved.
Close left tabs menu item name
Close other tabs menu item name
Close right tabs menu item name
Close tab menu item name
closeAllViewerWindows Closes and destroys all windows that were created from this control
closeAllViewerWindows Closes and destroys all windows that were created from this control
Button in the in the widget control's titlebar that closes the widget control
Close toolpanel
Close the given toolpanel
A DOMString with the code value of the physical key represented by the event.
The column key of the data item
collapse all groups
#API
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, HSB, and hexadecimal representation.
Note that most of the methods are static, meaning that you don't have to instantiate a custom object in order to use the class. For example:
myBBjColor! = Colors.getBBjColorFromHexString("#fafbfc")
Most color representations support a built-in alpha channel and the conversion will take that into account. For backward compatibility with older systems, hex color strings and formatted HSLA strings are returned without the alpha digits when the alpha channel is fully opaque.
There are a variety of ways to specify a hexadecimal color, including standard and shorthand notation, with or without an octothorpe (#), and with or without an alpha component:
#rrggbb
- standard representation, prefixed by an octothorpe (the pound sign) with two hex digits for the red, green, and blue (RGB) channels rrggbb
- standard representation without the octothorpe with two hex digits for the RGB channels #rgb
- shorthand representation with 1 hexadecimal digit that will be doubled for the RGB channels, e.g. #f0c = #ff00cc
rgb
- shorthand representation without the octothorpe with 1 hexadecimal digit that will be doubled for the RGB channels, e.g. #f0c = #ff00cc
#rrggbbaa
- standard representation with two hex digits for the red, green, blue, and alpha (RGBA) channels rrggbbaa
- standard representation without the octothorpe with two hex digits for the RGBA channels #rgba
- shorthand representation with 1 hexadecimal digit that will be doubled for the RGBA channels, e.g. #f0c8 = #ff00cc88
rgba
- shorthand representation without the octothorpe with 1 hexadecimal digit that will be doubled for the RGBA channels, e.g. #f0c8 = #ff00cc88
For all Hue, Saturation, Lightness, and Alpha methods, all parameters are floating point number with the following numerical ranges:
For all Hue, Saturation, Brightness, and Alpha methods, all parameters are floating point number with the following numerical ranges:
Comparing HSL and HSB Color Models:
HSB is the same color model as HSV, where the last letter stands for Brightness or Value and resolve to the same value. HSB differs from HSL, even
though we typically think of Lightness and Brightness as the same thing. In the HSL color model the Saturation ranges from grey to full color, and
the Lightness ranges from black (0) to full color (0.5) to white (1). In the HSB color model the Saturation ranges from white to full color, and
the Brightness ranges from black to full color.
THROW
n Error Codes:
313
: Invalid color specified. The specified string for a hex color description was invalid. It should be in a format like #fafbfc
, or #f0c
, or #fafbfc80
, or #f0cc
.314
: Invalid BBjVector of HSLA or HSBA values provided.
315
: Invalid hex value provided.
316
: Invalid decimal value provided.
ToDo:
color manipulation: darken, lighten, saturate, desaturate
color blending
The index of the color theme associated with the widget, if applicable
Number of character columns to display. Default is 60.
Space in pixels between columns of widgets
The column model
The cell's column
The working column
A constant which defines the group state as opened
A constant which defines the group state as opened
A constant which defines the group state as opened
A constant which defines the group state as opened
A constant to define the algorithm used to determine the grid column widths, used in conjunction with the setColumnWidths() method. This causes the columns to be wide enough to fit the grid's cell data.
A constant to define the algorithm used to determine the grid column widths, used in conjunction with the setColumnWidths() method. This causes the columns to be wide enough to fit the grid's header text.
A constant to define the algorithm used to determine the grid column widths, used in conjunction with the setColumnWidths() method. This causes the columns to be wide enough to fit the grid's header text and cell data.
A constant to define the algorithm used to determine the grid column widths, used in conjunction with the setColumnWidths() method. This causes all columns to fit within the widget without requiring a horizontal scrollbar.
Whether to show the column when the group is open / closed.
#Configuration
#ColumnsRenderer
A number that detmines the grid's column header height in pixels
Grid column header mouse up handler
Set to true to highlight columns by adding the ag-column-hover
CSS class.
#Configuration
#GridRenderer
A developer-provided vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget
A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget
A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget
A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget
A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget
An array of column objects where every object is instance of GxClientColumnModel
A list of column ids to use. Note that none existing columns will be ignored silently
Column & column groups definitions map
The column definitions map
The column groups definitions map
Columns Manager instance
A grid expression which can be executed to perform column spanning.
The expression must return the number of columns to span , if no spanning should be applied , then
return 1
instead (ex: "data.Section === 'quarters'")
By default, each cell will take up the width of one column. You can change this behaviour to allow cells to span multiple columns. This feature is similar to 'cell merging' in Excel or 'column spanning' in HTML tables.
Constraints with Column Spanning :
Column Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Column Spanning, be aware of the following:
#Configuration
#ColumnsRenderer.
Compare two cell editors
Compare two filters
Compare two cell renderers
Constant value that represents a connection error
A developer-provided JDBC connect string used to connect to the database
A JDBC connect string used to connect to the database
A JDBC connect string used to connect to the database
A JDBC connect string used to connect to the database
A JDBC connect string used to connect to the database
Logs the provided string to the browser's console for debugging purposes regardless of whether the EnableDebug option has been set.
If you provide a simple string, like
"Got Here!
"
then you'll see an entry in the console that looks like
"BBjCalendarWidget Debug: Got Here!
"
Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string
"'Calendar View: ', window.calendar.view.type
"
(note the single quotes) results in the following message being printed in the console:
"BBjCalendarWidget Debug: Calendar View: timeGridWeek
".
In other words, if you supply single quotes then the entire parameter is applied to the console.log()
JavaScript function without any modifications.
Method constructName: Construct a valid control name
contactsDialogChange Brings up the contacts dialog
Translated text for contains
Returns whether an entry contains all the provided tags in the entry's vector of tags.
Returns whether a CalendarEntry
contains all the provided tags in comma-delimted string in the entry's vector of tags.
This is similar to the containsAllTags()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Returns whether an entry contains any of the provided tags in the entry's vector of tags.
Returns whether an entry contains any of the provided tags in the entry's vector of tags.
This is similar to the containsAnyTag()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Returns whether the provided extended property key exists the entry's HashMap of extended properties.
Returns whether the provided tag exists the entry's vector of tags.
A payload of data to be sent with the request. This is often used with POST and PUT and can be the contents of a form that the user submitted. Or a file that is to be uploaded to the webserver.
The grid context menu
#Configuration
#GridRenderer
By default, column groups start expanded. Pass true to default to contracted groups
Control
Control Class
Constructor Control
Constructor Control
Viewer control child window name
Viewer control child window name
Constant that represents a control error
A utility method that converts a JSON array of calendar entries, such as what's received from the JavaScript code, into a BBjVector filled with CalendarEntry objects.
A utility method that converts a stringified JSON array of calendar entries, such as what's received
from the JavaScript code, into a BBjVector filled with CalendarEntry
objects.
A utility method that converts a BBjVector filled with CalendarEntry
object to a JSON array of calendar entries.
Converts grid to a BBjDataAwareGrid
Specifies type of cookie. (Session, etc.) default is null.
Indicates the name of the variable that stores the refresh token in the cookie.
Indicates the name of the variable that stores scopes in the cookie. Typically does not need to be modified.
Indicates the name of the variable that is used to store the token in the cookie. Typically does not need to be modified.
Method to copy a file to another directory by providing the fully qualified path to both the source file and the target file. Note: The target path must include the target filename; it cannot be the directory in which the file will ultimately reside.
copyToClient Copies the passed server file to the passed client file
Inject a js Script.
Number of times for event recurrence. Required if not using UntilDate or UntilDateTime.
Creates an HttpRequestBase object from the fields of this object.
Called to create the widget
Creates a BBjWidget in the specified BBjChildWindow
Creates the ImageWidget
Creates the HtmlViewWidget
Called to create the widget
Creates the GridWidget
Creates the PieChartWidget
Creates the RingChartWidget
Creates the BarChartWidget
Creates the StackedBarChartWidget
Creates the StackedPercentageBarChartWidget
Creates the LineChartWidget
Creates the AreaChartWidget
Creates the StackedAreaChartWidget
Creates the XYChartWidget
Creates the JasperViewerWidget
Translated text for create image
Create imaage tool button name
Create imaage tool button name
Creates and returns an area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns an area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates a BBjCalendarWidget
given a BBjWindow where the widget takes up the full size of the window.
Creates a BBjCalendarWidget
given a BBjWindow where the widget takes up the full size of the window.
Creates a BBjCalendarWidget
given a BBjWindow and control ID, and the calendar's size and position.
Creates a BBjCalendarWidget
given a BBjWindow and control ID, the calendar's size and position, and a CalendarOptions
object.
Creates a BBjCalendarWidget
given a BBjWindow and control ID, size and position information, a calendar configuration, initial HTML template for the calendar, and a debug flag.
If you choose to provide your own HTML template, you may want to base it off of the default index.html file that can be found in the BBjCalendarWidget's lib/basis
directory.
Method createBuildItem: Creates the build item
Method getDashboardControl: Creates and returns a dashboard control
Creates a CalendarEntry
given a JsonObject representation of the CalendarEntry
object.
Creates a CalendarEntry
given an entry title and starting date/time string.
Creates a CalendarEntry
given an entry title, starting date/time string, and ending date/time string.
Creates a CalendarEntrySource
with default values.
Creates a CalendarEntrySource
given a unique ID that identifes the entry source
for later use, such as with the BBjCalendarWidget::getEntrySourceById()
method,
and a URL to access the feed.
Creates a CalendarEntrySource
given a unique ID that identifes the entry source
for later use, such as with the BBjCalendarWidget::getEntrySourceById()
method, along with the URL and
colors for the source's entries.
Note: Colors may be specified as any valid CSS color, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
Note: You may pass in a null()
or empty string for any of the colors as a way to indicate that the default entry color should be used for this source.
Contructs a CalendarEntrySourceGoogle
object for the provided Google Calendar ID.
Creates a CalendarEntrySourceGoogle
object for the provided Google Calendar ID specifying a color scheme for the source's entries.
Note: In order to access public Google calendars programmatically, you need to
sign up for a developer's account and generate an API key. See the CalendarOptions::setGoogleCalendarApiKey()
method for documentation links and setting the API key.
Note: Colors may be specified as any valid CSS color, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
Note: You may pass in a null()
or empty string for any of the colors as a way to indicate that the default entry color should be used for this source.
Creates a CalendarEntrySourceiCalendar
for an iCalendar feed given a unique ID that identifes the entry source
for later use, such as with the BBjCalendarWidget::getEntrySourceById()
method,
and a URL to access the feed.
Creates a CalendarEntrySourceiCalendar
for an iCalendar feed given a unique ID that identifes the entry source
for later use, such as with the BBjCalendarWidget::getEntrySourceById()
method,
a URL to access the feed, and a color scheme for the source's entries.
Note: Colors may be specified as any valid CSS color, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
Note: You may pass in a null()
or empty string for any of the colors as a way to indicate that the default entry color should be used for this source.
Creates an instance of the CalendarOptions
class with default values.
Creates a CalendarToolbar
using the default toolbar position of CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP()
.
Creates a CalendarToolbar
given the desired toolbar position, e.g. CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP()
or CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM()
.
Creates a CalendarToolbar
given the desired toolbar position, e.g. CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP()
or CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM()
.
Creates a CalendarToolbar
given the desired toolbar position, e.g. CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP()
or
CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM()
along with comma-delimited string representations of the start, center, and end sections.
Creates a CalendarToolbarSection
. There are three possible alignments, or positions, for the section that include:
CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START()
- The left-most section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER()
- The center section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END()
- The right-most section of the toolbar.Creates a CalendarToolbarSection
that takes an alignment and a set of options that would normally be set via the setObjects() method.
There are three possible alignments, or positions, for the section that include:
CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START()
- The left-most section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER()
- The center section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END()
- The right-most section of the toolbar.Creates a CalendarView
object given a view type. The provided view type should be one of the constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
, CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
, etc.
Creates a CalendarView
given a JsonObject representation of the view object.
Creates a BBjImage by overlaying one image on top of another, specifying the final image dimensions
Creates a BBjImage by combining two images with text
This is an internal method that's used to draw text (such as the user-settable ErrorDisplayText) over two existing images (such as a partially-filled chart and default error image). It's a convenience method that combines calls to the createImageFromText() and createCombinedImage() methods.
Creates a BBjImage by combining an existing image with text
This is an internal method that's used to draw text (such as the user-settable ErrorDisplayText) over an existing image (such as a partially-filled chart). It's a convenience method that combines calls to the createImageFromText() and createCombinedImage() methods.
Creates and returns a embedded widget
Creates and returns a embedded widget set
createFileFromStream
Creates and returns a grid embedded widget
Creates and returns a grid embedded widget
Creates and returns a grid embedded widget
Creates and returns a grid embedded widget
Creates and returns an empty GridWidget as an embedded widget
Creates and returns an empty GridExWidget as an embedded widget
Creates and returns a GridExWidget as an embedded widget using a connection string and SQL query
Creates and returns a GridExWidget as an embedded widget using a connection string, SQL query, and mode
Creates and returns a GridExWidget as an embedded widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data
Creates and returns a GridExWidget as an embedded widget using BBjVectors for the column header data and row data
Creates and returns a html view embedded widget
Creates and returns a html view embedded widget
Creates and returns an image embedded widget
Creates and returns an image embedded widget
Creates and returns an image embedded widget
Creates a BBXImage from a BBjImage
Creates a BBXImage from a Java Image Object
Creates a BBXImage from a Java ImageIcon object
Creates a BBXImage from a server file
Creates a BBjImage by drawing automatically-sized text on a graphics context
This method dynamically determines the best font size to maximize the size of the text given the image's dimensions. You can use a linefeed character ($0A$) to split the text into multiple lines. The text block will be centered both vertically and horizontally in the resultant image.
Creates a BBjImage by drawing automatically-sized text on a graphics context
This method is used internally to indicate that a widget does not contain any data or has experienced an error. The method uses a default font, foreground color, and background color. It centers the text both vertically and horizontally. It also dynamically determines the best font size to maximize the size of the text given the image's dimensions. You can use a linefeed character ($0A$) to split the text into multiple lines.
Creates a BBjImage by drawing text on a graphics context
You can use a linefeed character ($0A$) to split the text into multiple lines
Creates a BBjImage by drawing text on a transparent background
You can use a linefeed character ($0A$) to split the text into multiple lines
Creates a BBXImage from a string represetatin of a URL
Creates a BBXImage from a URL
Create a new suggestion item
Create a new suggestion item
Create a new suggestion item
Creates and returns a jasper viewer embedded widget by passing in a BBJasperReport object
Creates and returns a jasper viewer embedded widget given parameters so that the Dashboard Utility can create and fill the report before it displays the widget
Creates and returns a line chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a line chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a line chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a line chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
createLocale
Creates a java Locale object from the passed string
If the string is null then null is returned. The string should be in one of the following formats: LANGUAGE LANGUAGE_COUNTRY LANGUAGE_COUNTRY_VARIANT
Method createNewFrame: Instantiate a wizard frame
Method createNewFrame: Instantiate a wizard frame
Method createPgmFile: Generate program file
Creates and returns a pie bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a pie bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a pie bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a pie bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a pie bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Gets a radial gradient paint based off of two colors and the center point relative to the entire chart
createReport Creates and returns a BBJasperReport using no SQL result set
createReport Creates and returns a BBJasperReport using an SQL result set
Creates and returns a ring chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a ring chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a ring chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a ring chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a ring chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Static method to create the GoldMineIntegrationWebService servlet
@result The servlet as an object
Creates and returns a stacked area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked area chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked percentage bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked percentage bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked percentage bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a stacked percentage bar chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
createSubReport Creates a sub report, which inherits parameters from this report
createTempDir Creates a temp directory and returns the path
createVector Creates and returns a BBjVector for the passed object
Creates and returns a xy chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a xy chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a xy chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Creates and returns a xy chart embedded widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Method to crop the BBXImage to a specified rectangular region
Method to return the smallest image possible by cropping out the background of the original image using the top left pixel's color as the base background color to crop out.
Method to return the smallest image possible by cropping out the transparent edges of the original image
Additional CSS classes to be applied to the menu item
Constant that represents the CSV save contributor
Constant that represents the CSV save contributor
CSV exporter which contains export options
Translated text for ctrl
Translated text for currrent page
Translated text for custom page
Custom page inputn name
Custom page menu item name
Custom page menu item name
Custom page static text name
Custom page window name
Custom widget type constant
Translated text for custom zoom
Custom zoome list edit name
Custom zoom menu item name
Custom zoom menu item name
Translated text for custom zoom
Custom zoom static text name
Custom zoom window name
A BBjVector containing one or more Java Color objects to be used when customizing the ChartWidget's colors
Customize control bar background name
Customize done button name
Customize preview add button 1 name
Customize preview html view 1 name
Customize preview image 1 name
Customize Next button name
Customize Previous button name
Customize status text
Customize preview Fixed Widget Size Checkbox
Customize preview widget window name
Customize preview Fixed Widget Size Checkbox
Customize preview widget window name
Customize preview widget title name
Customize preview widget window name
Customize window name
Make a color darker
Dashboard Data class that encapsulates the entities that comprise a dashboard
Dashboard Constructs a Dashboard given a name which uniquely identifies the Dashboard, and a title which displays on the Dashboard window's title bar
Note that the p_name$ parameter is used to uniquely identify the Dashboard, and the first 8 characters of the name are used as a prefix when saving the user's preferences for the Dashboard window's size and position as well as information about each Dashboard Category and all of the widgets contained within those categories. Providing a unique identifier for the Dashboard name will ensure that all of its properties will not be overwritten by other Dashboards with a similar name.
Dashboard category control title bar name
Dashboard category control title text name
Dashboard category window name
Dashboard control customize button name
Dashboard control refresh button name
Dashboard control tab ctrl name
Dashboard control title bar name
Dashboard control title text name
Dashboard control tool bar name
Dashboard control window name
Dashboard exit button name
Dashboard glass pane name
Auto refresh config menu name
Auto refresh done button name
Auto refresh menu item name
Auto refresh rate name
Auto refresh text name
Auto refresh units name
Auto refresh window name
Widget close button name
Widget decoration window name
Manual refresh menu item name
Widget options button name
Widget popout button name
Refresh menu name
Widget title bar name
Widget title text name
Widget window name
Dashboard window name
DashboardCategory Data class that encapsulates the entities which comprise a dashboard category
DashboardCategory Constructs a DashboardCategory
DashboardCategory which a part of
DashboardCategoryAttribute Data class for attributes of a dashboard category
Constructs a DashboardCategoryAttribute with default values. Note that the name must be set to a unique value later for the DashboardCategoryAttribute to be valid.
Constructs a DashboardCategoryAttribute given an existing DashboardCategory. The DashboardCategoryAttribute's fields are populated automatically from the DashboardCategory.
Constructs a DashboardCategoryAttribute given a string template. The DashboardCategoryAttribute's fields are populated automatically from the values stored in the string template.
Constructs a DashboardCategoryAttribute given all the field values
DashboardCategoryControl UI class that displays a dashboard category
Constructs a DashboardCategoryControl
Constructs a DashboardCategoryControl
Constructs a DashboardCategoryControl
DashboardControl UI class that displays a dashboard in a BBjChildWindow
Constructs a DashboardControl
Constructs a DashboardControl
Constructs a DashboardControl
DashboardItem The base dashboard class that all of the other dashboard data classes extend
DashboardItem Constructs a DashboardItem
DashboardWidget Data class that encapsulates the entities which comprise a dashboard widget
DashboardWidget Constructs a DashboardWidget
DashboardWidget Constructs a DashboardWidget
Internal field variable used to associate the parent DashboardWidget with this widget.
DashboardWidget that the event occurred on
DashboardWidgetAttribute Data class for attributes of a dashboard widget
Constructs a DashboardWidgetAttribute
DashboardWidgetClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_CLICK event.
This event is independent of the mouse button (left, middle, right) and overrides any callbacks associated with the ON_WIDGET_LEFT_CLICK or ON_WIDGET_RIGHT_CLICK event types.
Contructs a DashboardWidgetClickEvent
The dashboard utility uses this method internally to create a DashboardWidgetClickEvent. After the user clicks on the widget the WidgetControl uses this method to create a DashboardWidgetClickEvent that is then passed to your callback routine.
DashboardWidgetControl UI class that displays a dashboard widget
Contructs a dashboard widget control
DashboardWidgetEvent Class that contains event information for a DashboardWidget. This is the base class for all dashboard widget events.
Contructs a DashboardWidgetEvent
The dashboard utility uses this method internally to create dashboard widget events
Determines if a dashboard widget exists given its name
DashboardWidgetFilter Data class for the filter of a dashboard widget
The dashboard utility uses this method internally when you execute the DashboardWidget::addFilter() method to create a DashboardWidgetFilter and add it to an existing DashboardWidget
Constructs a DashboardWidgetFilter using default filter type of FILTER_TYPE_LISTBUTTON
The dashboard utility uses this method internally when you execute the DashboardWidget::addFilter() method to create a DashboardWidgetFilter and add it to an existing DashboardWidget
Constructs a DashboardWidgetFilter specifying default filter type
The dashboard utility uses this method internally when you execute the DashboardWidget::addFilter() method to create a DashboardWidgetFilter and add it to an existing DashboardWidget
DashboardWidgetFilterSelectEvent Class that contains widget filter select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a filter item from a custom DashboardWidgetFilter if you have previously executed the DashboardWidget::setCallback() method to register for the ON_FILTER_SELECT event.
Contructs a DashboardWidgetFilterSelectEvent with the default filter type of FILTER_TYPE_LISTBUTTON
The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.
Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter
The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.
Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter
The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.
DashboardWidgetLeftClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a left click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_LEFT_CLICK event.
Contructs a DashboardWidgetLeftClickEvent
The dashboard utility uses this method internally to create a DashboardWidgetLeftClickEvent. After the user left-clicks on a widget the WidgetControl uses this method to create a DashboardWidgetLeftClickEvent that is then passed to your callback routine.
DashboardWidgetLink Data class for a link of a dashboard widget
The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget
Constructs a DashboardWidgetLink
The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget
DashboardWidgetLinkSelectEvent Class that contains widget link select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a link item from a custom DashboardWidgetLink if you have previously executed the DashboardWidget::setCallback() method to register for the ON_LINK_SELECT event.
Contructs a DashboardWidgetLinkSelectEvent
The dashboard utility uses this method internally to create a DashboardWidgetLinkSelectEvent. After the user clicks on a DashboardWidgetLink the WidgetControl uses this method to create a DashboardWidgetLinkSelectEvent that is then passed to your callback routine.
DashboardWidgetMenu Data class for a custom popup menu associated with a dashboard widget
The dashboard utility uses this method internally when you execute the DashboardWidget::addMenu() method to create a DashboardWidgetMenu and add it to an existing DashboardWidget
Constructs a DashboardWidgetMenu
The dashboard utility uses this method internally when you execute the DashboardWidget::addMenu() method to create a DashboardWidgetMenu and add it to an existing DashboardWidget
DashboardWidgetMenuSelectEvent Class that contains the custom menu item selection event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a menu item from a custom DashboardWidgetMenu if you have previously executed the DashboardWidgetMenu::setCallback() method to register for the ON_POPUP_ITEM_SELECT event.
Contructs a DashboardWidgetMenuSelectEvent
The dashboard utility uses this method internally to create a DashboardWidgetMenuSelectEvent. After the user selects an item from a DashboardWidgetMenu, the WidgetControl uses this method to create a DashboardWidgetMenuSelectEvent that is then passed to your callback routine.
DashboardWidgetRefreshEvent Class that contains refresh event information for a DashboardWidget This data class will be made available to your custom callback routine after a refresh has been triggered if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_REFRESH event.
Contructs a DashboardWidgetRefreshEvent
The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine.
Contructs a DashboardWidgetRefreshEvent specifying the refresh type
The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine.
DashboardWidgetRightClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a right click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_RIGHT_CLICK event.
Contructs a DashboardWidgetRightClickEvent
The dashboard utility uses this method internally to create a DashboardWidgetRightClickEvent. After the user right-clicks on the widget the WidgetControl uses this method to create a DashboardWidgetRightClickEvent that is then passed to your callback routine.
DashboardWidgetSelectEvent Class that contains select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_SELECT event.
Contructs a DashboardWidgetSelectEvent
DashboardWindow UI class that displays a dashboard in a BBjTopLevelWindow
Constructs a DashboardWindow
A constant that indicates a category-based chart's data item label will be placed inside the item toward the bottom, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed inside the item at the center, used with the ChartWidget::setChartDataItemLabels() method and the default when the position is not specified.
A constant that indicates a category-based chart's data item label will be placed inside the item toward the left, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed inside the item toward the right, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed inside the item toward the top, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed outside the item toward the bottom, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed outside the item toward the left, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed outside the item toward the right, used with the ChartWidget::setChartDataItemLabels() method.
A constant that indicates a category-based chart's data item label will be placed outside the item toward the top, used with the ChartWidget::setChartDataItemLabels() method.
DatabaseType class
Constructor Constructs a DatabaseType for the given database.
Constructor Constructs a DatabaseType for the given type and database.
DataFillableWidget Interface that facilitates the filling of the underlying dataset of the widget
DataItem Base class for an item of data
See the classes that extend this class for more details, such as the CategoryDataItem, KeyedValueDataItem, and XYSeriesDataItem
Contructs a DataItem
A string template which will be compiled on the client to return an array for the tree hierarchy.
#Enterprise
#Configuration
#GridRenderer
The number of milliseconds to debounce by before applying the filter
A field variable that turns on and off debug capability
A boolean that determines whether the plug-in should run in debug mode - when true it will use unminified Javascript and display the debugger in GUI and log messages to the console.
When true the grid will use the unmingled version of the Javascript code then open the debugger in a new window.
A field variable that contains the location of the debug file. It defaults to 'TranslatorDebug.txt' in the current directory.
Logs a debug string to the browser's console for debugging purposes if the EnableDebug option has been set. This method is used
internally by the BBjCalendarWidget and may also be used in your applications. To always log information to the console
regardless of whether the EnableDebug option has been set, use the consoleLog()
method instead.
If you provide a simple string, like
"Got Here!
"
then you'll see an entry in the console that looks like
"BBjCalendarWidget Debug: Got Here!
"
Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string
"'Calendar View: ', window.calendar.view.type
"
(note the single quotes) results in the following message being printed in the console:
"BBjCalendarWidget Debug: Calendar View: timeGridWeek
".
In other words, if you supply single quotes then the entire parameter is applied to the console.log()
JavaScript function without any modifications.
Number of decimal to use when parsing the size. default is 2
The number's decimal separator to use. by default the bbj decimal separator will be used
The number's decimal separator to use. by default the bbj decimal separator will be used
Constant which represents the default save location as the disk
Constant which represents the default save location as the disk
Constant which represents the default save location as Google docs
Constant which represents the default save location as Google docs
Contains column properties all columns will inherit.
#Configuration
#GridRenderer
Contains column group properties all column groups will inherit.
#Configuration
#GridRenderer
The default dates mask to use. by default %Dz.%Mz.%Yd
Initial value of the hour element.
Initial value of the minute element.
The default numbers mask to use. by default null()
The default Filter Options to be selected. By default it is Equals
The default Filter Options to be selected. By default it is Equals
Sets the default save location, which is either DEFAULT_SAVE_DISK or DEFAULT_SAVE_GOOGLE. Default is DEFAULT_SAVE_DISK
Contributor that will be used by default on a save
File that will be used by default on a save
Folder that will be used by default on a save
The default strings mask to use. by default null()
The default dates mask to use. by default %Dz.%Hz:%mz:%sz
The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz
Set this to true to instead show all values as de-selected by default. Default: false
The id of the default panel
Delete Access Control List. (Not implemented. Subject to removal or relocating.)
Delete Calendar. (Not implemented. Subject to removal or relocating.)
Deletes a column
Delete an event in the calendar.
Deletes a row Note: The QVGrid completely handles the grid content displayed, so this method has no effect.
By default when new columns are loaded into the grid, the following properties (Order, Aggregation Function, Width, Pivot, Row Group, Pinned ) are not used
To change this behaviour and have column attributes above take effect each time the grid updates the columns, then set this option to true
#Configuration
#GridRenderer
DemoUtils
In BBj 20.01 and higher, the DemoUtils
is a BBj Custom Class that provides commonly-used routines for demo programs
THROW
n 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.deselect all rows
#API
deselect all rows
#API
Deselects all of the cells in the grid
Deselects the current widget control
DesignType base class
Constructor Constructs a DesignType for the given type.
Destroys the dashboard
Destroys the dashboard category and destroys all dashboardWidgets contained in the category
Destroys the DashboardWidget
Destroys the filter
Destroys the DashboardWidgetMenu
Destroys the link
Destroys the dashboard window
Destroys the dashboard control
Destroys the dashboard category control
Destroys the widget control
Destroys the dashboard widget control
Destroys the EmbeddedWidgetWindow
Destroys the EmbeddedWidgetSetWindow
Destroys the widget
Destroys the widget
Destroys the BBjWidget and its interior BBjControl
Destroys the ImageWidget
Destroys the HtmlViewWidget
Destroys the GridExWidget
Destroys the GridWidget
Destroys the PieChartWidget
Destroys the BarChartWidget
Destroys the LineChartWidget
Destroys the JasperViewerWidget
Method destroy: Frame destruction
Method destroy: Frame destruction
Method destroy: Frame destruction
Method destroy: Frame destruction
Destroys the QVGrid component child window
destroy Destroys the BBJasperReport object
destroy Removes self from any parent viewer control, then destroys the viewer control and the viewer window
destroy Destroys the viewer control
destroy Destroys the control and optionally all viewer windows that were created by this control
destroy Destroys the tabbed view and all contained views
destroy Destroys the view
destroy Destroys the view and optionally all viewer windows that were created by this control
destroy Destroys the progress window
Destroy the grid
Method to destroy the dial chart, used when you are finished using it
A BBjNumber identifying the screen's pixel ratio. Any real number between 0.5 and 4.0 is allowed.
This numeric field variable may be set as desired to any real number, although a minimum of 0.5 and maximum of 4 will be enforced
by the utility to avoid rendering enormous images that consume a huge amount of memory. If it is not modified, it will be set
according to the pixel ratio of the current screen. Here is an example showing how to set the DevicePixelRatio via a widget:
widget!.setDevicePixelRatio(2)
Note that you may also set the "BASIS_UTILITY_DEVICE_PIXEL_RATIO" global string entry
either via code or in a configuration file in order to control the pixel ratio used when generating images, such as
charts or reports. Here are two examples:
1) Setting the global string entry in code, before creating any widgets or reports:
temp$ = STBL("BASIS_UTILITY_DEVICE_PIXEL_RATIO", "2")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_UTILITY_DEVICE_PIXEL_RATIO=2
DialogUtils
Dialog Utilities Class
DialogWizard
Dialog Wizard Class
Constructor DialogWizard
Constructor DialogWizard
DialogWizardFrame
Dialog Wizard Frame Class
Constructor DialogWizardFrame
DialogWizardFrame1
Resource/Program Paths Frame
Constructor DialogWizardFrame1
DialogWizardFrame2
Control/Programm Variable Assignments Frame
Constructor DialogWizardFrame2
DialogWizardFrame3
Control/Event Callback Assignments Frame
Constructor DialogWizardFrame3
DialogWizardFrame4
Toolbar Wizard Frame
Constructor DialogWizardFrame4
DialogWizardFrameFactory
Dialog Wizard Frame Factory Class
Constructor DialogWizardFrameFactory
DialogWizardFrameIntf
Dialog Wizard Frame Interface
DialogWizardRun
Run Type Selection Dialog
Constructor DialogWizardRun
A field variable that specifies the BBTranslations have been modified
Set disableMobile to true to always use the non-native picker.
Called to display or hide the widget
If the BBjWidget's interior BBjControl has already been created, then this method sets its visibiity
Sets the widget's visibility
Sets the widget's visibility
Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
Dock location of the filter
Dock location of the link
Constant that represents the DOCX save contributor
Constant that represents the DOCX save contributor
DOCX exporter which contains export options
doEmailDialog Runs the email dialog
Method doFinish: Finish work
Method doFinish: Finish work
Adjusts, for a given column, the data to lowercase before displaying to the user
Adjusts, for a given column, the data to lowercase before returning it to the program
Shows the dashboard window modally, returns when the dashboard window is closed
Shows the embedded widget window modally, returns when the window is closed
Shows the embedded widget set window modally, returns when the window is closed
Runs the widget wizard modally. Control will return when the widget wizard is closed
doModal Shows and runs the export data dialog modally
doModal Runs the email dialog
doModal Shows the progress window and runs process events
doSave Saves the report
doSaveAs Save as the report
OnSaveGoogleDoc Callback for when the save google doc menu item is selected
Adjusts, for a given column, the data to uppercase before displaying to the user
Adjusts, for a given column, the data to uppercase before returning it to the program
Indicates if dragging is enabled for the widget control
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Note that specifying the same value for the width and height results in a circle.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
Draws the specified text on the current BBXImage object. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.
Set to true if the column is editable, otherwise false.
#Configuration
#ColumnsRenderer
An expression which determines whether the column is editable
or not. when this config is different than null , then the column
configuration Editable
will be ignored
Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
#Configuration
#GridRenderer
Email Allows for the sending of email messages, leaving the means by which the message is populated and sent up to the caller. Attachments are supported.
Constructor Constructs an Email without specifying any parameters, using those specified in global string variables instead. In order for this constructor to succeed, the mail server's hostname (at a minimum) must be specified via an STBL entry. This is done by setting the global string entries listed below either via code or in a configuration file.
temp$ = STBL("BASIS_UTILITY_EMAIL_SERVER", "MyMailServer")
2) Setting the global string entries in the config file, without changing any code:
SET BASIS_UTILITY_EMAIL_SERVER=smtp.comcast.net
SET BASIS_UTILITY_EMAIL_PORT=465
SET BASIS_UTILITY_EMAIL_USER=BBj@comcast.net
SET BASIS_UTILITY_EMAIL_PASSWORD=myEmailPassword
SET BASIS_UTILITY_EMAIL_SMTP=smtps
SET BASIS_UTILITY_EMAIL_FROM=BBj@comcast.net
Notes:
BASIS_UTILITY_EMAIL_FROM
parameter is only used with the EmailDialog class. You
must call the setFrom() method when using the Email class.BASIS_UTILITY_EMAIL_SMTP
parameter are either 'smtp' or 'smtps'. The
value will be used as-is for the Email class, and will be translated into either a 0 or 1 for the EmailDialog's
EmailServerSSL setting.Constructor Constructs a EMail given a host and a port
Constructor Constructs a Email given a host, port, user name, and access token
Constructor Constructs a Email given a host, port, user name, password, and protocol
Called to display a email dialog in order to email the widget
Displays a dialog that facilitates emailing a screenshot of the HtmlViewWidget as an attachment to one or more recipients
Displays a dialog that facilitates emailing a screenshot of the grid as an attachment to one or more recipients
Displays a dialog that facilitates emailing a screenshot of the grid as an attachment to one or more recipients
Displays a dialog that facilitates emailing a screenshot of the chart as an attachment to one or more recipients
email Emails the report as an attachment
An error will be thrown if not successful.
Translated text for email
Translated text for email
Constant that represents a email BCC address type
Constant that represents a email CC address type
Email menu item name
Email menu item name
Constant that represents a email To address type
Email tool button name
Email tool button name
EmailableWidget Interface that facilitates emailing of the widget
Contact email address
EmailContact Used to keep track of email contact information including first and last names and email addresses
Default Constructor Creates an empty EmailContact object
Constructor Creates an EmailContact object given an email address
Constructor Creates an EmailContact object given a first name, last name, and email address
EmailDialog Displays a dialog which allows users to send emails and maintain email settings and contacts
Default Constructor Creates an empty EmailDialog object
Constant that represents the embedded images XML save contributor
Constant that represents the embedded images XML save contributor
EmbeddedWidget Class that is used to embedded widget
Constructs a EmbeddedWidget
EmbeddedWidgetControl Class that is used to display a embedded widget in a control
Constructs a EmbeddedWidgetControl
EmbeddedWidgetFactory Factory class that is used to create embedded widgets
EmbeddedWidgetSet Class that is used to embedded a widget set
Constructs a EmbeddedWidgetSet
EmbeddedWidgetSetControl Class that is used to display a embedded widget set in a control
Constructs a EmbeddedWidgetSetControl
Constructs a EmbeddedWidgetSetControl
EmbeddedWidgetSetWindow Class that is used to display a embedded widget set in a window
Constructs a EmbeddedWidgetSetWindow
Constructs a EmbeddedWidgetSetWindow passing in a desired width and height
EmbeddedWidgetWindow Class that is used to display a embedded widget in a window
Constructs a EmbeddedWidgetWindow
Constructs a EmbeddedWidgetWindow passing in a desired width and height
The message that will be showed when there are no suggestions that match the entered value.
Enable / disable time 24 format.
Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
#Configuration
#GridRenderer
Enable / disable Calendar input.
Set to true to enable charting
#Enterprise
#Configuration
When true the filter is enabled, disabled otherwise
#Configuration
#ColumnsRenderer
When true enables the floating filters, disable otherwise
#Configuration
#GridRenderer
Set to true if you want to be able to pivot by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Set to true to enable Range Selection
#Enterprise
#Configuration
Enables/Disables the refresh button
Set to true if you want to be able to row group by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Set to true to operate grid in RTL (Right to Left) mode.
#Configuration
#GridRenderer
Enable / disable seconds selection
Enable / disable time selection
Set to true if you want to be able to aggregate by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Enables display of week numbers in calendar.
End row id or index
Translated text for end
Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.
Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.
Ensures the column is visible, scrolling the table if needed.
#API
Ensures the row key is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Ensures the row index is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.
#Configuration
#GridRenderer
Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.
#Configuration
#GridRenderer
Translated text for entire report
LinkedHashMap that contains filter key/value pairs
Compare two filters
Compare two filters
Compare two filters
Compare two filters
Compare two expressions
Compare two expressions
Compare two filters
Compare two filters
Compare two filters
Compare two filters
Compare two cell renderers
Compare two cell renderers
Compare two cell renderers
Translated text for error saving
Error message
Event
Event Class
Constructor Event
Executes the provided JavaScript code on the client, specifying all available parameters.
Executes the provided JavaScript code on the client and uses the script itself as a key with the specified priority.
Executes the provided JavaScript code on the client without a priority, which is a more typical use case.
Executes the provided JavaScript code on the client using the script itself as a key and without priority, which is the typical use case.
Executes and debounces the provided JavaScript code on the client without a priority.
Executes and debounces the provided JavaScript code on the client using the script itself as a key and without a priority.
Execute the transaction on the widget model (ResultSet)
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Execute a Javascript code on the client
Execute a Javascript code on the client and use the script itself as a key
Execute a Javascript code on the client with an auto calculated priority
Execute a Javascript code on the client , use the script itself as a key and auto calculate priority
Execute and debounce a Javascript code on the client and auto calculate priority
Execute and debounce a Javascript code on the client , use the script itself as a key and auto calculate priority
Asynchronously executes the specified JavaScript in the HtmlViewWidget after it has been created. This method sets a single JavaScript, so calling it multiple times will overwrite any previous JavaScript specified earlier. To add multiple JavaScript files to a list that will all be executed in the HtmlViewWidget use the executeAsyncScripts() method. That method also allows you to specify different scripts for the regular and popped-out versions of the widget, whereas this simplified version uses the same script for both.
Adds the specified JavaScript into a vector of JavaScripts that will be executed asynchronously in the HtmlViewWidget. When the HtmlViewWidget control is created all of the JavaScripts in the vector will be executed in the control. By specifying a different JavaScript string for the p_poppedOutScript$ parameter you can change the behavior of the popped-out version or simply rename unique elements, such as DIV IDs.
Set and apply a filter transaction
The transaction is a LinkedHashMap
of columns and their models.
This the fastest way to apply several filters on several columns.
When using this method The grid will delay executing the filters on the data
until all models are set and ready.
#API
#Configuration
Executes the provided JavaScript directly in the BBjHtmlView control without debouncing so that it can return a valid return object as a generic Object
.
Executes the specified JavaScript in the HtmlViewWidget after it has been created. This method sets a single JavaScript, so calling it multiple times will overwrite any previous JavaScript specified earlier. To add multiple JavaScript files to a list that will all be executed in the HtmlViewWidget use the executeScripts() method. That method also allows you to specify different scripts for the regular and popped-out versions of the widget, whereas this simplified version uses the same script for both.
Executes the provided JavaScript via the BBjJavaScriptExecutor class which results in a debounced execution, which
is useful when you don't need the return value from the script and the script can be batched with other scripts. If you
need the return value from the script, then you need to call the
executeScriptImmediately()
method instead.
Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects.
If the BBjHtmlView is not ready yet then the script will be queued. After the BBjHtmlView control is ready then the executor will execute it on the client.
Execute a javascript code on the client.
Note that if the grid is not ready yet , then script will queued until the grid is ready then send to the client. If some reason you do not want this behavior , then use the executeScript method from the created internal HTML View
Executes the provided JavaScript immediately via the BBjJavaScriptExecutor class without debouncing, which is necessary when you need the return value from the script.
Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects.
If the BBjHtmlView is not ready then this method will throw an error 500. Setting a callback for the
CalendarAPI.ON_CALENDAR_READY
will result in your application getting a CalendarReadyEvent
event signaling that the calendar is ready for interaction.
Adds the specified JavaScript into a vector of JavaScripts that will be executed in the HtmlViewWidget. When the HtmlViewWidget control is created all of the JavaScripts in the vector will be executed in the control. By specifying a different JavaScript string for the p_poppedOutScript$ parameter you can change the behavior of the popped-out version or simply rename unique elements, such as DIV IDs.
Execute a bulk update on the grid
The transaction method is to pass a transaction object to the grid containing rows to add, remove and update.
The grid keeps all active sorting, grouping and filtering, including updating to reflect the changes in the data should the sorting, grouping or filtering be impacted.
Updating using transactions is the best way to do large updates to the grid, as the grid treats them as delta changes, so the grid only refreshes what is needed giving a performance boost.
All row and range selection will be kept.
Note that all update done on the grid will reflected also on the ResultSet instance which is the grid is using.
#API
Execute a bulk update on the grid
The transaction method is to pass a transaction object to the grid containing rows to add, remove and update.
The grid keeps all active sorting, grouping and filtering, including updating to reflect the changes in the data should the sorting, grouping or filtering be impacted.
Updating using transactions is the best way to do large updates to the grid, as the grid treats them as delta changes, so the grid only refreshes what is needed giving a performance boost.
All row and range selection will be kept.
Note that all update done on the grid will reflected also on the ResultSet instance which is the grid is using.
#API
Instance of he scripts executor
Method to determine whether the BBXImage exists or not
Width of the exit button
Expand all groups
#API
ExportData Exports data from record sets, grids, and data sets to an ASCII file that can use various field and record delimiters, as well as diffent string qualifiers.
Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options
Called to display a export dialog in order to export widget data
Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options
Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options
Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options
ExportDataDialog Provides a dialog which displays a UI to faciliate the exportation the data.
Constructor for the ExportDataDialog
Constructor for the ExportDataDialog
Constructor for the ExportDataDialog
Constructor for the ExportDataDialog
Constructor for the ExportDataDialog
exportToClientFile Exports column and row (grid) data to a client file
exportToClientFile Exports data from a BBjRecordSet to a client file
exportToClientFile Exports data from a DefaultPieDataset to a client file
exportToClientFile Exports data from a DefaultCategoryDataset to a client file
exportToClientFile Exports data from a XYSeriesCollection to a client file
exportToCSV Exports the report in CSV file format
exportToCSV Exports the report in CSV file format
exportToCSV Exports a client report to a client CSV file
exportToCSV Exports a server report to a server CSV file
exportToDOCX Exports the report in DOCX file format
exportToDOCX Exports the report in DOCX file format
exportToDOCX Exports a client report to a client DOCX file
exportToDOCX Exports a server report to a server DOCX file
exportToHTML Exports the report in HTML file format
exportToHTML Exports the report in HTML file format
exportToHTML Exports a client report to a client HTML file
exportToHTML Exports a server report to a server HTML file
exportToJRPRINT Exports the report in JRPRNT file format
exportToJRPRINT Exports a client report to a client JRPRINT file
exportToJRPRINT Exports a server report to a server JRPRINT file
exportToODS Exports the report in ODS file format
exportToODS Exports the report in ODS file format
exportToODS Exports a client report to a client ODS file
exportToODS Exports a server report to a server ODS file
exportToODT Exports the report in ODT file format
exportToODT Exports the report in ODT file format
exportToODT Exports a client report to a client ODT file
exportToODT Exports a server report to a server ODT file
exportToPDF Exports the report in PDF file format
exportToPDF Exports the report in PDF file format
exportToPDF Exports a client report to a client PDF file
exportToPDF Exports a server report to a server PDF file
exportToPPTX Exports the report in PPTX file format
exportToPPTX Exports the report in PPTX file format
exportToPPTX Exports a client report to a client PPTX file
exportToPPTX Exports a server report to a server PPTX file
exportToRTF Exports the report in RTF file format
exportToRTF Exports the report in RTF file format
exportToRTF Exports a client report to a client RTF file
exportToRTF Exports a server report to a client RTF file
exportToServerFile Exports column and row (grid) data to a server file
exportToServerFile Exports data from a BBjRecordSet to a server file
exportToServerFile Exports data from a DefaultPieDataset to a server file
exportToServerFile Exports data from a DefaultCategoryDataset to a server file
exportToServerFile Exports data from a XYSeriesCollection to a server file
exportToTXT Exports the report in TXT file format
exportToTXT Exports the report in TXT file format
exportToTXT Exports a client report to a client TXT file
exportToTXT Exports a server report to a server TXT file
exportToXLS Exports the report in XLS file format
exportToXLS Exports the report in XLS file format
exportToXLS Exports the report in XLS file format
exportToXLS Exports the report in XLS file format
exportToXLS Exports a client report to a client XLS file
exportToXLS Exports a server report to a server XLS file
exportToXLSX Exports the report in XLSX file format
exportToXLSX Exports the report in XLSX file format
exportToXLSX Exports a client report to a client XLSX file
exportToXLSX Exports a server report to a server XLSX file
exportToXML Exports the report in XML file format
exportToXML Exports the report in XML file format
exportToXML Exports a client report to a client XML file
exportToXML Exports a server report to a server XML file
Expression string
False value translation
The value to use when when the component needs to render false values. in case it is null() then we use the first item in PossibleFalseValues!
The field of the row to get the cells data from
Note: Once the field name is set, it becomes immutable
Translated text for field
Translated text for CSV file description
Translated text for DOCX file description
Translated text for HTML file description
Translated text for JRPRINT file description
Translated text for ODS file description
Translated text for ODT file description
Translated text for PDF file description
Translated text for PPTX file description
Translated text for RTF file description
Translated text for TXT file description
Translated text for multiple sheets XLS file description
Translated text for single sheet XLS file description
Translated text for single sheet XLSX file description
Translated text for XML file description
Translated text for embedded images XML file description
Translated text for file overwrite
File save name
Fills the widget's underlying dataset with data from an SQL query
Fills the widget underlying dataset with data from a BBjRecordSet
Fills the grid's underlying dataset with a BASIS Components ResultSet
Fills the grid's underlying dataset from an MKEYED, XKEYED, or VKEYED file, a string template describing the records in the file, and an optional DataRow to filter the data Note: You can pass in a null() for the DataRow filter to get all records. The filter can be used to specify:
The filter should use one of the following static fields:
Example:
filter! = new DataRow()
filter!.setFieldValue("FILTER_KNUM", "1")
filter!.setFieldValue("FILTER_RANGE_FROM", "000002")
filter!.setFieldValue("FILTER_RANGE_TO", "000010")
Fills the grid's underlying dataset with data from an SQL query
Fills the grid's underlying dataset with data from an SQL query and a mode string
Fills the grid's underlying dataset with data from BBjRecordSet and BBjVector specifying the columns to use
Fills the grid's underlying dataset with data with passed vectors BBjVector specifying the columns to use
Fills the grid's underlying dataset with data from an SQL query
Fills the grid's underlying dataset with data from an SQL query and a mode string
Fills the grid's underlying dataset with data from BBjRecordSet and BBjVector specifying the columns to use
Fills the grid's underlying dataset with data with passed vectors BBjVector specifying the columns to use
Fills the pie chart's underlying dataset with data from an SQL query
Fills the pie chart's underlying dataset with data from an SQL query and a mode string
Fills the pie chart's underlying dataset with data from a BBjRecordSet
Fills the bar chart's underlying dataset with data from an SQL query
Fills the bar chart's underlying dataset with data from an SQL query and a mode string
Fills the bar chart's underlying dataset with data from a BBjRecordSet
Fills the line chart's underlying dataset with data from an SQL query
Fills the line chart's underlying dataset with data from an SQL query and a mode string
Fills the bar chart's underlying dataset with data from a BBjRecordSet
Create an XYSeries based off of the widget name, fill it with data from a query, and add it to the XYSeriesCollection for the chart
Create an XYSeries, fill it with data from a query, and add it to the XYSeriesCollection for the chart
Create an XYSeries, fill it with data from a query, and add it to the XYSeriesCollection for the chart
Create an XYSeries, fill it with data from a BBjRecordSet and vector of columns, and add it to the XYSeriesCollection for the chart
fill Fills the report with data
fill Fills the report with data
fill Fills the report with data using a JDBC connection object or Result Set object and returns a JasperPrint object
Constant value that represents that the fill operation was canceled
Constant value that represents a fill error
Determines how the dashboard should react after encountering an error filling a widget.
This numeric field variable defaults to Dashboard.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like Dashboard.getON_FILL_ERROR_IGNORE(), Dashboard.getON_FILL_ERROR_WARN(), or Dashboard.getON_FILL_ERROR_STOP().
The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.
Here is an example showing how to set the behavior in code via a dashboard:
dashboard!.setFillErrorAction(Dashboard.getON_FILL_ERROR_WARN())
Note that you may also set the "BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION" global string entry
either via code or in a configuration file to control the behavior. If the FillErrorAction is set
via a global string it will override all default and programmatically set values for all widgets.
Here are two examples showing how to set the FillErrorAction via a global string:
1) Setting the global string entry in code, before creating any dashboards or widgets:
temp$ = STBL("BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION", "1")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION=1
Determines how the dashboard should react after encountering an error filling a widget.
This numeric field variable defaults to DashboardCategory.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like DashboardCategory.getON_FILL_ERROR_IGNORE(), DashboardCategory.getON_FILL_ERROR_WARN(), or DashboardCategory.getON_FILL_ERROR_STOP().
The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.
Here is an example showing how to set the behavior in code via a dashboard:
category!.setFillErrorAction(DashboardCategory.getON_FILL_ERROR_WARN())
Note that you may also set the "BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION" global string entry
either via code or in a configuration file to control the behavior. If the FillErrorAction is set
via a global string it will override all default and programmatically set values for all widgets.
Here are two examples showing how to set the FillErrorAction via a global string:
1) Setting the global string entry in code, before creating any dashboards or widgets:
temp$ = STBL("BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION", "1")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION=1
Determines how the dashboard should react after encountering an error filling a widget.
This numeric field variable defaults to Widget.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like Widget.getON_FILL_ERROR_IGNORE(), Widget.getON_FILL_ERROR_WARN(), or Widget.getON_FILL_ERROR_STOP().
The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.
Here is an example showing how to set the behavior in code via a widget:
widget!.setFillErrorAction(Widget.getON_FILL_ERROR_WARN())
Note that you may also set the "BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION" global string entry
either via code or in a configuration file to control the behavior. If the FillErrorAction is set
via a global string it will override all default and programmatically set values for all widgets.
Here are two examples showing how to set the FillErrorAction via a global string:
1) Setting the global string entry in code, before creating any dashboards or widgets:
temp$ = STBL("BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION", "1")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION=1
Specifies whether to fit all columns into the displayed width of the grid
Given an SQL query, fill an XYSeries with the resultant two columns of numerical data
Given an SQL query, fill an XYSeries with the resultant two columns of numerical data
Given a BBjRecordSet and a vector of columns, fill an XYSeries with the resultant two columns of numerical data
The value associated with the filter.
The value associated with the filter.
The value associated with the filter.
The value associated with the filter.
The filter component to use for this column
#Configuration
#ColumnsRenderer
Constant for Editbox-based filter used in the addFilter() method.
Constant for Editbox-based filter, optionally used when constructing a DashboardWidgetFilter.
Constant for a BBjListButton-based filter used in the addFilter() method.
Constant for a BBjListButton-based filter, optionally used when constructing a DashboardWidgetFilter.
Constant for BBjListEdit-based filter used in the addFilter() method.
Constant for BBjListEdit-based filter, optionally used when constructing a DashboardWidgetFilter.
A number acting as a boolean that determines whether the grid enables filtering by columns
A number acting as a boolean that determines whether the grid enables filtering by columns via a floating filter
What Filter Options to present to the user. By default all supported options are presented
What Filter Options to present to the user. By default all supported options are presented
CustomObject that constains the callback routine to handle a filter select event
Callback routine to handle a filter select event
Name of the filter select event
In case you are using range filter , then this is the second input value
In case you are using range filter , then this is the second input value
Type of filter
An Ag Grid expression which can be executed to get the value for filtering purposes.
#Configuration
#ColumnsRenderer.
Translated text for find
Translated text for find
Find case sensitivity insensitive constant
Find case sensitivity sensitive constant
Find clear text tool button name
Width of the find edit, the default is 140
Find highlight field constant
Find highlight text constant
Find list edit name
Find match contains constant
Find match full word constant
Find match starts with constant
Find menu item name
Find menu item name
Find menu name
Translated text for searc next
Find next menu item name
Find next menu item name
Find next tool button name
Translated text for find previous
Find previous menu item name
Find previous menu item name
Find previous tool button name
Find scope current page constant
Find scope entire report constant
Width of the find static text, the default is 60
Find status bar name
Find tool button name
Find tool button name
Find window name
Translated text for finding
findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find.
findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find.
findStaticTextElement Finds a static text element in the passed element group
findTextFieldElement Finds a text field element in the passed element group
Returns the locale that contains the passed translation key
Constant which represents the fill operation has finished
Translated text for first page
Translated text for first page
First page menu item name
First page menu item name
First page tool button name
First page tool button name
The first filter condition
Contact first name
firstPage Changes the view to display the first page, if it's not already on the first page
Fit actual size tool button name
Fit actual size tool button name
Translated text for fit to page
Translated text for fit to page
Fit page menu item name
Fit page menu item name
Fit page tool button name
Fit page tool button name
Constant for fit type actual
Constant for fit type actual
Constant for fit type page
Constant for fit type page
Constant for fit type width
Constant for fit type width
Constant for fit type zoom
Constant for fit type zoom
Translated text for fit to width
Translated text for fit to width
Fit width menu item name
Fit width menu item name
Fit width tool button name
Fit width tool button name
Fit page
A number acting as a boolean that determines whether the columns will fit inside the grid or if the grid will be horizontally scrollable - note that when FitToGrid is enabled, the columns will be sized to take up the full width of the grid but they may all be the same width.
Fit width
The fixed width in pixels in of widgets. This value is used in combination with setWidgetSizingModel(DashboardCategory.getWIDGET_SIZING_FIXED_SIZE()), which determines how the widgets are sized and positioned in the DashboardCategory
FixedWidgetWidth attribute
DashboardCategoryAttribute string template
Equivalent to flex-grow in CSS. When flex is set on one or more columns, any width value is ignored and instead the remaining free space in the grid is divided among flex columns in proportion to their flex value, so a column with flex: 2 will be twice the size as one with flex: 1.
#Configuration
#ColumnsRenderer
Method to flip the BBXImage horizontally
Method to flip the BBXImage vertically
The row pin position (top , bottom , null)
When true enable the floating filter on this column , false otherwise
#Configuration
#ColumnsRenderer
The height for the row containing the floating filters. If not specified the default is 20px.
#Configuration
#GridRenderer
Flushes the executor's queue by iterating over the enqueued scripts, combining them into a single batch, executing them on the BBjHtmlView control.
The widget should call this method once when it is ready to begin the execution process. This is normally this done after the 'ON_PAGE_LOADED' event has fired. If this method isn't explicitly called by the widget, then it will be called automatically after the Rate timer has expired, which is 200 milliseconds by default. The executor will continue to flush the queue whenever it is needed.
Iterate over the enqueued scripts and execute them on the HTML View.
The gird should call this method once when it is ready to kick in the execution process.
Normally this done after the ON_PAGE_LOADED
event is fired.
The executor then will keep flushing itself whenever it is needed.
Sets the focus on the grid control
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the first column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the first column
#API
Will set the focus on the first cell of the first row. In case the grid has already a different selected cell , the the method will retain this information.
#API
A BBjFont that is applied to the underlying BBjGrid control, allowing customization of the font family, size, and style - note that the font information is translated into CSS for the underlying BBjGridExWidget
A BBjFont that is applied to the underlying BBjGrid control, allowing customization of the font family, size, and style
Provide a footer value getter expression
When true, the grid will force using the community version of the grid whether there is a license key or not.
Affects the output by switching the way a mask with "#" characters in the trailing positions is filled. for example, the function NumberMask.mask(.10:"#.##") returns .10 instead of .1 . The options is used only when numberMask is defined
A valid expression which validates the datetime
Constant for days
Constant for hours
Constant for minutes
Constant for months
Constant for seconds
Constant for weeks
Frequency with which an event or exception should occur: required
Translated text for from currrent page
Translated text for full word
If true, then row group, pivot and value aggregation will be read only from the UI.
The grid will display what values are used for each, but will not allow the use to change the selection
#Configuration
#API
Access Control List class (Currently unimplemented. Subject to relocation or deletion.)
This class is used by the various Google APIs to provide the bearer authorization token whenever a request is sent to one of Google's API endpoints. This class will generally not be used by someone outside of BASIS unless wrapping a Google API in-house.
This constructor takes an authorization token obtained through OAuth 2.0 with Google. The token will be used in the authorization header of the Google API client that uses this class.
gapps.bbj
GCalendar is a wrapper around Google's CalendarListEntry and represents a single calendar. All filter fields for the getEvents() method default to null. If a field has been set, but the value of the filter is no longer desired, the field can be set to null() and the filter will no longer be applied.
Constructor
This class is the entry point into the Google Calendar API. From this class, you can create, access, and delete Calendars. This class can be accessed by providing a GOAuth2 object to the getInstance() method.
This constructor for the Google Calendar API takes a GOAuth2 object. It is assumed that authorization has already been performed in such a way that the token is already available.
Class for accessing large sets of GDocs without having to perform the conversion on every single document
@description: General BBj-related utilities class
Method generateBuildItemProgramCode: Generates and returns BBj program code
Method generateProgramCode: Generates and returns BBj program code
Get sorting for the given column
Method get_active_func: Check for and act on last application event, invoke caller's toolbar button push callback method
Get access role.
Read Access Control List. (Not implemented. Subject to removal or relocating.)
Get all Access Control Lists. (Not implemented. Subject to removal or relocating.)
Returns the current position of an active dashboard widget control that is part of the dashboard category control
Returns the active dashboard widget controls in the dashboard category control
Returns the calendar's last visible day as a date string.
Note: This value is exclusive, as are all ending dates.
Returns the calendar's first visible day as a date string.
Returns the section's horizontal alignement as one of the three possible alignments constants.
Get the component alignment
Method getAllControls: Get all controls in a resource file
Method getAllControls: Get all controls in a resource file for a particular window id
Method getAllControls: Get all controls using a window object
getAllControls Returns a HashMap containg all of the controls
getAllControls Returns a HashMap containg all of the controls
getAllControls Returns a HashMap containg all of the controls
Method getAllControlsRecursive: Get all controls recursively
Returns a BBjNumber acting as a boolean that determines whether the user selected all-day cells (1) or not (0).
Returns a BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).
Returns an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
Create an all-day Google EventDateTime object by specifying 6 numbers for Year, Month, and Day.
Create an all-day Google EventDateTime object by specifying 6 numbers for Year, Month, and Day.
Create an All-Day Google EventDateTime object using a java.util.Date
Create an All-Day Google EventDateTime object using a java.util.Date
Returns a BBjVector filled with all possible calendar view types.
Returns a BBjVector filled with all possible calendar view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
, CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
, etc.
Returns whether the user's alt key was pressed when the event occurred.
Indicates whether people can invite themselves to the event regardless of ownership.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarOptions
object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEvent
object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntry
object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarView object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarToolbar object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarToolbarSection object.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntrySource
object.
Convert the model to JSON array
Returns the CalendarOptions
as a JsonObject.
Returns a JsonObject representation of the CalendarEvent
.
Returns a JsonObject representation of the CalendarEntry
object.
Returns a JsonObject representation of the calendar view object.
Returns the CalendarToolbar object as a JsonObject.
Returns the component's JSON representation.
Returns the options object as a JsonObject.
Build the grid json configuration object
Convert the filter definition to Json Object
@override
{@inheritDoc}
@override
{@inheritDoc}
Convert the filter definition to Json Object
@override
{@inheritDoc}
@override
{@inheritDoc}
@override
{@inheritDoc}
Get the row data as JsonObject
Convert the model to JSON object
Convert the model to JSON object
Convert the model to JSON object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
@override
Convert the filter definition to Json Object
Transform the options object to json
Transform the options object to json
Build the grid json configuration object
Convert the renderer definition to Json Object
Convert the renderer definition to Json Object
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Convert the sidebar into json object
Get the component's JSON representation
Get the component's JSON representation
Get the component's JSON representation
Returns the width-to-height aspect ratio of the calendar.
Returns a stringified JsonObject representation of CalendarOptions
object.
Returns a stringified JsonObject representation of the CalendarEvent
.
Returns a stringified JsonObject representation of the CalendarEntry
object.
Returns a stringified JsonObject representation of the calendar view object.
Returns a stringified JsonObject representation of CalendarToolbar object.
Returns a stringified JsonObject representation of CalendarToolbarSection object.
Returns a stringified JsonObject representation of the CalendarEntrySource
object.
Get a list of participants in the meeting
Indicates whether attendees have been omitted from the event.
Returns a control attribute previously set with setAttribute() for the grid control
Returns the auto refresh enabled state (1 for enabled and 0 for disabled)
Returns the auto refresh status
Returns the auto refresh interval
Returns the auto refresh rate
Returns the auto refresh unit
Returns the auto refresh unit
Returns the background color of dashboard item
Returns the background color of the dashboard window
Returns the background color of the dashboard control
Returns the background color of the dashboard category control
Returns the background color of the widget control
Returns the background color of the grid control
Returns the background color of the calendar's containing window.
Get background color.
Returns an entry's background color.
Returns the source's entry background color.
getBands Returns all the bands in the JasperDesign object
Method to return the BBXImage out to an Image Output Stream 32-bit converted to a Base64 ASCII Stream
Method to create a BBjColor from a Java Color, taking into account an alpha channel if it exists
Method to create a BBjColor from a hex color string
Method to create a BBjColor from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values
Method to create a BBjColor from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a vector
Method to create a BBjColor from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values
Method to create a BBjColor from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a vector
Method to create a BBjColor from a Java Color with an alpha channel
Method to create a BBjColor with an alpha channel from a hex string
Returns a dashboard window BBj control
Returns a dashboard window BBj control
Returns a BBj control give a name
Returns the BBjControl identified by the provided control name
Method getBBjEventName: Get BBj event class name (e.g. "BBjButtonPushEvent")
Method to get a BBjFont object from a Java Font object
Method to get a BBjFont object from a path to a TTF or OTF file
Method to get a BBjImage for the BBXImage
Method getBBjTypeName: Get control BBj type class name
A utility method that returns a JSON array version of the supplied BBjVector.
Returns a JSON array version of the supplied BBjVector.
This method exchanges the refresh token for a bearer token. The bearer token can then be used for future API requests. This method assumes the refresh token was obtained somewhere other than a cookie and therefore does not set a cookie with a refresh token.
Returns whether the grid will beep when the program calls 'accept(0)' in response to a validation event
Text containing the information to be retrieved by the webserver. This could be an HTML web page or XML or JSON document amongst other possibilites.
Returns an entry's border color.
Returns the source's entry border color.
getBottom Creates and returns a print media tray object that contains bottom tray information
Returns the current visible bottom row
Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage
Method to get a BufferedImage from the BBXImage
Get the major iOS version if running in a BUI environment in iOS (5, 6, 7, etc.) as determined by the client browser's user agent string.
Get the iOS version if running in a BUI environment in iOS (7, 7.1, etc.) as determined by the client browser's user agent string.
Method getBuildItem Returns the BuildItem
Method getBuildItemEmbeddedCode: Returns the BBj program code necessary to embed the build item
Method getBuildItemType: Returns the build type
For BUI, inject the $gw_wnd and $gw_doc variables in the iframe. This will make sure the variables are available for all js code executed in the iframe.
Returns the text of the provided button or null() if the text has not been set, where the button is identified via a constant like CalenarAPI.CALENDAR_TOOLBAR_BUTTON_TODAY.
Retrieves the GCalendar corresponding to calendarId!
Returns the entry (appointment, event, etc.) from the calendar.
Returns the entry (appointment, event, etc.) from the calendar.
Returns the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".
Retrieves list of all GCalendars associated with user's Google Account. This includes Calendars visible to the user.
Returns a unique ID that identifes the calendar instance to which the event belongs.
Returns a unique ID that identifes the calendar instance to which the view belongs.
Returns the calendar's CalendarView
object.
Returns the X-coordinate of the user's mouse relative to the calendar control. This can be used along with getCalendarY()
to show a popup at the user's click location relative to the calendar control.
This value is calculated to be the horizontal offset of the mouse compared to the calendar control. It's technically the clientX of the mouse minus the calendar's X coordinate. This method can be used to show a popup when the user clicks on the calendar or an entry in the calendar:
rem Display the popup menu based on the calendar control and the click X and Y positions myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
Returns the Y-coordinate of the user's mouse relative to the calendar control. This can be used along with getCalendarX()
to show a popup at the user's click location relative to the calendar control.
This value is calculated to be the vertical offset of the mouse compared to the calendar control. It's technically the clientY of the mouse minus the calendar's Y coordinate. This method can be used to show a popup when the user mouses on the calendar or an entry in the calendar:
rem Display the popup menu based on the calendar control and the click X and Y positions myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
Returns whether entering the grid control will trigger control validation on the control that previously had focus
Map a JSON object to GxClientCellModel
Map a JSON string to GxClientCellModel
Map a JSON object to GxClientCellModel
Map a JSON string to GxClientCellModel
Returns the alignment of a cell
Returns the background color of a cell
A constant which holds the client cell editor real name
@override
{@inheritDoc}
@override
{@inheritDoc}
@override
{@inheritDoc}
A constant which holds the client cell editor real name
@override
{@inheritDoc}
@override
{@inheritDoc}
A constant which holds the client cell editor real name
@override
{@inheritDoc}
Returns the font of a cell
Returns the foreground color of a cell
Returns whether a BBjStandardGrid cell has an associated query button
Returns the list control for a cell
Returns the list selection for a list control in a cell
Returns the mask for a cell
Returns the "related" text associated with a cell
A constant which holds the client renderer real name
A constant which holds the client renderer real name
Returns the restore value for a cell
Returns the checked state of a check box or button style cell
Returns the style of a cell
Returns a list of all CSS style names that have been added to a grid cell
Returns the text of a cell in the GridWidget given the cell's row and column number
Returns the value of the text stored in the specified cell
Returns the vertical alignment of a cell
Gets the chart's last data item with an area that encloses the specified coordinates
This method is typically used to get information about a data entity in the chart when the user clicks on the chart. Depending on the chart type, it's possible that the provided point will be inside more than one data entity, such as in an AreaChart where the areas overlap one another. This method will return the last entity that matches, but the getChartDataItemsFromPoint() method will return information for all matching entities.
Gets all of the chart's data items with an area that encloses the specified coordinates
This method is typically used to get information about a data entity in the chart when the user clicks on the chart. Depending on the chart type, it's possible that the provided point will be inside more than one data entity, such as in an AreaChart where the areas overlap one another. This method will return all matching entities, but the getChartDataItemFromPoint() method will return only the last matching entity.
Returns the custom decimal format for the XYChart's domain axis (x-axis) numbers - note that this applies only to an XYChart
Gets the customized font file for the chart.
Returns the height of the chart
Method to get a screenshot of the chart in the form of a BBjImage sized to the provided width and height parameters
Returns the custom decimal format for the chart's range axis (y-axis) numbers
Return a BBjNumber indicating if the range axis was set to show its values formatted as currency for the current locale
Return a BBjNumber indicating if the range axis was set to show its values formatted as a percentage.
When the range axis is set to show values as a percentage, the range values will be multiplied by 100 and the percent sign will be appended to the value.
Returns the width of the chart
Returns the children of the translations in a HashMap
getChromaticity Returns the chromaticity object
DEPRECATED Returns an entry's a class name string.
Returns the source's entry class name string.
Returns an entry's class names (or CSS styles) in a vector of strings.
Returns a constant representing which part of the the GridWidget's that the user clicked
This method can be used to tell if the user clicked on a grid cell, header, or scrollbar component of the grid. It's possible to use this information to do different actions, for example a click on a cell can be used to cause the widget to drill down based on the selected cell, but a click on the header can be used to refresh the grid.
Get the grid's client context
Returns whether the client (lowered) border is set for the grid control
getClientJasperPrint Creates (if necessary) and returns the client JasperPrint object
Get instance of GxClientJsonFactory
getClientLocale Returns the locale used by the client
Returns the locale used by the client
Returns the locale used by the client
Returns the locale string used by the client
Returns the locale string used by the client
getClientPrintRequestAttributeSet Returns the client print request attribute set
see BBjControl
getClientSlash Returns the client's path separator: "" for Windows and "/" for all other operating systems
getClientSlash Returns the last record delimiter used
Returns the X-coordinate of the user's mouse relative to the calendar's window.
In the BUI and DWC clients, this value increases as the windows's position moves further right on the browser. In the GUI client, this value increases as the mouse moves further right on the calendar.
Returns the Y-coordinate of the user's mouse relative to the calendar's window.
getCloseOnSend Returns whether the dialog should be closed on a send
getColor Creates and returns a chromaticity object that contains color information
Returns an entry's combined background and border color, or null if the CalendarEvent
object was provided
by the FullCalendar. This is because the setColor()
method is a shorthand way of specifying the
backgroundColor and borderColor at the same time. The color will be passed to the FullCalendar, but it internally sets
the backgroundColor
and borderColor
to the value of the specified color and discards the given
color. Therefore, you can set colors with the setColor()
method, but this getColor()
method may not return anything if you're working with a CalendarEvent
object that was returned from the FullCalendar.
Note: For a quick way to set a CalendarEvent
's colors, see the setColors(backgroundColor!, borderColor!, textColor!)
method.
Returns the source's entry combined background and border color.
Method to create a Java Color from a hex string. As of BBj 21.12, this method supports hex color string with an alpha channel.
Get color id.
Gets the color id of the event.
Gets a pre-defined color theme vector
Gets the total number of color themes
Gets the description of the specified color theme
Method to create a Java Color with an alpha channel from a BBjColor where opacity = (0-1)
Method to create a Java Color with an alpha channel from a Java Color by specifying an opacity amount.
Method to create a Java Color with an alpha channel from a hex string
Method to create a Java Color with an alpha channel from a hex string
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the cell's column
Map column name to GxClientColumnModel
Map column name to GxClientColumnModel
Get the working column
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the column definition instance
#Configuration
#ColumnsRenderer
Returns the default horizontal alignment for a column
Returns the default background color of a column
Returns the default font of a column
Returns the default foreground color of a column
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Returns the number of pixels separating the column header and the main grid area
Returns whether all cells in the specified column have associated query buttons
Returns the column header object for the grid
Returns the default column header horizontal alignment
Returns the default background color of the column header
Returns the horizontal alignment for a column header cell
Returns the background color of a column header cell
Returns the foreground color of a column header cell
Returns the style of a column header cell
Returns the text displayed in a column header cell
Returns the vertical alignment for a column header cell
Returns the header data of the GridWidget in a BBjVector
Returns the header data of the GridWidget in a BBjVector
Returns the default font of the column header
Returns the default foreground color of the column header
Returns the height of the column header
Returns the style used by default for the column headers
Returns the default column header vertical alignment
Returns the list control for a column
Returns the default selected index for the list control in the column
Returns the default mask for a column
Returns the Columns
getColumns Returns the columns
Get the grid's columns , sorting and filtering state
#API
Returns the default style of a column in the grid
Returns a list of all CSS styles names that have been added to a grid column
Returns the default vertical alignment for all of the cells in a particular column
Retrieves the width of a specified column
Returns a vector containing the column widths within a grid
Attendee's comment for the event. Example: "I am bringing cherry cobbler to the party."
Get statusbar component
see BBjControl
Returns the JDBC connect String
getConnectString Returns the JDBC connect string
getConnectString Returns the connect string
Method getContainer Returns the container type
Returns the context ID of the QVGrid component child window
Get the grid default context menu
getControl Returns a control given the control name
getControl Returns a control given the control name
getControl Returns a view control given the control name
Returns whether the user's control key was pressed when the event occurred.
Returns the control type of the grid control Note: For a listing of control type constants, see Constants in BBjControl.
Returns the unique control type for the BBjCalendarWidget
, which is 65050.
Get the unique control type
Method to get multiple string-based user preferences in a HashMap to reduce client-server round trips
The get/setCookies() methods offer a simple way to persist application setting via a HashMap. You save information by calling the setCookies() method providing a unique key value that's used to store the information (usually the app's name, but it can be virtually any string) and a HashMap filled with the information to store. You can then call the getCookies() method to retrieve the saved information in a HashMap. The methods bypass the effort of creating string templates and BBjTemplatedStrings as well as encoding information for safety and portability.
Both get/setCookies() methods throw errors, so you may want to add an , err=
branch when
calling these methods. The getCookies() method will return a Hashmap filled with key/value pairs if
the cookie exists. If it does not exist, it will return null()
.
getCreateContactsOnSend Returns whether contacts should be created for new email addresses on a send
Gets the creation time of the event.
Gets the creator of the event.
getCSVExporter Returns the CSV exporter which contains export options
Returns the calendar's date that is the end of the interval the view is trying to represent.
Note: This value is exclusive, as are all ending dates.
Returns the calendar's start date of the interval the view is trying to represent.
Returns the encapsualted dashboard
Returns the encapsualted dashboard
Returns the categories of the dashboard
Returns a category of the dashboard, give a category name
Returns the encapuslated dashboard category used in the dashboard category control
Returns a dashboard category control given its unique name
Returns the dashboard category control that the dashboard widget control is housed in
Returns the window of the dashboard category control
Returns the encapsualted dashboard control
Returns the dashboard control that this dashboard category control is a part of
Returns the window of the dashboard control
Returns a dashboard widget given its name
Returns the encapuslated dashboard widget used in the widget control
Returns the DashboardWidget that is associated with the event
Returns a dashboard widget control
Returns the dashboard widget controls in the dashboard category control
Returns the left dashboard widget filter
Returns the right dashboard widget filter
Returns the left dashboard widget link
Returns the right dashboard widget link
Returns the custom popup menu associated with the dashboard widget given the menu trigger type
Returns the position of a dashboard widget
Returns the dashboard widgets in a BBjVector
Returns the dashboard window that houses the dashboard control
Alias for getAsJsonObject()
getDatabaseName Returns the database name
Returns the PieChart's underlying dataset, which is a JFreeChart DefaultPieDataset
Note that PieCharts return a DefaultPieDataset, BarCharts and LineCharts return a DefaultCategoryDataset, and XYCharts return an XYSeriesCollection
Returns the BarChart's underlying dataset, which is a JFreeChart DefaultCategoryDataset
Note that PieCharts return a DefaultPieDataset, BarCharts and LineCharts return a DefaultCategoryDataset, and XYCharts return an XYSeriesCollection
Returns the LineChart's underlying dataset, which is a JFreeChart DefaultCategoryDataset
Note that PieCharts return a DefaultPieDataset, BarCharts and LineCharts return a DefaultCategoryDataset, and XYCharts return an XYSeriesCollection
Deprecated as of BBj 20.20 - This method used to returns the XYChart's underlying dataset but now returns null() - use the XYChartWidget.getXYDataset()
method instead to get the chart's XYSeriesCollection
Note that PieCharts return a DefaultPieDataset, BarCharts and LineCharts return a DefaultCategoryDataset, and XYCharts return an XYSeriesCollection
Returns the calendar's currently selected date.
Returns the calendar's date (day/time) that was clicked.
Returns the calendar's currently selected date in ISO format.
Returns the calendar's date in ISO 8601 format. Depending on what the user clicked, it may or may not include a time and time zone portion.
Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255
Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255
Gets the default colors for a chart
Returns the default col spacing between widgets
Returns the default column width
getDefaultFilePrefix returns the default file prefix for temporary files like email attachements
Returns the default style of cells in the grid
Returns the default maximum widget width
Returns the default minimum widget width
Returns the default row spacing between widgets
getDefaultSave Returns the default save location
Returns the fallback duration for timed entries that do not have a specified end time.
Gets deleted events
Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's date/time was moved by.
Get DeltaColumn Mode value
Method to get the description of the BBXImage
Description of the calendar.
Gets the event's description.
Returns an entry's extended information that can be used to further describe the entry beyond the title text.
Returns a source's extended information that can be used to further describe the source.
An internal method used to set/get the device pixel ratio for the widget
This is first called upon widget creation to set the device pixel ratio (DPR) for the widget, which is a static to prevent the code from being executed several times per dashboard. If the BASIS_UTILITY_DEVICE_PIXEL_RATIO STBL is set it will be used preferentially over all other other values. If the STBL is not set, the method will determine the DPR for the widget. If the widget already has a UI, then it uses the DPR for the screen on which the widget is displayed. If the widget does not have a UI it will use the DPR for the default screen.
Gets the screen's device pixel ratio used for modifying ChartWidgets
Returns an entry's display style.
Returns the source's display style.
The attendee's name, if available.
https://developers.google.com/drive/web/search-parameters
getDOCXExporter Returns the DOCX exporter which contains export options
getDraft Creates and returns a print quality object that contains draft quality information
Returns whether the grid accepts drag and drop operations
Returns the actions that are currently available when dragging from the grid control
Returns whether the grid control should allow drag operations
Returns the drag type that was set for a particular cell in a previous call to setDragType()
Returns the drag type that was set for a particular column in a previous call to setDragType()
Returns an optional type string, previously set with setDragType(), that the grid control advertises to potential drop targets when it acts as a drag source
Returns the actions that are currently available when dropping to the grid control. Returns ACTION_NONE if the control is disabled or non-editable.
Returns the drop types that were set for a particular cell in a previous call to setDropTypes()
Returns the drop types that were set for a particular column in a previous call to setDropTypes()
Returns the drop types that were set in a previous call to setDropTypes()
getDuplex Creates and returns a print sides object that contains duplex sides information
Returns the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.
Returns the current edit text associated with the grid Note: The QVGrid is not editable, so this method has no meaning
getElements Returns all the design elements in the passed element group
The attendee's email address, if available. This field must be present when adding an attendee.
getEmailAttachments Returns the file names of the email attachments
getEmailContacts Returns the email contacts
getEmailDialog Returns the EmailDialog object so that it can be customized
getEmailDialog Returns the EmailDialog object so that it can be customized
getEmailFrom Returns the email from address
getEmailMessage Returns the email message
getEmailServerHost Returns the email server host name
getEmailServerPassword Returns the email server password
getEmailServerPort Returns the email server port
getEmailServerSSL Returns the email server SSL
getEmailServerUserName Returns the email server user name
getEmailSubject Returns the email subject
Returns the encapsulated EmbeddedWidgetControl
Returns the encapsulated EmbeddedWidgetSetControl
Returns whether the day headers should appear for the Month, TimeGrid, and DayGrid views (1) or not (0).
Returns whether the BBjCalendarWidget
should run in debug mode (1) or not (0).
Returns the entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).
Returns the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
Returns whether the user can modify entries on the calendar (1) or not (0).
Returns the entry's editable status that determines if the entry can be modified by the user.
Returns the source's entry editable status that determines if the entry can be modified by the user.
Returns whether the user can modify entry durations on the calendar (1) or not (0).
Returns whether entries being dragged and resized are allowed to overlap one other (1) or not (0).
Returns an entry's overlap status that determines if the entries may be dragged/resized over one another.
Returns whether the user can resize an entry from its starting edge (1) or not (0).
Returns whether the user can modify event start times through dragging (1) or not (0).
Returns whether a calendar view's rows will expand to fit the available height (1) or not (0).
Returns whether the calendar will always show 6 weeks in month view (1) or not (0).
Returns whether day and week names are clickable (1) or not (0), causing the associated view to be loaded on click.
Returns whether the calendar will display a marker indicating the current time (1) or not (0).
Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).
Returns whether the user can highlight multiple days or timeslots by clicking and dragging (1) or not (0).
Returns whether the previous or next month's dates should display in the calendar's month view (1) or not (0).
Returns whether entries should visually overlap one another (1) or not (0).
Returns the entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
Returns the source's entry start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
Returns whether clicking elsewhere on calendar/window causes the current selection to be cleared (1) or not (0).
Returns whether the calendar views include Saturday/Sunday columns (1) or not (0).
Returns whether week numbers should be displayed on the calendar (1) or not (0).
Gets the ending time or date for an event
Returns the calendar's ending date of the selection, which may include timezone information and is exclusive.
Returns the calendar's ending date for the current range.
Returns an entry's exclusive ending date/time.
Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's end date was moved by.
Returns the calendar's ending date in ISO 8601 format for the current range.
Returns the calendar's selected ending date in ISO 8601 format and is exclusive. Depending on what the user selected, it may or may not include a time and time zone portion.
Gets whether the end time for the event is unspecified.
Returns all of the calendar's entries as a BBjVector of CalendarEntry
objects.
Returns the calendar's entries as a BBjVector filled with CalendarEntry
objects.
Returns all of the calendar's entries as a JsonArray of JsonObject events.
Returns a BBjVector filled with CalendarEntry
objects for all the fetched entries.
Returns all of the calendar's entries as a BBjVector of CalendarEntry
objects.
Returns all of the calendar's entries as a BBjVector of CalendarEntry
objects.
Returns the background color for all calendar entries.
Returns the border color for all calendar entries.
Returns the background and border color for all calendar entries.
Returns the display setting parameter for the calendar entries.
Returns a BBjVector filled with IDs for all the CalendarEntrySource
objects that have previously been added to the calendar via the addEntrySource()
method.
Returns the text color for all calendar entries.
getEnvelope Creates and returns a print media tray object that contains envelope tray information
Returns a the error message associate with the fetching failure.
ETag for the calendar. ETags are used in caching to determine whether a resource has changed.
ETag for the event. ETags are used in caching to determine whether a resource has changed.
Method getEvent: Get event id
Create a Google EventDateTime object by specifying 6 numbers for Year, Month, Day, Hour, Minute, and Second.
Create a Google EventDateTime object by specifying 6 numbers for Year, Month, Day, Hour, Minute, and Second.
Create a Timed Google EventDateTime object using a java.util.Date
Create a Timed Google EventDateTime object using a java.util.Date
A utility method that returns a descriptive string given an event number based on the CalendarAPI.ON_CALENDAR_*
callback constants.
Method getEventName: Get event name (e.g. "ON_BUTTON_PUSH")
Returns the event number that corresponds to one of the CalendarAPI.ON_CALENDAR_*
callback constants.
Method getEvents: Get allowed events for control
Get all events (like scheduled appointments) associated with this calendar.
Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.
Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.
Get all events (like scheduled appointments) associated with this calendar using a token that represents a datetime when events were last retrieved.
ExtendedProperties for the event.
Returns an entry's custom key/value string pairs that define the entry's custom properties
Returns the value of the provided extended property if the key exists in the entry's HashMap of extended properties.
Method to return a file's base name by stripping its extension. If the file
Method to get a file's contents in a BBjString variable, regardless of whether it's a text or binary file and without taking into account the character encoding. NOTE: This method read all bytes into memory in a single statement so do not use it to read large files (2GB), as it could results in an OutOfMemoryError.
This method uses the Java Files::readAllBytes() method to get the contents of a file. The utility's getFileContents() method is similar, except that method uses BBj syntax to load the contents of a file. In practice, that method will be slower and will only return up to the first 10 megabytes of the file. In contrast, this method can be up to five times faster and it can read in over 1 gigabyte of data. However, if you provide a file that is too large, it will result in an out of memory error.
Method to get a file's contents in a BBjString variable - Note that this method reads in a maximum of 10 megabytes.
Method to get a file's extension
Method to get a file's name from a fully-qualified path by stripping all the directories
Method to get a file's name without extension from a fully-qualified path by stripping all the directories, dot, and extension
Gets the number of the last error that occurred when filling the widget. A return value of 0 indicates that no fill error occurred.
Gets the description of the last error that occurred when filling the widget. A return value of an empty string indicates that no fill error occurred.
Parse a filter conditions (single or combined) and return a filter model
Parse a filter conditions (single or combined) and return a filter model
Parse a filter conditions (single or combined) and return a filter model
Parse a filter conditions (single or combined) and return a filter model
Get The combined filter model for the given column
This method will return a GxClientFilterCombinedModel
for the given column
If the column has already some filter values set through the UI , then the model will contain
these changes too.
In case the grid is not ready (not renderer yet) then the method will just return any empty combined filter model for the column.
#API
#Configuration
Parse a filter condition and return a filter model
Parse a filter condition and return a filter model
Returns the filter's underlying BBjControl, such as a BBjListButton, BBjEditBox, etc.
This means that you can then modify the filter control directly, such as using the BBjListButton::selectIndex method to select the desired index in a BBjListButton-based filter. If you choose to programmatically modify the selected value from the underlying BBjControl, you should also execute the setKey() and setValue() methods on the DashboardWidgetFilter object to ensure that the model and the view are in sync.
Returns the filter key for a specified filter value
Returns the key of a dashboard widget filter select event
Get The filter model for the given column
This method will return a GxClientFilterModel
for the given column
If column has already some filter values set through the UI , then the model will contain
these changes too.
In case the grid is not ready (not renderer yet) then the method will just return any empty filter model for the column.
#API
#Configuration
Returns the name of a dashboard widget filter select event
A constant which holds the client filter real name
@override
A constant which holds the client filter real name
Returns the filter type of a dashboard widget filter select event
Returns the filter value for a specified filter key
Returns the value of a dashboard widget filter select event
Returns the day on which each week begins where the value is a 0-based number starting with Sunday.
getFitType Returns the FitType for the report (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
getFitType Returns the fit type of the tabbed view (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)
Create a java font from a BBjFont
Returns the font of the grid control
Gets the custom font scaling factor for the chart as set by the original dashboard program.
Returns the header or footer toolbar that's displayed on the calendar.
Returns the foreground (text) color of the grid control
Get foreground color.
Returns a formatted string representation of the value.
The formatting will be the same as specified in the setLabelFormat() method. If the setLabelFormat() method was never called, then the value will simply be converted to a string.
Method getFriendlyName: Get control translateable "friendly" name
Method getFriendlyName: Get (translateable) "friendly" event name (e.g. "Button Push")
Gets the Gadget for the event.
getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized
getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized
Returns the API key that is used to access public Goolge Calendars programmatically.
getGoogleSaveDocument Returns the Google save document
Returns the GridExWidget's underlying BBjGridExWidget, but only after it has been created (meaning that it would only be available in response to a callback event)
Gets the GridWidget's BBjGrid
Returns the underlying BBjStandardGrid object
Gets the GridWidget that the event is for
Returns an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
getGroups Returns the groups
Gets whether participants can invite other participants to the event.
Gets whether participants can modify the event.
Gets whether participants can see what other participants are invited to the meeting.
Gets the hangout link associated with the meeting.
Returns whether the grid has a column header
Returns whether the grid has a row header
Returns whether the widget is using a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
Get the tooltip for the column group header
Retrieves an array of headers from the response. These headers could be information like content type, cookies, authorization tokens, etc.
Returns whether header selection is active
Returns the header or footer toolbar that's displayed on the calendar.
Method to get the height of the BBXImage
Returns the height of the widget control
Returns the height of the EmbeddedWidgetWindow
Returns the height of the EmbeddedWidgetSetWindow
getHeight Returns the height of the dialog
getHeight Returns the height of the dialog
Returns the height of the QVGrid component child window
getHeight Returns the height of the viewer control
getHeight Returns the height of the tabbed view
getHeight Returns the height of the viewer control
Returns the widget's height.
Returns the height setting parameter for the calendar.
Method to convert a decimal number to a hexadecimal number
Method to get a hexadecimal color from a BBjColor
Method to get a hex representation of a Java Color with an alpha channel
Method to get a hex representation of a Java Color with an alpha channel
Method to create a hexadecimal color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values
Method to create a hexadecimal color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a vector
Method to create a hexadecimal color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values
Method to create a hexadecimal color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a vector
Method to get a hex representation of a Java Color
Returns whether calendar is suppressed from displaying. User can have several calendars, but only show the desired calendars at any time.
Returns which days of the week should be hidden in the calendar in a BBjVector containing the day numbers that should be hidden.
Returns a BBjVector filled with optional custom tags that were previously set with the setHiddenTags() method and determine which calendar entries should be hidden.
When dealing with entry tags, there are three sets to be aware of:
CalendarEntry
custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.BBjCalendarWidget::setVisibleTags()
methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally.BBjCalendarWidget::setHiddenTags()
methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view.
Note: If the BBjCalendarWidget
's set of visible tags is empty then all calendar entries will be visible.
If the BBjCalendarWidget
's set of hidden tags is empty then all calendar entries will be visible.
Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
getHigh Creates and returns a print quality object that contains high quality information
Returns which selection highlight method is currently being used
Returns the amount of horizontal space between the columns
Returns whether horizontal lines between the rows are visible
Returns whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid
Returns whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed
Method to format a BBjColor into an HSBA string in the format hsba(h, s%, b%, a)
Method to format a hex color string into an HSBA string in the format hsba(h, s%, b%, a)
Method to format individual HSBA values into an HSBA string in the format hsba(h, s%, b%, a)
Method to format a BBjVector of individual HSBA values into an HSBA string in the format hsba(h, s%, b%, a)
Method to format individual HSLA values into an HSBA string in the format hsba(h, s%, b%, a)
Method to format a BBjVector of individual HSLA values into an HSBA string in the format hsba(h, s%, b%, a)
Method to format a Java Color into an HSBA string in the format hsba(h, s%, b%, a)
Method to convert a BBjColor to its corresponding HSLA (Hue, Saturation, Brightness, and Alpha) values and return an array containing the 4 HSBA parameters of the BBjColor
Method to convert a hex color to its corresponding HSBA (Hue, Saturation, Brightness or sometimes Value, and Alpha) values and return an array containing the 4 HSBA parameters of the hex color
Method to get a vector of HSBA values from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values
Method to get a vector of HSBA values from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a vector
Method to convert a Java Color to its corresponding HSLA (Hue, Saturation, Brightness, and Alpha) values and return an array containing the 4 HSBA parameters of the Java Color
Method to format a BBjColor into an HSB string in the format hsb(h, s%, b%)
Method to format a hex color string into an HSB string in the format hsb(h, s%, b%)
Method to format individual HSB values into an HSB string in the format hsb(h, s%, b%)
Method to format a BBjVector of individual HSB values into an HSB string in the format hsb(h, s%, b%)
Method to format individual HSL values into an HSB string in the format hsb(h, s%, b%)
Method to format a BBjVector of individual HSL values into an HSB string in the format hsb(h, s%, b%)
Method to format a Java Color into an HSB string in the format hsb(h, s%, b%)
Method to convert a RGB Color to its corresponding HSB (Java) values and return an array containing the 3 HSB values
Method to format a BBjColor into an HSLA string in the format hsla(h, s%, l%, a)
Method to format a hex color string into an HSLA string in the format hsla(h, s%, l%, a)
Method to format individual HSBA values into an HSLA string in the format hsla(h, s%, l%, a)
Method to format a BBjVector of individual HSBA values into an HSLA string in the format hsla(h, s%, l%, a)
Method to format individual HSLA values into an HSLA string in the format hsla(h, s%, l%, a)
Method to format a BBjVector of individual HSLA values into an HSLA string in the format hsla(h, s%, l%, a)
Method to format a Java Color into an HSLA string in the format hsla(h, s%, l%, a)
Method to convert a BBjColor to its corresponding HSLA (Hue, Saturation, Lightness, and Alpha which is typically used in CSS) values and return an array containing the 4 HSLA parameters of the BBjColor
Method to convert a hex color to its corresponding HSLA (Hue, Saturation, Lightness, and Alpha which is typically used in CSS) values and return an array containing the 4 HSLA parameters of the hex color
Method to get a vector of HSLA values from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values
Method to get a vector of HSLA values from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a vector
Method to convert a Java Color to its corresponding HSLA (Hue, Saturation, Lightness, and Alpha which is typically used in CSS) values and return an array containing the 4 HSLA parameters of the Java Color
Method to format a BBjColor into an HSL string in the format hsl(h, s%, l%)
Method to format a hex color string into an HSL string in the format hsl(h, s%, l%)
Method to format individual HSB values into an HSL string in the format hsl(h, s%, l%)
Method to format a BBjVector of individual HSB values into an HSL string in the format hsl(h, s%, l%)
Method to format individual HSL values into an HSL string in the format hsl(h, s%, l%)
Method to format a BBjVector of individual HSL values into an HSL string in the format hsl(h, s%, l%)
Method to format a Java Color into an HSL string in the format hsl(h, s%, l%)
Method to convert a RGB Color to its corresponding HSL (CSS) values and return an array containing the 3 HSL values
Returns the native HTML element with low-level information such as content, size, and position.
Returns the native HTML element with low-level information such as content, size, and position.
Returns the native HTML element with low-level information such as content, size, and position.
getHTMLExporter Returns the HTML exporter which contains export options
Gets the HTML Link for the meeting
Returns the underlying BBjHtmlView control that contains the JavaScript FullCalendar.
getHyperlinkPopupMenu Returns the hyperlink popup menu
Gets the iCalendar User ID for the meeting.
Returns the control ID of the QVGrid component child window
getID Returns the ID of the tabbed view
Returns the calendar's Id string. Can be used to reference the calendar later. The special ID String "primary" refers to the Google account's default calendar.
Gets the Google Event ID. This is what you would use to access a particular event from the list of events associated with a Google Calendar.
The attendee's Profile ID, if available.
Returns an entry's unique ID if it has previously been set. If the entry's ID was set at creation time, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
Returns the source's unique ID that identifes the entry source for later use, such as with the getEntrySourceById()
method.
Note that if you create a CalendarEntrySource
with a constructor that doesn't take any parameters
then the ID will be set automatically. If you wish to specify the ID, you should use the constructor that
takes an ID as a parameter.
Get the editor unique id
Get the menu item ID
Get the menu item ID
Get the toolbar unique name
Get the component id
Method to get an ImageIcon from the BBXImage
Returns an image specified in the provided path. This is used internally by the Dashboard Utility for loading images, such as a widget's preview image. If the specified image is not found, it will return the default preview image for all widgets, which is an image with text saying that no preview of the widget is available. This is typically used to provide a preview of the widget in the Customize screen.
Gets an image from the provided file path or Java URL. If the desired image cannot be retrieved, the provided default image will be returned instead (if the default image parameter is null(), then that will be the return value).
You may either provide a fully-qualified path or a relative path based on the prefix for the first parameter. You may pass in null() or a valid widget for the last parameter. If the widget parameter is valid, the method will log a Dashboard Utility error with an error code of 320 and set the widget's error code and description accordingly.
Returns a BBjImage screenshot of the BBjCalendarWidget
.
Alias for imageToBase64()
Method to get an ImageIcon from the BBXImage
Returns the image name for the widget.
Returns the image URL for the widget.
Method getImgPathQueryResult: Namespace event handler for the image path query file chooser
Returns the current position of an inactive dashboard widget control that is part of the dashboard category control
Returns the inactive dashboard widget controls in the dashboard category control
Get the column index
Returns the index of the column with the specified name.
Method to return the index of a file's extension separator which is a dot. If the file doesn't have an extension, which can also occur when a file contains a dot within its path but is later followed by the path separator character or slash, then the method will return -1.
Returns the initial date that the calendar displays.
Returns the calendar's initial view type.
Returns an indication of whether InputN style cells will beep when user enters an invalid character
Returns the character that InputN style cells will display as their 'thousands' separator
Returns the character that InputN style cells will display as their decimal separator
Returns an indication of whether InputN style cells will display a character at each 'thousands' position
Method getInputValueType: Get control standard input type
Returns whether the editor is in insert mode
Returns an instance of the BBTranslator given a translation bundle name
Returns an instance of the BBTranslator given a translation bundle name, language, language of origin, and translation bundle directory
Returns an instance of the BBTranslator given a translation bundle
Returns an instance of the BBTranslator so that there is only one instance per translation bundle and locale
Return the number of initiated instances of the grid
Method getInterspace: Note: This method has been deprecated since BBj 5.0. Use getHorizontalCellSpacing().
getISO_A3 Creates and returns a media sized name object that contains ISO A3 media name information
getISO_A4 Creates and returns a media sized name object that contains ISO A4 media name information
Returns a BBjNumber acting as a boolean that indicates whether the widget is ready to be interacted with (1) or not (0).
getJasperDesign Returns the JasperDesign object
getJasperPrint Returns the JasperPrint object
getJasperPrint Returns the JasperPrint object
getJasperPrint Returns the JasperPrint of the tabbed view
getJasperPrint Returns the JasperPrint object
getJasperReport Returns the JasperReport object
Method to create a Java Color from a BBjColor
Method to create a Java Color from a hex color string
Method to create a Java Color from a BBjColor
Method to create a Java Color from a hex color string
Method to create a Java Color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a BBjVector
Method to create a Java Color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values
Method to create a Java Color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a BBjVector
Method to create a Java Color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values
Convert a Google EventDateTime object to a java.util.Date
Method to get a Java Font object from a BBjFont object
Given an SQL query, return a DefaultCategoryDataset filled with the desired data
Given an SQL query, return a DefaultCategoryDataset filled with the desired data
Given a BBjRecordSet and a BBjVector containing the columns of interest, return a DefaultCategoryDataset filled with the desired data
Given an SQL query, return a DefaultPieDataset filled with the desired data
Given an SQL query, return a DefaultPieDataset filled with the desired data
Given a BBjRecordSet and a BBjVector containing the columns of interest return a DefaultCategoryDataset filled with the desired data
Method to get the underlying JFreeChart so that it can be further manipulated if desired
Returns the native JavaScript event for the calendar event with low-level information such as click coordinates.
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the native JavaScript event object.
Returns a stringified JsonObject representation of the native JavaScript event.
A utility method that returns a BBjVector version of the supplied JSON array.
Returns a BBjVector version of the supplied JSON array.
Method to get the CSS properties for a given BBjFont and return a Google JsonObject, typically used when themeing the BBjGridExWidget
Method to get the CSS properties for a given BBjFont and return a Google JsonObject, typically used when themeing the BBjGridExWidget
A utility method that returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.
Returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.
Map a JSON object to GxClientKeypressModel
Map a JSON object to GxClientKeypressModel
Returns a collection translation keys
Specifies the type of Google resource.
Gets the Google resource kind.
getLandscape Creates and returns a print orientation object that contains landscape information
Get the selected language
Get the language keys
Get the translation keys as JSON string
Get the language keys
Get the translation keys as JSON string
Get the language manager instance
getLargeCapacity Creates and returns a print media tray object that contains large capacity tray information
getLastExportDir Returns the last export directory used
getLastFieldDelimiter Returns the last field delimiter used
getLastRecordDelimiter Returns the last record delimiter used
getLastSaveAsDefault Returns the last save as default value
getLastTextQualifier Returns the last text qualifier used
Returns the current visible left-most column
Gets the font size for the chart's legend items. This is used internally to ensure that the legend item shapes are the same size as the legen item text.
Returns the color of the separator lines
Returns the locale of the translations
Returns the calendar's locale setting which defaults to null() and can be modified via the setLocale()
method.
Returns the difference between the client's local time and UTC in minutes. For example, if your time zone is UTC+10, then -600 will be returned because UTC is 600 minutes behind the local time zone. Another way to view it is that the return value is the number of minutes that should be added to the local time in order to find UTC. Note that daylight savings time prevents this value from being a constant.
DEPRECATED Returns the difference between the client's local time and UTC in minutes. For example, if your time zone is UTC+10, then -600 will be returned because UTC is 600 minutes behind the local time zone. Another way to view it is that the return value is the number of minutes that should be added to the local time in order to find UTC. Note that daylight savings time prevents this value from being a constant.
Get Calendar's location.
Gets a string representing the event location
Returns an entry's extended information that can be used to further describe the entry beyond the title text.
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
Returns the text that appears in the status bar when the mouse pointer hovers over the grid control
getLargeCapacity Creates and returns a print media tray object that contains main tray information
Returns the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
Returns the default background color of the grid
Returns the default font of the grid
Returns the default foreground color of the grid
Returns the background stripe color of the grid
Returns the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headerthe default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.s.
getManual Creates and returns a print media tray object that contains manual tray information
Get the column mask
Returns the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated and always returns 2147483647.
Returns the maximum number of rows allowed in the data set
getMediaSizeName Returns the media size name object
getReverseLandscape Returns the media try object
Get the column type
Returns the metadata of the column.
Returns whether the user's meta key was pressed when the event occurred.
getMiddle Creates and returns a print media tray object that contains middle tray information
Get the mini filter value.
Note that if the grid is not ready , then this method will always return an empty string
even if you have called setMiniFilter
before.
#API
getMonochrome Creates and returns a chromaticity object that contains monochrome information
getNA_Ledger Creates and returns a media sized name object that contains NA Ledger media name information
getNA_Legal Creates and returns a media sized name object that contains NA Legal media name information
getNA_Letter Creates and returns a media sized name object that contains NA Letter media name information
Returns the name of dashboard item
Returns the name of the widget control
Returns the name of the dashboard category control
Returns the name of the widget control
Returns the control name of the grid control
Returns the widget's name as previously-set via the setName()
method.
Get the column name
Returns whether the grid control has no border
getNormal Creates and returns a print quality object that contains normal quality information
Returns the number of active dashboard widget controls in the dashboard category control
Returns the number of fetched entries.
Returns the number of columns in the bar chart's dataset
Returns the number of rows in the line chart's dataset
Returns the number of columns in the GridExWidget
Returns the number of columns in the GridWidget
Returns the number of columns in the grid
Returns the number of dashboard widget controls in the dashboard category control
Returns the number of dashboard widgets
Returns the number of inactive dashboard widget controls in the dashboard category control
Gets the number of items in the first series in the chart
Gets the number of items in the chart for a particular series
Returns the number of pages in the report
getNumPages Returns the number of pages in the report
Returns the number of rows in the GridExWidget
Returns the number of rows in the GridWidget
Returns the number of rows in the pie chart's dataset (or slices in the pie)
Returns the number of rows in the bar chart's dataset
Returns the number of rows in the line chart's dataset
Gets the number of series (number of lines) in the chart
Returns the number of rows in the grid
geNumViews Returns the number of views
getODSExporter Returns the ODS exporter which contains export options
getODTExporter Returns the ODT exporter which contains export options
Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.
Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.
Returns the old version of the calendar entry, e.g. the entry as it existed before the changes were applied.
getOneSided Creates and returns a print sides object that contains one sided information
Whether this is an optional attendee. Optional. The default is False (0).
Returns the calendar's current options in an instance of the CalendarOptions
class.
Returns the calendar's options as a JsonObject.
The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
Whether this attendee is also the organizer. Default is 0.
getOrientation Returns the orientation requested object
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
getPage Return the current page
getPage Returns the current viewed page of the report
Test method that retrieves the local webserver page at http://localhost:8888/
Returns the number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no meaning
getParam Returns an individual parameter
getParameter Returns a export parameter value
getParameters Returns export parameter values
getParams Returns all report parameters
Returns the parent of the translations
Returns the widget control's parent window which was specified during the construction of the WidgetControl
see BBjControl
getParentWindow Returns the parent window that houses the tabbed view
getPDFExporter Returns the PDF exporter which contains export options
Method getPgmFileFindResult: Get result of program file find from namespace
Method getPgmFilePath: Get program file path from input control
Get the pinned bottom rows as defined in the grid options
Get the bottom pinned rows as json String
Get the bottom pinned rows as Json Array
Get the count of pinned rows on bottom
Get the pinned top rows as defined in the grid options
Get the top pinned rows as json String
Get the top pinned rows as Json Array
Get the count of pinned rows on top
Check if pivot mode is enabled or disabled
#Configuration
#API
Retrieves a popup menu from the grid control
getPortait
getPortrait Creates and returns a print orientation object that contains portrait information
Returns the position of the calendar's toolbar as of the toolbar position constants like
CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP()
or CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM()
.
getPPTXExporter Returns the PPTX exporter which contains export options
Returns the preview image for the widget control that is used for display in the customize dialog
Get the primary calendar. This is the user's default calendar when they navigate to https://www.google.com/calendar
getPrinterName Returns the printer name
getChromaticity Returns the print quality object
getPrintRequestAttributeSet Returns the print request attribute set
getPrintServiceExporter Returns the PrintService exporter which contains export options
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False (0).
Returns the translations properties
Returns a properties file name
getQuery Returns the SQL query string
getQueryLanguage Returns the query language string, e.g. "SQL"
Returns whether the grid control has a raised border
Map a JSON object to GxClientRangeSelectionModel
Map a JSON object to GxClientRangeSelectionModel
The method will return a vector of the selected ranges including columns and rows
#API
Text about the status code. Some webservers may give more elaborate error information than the standard status code text.
Retrieves the current record data
Returns the RecordSet
Retrieves the current record template definition
Returns a vector of strings containing the iCalendar-format
rules for the event recurrence.
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
The authorization refresh token. This is a long term token used to retrieve session tokens.
Returns the type of refresh (a constant defined in the ChartWidget class) based on what initiated the event.
Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
Gets information about reminders such as email and popup notifications.
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.
getReport Returns the BBJasperReport object
getReport Returns the report of the tabbed view
getReport Returns the BBJasperReport object
getReportChildWindow Returns the ReportChildWindow object
getReportDir Returns the report directory
getReportFile Returns the report file
getReportFile Returns the report file path
getReportName Returns the report name
getReportName Returns the report name
getReports Returns a BBjVector containing the BBJasperReport objects
Method getResFileFindResult: Get result of resource file find from namespace
Get the editor resolver instance
Whether the attendee is a resource. Read-only. The default is False (0)
The attendee's response status. Possible values are: "needsAction" - The attendee has not responded to the invitation. "declined" - The attendee has declined the invitation. "tentative" - The attendee has tentatively accepted the invitation. "accepted" - The attendee has accepted the invitation.
Returns the GridExWidget's underlying BASIS Components ResultSet
Returns the pie chart's underlying dataset as a BBjRecordSet
Returns a BASIS Components ResultSet filled with data given a BBjRecordSet and a vector of columns
This is an internal method used by the widget class
Returns a BASIS Components ResultSet filled with data given a connect string and SQL query
This is an internal method used by the widget class
Returns a BASIS Components ResultSet filled with data given BBjVectors for the column header data and row data
This is an internal method used by the widget class
getReverseLandscape Creates and returns a print orientation object that contains reverse landscape information
getReversePortait
getReversePortrait Creates and returns a print orientation object that contains reverse portrait information
Method to get an RGBA representation of a BBjColor
Method to get an RGBA representation of a hex color string
Method to get an RGBA representation from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values
Method to get an RGBA representation from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a vector
Method to get an RGBA representation from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values
Method to get an RGBA representation from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a vector
Method to get an RGBA representation of a hex color string
Method to get an RGBA representation of a Java Color
Method to create a java RGB Color from its corresponding HSL (CSS) values
Method to get an RGB representation of a BBjColor
Method to get an RGB representation of a hex color string
Method to get an RGB representation of a Java Color
Get the root id of the grid
The root id is a unique & auto-generated id for the grid instance. This id is used in the client to distinguish the grid instances
Returns the row with the given key from the grid.
Note : if you only need to get the row and you don't care about other meta data like parent(when grouping) , isSelected, ... then use the ResultSet API (ex ResultSet.getItem(BBjString key!) )
Get the cell's row
Map a JSON object to GxClientRowModel
Map a JSON string to GxClientRowModel
Map a JSON object to GxClientRowModel
Map a JSON string to GxClientRowModel
Returns the horizontal alignment of a row
Returns the data of the GridWidget in a BBjVector
Returns the data of the GridWidget in a BBjVector
Returns the default font of a row
Returns the number of pixels separating the row header and the main grid area
Returns the BBjGridHeader object for this grid
Returns the default alignment of the row header
Returns the default background color of the row header
Returns the alignment of a row header cell
Returns the background color for a row header cell
Returns the foreground color of a row header cell
Returns the style of a row header cell
Returns the text displayed in a row header cell
Returns the vertical alignment of the row header cell
Returns the default font of the row header
Returns the default foreground color of the row header
Returns the default style of the row header
Returns the vertical alignment of the row header
Returns the width of the row header
Returns the height of a row in pixels
Returns the default height in pixels of the rows
Retrieves the row key for the specified resultset row
Maps the view index of a row to the model index
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid after sorting and filtering
Returns a vector of style names that have been added to a row
Returns the default vertical alignment for a row
Maps the model index of a row to the view index
getRTFExporter Returns the RTF exporter which contains export options
getSaveFile Returns the save file
geSavePopupMenu Returns the save popup menu
Method getScreenImage: Capture an image of the entire screen
Method to get the ratio of physical to logical pixels on the default client screen device. HiDPI (Retina) displays report values greater than 1, typically 2
Note that you can use the getScreenPixelRatio(BBjWindow p_window!)
method to get the pixel ratio of a particular screen associated with a BBjWindow
Method to get the ratio of physical to logical pixels on the specific client screen device. HiDPI (Retina) displays report values greater than 1, typically 2
Note that you can use the getScreenPixelRatio()
method to get the pixel ratio of the default screen if you don't have a BBjWindow object avialable
Returns the X location of the widget control on the screen
Returns the X coordinate of the the QVGrid component child window on the screen
Returns the X-coordinate of the user's mouse relative to the screen.
In the BUI and DWC clients, this value increases as the browser's position moves further right on the screen. In the GUI client, this value increases as the window moves further right on the screen.
Returns the Y location of the widget control on the screen
Returns the Y coordinate of the the QVGrid component child window on the screen
Returns the Y-coordinate of the user's mouse relative to the screen.
Returns whether the grid will scroll when the mouse cursor is moved outside the bounds of the grid during a drag and drop operation
Returns whether the grid updates the display of data in the cells while being scrolled
Returns a constant indicating under what situations the grid control will respond to the mouse scroll wheel
Returns the currently selected column in the GridWidget
Returns the currently selected column
Returns a BBjVector containing selected columns
Returns the currently selected row in the GridWidget
Returns the currently selected row
Get the current selected row
#API
Get the number of affected rows by the last event
Returns a vector containing the selected rows in a grid
Get Array of selected rows
#API
Returns the text of the currently selected cells in the GridWidget via a BBjVector.
Each index in the vector corresponds to the similarly numbered column in the BBjGrid.
Returns the current selection mode
Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
iCalendar sequence number.
Returns the requested series
Returns the name of the specified series number associated with the XY Chart
Returns the names of the series associated with the XY Chart
Returns the number of the specified series name associated with the XY Chart
@description: Changed with transition to Google Drive. Used to return DocsService and now returns Drive (a service object)
Returns whether the user's shift key was pressed when the event occurred.
Returns the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as getToolTipText().
Method getShortName: Get control short name
Returns whether the grid should highlight the entire column of the currently selected cell
Returns whether the grid should highlight the entire row of the currently selected cell
getShowFileDialogOnInitDefaultSave Returns if the file save dialog should be shown on the intitial save
getShowGoogleDialogOnInitDefaultSave Returns if the Google save dialog should be shown on the intitial save
Returns whether input style cells display the decoration characters of their mask in non-edit mode Note: This method has been deprecated.
getSide Creates and returns a print media tray object that contains side tray information
Get the grid sidebar instance
getSides Returns the sides object
Returns the number of translations
Returns the time slot duration.
Returns the maximum time slot (latest time) that will be displayed for each day in a time grid view.
Returns the minimum time slot (earliest time) that will be displayed for each day in a time grid view.
Returns the time slot that the calendar initially scrolls to.
Returns whether the gird will adjust its height so that only full rows appear in the grid Note: The QVGird always shows only complete rows, so this method always returns the default of TRUE.
Returns an indication of whether this grid sorts by multiple columns
Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
Method getSourceFile: Returns the source file
Returns the SQL query
The event's start time.
Returns the calendar's selected starting date, which may include timezone information.
Returns the calendar's starting date for the current range.
Returns an entry's starting date/time.
Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's start date was moved by.
Returns the selection mode that will be used when starting to edit a cell Note: The QVGrid is not editable, so this method has no further meaning
Returns the calendar's starting date in ISO 8601 format for the current range.
Returns the calendar's selected starting date in ISO 8601 format. Depending on what the user selected, it may or may not include a time and time zone portion.
Get the grid's columns , sorting and filtering state
#API
Whether the event is occurring. Values are "confirmed", "tenative", and "cancelled". The default is "confirmed".
Get the grid statusbar instance
The status code resulting from sending the corresponding request. I.E., 404 for "File Not Found" or "200" for "success".
Returns the width of a string in pixels
Returns the number of grid rows to alternate between the stripe color and the default background color
see BBjControl
Returns the value of the specified CSS property.
Gets a vector of all CSS style names that have been added to the grid control
Returns the widget's name as previously-set via the setName()
method.
Method to return a BBXImage that is a subimage defined by a specified rectangular region
Retrieves the calendar's summary.
Get the title of the event.
Retrieves the calendar's summary override.
Gets the SysGui event
Returns the current tab action of the grid
When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method is not influenced by a previous setTabActionSkipsNonEditableCells().
getTabbedView Returns the tabbed view
getTable Returns the table name
getTabOnParentHyperlinkTarget Returns whether a tab will be created when hyperlink targets are set to parent, otherwise a window will be created
Returns an entry's tags in a vector of strings.
Method getTempDir: Get temporary directory path
Method getTempDir: Get temporary directory path on server or client
getTemplate Returns the BBJasperTemplate object
Gets a BBjTemplatedString representation of the DashboardCategoryAttribute
Returns the control text assigned to the grid control Note: The relevance of this method for a grid is questionable, but provided for compatability.
Returns an entry's text color.
Returns the source's entry text color.
Returns the theme that the calendar is using.
Returns all of the calendar's available themes as an alphabetized list in a BBjVector filled with the theme names.
After determining which themes are available, you can call the setTheme()
method specifying any of the theme names in the return vector to change the calendar's theme.
Note that the installed themes are located in the BBjCalendarWidget's lib/bootstrap/themes/
directory. The installed themes
are free Bootstrap themes from https://bootswatch.com/
, although free
Bootstrap themes are available from many other sites such as
https://startbootstrap.com/themes
.
If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the bootstrap.css
and
bootstrap.min.css
files in the newly-created subdirectory. The calendar will attempt to find and use the
bootstrap.min.css
first due to its reduced size.
Get the grid supported themes
#API
Retrieves the calendar's timezone.
Returns the calendar's timezone setting which defaults to "local".
Returns the calendar's time zone setting.
Returns the title of dashboard item
Gets the dashboard window's title
Returns the title of the widget control
getTitle Returns the dialog title
Returns an entry's optional unique ID if it has previously been set.
Returns the view's current title, which is a property for users of the class. It's the title text that's displayed at the top of the header toolbar, such as "September 2020" or "Sep 7 - 13 2020".
The authorization token.
If a refresh token is stored in a cookie for our current set of permissions, submit the refresh token to get a new token from Google.
Returns the toolbar of the dashboard control
getToolbar Returns the tool bar
getToolbarControlAt Returns a tool bar control at the specified index
getToolsPopupMenu Returns the tools popup menu
Returns the tooltip text (also known as short cue) for a cell
Returns the tooltip text (also known as short cue) for a column
Returns the tooltip text (also known as short cue) for the grid control
getTop Creates and returns a print media tray object that contains top tray information
Returns the current top visible row
Method getTopWindowId: Get the first top level window id in a resource file
Method getTopWindowIdList: Get a list of all the top level window ids in a resource file
Returns the translation value given a key
getTranslation Returns a translation value, given a translation key
Returns the translated string given a key
If the translation is not found, then the passed in key is returned
Returns the translated string given a key
If the translation is not found, then the passed in default value is returned
Returns the translated string given a key
If the translation is not found, then the passed in default value is returned. The key/value can be added if not found.
Returns the translated string given a key
If the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found.
Returns the translated string given a key
If the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found. The parent locale translations can be optionally skipped.
Returns the translated string given a key, if the translation is not found, then the passed in key is returned
Returns the translated string given a key, if the translation is not found, then the passed in default value is returned
Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added if not found.
Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found.
Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found. The parent locale translation can be optionally skipped.
Returns the translation Bundle
Returns all translations for the current locale
Indicates whether the event blocks time on the calendar. "transparent" means other events may take place at the same time. "opaque" blocks other events on the calendar. The default is "opaque".
Returns whether the grid will trim its size if it is larger than the size needed to display the data, all headers and all scrollbars
getTumble Creates and returns a print sides object that contains tumble information
getTwoSidedLongEdge Creates and returns a print sides object that contains two sided long edge information
getTwoSidedShortEdge Creates and returns a print sides object that contains two sided short edge information
getTXTExporter Returns the TXT exporter which contains export options
Method getType: Get control type id
getType Returns the design type
Returns the calendar's view type.
Get the column type
Returns the value of the ColumnType property from the ResultSet's metadata.
Method getTypeName: Get control type name
Returns whether the grid sends table update events
The time the event was last updated.
Returns the URL of a dashboard widget link select event
Returns an entry's associated URL that may be visited when this entry is clicked by the user.
Returns the source's URL parameter.
Returns the user agent string for the HtmlViewWidget
This requires a BBj 15 or greater interpreter
Returns the user data object of dashboard item
Retrieves user data associated with the grid control after having called setUserData()
Returns the custom object that was previously associated with the widget by calling the setUserData()
method.
Gets the custom font scaling factor or the chart as set by the user in the Customize screen.
Returns a unique auto-generated ID for the calendar instance that may be used to distinguish between instances of the class.
Returns an entry's unique UUID that is automatically generated for all entries.
Returns the value that the user just entered into the grid control Note: The QVGrid is not editable and a grid control always returns an empty string, so this method has no meaning
Returns a date string formatted as YYYY-MM-DD if the provided date string can be parsed into a valid date, or null() if the date string is invalid.
Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ
) is never ambiguous, but this method exists to attempt to parse an ambiguous
date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to
resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example,
a date of "1-2-3"
is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind.
That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000"
is far less
ambiguous and will likely be parsed correctly in to "2000-01-01"
.
Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of
this writing, Chrome can parse ambiguous dates like "May 2020"
and "May 15"
. However, Firefox returns an "Invalid Date" for those values.
DEPRECATED Returns a formatted date string if the provided date string can be parsed into a valid date, or null() if the date string is invalid.
Returns an ISO 8601 formatted date/time string if the provided date/time string can be parsed into a valid date, or null() if it can't be parsed.
Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ
) is never ambiguous, but this method exists to attempt to parse an ambiguous
date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to
resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example,
a date of "1-2-3"
is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind.
That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000"
is far less
ambiguous and will likely be parsed correctly in to "2000-01-01"
.
Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of
this writing, Chrome can parse ambiguous dates like "May 2020"
and "May 15"
. However, Firefox returns an "Invalid Date" for those values.
DEPRECATED Returns an ISO 8601 formatted date/time string if the provided date/time string can be parsed into a valid date, or null() if the date string is invalid.
Method getValidEvents: Get valid events map
Returns the calendar's ending date that the user sees and interact with.
Returns the calendar's starting date that the user sees and interact with.
Returns a time string formatted as HH:MM:SS using 24-hour format if the provided time string can be parsed into a valid time, or null() if the time string is invalid.
Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ
) is never ambiguous, but this method exists to attempt to parse an ambiguous
date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to
resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example,
a date of "1-2-3"
is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind.
That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000"
is far less
ambiguous and will likely be parsed correctly in to "2000-01-01"
.
Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of
this writing, Chrome can parse ambiguous dates like "May 2020"
and "May 15"
. However, Firefox returns an "Invalid Date" for those values.
DEPRECATED Returns a formatted time string if the provided time string can be parsed into a valid time, or null() if the time string is invalid.
Method getValidTypes: Get all valid control type information
getValue
Given a dot-delimited JSON path and a JSON document as a string, traverses the JSON document
to extract the value.
For example:
If I have the path "RestResponse.result[0].name" and my JSON document consists of
{ "RestResponse" : { "result" : [ { "name" : "Afghanistan" } ] } } ,
my result will be "Afghanistan".
Get the cell value
Method to get the dial chart's current value which is in the range from 0 to 100, indicating percentage complete
Method to get the value of the dial chart
Method to create a vector of divergent colors with a specified starting, middle, and ending range.
In order to result in a balanced divergent palette, the p_numColors must be at least 3 and should be an odd number.
Method to create a vector of Java Colors with a specified starting and ending range
Given a BBjRecordSet and a vector of columns, return vectors for the grid's column headers and data embedded in a return vector.
This is an internal method used by the widget class
Given an SQL query, return vectors for the grid's column headers and data embedded in a return vector.
This is an internal method used by the widget class
Returns the amount of vertical space between the rows
Returns whether the vertical lines between columns are visible
Returns whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid
Returns whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so 1 (true) is always returned.
getView Returns the BBJasperView for the widget
getView Returns the current view
getView Returns the current view of the tabbed view
getViewAt Returns a view at a specified index
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.
getViewerControl Returns the viewer control
getViewerControl Returns the viewer control that houses the tabbed view
getViewerWindow Returns the viewer window
Returns the view index in the view vector
getViews Returns all views in a vector
Returns the calendar's view type which will be one of the following constants:
CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()
.CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
.CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY()
.CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
.CalendarAPI.CALENDAR_VIEW_LIST_DAY()
.CalendarAPI.CALENDAR_VIEW_LIST_WEEK()
.CalendarAPI.CALENDAR_VIEW_LIST_MONTH()
.CalendarAPI.CALENDAR_VIEW_LIST_YEAR()
.Visibility of the event. Can be the following values: "default": default visibility. This is the default value. "public": Anyone who can see the calendar can see the event. "private": Only participants can see the event. "confidential": alias to "private" provided for compatibility reasons.
Returns the number of rows that are currently visible in the grid
Returns a BBjVector filled with optional custom tags that were previously set with the setVisibleTags() method and determine which calendar entries should be displayed.
When dealing with entry tags, there are three sets to be aware of:
CalendarEntry
custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.BBjCalendarWidget::setVisibleTags()
methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally.BBjCalendarWidget::setHiddenTags()
methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view.
Note: If the BBjCalendarWidget
's set of visible tags is empty then all calendar entries will be visible.
If the BBjCalendarWidget
's set of hidden tags is empty then all calendar entries will be visible.
Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
Get the URL of the Jetty Web Server's apps directory.
Get the URL of the Jetty Web Server's apps directory, specifying whether an SSL connection is required or not.
Get the URL of the Jetty Web Server's files directory.
Get the URL of the Jetty Web Server's files directory, specifying whether an SSL connection is required or not.
Get the host of the Jetty Web Server.
Get the port of the Jetty Web Server.
Get the port of the Jetty Web Server.
Get the port of the Jetty Web Server, specifying whether an SSL connection is required or not.
Get the SSL port of the Jetty Web Server.
Get the URL of the Jetty Web Server's root directory.
Get the URL of the Jetty Web Server's root directory, specifying whether an SSL connection is required or not.
Returns the encapsulated widget
Returns the encapuslated widget used in the widget control
Get the widget instance
Get the widget instance
Get the widget instance
Get the widget instance
Get the widget instance
Returns the widget attributes
Returns the widget type
Method to get the width of the BBXImage
Returns the width of the widget control
Returns the width of the EmbeddedWidgetWindow
Returns the width of the EmbeddedWidgetWindow
getWidth Returns the width of the dialog
getWidth Returns the width of the dialog
Returns the width of the QVGrid component child window
getWidth Returns the width of the viewer control
getWidth Returns the width of the tabbed view
getWidth Returns the width of the viewer control
Returns the widget's width.
getWindow Returns the export window
getWindow Returns the wizard window
getWindowOnBlankHyperlinkTarget Returns whether a window will be create when hyperlink targets are set to blank, otherwise a tabe will be created
getWindowTitle Returns the title of the viewer window
Returns the X location of the widget control
Returns the X location of the EmbeddedWidgetWindow
Returns the X location of the EmbeddedWidgetSetWindow
getX Returns the X screen location of the dialog
getX Returns the X location of the email dialog
Returns the X coordinate of the QVGrid component child window
getX Returns the X location of the viewer control
getX Returns the X location of the tabbed view
getX Returns the X location of the viewer control
Returns the widget's X coordinate, or horizontal position.
getXHTMLExporter Returns the XHTML exporter which contains export options
getXLSExporter Returns the XLS exporter which contains export options
getXLSXExporter Returns the XLSX exporter which contains export options
getXMLExporter Returns the XML exporter which contains export options
Returns the XYChart's underlying dataset, which is a JFreeChart XYSeriesCollection
Note that PieCharts return a DefaultPieDataset, BarCharts and LineCharts return a DefaultCategoryDataset, and XYCharts return an XYSeriesCollection
Returns the Y location of the widget control
Returns the Y location of the EmbeddedWidgetWindow
Returns the Y location of the EmbeddedWidgetSetWindow
getY Returns the Y screen location of the dialog
getY Returns the Y location of the email dialog
Returns the Y coordinate of the QVGrid component child window
getY Returns the Y location of the viewer control
getY Returns the Y location of the tabbed view
getY Returns the Y location of the viewer control
Returns the widget's Y coordinate, or vertical position.
getZoomLevel Returns the current zoom level
getZoomLevel Returns the current zoom level
getZoomNumber Returns the zoom number, given a precentage string
Represents a single event on the Google calendar. Events are designated
time segments on a calendar, like appointments, vacations, etc. There
are several types of events including timed events, all-day events, and
recurring events.
Timed events: Timed events begin at a specified time and
end at a later specified time. For example, a meeting might begin at
13:00 EST on November 4, 2013 and and at 14:30 EST on November 4, 2013.
All-Day Events: All-Day events begin on the specified start date and end
at the end of the day right before the specified end date. So, a 5-day
vacation starting on November 4th, 2013 would be expressed as
November 4, 2013 to November 9, 2013 where the days of vacation are
4, 5, 6, 7, and 8.
Recurring Events: Recurring events happen more than once with a given
interval over a span of time. Recurring events can be timed events or
all-day events. An example of a recurring event would be a meeting that
happens on the first of each month from 8:00 to 10:00 from January 1, 2012
to December 31, 2019.
Constructor for creating a brand new event.
Constructor for wrapping an existing Google Event.
Represents an event participant and includes the following properties: Comment DisplayName Email Id Organizer -- Indicates whether this participant is the event organizer. Optional -- Whether this is an optional attendee. Resource ResponseStatus Self
Default constructor that creates a new attendee.
Constructor that wraps an existing Google attendee.
A collection of one or more events in the Google calendar. This is often the result of an events request on the calendar. /
Constructor for GEvents.
Translated text for go to
Go to menu name
Translated text for go to page
Translated text for go to page
Class for authorization via Google OAuth 2.0.
Authorization occurs when the user accepts permission from a spawned
webpage, but a temporary local webserver recieves the token, so that
the user is not involved in providing the intermediate code to the
application.
OAuth authentication has the concept of scopes, which indicate
what permissions the requesting application is asking for. Such
permissions may include accessing the user email address, calendar,
posting via their Google Plus profile, etc.
After an application first asks for permission for a given set of
scopes, this class stores a cookie with the refresh token. In the
future, when calls are made to getTokenFromCookie, this class quietly
retrieves a new token from Google using the refresh token and uses
that token for authentication.
In the context of GUI, cookies are stored in Java Preferences.
GoldMineIntegrationWebService Class that provides a REST-based web service that integrates with GoldMine by passing XML strings. Addon now integrates with GoldMine and it uses this web service as one of its communications methods. The GoldMine servlet is a back-end class that handles low-level communications, and Addon takes care of all of the gory details so it's a seamless experience for the end user.
Constructor. Basic construction is provided by the GoldMineIntegrationWebServiceFactory factory class
Creates a GoldMineIntegrationWebService instance
Google Doc save notify name
Document that will be used by default on a google doc save
Folder that will be used by default on a google doc save
Type that will be used by default on a google doc save
The wrapped Google Event object. Allows direct calls to the Java-based Google-based API.
The wrapped Google EventAttendee object. This can be accessed to make direct calls to the Java-based Google API.
Mouse scroll wheel event handler
Constant value to define centered column
Constant value to define left aligned column
Constant value to define right aligned column
Constant value to define editing mode "cell"
Constant value to define editing mode "row"
Constant value to define enter key behavior (Move to next cell)
Constant value to define enter key behavior (Stop editing)
Constant value which defines the rows floating on bottom
Constant value which defines the rows with no floating
Constant value which defines the rows floating on top
Constant value which defines that group panel must always be hidden
Constant value which defines that group panel must be shown only when grouping
Constant value which defines that group panel must always be shown
Constant value to define navigation behavior (Move to next cell)
Constant value to define navigation behavior (Move to next row)
Constant value to define row position
Constant value to define row position
Constant value to define row position
Constant value which describes the rows in after filtering phase.
Constant value which describes the rows in after filtering and sorting phase.
Constant value which describes the rows in before sorting and filtering phase.
Constant value which defines the alpine theme
Constant value which defines the alpine dark theme
Constant value which defines that balham theme
Constant value which defines that balham dark theme
Constant value which defines the material theme
Grid widget type constant
JGridEx widget type constant
GridExWidget A Dashboard Utility Widget that displays data in a BBjGridExWidget, a BBj plug-in available from the BBj Plugin Manager
The GridExWidget is based on the BBjGridExWidget plug-in which is a fast, full-featured grid that offers filtering, grouping, pinning, pivoting, and rules-based styling.
Creates an empty GridExWidget to be filled later with one of the fill() methods
Creates a GridExWidget that is filled with a BASIS Components ResultSet
Creates a GridExWidget with a connection string and SQL query which are used to automatically populate the grid with data
Creates a GridExWidget with a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data which are used to automatically populate the grid with data
Creates a GridExWidget providing the column header data and row data for the grid via BBjVectors
Creates a GridExWidget that is filled using the BASIS Components to build a ResultSet based off of a data file, string template, and filter
Creates a GridExWidget with a connection string, SQL query, and mode which are used to automatically populate the grid with data
GridWidget A Dashboard Utility Widget that displays data in a grid
Creates a GridWidget
Creates a GridWidget with a connection string and SQL query which are used to automatically populate the grid with data
Creates a GridWidget with a BBjRecordSet which is used to automatically populate the grid with data
Creates a GridWidget providing the column header data and row data for the grid via BBjVectors
Creates a GridWidget with a connection string and SQL query which are used to automatically populate the grid with data
GridWidgetEvent Class that contains event information for a GridWidget
Contructs a GridWidgetEvent
GridWidgetRefreshEvent Class that contains event information for a GridWidget that has just refreshed
Contructs a GridWidgetRefreshEvent
Specifies the results of row grouping should be displayed as custom: informs the grid that group columns will be provided.
Specifies the results of row grouping should be displayed as group rows: group rows are automatically added instead of group columns.
Specifies the results of row grouping should be displayed as multiple columns: a group column per row group is added automatically.
Specifies the results of row grouping should be displayed as single column: single group column automatically added by the grid.
If grouping, set to the number of levels to expand by default. Eg 0 for none, 1 first level only, etc. Default is 0 (expand none). Set to -1 for expand everything
#Configuration
#GridRenderer
Specifies how the results of row grouping should be displayed.
The options are:
#Configuration
#GridRenderer
The height for the rows containing header column groups. If not specified, it uses headerHeight
#Configuration
#GridRenderer
Set to true to hide parents that are open. When used with multiple columns for showing groups, it can give more pleasing user experience
#Configuration
#GridRenderer
The unique ID to give the column.
If grouping, whether to show a group footer when the group is expanded.
If true, then by default, the footer will contain aggregate data (if any)
when shown and the header will be blank.
When closed, the header will contain the aggregate data regardless
of this setting (as footer is hidden anyway).
This is handy for 'total' rows, that are displayed below the data when
the group is open, and alongside the group when it is closed
#Configuration
#GridRenderer
Set to true to show a 'grand' total group footer across all groups.
#Configuration
#GridRenderer
If using auto column, set to true to have each group in its own column separate column, eg if group by Country then Year, two auto columns will be created, one for country and one for year
#Configuration
#GridRenderer
Set to true to collapse lowest level groups that only have one child.
#Configuration
#GridRenderer
Set to true to collapse groups that only have one child.
#Configuration
#GridRenderer
When true, selecting a group will have the impact of selecting all its children
When false, then the group is selectable independently of the child nodes.
#Configuration
#GridRenderer
NoteThat this settings has no effect if MultipleSelection is disabled
If using groupSelectsChildren, then only the children that pass the current filter will get selected
#Configuration
#GridRenderer
The number's group separator to use. by default the bbj group separator will be used
The number's group separator to use. by default the bbj group separator will be used
If true, the grid will not swap in the grouping column when grouping is enabled.
Use this if you want complete control on the column displayed and don't want the grids help.
In other words, you already have a column in your column definitions that is responsible for displaying the groups
#Configuration
#GridRenderer
If true, and showing footer, aggregate data will be displayed at both the header and footer levels always.
This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
#Configuration
#GridRenderer
If true, the group row won't be displayed and the groups will be expanded by default with no ability to expand / contract the groups. Useful when you want to just 'group' the rows, but not add parent group row to each group
#Configuration
#GridRenderer
If grouping, set to true or false (default is false).
If true, a group row will span all columns across the entire width of the table.
If false, the cells will be rendered as normal and you will have the opportunity to include
a grouping column (normally the first on the left) to show the group
#Configuration
#GridRenderer
A structure representing the time interval for a busy space on a calendar.
@description: General Google-related utility class
A Class for performing conversions needed to go from Google constructs to those more recognized by BBj and standard Java.
Allows specifying the group 'auto column' if you are not happy with the default. If grouping, this column def is included as the first column definition in the grid. If not grouping, this column is not included.
Construct new instance
Abstract implementation for GxCellEditorInterface
Simple switch button to switch boolean values
A simple boolean editor based on the GxCellEditorRichSelect.
The editor provides a select box where the user can selected one of the three values (true , false , none)
#OnlyGUI
#Enterprise
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
A simple boolean editor based on the GxCellEditorSelect.
The editor provides a select box where the user can selected one of the three values (true , false , none)
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
A date cell editor
Construct a new GxCellEditorBasicDate
Construct new GxCellEditorBasicDate
A cell editor for timestamps
Construct new GxFilterBasicDateTime
Simple number input
Simple text input
Construct new GxCellEditorBasicText
A date cell editor
Construct a new GxCellEditorBasicTime
Construct new GxCellEditorBasicTime
Alias for GxCellEditorBasicDateTime
Construct new GxFilterBasicDateTime
Compare two cell editor components
Column Filter Public Interface
Simple editor that uses the standard HTML 'textarea' tag.
Simple editors that use the standard HTML select tag.
It is same as GxCellEditorSelect but as popup.
The standard HTML select to behave oddly in the grid. This is because the browser doesn't have a great API for opening and closing the selected popup.
We advise that you don't use it unless you have to - that is we advise against GxCellEditorPopupSelect as they give poor user experience, especially if using keyboard navigation.
If using Enhanced grid, you should use the provided GxCellEditorRichSelect.
#Enterprise
Same as GxCellEditorText but as popup.
Available in Enhanced Grid only. An alternative to using the browser's select popup for dropdown inside the grid.
#Enterprise
Simple editors that use the standard HTML select tag.
The standard HTML select to behave oddly in the grid. This is because the browser doesn't have a great API for opening and closing the selected popup.
We advise that you don't use it unless you have to - that is we advise against GxCellEditorSelect as they give poor user experience, especially if using keyboard navigation.
If using Enhanced grid , you should use the provided GxCellEditorRichSelect.
A Suggestion/autocomplete cell editor.
The suggestion cell editor is an input which gives the user a list of values (suggestions) to choose from while it types.
The suggestion list can be resolved using a custom object which implements
GxCellEditorSuggestionResolverInterface
or extends GxCellEditorSuggestionResolver
ex:
use ::BBjGridExWidget/GxCellEditors.bbj::GxCellEditorSuggestion editor! = new GxCellEditorSuggestion("ANY_UNIQUE_ID", new CustomResolver()) editor!.setEmptyMessage("No data to display") column! = grid!.getColumn("COLUMN_ID") column!.setCellEditor(editor2!)
Construct new GxCellEditorSuggestion
An generic implementation of GxCellEditorSuggestionResolverInterface
The class implements the resolve
method defined in GxCellEditorSuggestionResolverInterface
and exposes some helpers methods like addItem
, createItem
to help building
the suggestion list.
Any Custom object which extends this class must implement the doResolve
method
which accepts the search term.
ex:
use ::BBjGridExWidget/GxCellEditors.bbj::GxCellEditorSuggestionResolver class public CustomResolver extends GxCellEditorSuggestionResolver method public void doResolve(BBjString term!) sbc! = new SqlQueryBC(BBjAPI().getJDBCConnection("CDStore")) rs! = sbc!.retrieve(String.format("SELECT TITLE , MUSICTYPE, CDNUMBER FROM CDINVENTORY WHERE TITLE LIKE '%%%s%%' ORDER BY MUSICTYPE", term!)) it! = rs!.iterator() while it!.hasNext() next! = it!.next() label! = String.format("[%s] %s", #getColumn().getName(), next!.getFieldAsString("TITLE")) value! = next!.getFieldAsString("CDNUMBER") group! = next!.getFieldAsString("MUSICTYPE") #addItem(label!, value!, group!) wend methodend classend
A interface which defines how a suggestion's resolver/builder should build the suggesting lst
Simple text editors that use the standard HTML 'input' tag
Compare two cell renderers components
The model is used to compose a range chart model in order to be applied on the client.
The model is used to compose a range selection model in order to be applied on the client.
Ranges are normally bounded by a start and end row. However it is also possible to define a range unbounded by rows (ie to contain all rows). For an unbounded range, do not provided start or end row positions.
A model for the client cell
A model for the client column
Construct new GxClientColumnModel
Cell Editing / Clicking Event
Context Menu Event
Keypress event
Cells range selection event
Cell Editing / Clicking Event
Row Selection Event (single & double)
A generic abstract implementation for the GxClientFilterModel interface
The filter model represents the state of the boolean filter
Construct new GxClientFilterBooleanModel
A filter a which wraps two filter models and combine them with an OR
or AND
operator
Construct new GxClientFilterCombinedModel
Construct new GxClientFilterCombinedModel
Construct new GxClientFilterCombinedModel
The filter model represents the state of the datetime filter. Please not this model will work for date , times and timestamps
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
When saving or restoring state on a filter the filter model is used. The filter model represents the state of the filter
The filter model represents the state of the number filter
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
The filter model represents the enhanced filter type "setFilter"
Construct new GxClientFilterSetFilterModel
An abstract filter model which defined the common properties of the provided simple filters
The filter model represents the state of the text filter
Construct new GxClientFilterTextModel
Construct new GxClientFilterTextModel
Construct new GxClientFilterTextModel
The class will create client models from JSON
Construct new GxClientJsonFactory
The class will create client models from JSON
Construct new GxClientJsonFactory
The model is used to represent a keypress on the client
This model is used when range selections are read from the client
A client model for rows
Construct new client row
The sorting model describes how the columns will be sorted on the client
The model describes an transaction operation that can be passed to the grid to add / remove & update that data at once.
Construct new transaction model
The class holds the grid column props, it also introduces several helper methods to update the styles like, fore/back colors.
Create a new column definition
Create a new column definition
Create a new column definition
Create a new column definition
The class holds the common props between column and column groups. Every property and method has one or more tag attached.
The following is the meaning for each tag :
Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
The class holds the shared ag filter options between all filter types. This is the base class for all ag filter types
Filter options constants for date/time filter
Filter options constants for numbers filter
Filter options constants for texts filter
The class holds the grid column group. With this object you can group several columns and several column groups together to create deep nested structure.
Construct new GxColumnGroup
Construct new GxColumnGroup
The class is a direct implementation for GxColumnsManagerInterface and it defines the common logic for all methods
The interface defines the common methods for columns and column groups management
Columns Toolpanel
Construct new columns toolpanel
Construct new toolpanel
Construct new toolpanel
A class which represents grid context menu
A class which represents a grid context menu item
Construct new Menu item
Construct new Menu item
Construct new Menu item
An interface which defines a menu item
The class represents the default column definition which the grid will use.
The class holds the default grid column group.
A class which represents the default grid context menu
Construct the default grid context menu
A class to define the default implementation of the grid sidebar
Construct the default grid sidebar
The GxExecutor is responsible of Javascript code execution in the HTMLView. It will also tries to debounce the scripts which are enqueued for execution and send them in patches at specific rate.
Construct new GxExecutor object
Expressions are Javascript functions which are written as strings. When you provide an expression to the grid, the grid converts the expression into a function for you and then executes the function on the client.
Expressions can be used with the columns ValueGetterExpression, ValueFormatterExpression, ValueSetterExpression, ValueParserExpression.
For example you can add a virtual column to the grid and define a value getter expression to get the value of this column based on other two columns.
Expression can be as simple as "data.CDNumber" or more complex as the GxExpressionNumbersFormatter which can accepts parameters.
When working with expression key the following points in mind:
Expression can access several predefined variables :
x | Mapped from cell value |
value | Same as x |
oldValue | Mapped from the cell's old value, this is mapped in editing |
newValue | Mapped from the cell's new value, this is mapped in editing |
data | Mapped from the DataRow |
column | Current column |
columnGroup | Current column group |
getValue | The value after it is processed by the ValueGetterExpression |
ctx | The grid client context |
Abstract implementation for GxExpressionInterface
The class defines a grid expression to format bytes to one of the following measuring terms : ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
The class defines a grid expression to format date/timestamps according to BBj supported masks
Construct a new GxExpressionDatesFormatter
Construct a new GxExpressionDatesFormatter
Construct a new GxExpressionDatesFormatter
The class defines a grid expression to format date/timestamps according to BBj supported masks
Construct a new GxExpressionDateTimesFormatter
Construct a new GxExpressionDateTimesFormatter
Construct a new GxExpressionDateTimesFormatter
GxExpressionInterface
The class defines a grid expression to format numbers according to BBj supported masks
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
The class defines a grid expression to format strings according to BBj supported masks
Construct a new GxExpressionNumbersFormatter
Alias for GxExpressionDateTimesFormatter
Construct a new GxExpressionTimestampsFormatter
Construct a new GxExpressionTimestampsFormatter
Construct a new GxExpressionTimestampsFormatter
The class represents the boolean filter
The class represents the date filter
Construct a new GxFilterBasicDateTime
Construct new GxFilterBasicDate
The class represents the date time filter
Construct new GxFilterBasicDateTime
The class represents the time filter
Construct a new GxFilterBasicTime
Construct new GxFilterBasicTime
Alias for GxFilterBasicDateTime
Construct new GxFilterBasicTimestamp
Compare two filter components
The class represents the default ag-grid date filter
Column Filter Public Interface
The class represents the default ag-grid number filter
GxFilterSetFilter allow you to filter on set data, influenced by how filters work in Microsoft Excel
#Enterprise
A class which represents the filters toolpanel
Construct new filters toolpanel
Construct new filters toolpanel
Construct new filters toolpanel
The class represents the default ag-grid text filter
GxLanguageManager.bbj
The language manager will add, remove language files to the grid.
The grid will query the language manager in every render to get the translation keys.
Note Changing the language in the language manager will not automatically trigger a grid re-render.
GxLanguageManager
Construct a new GxLanguageManager instance
A logger class which is used internally to output log , warn , error messages to the console and to the debug.log file
The class holds the grid configuration properties
Every property and method has one or more tag attached.
The following is the meaning for each tag :
Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
Construct new GxOptions instance
The class defines the common boolean options shared between components which manipulate booleans
Construct new GxOptionsBoolean
The class defines the common date time options shared between components which manipulate dates , times & timestamps
Abstract implementation for GxRendererInterface
The class represents a boolean cell renderer
The class can render a custom html using lodash string templates.
Inside the template you will have access to the params object which contains value, valueFormatted, ...
Use This render if you want to render the data with a custom html.
Construct new GxRendererCustomHTML
If you are grouping in the grid, then you will need to provide a group cell renderer as the group cell renderer is what provides the user with the expand and collapse functionality.
Construct new GxRendererGroupCellRenderer
Construct new GxRendererGroupCellRenderer
The renderer can be used to display a list of images based on the cells values using a json object
Construct new GxRendererImageRenderer
GxRendererInterface
The class manages the grid sidebar and its toolpanels
Construct new sidebar
The Grid state object
GxStatusBar
Gx status bar manager. The class can add, remove & hide status bar components
Construct new sidebar
A statusbar component which provides aggregations on the selected range.
Construct new Aggregation Component
Construct new Aggregation Component
An Abstract implementation for GxStatusBarComponentInterface
Constructor
An interface which defines a status bar component
A statusbar component which provides the filtered row count.
Constructor
A statusbar component which provides the selected row count
Constructor
A statusbar component which provides the total and filtered row count.
Constructor
A statusbar component which provides the total row count.
Constructor
An abstract class which represents a toolpanel which can be attached to a sidebar
Construct new toolpanel
Construct new toolpanel
A interface which defines a grid toolpanel
A constant to define horizontal alignment of the chart legend's container
A constant to define horizontal alignment of the chart legend's container
A constant to define horizontal alignment of the chart legend's container
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Indicates whether the chart has a legend
Set to true to render a selection checkbox in the column's header.
#Configuration
#ColumnsRenderer
When true , The checkbox will select only filtered rows when checked and un-select only filtered rows when unchecked. The checkbox will update its state based only on filtered rows. When false The checkbox will select all rows when checked, and un-select all rows when unchecked. The checkbox will update its state based on all rows.
#Configuration
#ColumnsRenderer
CSS class(es) to use for the header cell.
#Configuration
#ColumnsRenderer
A BBjFont that is applied to the header in the underlying BBjGrid control, allowing customization of the font family, size, and style - note that the font information is translated into CSS for the underlying BBjGridExWidget
A BBjFont that is applied to the header in the underlying BBjGrid control, allowing customization of the font family, size, and style
Tooltip for the column group header
The height for the row containing the column label header. If not specified the default is 25px.
#Configuration
#GridRenderer
A vector of BBHeader. These are name/value pairs that provide the web server with additional information about the request.
Tooltip for the column header
#Configuration
#ColumnsRenderer
Height
Setup the suggestion list height in pixels
The image's height
Set to true to make a column hidden by default.
#Configuration
#ColumnsRenderer
When true, the sidebar will be hidden on the first draw, visible otherwise. default is false
Method hide: Hide frame
Method hide: Hide frame
Method hide: Hide frame
Method hide: Hide frame
Clear all overlays
#API
Translated text for highlight
Hit bottom event handler
Hit top event handler
Translated text for home
A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods
A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable
A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods
A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable
A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods
A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable
A number that determines the default horizontal alignment for cells in the grid. The default value is BBjGrid.GRID_ALIGN_CENTER
A number that determines the default horizontal alignment for column header cells in the grid. The default value is BBjGrid.GRID_ALIGN_CENTER.
A number that determines whether the horizontal scrollbar will appear if there are more columns than can be displayed in the grid's client area. The default value is 0.
Constant for hours
Constant that represents the HTML save contributor
Constant that represents the HTML save contributor
HTML View chart widget type constant
HTML exporter which contains export options
The BBjHtmlView control that will execute the JavaScript.
Instance of the created HTMLView
HtmlViewWidget A Dashboard Utility Widget that displays html text or the contents of a URL
Creates an HtmlViewWidget
Creates an HtmlViewWidget
HtmlViewWidgetEvent Contains information for an HtmlViewWidget event that can be registered using the setCallback() method on the HtmlViewWidget
{@link Dashboard.HtmlViewWidget#setCallback()} has an example
Constructs a HtmlViewWidgetEvent
Filter for getEvents() method: Specifies event ID in the iCalendar format to be included in the response. Optional. (string)
The icon to display beside the icon, either a DOM element or HTML string
Icons to use inside the column instead of the grid's default icons.
The icons can either be set on the grid options (all icons) or on the column definition (all except group). If defined in both the grid options and column definitions, the column definition will get used. This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons and just the simple arrow for other columns.
#Configuration
#ColumnsRenderer.
The icons are set as follows:
// column header items
menu
filter
columns
sortAscending
sortDescending
sortUnSort
// row checkbox selection and tool panel column selection
checkboxChecked
checkboxUnchecked
checkboxIndeterminate
// tool panel column selection, when read only (ie disabled checkboxes)
checkboxCheckedReadOnly
checkboxUncheckedReadOnly
checkboxIndeterminateReadOnly
// when moving columns
columnMovePin // when column is to the left, before it gets pinned
columnMoveAdd // when adding a column
columnMoveHide // when removing a column
columnMoveMove // when moving a column
columnMoveLeft // when moving and scrolling left
columnMoveRight // when moving and scrolling right
columnMoveGroup // when about to drop into group panel
columnMoveValue // when about to drop into value panel
columnMovePivot // when about to drop into pivot panel
dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
// menu
menuPin // beside the column pin menu item
menuValue // beside the column value menu item
menuAddRowGroup // beside the column row group menu item
menuRemoveRowGroup // beside the column row group menu item
clipboardCopy // beside the copy to clipboard menu item
clipboardPaste // beside the paste from clipboard menu item
// column drop panels
pivotPanel // beside where to drop columns for pivot
valuePanel // beside where to drop columns for value
Icons to use inside the grid instead of the grid's default icons.
The icons can either be set on the grid options (all icons) or on the column definition (all except group).
If defined in both the grid options and column definitions, the column definition will get used.
This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
and just the simple arrow for other columns.
#Configuration
#GridRenderer.
The icons are set as follows:
// column header items
menu
filter
columns
sortAscending
sortDescending
sortUnSort
// expand / contract row group
groupExpanded
groupContracted
// expand / contract column group
columnGroupOpened
columnGroupClosed
// tool panel column group open / close
columnSelectOpen
columnSelectClosed
// row checkbox selection and tool panel column selection
checkboxChecked
checkboxUnchecked
checkboxIndeterminate
// tool panel column selection, when read only (ie disabled checkboxes)
checkboxCheckedReadOnly
checkboxUncheckedReadOnly
checkboxIndeterminateReadOnly
// when moving columns
columnMovePin // when column is to the left, before it gets pinned
columnMoveAdd // when adding a column
columnMoveHide // when removing a column
columnMoveMove // when moving a column
columnMoveLeft // when moving and scrolling left
columnMoveRight // when moving and scrolling right
columnMoveGroup // when about to drop into group panel
columnMoveValue // when about to drop into value panel
columnMovePivot // when about to drop into pivot panel
dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
// menu
menuPin // beside the column pin menu item
menuValue // beside the column value menu item
menuAddRowGroup // beside the column row group menu item
menuRemoveRowGroup // beside the column row group menu item
clipboardCopy // beside the copy to clipboard menu item
clipboardPaste // beside the paste from clipboard menu item
// column drop panels
rowGroupPanel // beside where to drop columns for row group
pivotPanel // beside where to drop columns for pivot
valuePanel // beside where to drop columns for value
Get the toolbar unique name
The row id
Image widget type constant
imageFileSaveDialog Displays a file save dialog to save a client image file.
The imagelist image file used by the Dashboard for its icons, such as on the Customize and Exit buttons. This version is used for device pixel ratios 2.0 and lower. For pixel ratios higher than 2.0 see the ImageListHiRes field variable.
The specified image file will be used instead of the [BBjHome]/utils/dashboard/images/iconWidgetImageList@2x.png file. If you wish to make your own imagelist file, it can be any size as long as it follows the rules for an imagelist: the imagelist file is made by joining images of equal width together end-to-end horizontally to create a single image. The Dashboard calculates the height of the provided imagelist, then uses that height for the width of the individual images since it assumes square icons. Typically these imagelists will have 10 entries, so if the icons are 36x36 pixels each then the entire imagelist should be 360x36 pixels.
The icons in order, from index #0 to #9 are:
See the Dashboard::ImageList field variable for more information - The imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios 2.0 and lower. Because this is a static, it only has to be called on a single DashboardWidget.
The high-res imagelist used by the Dashboard for its icons, such as on the Customize and Exit buttons. This is used for device pixel ratios greater than 2.0.
See the Dashboard::ImageList field variable for more information - The high-res imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios greater than 2.0. Because this is a static, it only has to be called on a single DashboardWidget.
Convert the image at the given path to base64 string
ImageWidget A Dashboard Utility Widget that displays an image retrieved from a file path or a URL
Creates an ImageWidget without an image, which defaults to a transparent image
Creates an ImageWidget specifying an image file for the image source
Creates an ImageWidget specifying a Java URL for the image source. Note that depending on the speed of the internet connection the host, retrieving an image from a URL may be slow.
Puts the grid into Immutable Column mode, so that setting new columns keeps column state. Default: false
#Configuration
#GridRenderer
Constant that represents that inches should be used for units
If true then blank (null or undefined) values will pass the 'equals' filter option.
If true then blank (null or undefined) values will pass the 'greaterThan' and 'greaterThanOrEqual' filter options.
If true then blank (null or undefined) values will pass the 'lessThan' and 'lessThanOrEqual' filter options.
Sync the client row data every time a new GxClientRowModel is composed by the grid.
Use this method if the row's data in the client is different that the row's data in the ResultSet
Translated text for incremental find
The row index
Constant value to define "info" log messages
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
Method initFrame: Frame initialization
This method is called by a Google API in order to set the Authorization Header on API requests. Generally, this method will not be invoked directly.
Injects the provided CSS string into the <head>
element of the HTML document in the BBjHtmlView that contains the calendar.
This method provides a simple way to add custom CSS that affects the calendar. For more advanced use cases, see the
injectCss()
method that takes several
parameters to provide greater control over the injection.
Injects the provided CSS string into the head
or body
of the HTML DOM (as specified by the location! parameter)
in the BBjHtmlView that contains the calendar, as well as providing the ability to tag the CSS and replace it in subsequent calls.
Injects the provided CSS string into the head or body of the HTML DOM (as specified by the location! parameter) in the specified BBjHtmlView, as well as providing the ability to tag the CSS and replace it in subsequent calls.
Injects the CSS contained in the specified file into the <head>
element of the HTML document in the BBjHtmlView that contains the calendar.
This is a convenience method that reads in the contents of the provided CSS file and injects it into the HtmlView control that contains the calendar.
Injects the CSS contained in the specified file into the head or body of the HTML DOM (as specified by the location! parameter) in the specified BBjHtmlView, as well as providing the ability to tag the CSS and replace it in subsequent calls.
This is a convenience method that reads in the contents of the provided CSS file and injects it into the HtmlView control via the injectCss()
method.
Method to get the contents of a JavaScript library and inject it into the specified BBjHtmlView
Note that you can specify the full path to any JavaScript library, or use one of the built-in libraries like
DemoUtils.getJQueryUIFileLocation()
for the first parameter.
When running your BBj application with JavaScript in GUI in a Chromium BBjHtmlView control, everything should behave as expected. However, things are shifted around slightly when running BUI due to BBj using the Google Web Toolkit (GWT) which uses the typical window and document objects. GWT executes the JavaScript included with BBj application via an implementation of JavaScript Native Interface (JSNI). Because of this, your JavaScript code that used to reference the window and document objects should instead reference $wnd and $doc. See this Stack Overflow post for a brief explanation.
Method to get the contents of the jQuery library and inject it into the specified BBjHtmlView
When running your BBj application with JavaScript in GUI in a Chromium BBjHtmlView control, everything should behave as expected. However, things are shifted around slightly when running BUI due to BBj using the Google Web Toolkit (GWT) which uses the typical window and document objects. GWT executes the JavaScript included with BBj application via an implementation of JavaScript Native Interface (JSNI). Because of this, your JavaScript code that used to reference the window and document objects should instead reference $wnd and $doc. See this Stack Overflow post for a brief explanation.
Injects the specified JavaScript into the HtmlViewWidget, making it available for subsequent use with the executeScript() method. This method sets a single JavaScript, so calling it multiple times will overwrite any previous JavaScript specified earlier. To add multiple JavaScript files to a list that will all be injected into the HtmlViewWidget use the injectScripts() method. That method also allows you to specify different scripts for the regular and popped-out versions of the widget, whereas this version uses the same script for both.
Injects the provided JavaScript string at the top-level window.
Inject a js Script.
Inject a js Script at the top window (iframe's parent window if any).
Injects the JavaScript contained in the specified script file into the top-level window. This is a convenience method that reads in the contents of the provided JavaScript file and injects it into the HtmlView control that contains the calendar.
Adds the specified JavaScript into a vector of JavaScripts that will be injected into the HtmlViewWidget. When the HtmlViewWidget control is created all of the JavaScripts in the vector will be injected into the control for subsequent use with the executeScript() method. By specifying a different JavaScript string for the p_poppedOutScript$ parameter you can change the behavior of the popped-out version or simply rename unique elements, such as DIV IDs.
Injects the specified JavaScript URL into the HtmlViewWidget, making it available for subsequent use with the executeScript() method. This method sets a single JavaScript URL, so calling it multiple times will overwrite any previous JavaScript URLs specified earlier. To add multiple JavaScript URLs to a list that will all be injected into the HtmlViewWidget use the injectUrls() method.
Injects the specified JavaScript URL into the HTML DOM, making it available for subsequent use by client-side JavaScript.
Adds the specified URL into a vector of URLs that will be injected into the HtmlViewWidget. When the HtmlViewWidget control is created all of the JavaScript URLs in the vector will be injected into the control for subsequent use with the executeScript() method. By specifying a different URL for the p_poppedOutUrl$ parameter you can change the behavior of the popped-out version of the widget.
Provide an inner renderer
If true then doing 'inRange' filter option will include values equal to the start and end of the range.
If true then doing 'inRange' filter option will include values equal to the start and end of the range.
Translated text for insensitive
Inserts a column
Inserts a row
Interval. If frequency is set to "WEEKLY" and Interval is set to 3, then the recurrence or exception is once every 3 weeks.
Indicates whether the chart is 3D or Flat (2D)
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, this method will always return 0 for 23 and higher.
Returns that active status
Returns the active status of the widget control
A Boolean that is true if the Alt key was active when the key event was generated.
Alias to getAnyoneCanAddSelf()
Indicates whether the chart is an Area Chart
Alias to getAttendeesOmitted()
Returns the enable status of the auto refresh configuration menu item in the options menu
Returns if auto refresh is enabled or disabled
Returns the enable status of the auto refresh menu item in the options menu
Indicates whether the chart is a Bar Chart
Indicates if BBj is running in a BUI environment in Android as determined by the client browser's user agent string.
Indicates if BBj is running in a BUI environment in iOS as determined by the client browser's user agent string.
Indicates if BBj is running in a touch-enabled environment or not as determined by the BBjBuiManager.
Returns whether a cell is editable
A number indicating whether the pie chart is circular or stretched into an elliptical shape
Returns the enable status of the close button in the widget control
Returns if close is enabled or disabled
Returns whether a column is editable Note: The QVGird is not editable, so this method always returns FALSE
Returns an indication of whether a given column is sorted by related data rather than by cell text
Returns whether the grid sorts a specified column when the user clicks in the header of that column
Returns whether a column is visible
Method isControlContainer: Returns if the container is a control
A Boolean that is true if the Ctrl key was active when the key event was generated.
Returns whether the grid is data aware Note: The QVGird is a BBjStandardGrid, so this method returns FALSE.
Returns whether the grid is data bound Note: The QVGird cannot be configured as a data bound control, so this method returns FALSE.
Indicates whether a chart's underlying dataset is empty or not
The method traverses the underlying dataset to determine if the widget is empty or not, which is slightly different than the getNumRows() method. For example, a PieChartWidget might have 4 slices defined, all with zero values, so the getNumRows() method would return the number 4. However, the isDataSetEmpty() method would return 1, because even though there were four slices all values for the slices were zero.
Note that if you change a widget's SQL via the setSQL() method, you would have to execute the refresh() method on the widget before executing this method, otherwise this method will be checking the widget's dataset for the previous SQL statement. Just setting the SQL statement doesn't force the widget to execute the new SQL statement and fill out the dataset, but the refresh() method does do that. This means that you could execute the setSQL() method, the refresh() method, then executing this method would check the result set of the new SQL statement.
Returns true if this is the default translations, otherwise false is returned
Indicates whether this calendar has been deleted.
Returns if the widget is destroyed
Returns if the widget control is destroyed
Returns if the EmbeddedWidgetWindow is destroyed
Returns if the EmbeddedWidgetSetWindow is destroyed
Called to determine if the widget is destroyed
Determins if the widget is destroyed
Returns whether the BBjWidget is destroyed
Returns if the ImageWidget is destroyed
Returns if the HtmlViewWidget is destroyed
Returns if the GridExWidget is destroyed
Returns if the GridWidget is destroyed
Returns if the PieChartWidget is destroyed
Returns if the BarChartWidget is destroyed
Returns if the LineChartWidget is destroyed
Returns if the JasperViewerWidget is destroyed
Returns whether the QVGrid component child window has been destroyed
Returns the dragging enable status of the widget control
Returns whether the grid is editable Note: The QVGrid is not editable, so this always returns FALSE.
Returns whether the grid is currently in edit mode Note: The QVGird is not editable, so this method always returns FALSE
Returns if email is enabled or disabled
Returns the enable status of the email menu item in the options menu
Indicates whether the widget's dataset is empty or not
Indicates whether the widget's dataset is empty or not
Indicates whether the widget's dataset is empty or not
Indicates whether the widget's dataset is empty or not
Indicates whether the widget's dataset is empty or not
Indicates whether the widget's dataset is empty or not
Returns whether the grid control is enabled
Returns whether the widget is enabled or disabled.
Alias to getEndTimeUnspecified()
Returns whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]
Returns if export data is enabled or disabled
Returns the enable status of the export data menu item in the options menu
Check if the filter is action or not
#API
Check if the filter is action or not
#API
Returns all columns are fitted into the displayed width of the grid
Indicates whether the chart is 3D or Flat (2D)
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, this method will always return 1 for version 23 and higher.
Returns a value indicating whether or not the user can focus the grid control
This method is deprecated. Use isEditable() instead. Note: The QVGrid is not editable, so FALSE is always returned.
see BBjControl
Alias to getGuestsCanInviteOthers()
Alias to getGuestsCanModify()
Alias to getGuestsCanSeeOtherGuests()
The method will check whether the grid has license key or not.
Indicates whether the chart is a Line Chart
Alias to getLocked()
Returns the enable status of the manual refresh menu item in the options menu
Returns whether multiple selection is allowed
Returns the opaque property of the grid control
Alias to getOptional()
Returns the enable status of the options button in the widget control
Returns if the options is enabled or disabled
Returns whether the grid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no meaning
Indicates whether the chart is a Pie Chart
Returns the enable status of the popout button in the widget control
Returns if the poput is enabled or disabled
Specifies whether this is the user's default calendar. There is one primary calendar per Google Account.
Alias to getPrivateCopy()
A flag which defines when the grid is ready and the process events started
Indicates whether the widget's dataset was built from a BBjRecordSet
Indicates whether the widget's dataset was built from a BBjRecordSet
Indicates whether the widget's dataset was built from a BBjRecordSet
Indicates whether the widget's dataset was built from a BBjRecordSet
Indicates whether the widget's dataset was built from a BBjRecordSet
Indicates whether the chart's dataset was built from a BBjRecordSet
Returns if refresh is enabled or disabled
Returns the enable status of the refresh menu in the options menu
Returns the enable status of the refresh menu item in the options menu
Alias to getResource()
Indicates whether the chart is a Ring Chart
Returns whether a row is editable Note: The QVGrid is not editable, so FALSE is always returned.
Returns whether a row is currently visible in the grid
Returns if save is enabled or disabled
Returns the enable status of the save menu item in the options menu
Returns that selected status
Indicates whether the calendar is selected.
True when the row is selected, false otherwise
Returns the selectability of the widget control
Alias to getSelf()
A Boolean that is true if the Shift key was active when the key event was generated.
Indicates whether the widget's dataset was built from an SQL query
Indicates whether the widget's dataset was built from an SQL query
Indicates whether the widget's dataset was built from an SQL query
Indicates whether the chart's dataset was built from an SQL query
Indicates whether the chart's dataset was built from an SQL query
Indicates whether the chart's dataset was built from an SQL query
Indicates whether the chart is a Stacked Area Chart
Indicates whether the chart is a Stacked Bar Chart
Indicates whether the chart is a Stacked Percentage Bar Chart
Returns a value indicating whether or not the user can navigate to the grid control using the tab key
Returns whether the columns in the grid can be resized by the user
Indicates whether the widget's dataset was built from BBjVectors for the column header and row data
Returns if view data is enabled or disabled
Returns the enable status of the view data menu item in the options menu
Returns the visiblity of the EmbeddedWidgetWindow
Returns the visiblity of the EmbeddedWidgetSetWindow
Returns whether the QVGrid component child window is visible
Returns whether the widget is visible or hidden.
Returns a number indicating whether the Web Server is enabled or not
Returns a number indicating whether the Web Server has enabled the HTTP protocol or not
Returns a number indicating whether the Web Server has enabled the SSL protocol or not
Method isWidgetBuildType: Returns if the build type is a widget
Method isWidgetDashboardBuildType: Returns if the build type is a widget dashboard
Method isWidgetSetBuildType: Returns if the build type is a widget set
Method isWindowContainer: Returns if the container is a window
Indicates whether the chart is an XY Chart
The item number of the data item
Jasper Viewer widget type constant
JasperViewerWidget A Dashboard Utility Widget that displays JasperReport where the user can view, perform drill downs, print and save reports to disk in various formats
Constructor 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.
Constructor 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.
Constructor 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.
JasperViewerWidgetControlEvent Contains information for a jasper viewer widget control event
Constructs a jasper viewer widget control event
A BBjString that defines the fully-qualified path to the jQuery library
A BBjString that defines the fully-qualified path to the jQuery library's 'slim' build, which excludes the ajax and effects modules
A BBjString that defines the fully-qualified path to the jQuery UI library
A BBjString that defines the fully-qualified path to the jQueryUI Touch library
The key of the data item
A keypress model which is received from the client.
Note The the key model is available for the following grid events only
ON_GRID_ROW_CLICK
and ON_GRID_DOUBLE_CLICK
. In all other cases , it will be null()
A keypress model which is received from the client
Filter key
A Number representing the Unicode reference number of the key. For keys whose char attribute contains multiple characters, this is the Unicode value of the first character in that attribute.
KeyedValueDataItem A KeyedValueDataItem extends the base DataItem class and is used for PieCharts and RingCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity.
A KeyedValueDataItem describes a dataset item comprising of a key and value.
The data for these charts will be in the format of:
Contructs a KeyedValueDataItem
The name to render in the column header.
#Configuration
#ColumnsRenderer
The item's label
The default label of the toolpanel
The grid language manager
Translated text for last page
Translated text for last page
Last page menu item name
Last page menu item name
Last page tool button name
Last page tool button name
Contact last name
lastPage Changes the view to display the last page, if it's not already on the last page
The last rendered version of the chart in a BBjImage format used for the Customize window's preview
Method launchIDE: Try to launch resultant program in the IDE
Lays out the widets in the currently selected category
Lays out the widets in all categories
layoutReport Lays out the report.
This should be abstract, as by default, there will be no layout performed.
layoutReport Lays out the report in a tabular fashion
layoutReport Lays out the report in a columnar fashion
Laysout the widget contained in the dashboard category control
Translated text for left/up arrow
Leg 1 constructs a permission request to send to Google, which then will obtain permission from the user. The end result if the user gives permission is an intermediate code value.
In Leg 3, the intermediate code is sent to Google in exchange for an authentication token. Obtaining the authentication token is the end goal of this class.
A constant to define the legend items' shape
A constant to define the legend items' shape
A constant to define the legend items' shape
A constant to define the legend items' shape
A constant to define the legend items' shape
A constant to define the legend items' shape
A constant to define the legend items' shape
The Grid enterprise key
Make a color lighter
Line chart widget type constant
LineChartWidget A Dashboard Utility Widget that displays a line chart which can display multiple data series simultaneously
Create an empty Line Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Line Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create a BBjRecordSet-based Line Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Line Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
CustomObject that contains the routine to handle a link select event
Routine to handle a link select event
Name of the link select event
A json array which is used by the addItem
methods and it
will be returned by the implemented resolve
method
A json object
loadEmailContacts Loads contacts from the HashMap into the contacts grid
loadEmailContacts Loads email contacts from the HashMap into the contacts grid
Method loadEvents: Load valid events for a control type
Loads the find options
Loads grid initally
Method loadValidEvents: Load all valid events
Method loadValidTypes: Load all valid control type information
The date / timestamp locale to use.
The locale used to format and display dates and times. default to the System settings
Used only for locaalhost authentication, leg 2 looks for an intermediate code that's been sent to the local webserver. (The local webserver is spawned by GOAuth2 -- It won't check for your own local webserver.)
Set to true block pinning column via the UI (API will still work).
#Configuration
#ColumnsRenderer
Set to true to always have column displayed first.
#Configuration
#ColumnsRenderer
Set to true block making column visible / hidden via the UI (API will still work).
#Configuration
#ColumnsRenderer
Output a log message on the console and Debug.log file
Output a log message on the console and Debug.log file
Output a log message on the console and Debug.log file
This is the common method that handles errors for the widgets. It's responsible for THROWing the passed in error and logging it to the BBjServices Debug log file.
As of BBj 18.20, the routine will behave differently based on the widget's FillErrorAction. It always logs the error information, but depending on the FillErrorAction it may quietly ignore the error and continue, warn the user of the error and continue, or THROW the error and stop. See the BaseWidget's FillErrorAction field for more information.
This method is used internally by the Dashboard Utility to optionally log the performance of SQL Queries for Widgets
Before analyzing the SQL timings, you must first instruct the Dashboard Utility to log all SQL timing
results to the BBj Debug log file located in the <BBj_HOME>/log directory. This is done by
setting the "BASIS_UTILITY_LOG_QUERY_PERFORMANCE" global string entry to the number one, either via
code or in a configuration file. Here are two examples:
  1) Setting the global string entry in code, before creating any widgets or running a dashboard:
      temp$ = STBL("BASIS_UTILITY_LOG_QUERY_PERFORMANCE", "1")
  2) Setting the global string entry in the config file, without changing any code:
      SET BASIS_UTILITY_LOG_QUERY_PERFORMANCE=1
Mail server host
Mail server port, default = 25
Return a vector of java colors given a comma delimited string of hex colors
Return a vector of Java Colors given a comma delimited string of hex colors and an opacity amount to be applied to all colors
Make Hex Color
Convert the given BBjColor to a hex color string
Gets a larger vector of colors by repeating the source vector, darkening it each time
Gets a larger vector of colors by repeating the source vector, lightening it each time
Gets a larger vector of colors by repeating the source vector, decreasing the opacity each time
Set to 'true' to keep columns in this group beside each other in the grid. Moving the columns outside of the group (and hence breaking the group) is not allowed.
A bbj string mask When set we use it to validate the value
The default column mask
The String mask to use.
The Number mask to use.
The date / timestamp mask to use.
The Date mask for calender input
Translated text for match
The max allowed value
A valid iso 8601 datetime which defines the max allowed value in the calender
This constant is ignored in BBj 24.12 and higher.
Max file size of jrxml and jasper report files, default is 10 MB
A field variable that defines the maximum file size
Filter for getEvents() method: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. (integer, 1+)
A number that specifies the maximum width of a single bar in the barchart as a percentage of the available plot space.
The default value is 0.33, meaning that a bar chart with a single bar will only take up 1/3 of the plot space to avoid filling the plot with a single huge bar.
Max number of characters to allow. Default is 200.
Filter for getEvents() method: Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. (integer, 1+)
Maximum width in pixels of widgets
MaxWidgetWidth attribute
Initial max width in pixels
#Configuration
#ColumnsRenderer
Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods.
Constant for DashboardWidget popup menu triggered by clicking on the Options tool button used in the addMenu() and getDashboardWidgetMenu() methods.
Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods.
CustomObject that contains the routine to handle a selection event from the custom popup menu.
Routine to handle a selection event from the custom popup menu.
Name of the menu selection event.
Set to an array containing zero, one or many of the pre built men tabs. This is used to figure out which menu tabs are present and in which order the tabs are shown.
The user event that triggers the display of the menu. Values can be DashboardWidget.getMENU_TRIGGER_LEFT_CLICK(), DashboardWidget.getMENU_TRIGGER_RIGHT_CLICK(), or DashboardWidget.getMENU_TRIGGER_OPTIONS_CLICK().
MimeMessage object
Specifies the operation that the webserver should perform. Supported operations include:
A constant to define CSS text mime type
A constant to define GIF image mime type
A constant to define JPG image mime type
A constant to define PNG image mime type
The min allowed value
A valid iso 8601 datetime which defines the min allowed value in the calender
Minimum height of the window
Specify the minimum length, when autocomplete should appear on the screen.
Constant for minutes
Minimum width in pixels of widgets
MinWidgetWidth attribute
Initial min width in pixels
#Configuration
#ColumnsRenderer
Minimum width of the window
Constant that represents that millimeters should be used for units
Translated text for more options
Change column position
#API
moveDir Moves a local directory. The directory can be moved accross machines when DS syntax is used for a destination directory
moveFile Moves a local file. The file can be moved accross machines when DS syntax is used for a destination directory
Indicates if the parent window that houses the widget control should be dragged when the widget control is dragged
Moves the selection to the next cell
Start Next Cell Editing
#API
Move to previous cell
#API
Multipart object
Constant that represents the multiple sheet XLS save contributor
Constant that represents the multiple sheet XLS save contributor
Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
#Configuration
#GridRenderer
Get the component name
Returns the unique name of the widget
Returns the name of the widget
The name of the header attribute.
Filter name
Name attribute
Name attribute
Navigates the calendar programmatically to the specified date. To ensure the calendar navigates to the correct date, the provided
date should be in the ISO 8601 format. However, this method attempts to parse ambiguous dates and is often able to construct
a date in the format "YYYY-MM-DD"
given a date string in another format.
If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly.
The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of
"1-2-3"
is very ambiguous and while the method may be able to return a valid date string, it may not be the particular
date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However,
a string like "Jan 1, 2000"
is far less ambiguous and will likely be parsed correctly in to "2000-01-01"
.
Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation.
For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020"
and "May 15"
.
However, Firefox returns an "Invalid Date" for those values.
The date string should ideally be in the "YYYY-MM-DD"
format at a minimum, but the parser should be able to interpret various formats.
Navigates the calendar programmatically one step forward (by a month or week for example), and is the same as the user clicking on the 'next' toolbar button. The amount of time moved depends on the current view type.
Navigates the calendar programmatically forward one year, and is the same as the user clicking on the 'nextYear' toolbar button.
Navigates the calendar programmatically one step back (by a month or week for example), and is the same as the user clicking on the 'prev' toolbar button. The amount of time moved depends on the current view type.
Navigates the calendar programmatically back one year, and is the same as the user clicking on the 'prevYear' toolbar button.
Navigates the calendar programmatically to the specified time. To ensure the calendar navigates to the correct time, the provided
time should be in the ISO 8601 format or "hh:mm"
format at a minimum.. However, this method attempts to parse ambiguous
times and is often able to construct a time in the format "hh:mm:ss"
given a time string in another format.
If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly.
The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of
"1-2-3"
is very ambiguous and while the method may be able to return a valid date string, it may not be the particular
date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However,
a string like "Jan 1, 2000"
is far less ambiguous and will likely be parsed correctly in to "2000-01-01"
.
Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation.
For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020"
and "May 15"
.
However, Firefox returns an "Invalid Date" for those values.
The time string should ideally be in one of the following formats.
Navigates the calendar programmatically to the current date, and is the same as the user clicking on the 'today' toolbar button.
Defines how users can move between rows using arrow keys.
#Configuration
#GridRenderer
A constant which describes the NewRowsAction behavior
A constant which describes the NewRowsAction behavior
If set to 'clear', then setting data into the grid will clear (reset) the filter If set to 'keep' then the grid will keep it's currently set filter. The default is 'clear'
Translated text for next page
Translated text for next page
Next page menu item name
Next page menu item name
Next page tool button name
Next page tool button name
nextFindPage Finds and sets the page to where the next find element is found
nextHighlight Finds the next find element
nextPage Changes the view to display the next page, if there is one
None value Translation
A number indicating the number of slices in the pie chart
OAuth access token
Constant that represents the ODS save contributor
Constant that represents the ODS save contributor
ODS exporter which contains export options
Constant that represents the ODT save contributor
Constant that represents the ODT save contributor
ODT exporter which contains export options
Translated text for of
The old value of the cell
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has clicked on a date or time.
Note that ON_CALENDAR_DATE_CLICK
event is not fired when the user clicks a day heading in a list view.
Setting a callback for this event type will result in your application getting a CalendarDateClickEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has clicked on a date or time.
Note that ON_CALENDAR_DATE_CLICK event is not fired when the user clicks a day heading in a list view.
Setting a callback for this event type will result in your application getting a CalendarDateClickEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's date range has changed in any way.
Setting a callback for this event type will result in your application getting a CalendarDatesSetEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's date range has changed in any way.
Setting a callback for this event type will result in your application getting a CalendarDatesSetEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user dropped an external draggable element or an event from another calendar onto this calendar.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user dropped an external draggable element or an event from another calendar onto this calendar.
Note: This event has not yet been implemented.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's entry data has changed in any way.
If you set a callback for this event, then add several entries to the calendar, your callback routine may be flooded because the event will fire for every entry that you add.
When responding to this event, the BBjSysGui::getLastEvent()
call
will return a CalendarEntriesSetEvent
object.
You can call the CalendarEntriesSetEvent::getEntries()
method to return a BBjVector of
CalendarEntry
objects that corresponds to all the known entries in the calendar at that instant in time.
Setting a callback for this event type will result in your application getting a CalendarEntriesSetEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's entry data has changed in any way.
If you set a callback for this event, then add several entries to the calendar, your callback routine may be flooded because
the event will fire for every event that you add.
When responding to this event, the BBjAPI().getLastEvent()
call will return a CalendarEntriesSetEvent
object.
You can call the CalendarEntriesSetEvent::getEntries()
method to return a BBjVector of CalendarEntry
objects
that corresponds to all the known entries in the calendar at that instant in time.
Setting a callback for this event type will result in your application getting a CalendarEntriesSetEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that an event has been added to the calendar.
Note: If you set a callback for this event, then add several events to the calendar, your callback routine may be flooded.
Setting a callback for this event type will result in your application getting a CalendarEntryAddEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that an event has been added to the calendar.
Note: If you set a callback for this event, then add several events to the calendar, your callback routine may be flooded.
Setting a callback for this event type will result in your application getting a CalendarEntryAddEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's event data has changed in any way.
Setting a callback for this event type will result in your application getting a CalendarEntryChangeEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's event data has changed in any way.
Setting a callback for this event type will result in your application getting a CalendarEntryChangeEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has clicked on a calendar's event.
Setting a callback for this event type will result in your application getting a CalendarEntryClickEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has clicked on a calendar's event.
Setting a callback for this event type will result in your application getting a CalendarEntryClickEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has started dragging an event.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has started dragging an entry. In other words, the user has started to reposition the entire entry in the calendar
as opposed to resizing the entry by dragging one of its edges.
Setting a callback for this event type will result in your application getting a CalendarEntryEvent
object.
Note that both the ON_CALENDAR_ENTRY_DRAG_START()
and ON_CALENDAR_ENTRY_DRAG_STOP()
events result in a CalendarEntryEvent
object, but
the native HTML element object associated with the event will be empty.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped dragging an event.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped dragging an entry. In other words, the user has repositioned the entire entry in the calendar
as opposed to resizing the entry by dragging one of its edges. This event is triggered after the user drags an entry, even if the entry doesn't
change its date/time. It is triggered before the entry's information has been modified (if moved to a new date/time) and before the
ON_CALENDAR_ENTRY_DROP
callback is triggered. Because the event occurs before the entry has been modified, the entry will be
the same as the ON_CALENDAR_ENTRY_DRAG_START
event.
Setting a callback for this event type will result in your application getting a CalendarEntryEvent
object.
Note that both the ON_CALENDAR_ENTRY_DRAG_START()
and ON_CALENDAR_ENTRY_DRAG_STOP()
events result in a CalendarEntryEvent
object, but
the native HTML element object associated with the event will be empty.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has dropped the event to a different day/time.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has finished dragging and dropping the entry to a different day/time. In other words, the user has repositioned the entire entry in the calendar
as opposed to resizing the entry by dragging one of its edges.
Setting a callback for this event type will result in your application getting a CalendarEntryDropEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user is about to drop one of the calendar events on to another calendar.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user is about to drop one of the calendar events on to another calendar.
Note: This event has not yet been implemented.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user moved the mouse into the bounds of a calendar event.
Setting a callback for this event type will result in your application getting a CalendarEntryMouseEnterEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user moved the mouse into the bounds of a calendar event.
Setting a callback for this event type will result in your application getting a CalendarEntryMouseEnterEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user moved the mouse out of the bounds of a calendar event.
Setting a callback for this event type will result in your application getting a CalendarEntryMouseLeaveEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user moved the mouse out of the bounds of a calendar event.
Setting a callback for this event type will result in your application getting a CalendarEntryMouseLeaveEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar has received an external draggable element with event data from another source or another calendar.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar has received an external draggable element with event data from another source or another calendar.
Note: This event has not yet been implemented.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that an entry has been removed from the calendar.
If you set a callback for this event, then remove several entries from the calendar, your callback routine may be flooded because
the event will fire for every entry that was removed.
Setting a callback for this event type will result in your application getting a CalendarEntryRemoveEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the calendar's event data has changed in any way.
Setting a callback for this event type will result in your application getting a CalendarEntryRemoveEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped resizing an event and the event has a different duration.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped resizing an event by dragging one of its edges and the event now has a different duration.
Setting a callback for this event type will result in your application getting a CalendarEntryResizeEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has started resizing an event.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has started resizing an event by dragging one of its edges.
Setting a callback for this event type will result in your application getting a CalendarEntryEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped resizing an event.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has stopped resizing an event. This event will be triggered after the user resizes an event by dragging one of its
edges, even if the event doesn't change in duration. It is also triggered before the ON_CALENDAR_ENTRY_RESIZE()
event is triggered.
Setting a callback for this event type will result in your application getting a CalendarEntryEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that fetching a CalendarEntrySource
failed.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that fetching a CalendarEntrySource
failed.
Setting a callback for this event type will result in your application getting a ??? - TBD
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that fetching a CalendarEntrySource
succeeded.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that fetching a CalendarEntrySource
succeeded.
Setting a callback for this event type will result in your application getting a ??? - TBD
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the BBjCalendarWidget
is ready.
Setting a callback for this event type will result in your application getting a CalendarReadyEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the BBjCalendarWidget
is ready.
Setting a callback for this event type will result in your application getting a CalendarReadyEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user selected a date or time.
Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable()
method
if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT
or BBjCalendarWidget:ON_CALENDAR_UNSELECT
events.
Setting a callback for this event type will result in your application getting a CalendarSelectEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user selected a date or time.
Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable()
method
if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT
or BBjCalendarWidget:ON_CALENDAR_UNSELECT
events.
Setting a callback for this event type will result in your application getting a CalendarSelectEvent
object.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user unselected a date or time.
Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable()
method
if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT
or BBjCalendarWidget:ON_CALENDAR_UNSELECT
events.
A selection might be cleared for a number of reasons:
The CalendarOptions::setEnableUnselectAuto()
impacts what causes the BBjCalendarWidget.ON_CALENDAR_UNSELECT
event to be fired.
If automatic unselection is enabled, then the unselection event will typically be fired after the user releases their selection mouse button.
Setting a callback for this event type will result in your application getting a CalendarUnselectEvent
.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user unselected a date or time.
Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable()
method
if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT
or BBjCalendarWidget:ON_CALENDAR_UNSELECT
events.
A selection might be cleared for a number of reasons:
The CalendarOptions::setEnableUnselectAuto()
impacts what causes the BBjCalendarWidget.ON_CALENDAR_UNSELECT
event to be fired.
If automatic unselection is enabled, then the unselection event will typically be fired after the user releases their selection mouse button.
Setting a callback for this event type will result in your application getting a CalendarUnselectEvent
.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has changed the view type of the BBjCalendarWidget
.
Note: This only fires when the type of view changes, not when the user changes the view from one subtype to another. For example,
the event will be triggered when the user switches from the
CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
to the
CalendarAPI.CALENDAR_VIEW_LIST_MONTH()
view. But it won't be triggerd when the user changes from
CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
to
CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()
since both views are
the same type (dayGrid) and just the subtype (week vs. month) changes.
A constant value that's used with the BBjCalendarWidget::setCallback()
method that signals that the user has changed the view type of the BBjCalendarWidget
.
Note: This only fires when the type of view changes, not when the user changes the view from one subtype to another. For example,
the event will be triggered when the user switches from the CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
to the
CalendarAPI.CALENDAR_VIEW_LIST_MONTH()
view. But it won't be triggerd when the user changes from
CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
to CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()
since both views are
the same type (dayGrid) and just the subtype (week vs. month) changes.
Setting a callback for this event type will result in your application getting a CalendarViewChangeEvent
object.
File save notify event
A constant to define how the dashboard handles widget fill errors - this value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - this value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - this value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file).
A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file.
A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file.
Constant for a filter select event, used in the setCallback() method
Google Doc save notify event
Constant value to define cell click event
Constant value to define cell double-click event
Constant value to define cell editing start event
Constant value to define cell editing stop event
Constant value to define cell value changed event
Alias for ON_GRID_STATE_CHANGE()
Alias to ON_GRID_ROW_DOUBLE_CLICK()
Constant value to define A filter changed event.
Constant value to define keyboard keypress
Constant value to define range selection event
Constant value to define the grid ready event.
Constant for widget refresh event.
Constant value to define row click events
Constant value to define row double-click event
Constant value to define row editing start event
Constant value to define row editing stop event
Alias for ON_GRID_SELECT_ROW
Constant value to define A row has changed. This event corresponds to Full Row Editing only.
A Constant value to define row selection (selected/deselected) change events
Constant value to define grid state changes
Constant for a link select event
Constant for the popup menu selection event used in the DashboardWidgetMenu::setCallback() method.
Constant for the popup menu selection event used in the setCallback() method.
Constant for widget click event used in the setCallback() method. This event is independent of the mouse button (left, middle, right) and overrides any callbacks associated with the ON_WIDGET_LEFT_CLICK or ON_WIDGET_RIGHT_CLICK event types.
Constant for widget left click event used in the setCallback() method
Constant for widget refresh event used in the setCallback() method
Constant for widget right click event used in the setCallback() method
Constant for widget select event used in the setCallback() method
OnActualSize Callback for when the actual size menu item is selected
OnActualSizeToolButton Callback for when the acutal size tool button is pushed
Method OnAddCategory: Called when the Add button is pressed
Called when the Add Widget button is pushed in the Customize window, changing a widget's state from inactive to active
OnAppClose Closes the application
OnAttachmentDialogApprove Callback when a file is choosen in the attachment dialog
OnAttachmentDialogClose Callback when the attachment dialog should be closed
OnAttachmentRemove Callback for when a remove attachment tool button is pushed
An internal method used by the WidgetControl that is called when the auto refresh menu item is selected
An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
An internal method used by the WidgetControl that is called when the auto refresh configuratoin menu item is selected
An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
An internal method used by the WidgetControl that is called when the auto refresh timer is fired. As of BBj 18.20 this event only applies to active widgets. A widget that is hidden will not refresh until it is activated again.
Method OnBackButton: Button push event handler for the "Back" button
OnBrowse Called when the browse button is pressed by the user to select the client side export file
OnBrowse Browse for a report file
Method onBtnBackPush: Button push event handler for the "Back" button
Method onBtnFinishPush: Button push event handler for the "Finish" button
Method onBtnNextPush: Button push event handler for the "Next" button
Method onBtnRunWizardPush: Button push event handler for the "Run Wizard Again" button
Method onBtnTestInBUIPush: Button push event handler for the "Test in BUI" button
Method onBtnTestInGUIPush: Button push event handler for the "Test in GUI" button
OnCancel Callback called when the user selects the cancel button
Method OnCategoryListSelect: Called when the widget category is selected
Method OnCategoryListSelect: Called when a category is selected from the BBjListButton
Method OnCategorySelect Called when a category is selected
Method OnCategorySelect Called when a category is selected
Method OnCategorySelect Called when a category is selected
Method OnCategoryTitleModify:
Called when the category title is modified
Removes the chart's tip that is shown after clicking on a data entity. This method is called automatically and is not typically accessed via code.
An internal method used by the WidgetControl that is called when the user deactivates the widget by pressing the close button on the widget control
OnClose Called when the window is closed by the user
Called when the close left tabs menu item is selected
Called when the close other tabs menu item is selected
Called when the close right tabs menu item is selected
Called when the close tab menu item is selected
Called when the user selects a color theme from the Customize window
OnConnectButtonPush Loads databases from selected host
OnContactChangeDialogClose Callback for when the contact change dialog is closed
OnContactChangeEmailEdit Callback for when the contact change email is edited
OnContactChangeFirstNameEdit Callback for when the contact change first name is edited
OnContactChangeLastNameEdit Callback for when the contact change last name is edited
OnContactChangeSave Callback for when the contact change save button is pressed
OnContactDialogEdit Callback when the contact edit button is pressed
OnContactDialogEdit Callback when the contact new button is pressed
OnContactsDialogClose Callback to close the Contacts dialog
OnContactsDialogRemove Callback for when the Contacts remove button is pressed
OnContactsDialogSelect Callback for when the contacts select button is preseed
OnContactsGridDoubleClick Callback when the user double clicks on the contacts grid
An internal method that is called when the mouse is right-clicked over the HtmlViewWidget
This method exists so that a custom popup menu will be displayed instead of the default browser's popup menu. The method is technically a no-op, but needs to exist as we need to register for the window's ON_POPUP_REQUEST event in order to prevent the browser from displaying its own popup menu when running in BUI.
An internal method that is called when the mouse is right-clicked over the GridWidget
This method exists so that a custom popup menu will be displayed instead of the default browser's popup menu. The method is technically a no-op, but needs to exist as we need to register for the window's ON_POPUP_REQUEST event in order to prevent the browser from displaying its own popup menu when running in BUI.
OnCreateImageToolButton Callback for when the create image tool button is pushed
Called when the customize button is pressed
Called when the Done tool button is pushed in the Customize window
Called when the Next tool button is pushed in the Customize window
Called when the Prev tool button is pushed in the Customize window
Called when the Customize window is resized.
Called when the resize timer is triggered
OnCustomPage Callback for when the custom page menu item is selected
OnCustomPageClose Callback for when the custom page window is close
OnCustomPageEdit Callback for when a key is pressed in the custom page inputN
OnCustomZoom Callback for when the custom zoom menu item is selected
OnCustomZoomClose Callback for when the custom zoom window is close
OnCustomZoomListEditSelect Callback for when the custom zoom list selection event occurs
An internal method used by the WidgetControl that is called when the user selects a menu item from a custom DashboardWidgetMenu
This routine responds to the user selecting a menu item from a custom DashboardWidgetMenu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetMenuSelectEvent.
Method OnDataListSelect: Called when a data option is selected from the BBjListButton
Method OnDataResultsClose Called when the Data Results Window is closed
OnDesignTreeSelect Called when a node in the design tree is selected
Called when the user chooses to use a dynamic widget size
Called when the email popup menu item is selected on the widget control
OnEmail Callback for when the email menu item is selected
OnEmailAddressEdit Callback for when an email address text is changed
OnEmailAddressLostFocus Callback for when an email address loses focus
OnEmailAddressRemove Callback for when the email dialog remove email address button is pushed
OnEmailAddressSelect Callback for when an email address is selected from the address list box
OnEmailBCCAddressKeypress Callback for when a key is pressed in the email bcc edit box
OnEmailCCAddressKeypress Callback for when a key is pressed in the email cc edit box
OnEmailDialogAttachmentClient Callback to add a client file as an attachment to the email
OnEmailDialogAttachmentServer Callback to add a server file as an attachment to the email
OnEmailDialogBCCAdd Callback for when the email dialog BCC add menu item is selected
OnEmailDialogBCContacts Callback to bring up the contacts dialog for the BCC addresees
OnEmailDialogBCCRemove Callback for when the email dialog BCC remove menu item is selected
OnEmailDialogCCAdd Callback for when the email dialog CC add menu item is selected
OnEmailDialogCCContacts Callback to bring up the contacts dialog for the CC addresees
OnEmailDialogCCRemove Callback for when the email dialog CC remove menu item is selected
OnEmailDialogClose Callback for when the email dialog is to be closed
OnEmailDialogSend Callback for when the email dialog send button is pressed
OnEmailDialogSettings Callback for when the email dialog settings button is pressed
OnEmailDialogToContacts Callback to bring up the contacts dialog for the To addresees
OnEmailSettingsDialogClose Callback for when the email settings dialog is to be closed
Callback for when the email settings dialog save button is pressed
OnEmailToAddressKeypress Callback for when a key is pressed in the email to edit box
OnEmailToolButton Callback for when the email tool button is pushed
OnExport Called when the export button is pressed to export the data to the client side file
Called when the export data popup menu item is selected on the widget control
OnFileChooserApprove Callback when a file is choosen in the file chooser window
OnFileChooserClose Callback when the file chooser window is closed/canceled
OnFileChooserFilter Callback run when user selects a filter in the file chooser
OnFileModify Called when the export file name is changed
An internal method used by the WidgetControl that is called when the a filter list item is selected in a filter on the widget control
This routine responds to the user selecting an item from a custom DashboardWidgetFilter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetFilterSelectEvent.
OnFind Callback for when the find menu item is selected
OnFindKeypress Callback method for key press events find list edit
OnFindToolButton Callback for when the find tool button is pushed
Method OnFinishButton: Button push event handler for the "Finish" button
OnFirstPage Callback for when the first page menu item is selected
OnFirstToolButton Callback for when the first page tool button is pushed
OnFitPage Callback for when the fit page menu item is selected
OnFitPageToolButton Callback for when the fit to page tool button is pushed
OnFitWidth Callback for when the fit width menu item is selected
OnFitWidthToolButton Callback for when the fit to width tool button is pushed
An internal method serving as a BBjTimerEvent callback which will be invoked when the executor timer's count down reaches 0 to flush the enqueued scripts.
A BBjTimerEvent listener which will be invoked when the executor count down reaches 0 to flush the enqueued scripts
Called when the user selects a custom font from the Customize window
Focus the grid by selecting the cell in the first cell and first column.
Note: If the grid has already a different selected cell , then the event handler will retain the selection
OnGetFields Gets the fields
Method onGrdControlVariablesKeyPress: Key press event handler for the control variables grid control
Method onGrdControlVariablesMouseUp: Mouse up event handler for the control variables grid control
Method onGrdControlVariablesTypeQuery: Cell query event handler for the "type" column
Method onGrdToolBarCellModify: Grid cell modify event handler for the "Toolbar" grid
Method onGrdToolBarGainedFocus: Grid gained focus event handler for the "Toolbar" grid
Method onGrdToolBarImgPathQuery: Grid cell query event handler for the "Image Path" column
Method onGrdToolBarKeyPress: Grid keypress event handler for the "Toolbar" grid
Method onGrdToolBarLostFocus: Grid lost focus event handler for the "Toolbar" grid
Method onGrdToolBarMouseUp: Grid mouse up event handler for the "Toolbar" grid
Method onGridToolBarSelectRow: Grid select row event handler for the "Move To Last" tool button
An internal method that is called when the user initiates an event on a GridWidget for which a callback event has been registered
Called when the HTML Text radio button is selected
Called when the HTML URL radio button is selected
An internal method that is called when an event occurs on the HtmlViewerWidget for which a callback event has been registered
OnHyperlink Callback when a hyperlink (tool button) is pushed
OnHyperlink Callback when a hyperlink (tool button) is right clicked
Method OnImageBrowse Called when the image browse button is pushed
Called when the Image file radio button is selected
Called when the Image url radio button is selected
Method onInePgmFilePathLostFocus: Focus lost event handler for the program file path input control
Method onIneResFilePathLostFocus: Lost focus event handler for the resource file path input control
An Event listener executed after the initial load of the HTML View.
At this phase the grid will inject all required js files in the client to make the grid functional.
Method onInnBtnSizeLostFocus: Lost focus event handler for the "Button Size" input control
Method onInnSepWidthLostFocus: Lost focus event handler for the "Separator Width" input control
Method OnJasperBrowse Called when the Jasper browse button is pushed
Called when the mouse is clicked in a Jasper Viewer
Method OnKeypress Called when a key is pressed in the Frame5 child window
OnKeypress Callback method for key press events in the view
OnLastPage Callback for when the last page menu item is selected
OnLastToolButton Callback for when the last page tool button is pushed
Method onLbtBarTplListChange: List change event handler for the "Toolbar Template" list button
Method onLbtBtnTypeListChange: List change event handler for the "Button Type" list button
Method onLbtDockLocListChange: List change event handler for the "Dock Location" list button
Method onLbxCallbacksClick: List click event handler for the "Callbacks" list box
Method onLbxCallbacksDoubleClick: List double-click event handler for the "Callbacks" list box
Method onLbxControlsListClick: List click event handler for the "Controls" list box
Method onLbxEventsClick: List click event handler for the "Events" list box
Method onLbxEventsDoubleClick: List double-click event handler for the "Events" list box
An internal method used by the WidgetControl that is called when a link is selected to invoke a URL for the widget control
This routine responds to the user clicking a DashboardWidgetLink, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetLinkSelectEvent.
In GUI, this routine executes a BBjThinClient::browse() to launch the link if the DashboardWidgetLink's BrowseOnSelect parameter is true. In BUI, the link is created with an anchor tag that has a target='_blank' attribute to open the link in a new tab instead of a popup browser window.
An Event listener executed after the second ON_PAGE_LOADED event
At this phase the grid flush all enqueued scripts
An Event listener for the fallback by timer
Sporadically the ON_PAGE_LOADED event did not fire
An Event listener for the loading the script by the WebManager
An internal method used by the WidgetControl that is called when the manual refresh menu item is selected
An internal method used by the WidgetControl that is called when the mouse is pressed down in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
An internal method used by the BBjDialChartProgress
that is called when the mouse is pressed down on the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress
.
An internal method used by the WidgetControl that is called when the mouse is moved in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
An internal method used by the BBjDialChartProgress
that is called when the mouse is moved in the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress
.
An internal method used by the WidgetControl that is called when the mouse is released in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
Called when mouse is released on the dashboard widget control
An internal method used by the BBjDialChartProgress
that is called when the mouse is released in the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress
.
An internal event handler for native JavaScript events from the BBjHtmlView control that converts a JavaScript calendar event to a BBj callback event.
On NativeEvent
Event Handler for Native JavaScript Event coming from the client Determines and dispatches the actual event
Method OnNextButton: Button push event handler for the "Next" button
OnNextPage Callback for when the next page menu item is selected
OnNextToolButton Callback for when the next page tool button is pushed
Called when open link in current window menu item is selected
Called when open link in new active tab menu item is selected
Called when open link in new inactive tab menu item is selected
Called when open link in new window menu item is selected
An internal method used by the WidgetControl that is called when the Options tool button is pushed on the widget control
An internal method that is called when the HtmlViewWidget's content (URL or HTML text) has finished loading so that URLs and JavaScript can be injected/executed if applicable
OnPageNumberEdit Callback for when a key is pressed in the page number inputN
An internal method used by the WidgetControl in response to the widget's popout button press event
Called popout button is pressed on the dashboard widget control
An internal method used by the WidgetControl in response to the popout window's close button's pressed event
Called when the popout window close button is pressed
An internal method used by the WidgetControl in response to the popout window's close event
An internal method used by the WidgetControl in response to the popout window's resize event
OnPreview Previews the report
Called when the preview window is scrolled in the Customize window
OnPrevousPage Callback for when the previous page menu item is selected
OnPreviousToolButton Callback for when the previous page tool button is pushed
OnPrint Callback for when the email menu item is selected
OnPrintToolButton Callback for when the print tool button is pushed
OnProgressChange Called when the namespace progress key value is changed
OnQueryModify Called when the SQL query is modified
Called when the Refresh tool button is pushed
Called when the refresh popup menu item is selected on the widget control
OnReload Callback for when the reload menu item is selected
OnReloadToolButton Callback for when the reload tool button is pushed
Method OnRemoveCategory: Called when the Remove button is pressed
OnReportNameModify Report name modification
Callback method that handles a view tab being close
Callback method that handles a view tab popup request
Callback method that handles a view tab being selected
Called when the mouse is pressed up over the report window
Called when the mouse is pressed up over the view
Called when the window is resized by the user
Called when the resize timer is triggered
Method OnRSBrowse Called when the RS browse button is pushed
Method OnRSColumns Called when the RS Fields button is pushed
Method OnRSColumnsCheckOff Called a check box is checked off in the fields grid
Method OnRSColumnsCheckOn Called a check box is checked on in the fields grid
Method OnRSColumnsClose Called when the RS Window is closed
Method OnRSColumnsExecute Called when the RS Fields Execute button is pushed
Called when the save popup menu item is selected on the widget control
OnSave Callback run when user selects to save the report
OnSave Callback run when user selects to save the report
OnSave Saves the design
OnSaveAs Callback run when user selects to save-as the report
OnSaveAs Callback run when user selects to save-as the report
OnSaveCurrentPageAsImage Callback for when the create current page as image menu item is selected
OnSaveGoogleDoc Callback for when the save google doc menu item is selected
OnSaveGoogleDoc Callback for when the save google doc menu item is selected
OnWindowResize Called when the screen is resized by the user
OnScreenResizeTimer Called when the screen resize timer is triggered
Method OnSeriesAdd: Called when the series add button is pushed
Method OnSeriesClose: Called when the series window is close
Method OnSeriesListSelect: Called when a series is selected from the BBjListButton
Method OnSeriesRemove: Called when the series remove button is pushed
Method OnSeriesSelect: Called when a series is selected from the BBjListBox
Method OnSeriesUpdate: Called when the series update button is pushed
Method OnSourceFileBrowseButton:
Generates the FileChooser to select a bbj file
Method OnSQLExecute Called when the SQL Execute button is pushed
OnTableCheckOff Called when a check box in the table contents grid is unchecked
OnTableCheckOn Called when a check box in the table contents grid is checked
Called when a tab is selected
Method OnTabSelect Called when the a tab is selected in the DashboardControl
Method onTbtAddPush: Push event handler for the "Add" tool button
Method onTbtAddPush: Tool button push event handler for the "Add" tool button
Method onTbtInsertPush: Tool button push event handler for the "Insert" tool button
Method onTbtMoveDownPush: Tool button push event handler for the "Move Down" tool button
Method onTbtMoveFirstPush: Tool button push event handler for the "Move To First" tool button
Method onTbtMoveLastPush: Tool button push event handler for the "Move To Last" tool button
Method onTbtMoveUpPush: Tool button push event handler for the "Move Up" tool button
Method onTbtPgmFileFindPush: Tool button push event handler for the program file find tool button
Method onTbtRemovePush: Push event handler for the "Remove" tool button
Method onTbtRemovePush: Tool button push event handler for the "Remove" tool button
Method onTbtResFileFindPush: Tool button push event handler for the resource file find tool button
Method OnTitleModify:
Called when the title is modified
Called when the mouse is pressed up over the tool bar window
OnToolButtonPush Callback called when a tool button is pushed
Method onTypeSelectBtnCancelPush: Button push event handler for the type selection "Cancel" button
Method onTypeSelectBtnOkPush: Button push event handler for the type selection "OK" button
Method onTypeSelectBtnSearchPush: Button push event handler for the type selection "Search" button
Method onTypeSelectLbtTypeChange: List change event handler for the type selection "Type" list button
Method OnUpdateCategory: Called when the Update button is pressed
Called when the user chooses to use a dynamic widget size
Called when the user chooses to use a fixed widget size
Called when the user chooses to use a fixed widget size
Called when the view data popup menu item is selected on the widget control
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
OnViewWindowClose Callback invoked when a view window is closed
Method OnWidgetAdd: Called when the widget add button is pressed
An internal method used by the WidgetControl that is called when the user presses a mouse key down and then releases it over the widget window
This routine responds to the mouse click and will either post custom events if the developer has registered for click events, or will execute default behavior based on which mouse button was pressed. By default, a left click adds a tooltip to the interior chart widget if the user clicked on a chart's data item, e.g. a bar in a bar chart or slice in a pie chart. By default, a right click displays the default popup Options menu which is also available by selecting a DashboardWidget's Options tool button.
If the developer set callbacks for a DashboardWidgetClickEvent, DashboardWidgetLeftClickEvent, or DashboardWidgetRightClickEvent then the routine creates the relevant DashboardWidgetEvent(s) based on the registered events, then posts the custom event(s) so that the developer's callback routines execute in response to the mouse event.
An internal method used by the WidgetControl that is called when the mouse is right-clicked over the widget window
This method exists so that a custom popup menu will be displayed instead of the default browser's popup menu.
Method OnWidgetDashboardSelect: Called when the widget dashboard radio button is selected
Called when the user selects a custom font scaling factor from the Customize window
Method OnWidgetListSelect: Called when a widget is selected from the BBjListButton
Method OnWidgetRemove: Called when the widget remove button is pressed
Called when a widget is selected
Called when a widget is selected
Method OnWidgetSelect: Called when the widget radio button is selected
Called when a widget is selected
Called when a widget is selected
Method OnWidgetSetSelect: Called when the widget set radio button is selected
Called when the window is resized by the user
Called when the resize timer is triggered
Called when the user selects a color theme from the Customize window
Method OnWidgetTitleModify: Called when the widget title is modified
Method OnWidgetTypeGainedFocus Called when the widget type menu button gains focus
Method OnWidgetTypeLostFocus Called when the widget type menu button loses focus
Method OnWidgetTypePushed Called when the widget type menu buton is pushed
Called when a widget type is selected
Method OnWidgetUpdate: Called when the widget update button is pressed
Method OnUpdateWidget: Called when the update button is pressed
OnWindowResize Called when the window is resized by the user
OnWindowResizeTimer Called when the window resize timer is triggered
Method onWndActivate: Set this task as the active task when window is activated
Method onWndRestore: Set this task as the active task when window is restored
Method onWndRunSelectClose: Window close event handler for the "Run Selection" dialog
Method onWndTypeSelectClose: Window close event handler for the type selection dialog
Method onWndWizardClose: Close event handler for the main window
OnZoomIn Callback for when the zoom in menu item is selected
OnZoomInToolButton Callback for when the zoom in tool button is pushed
OnZoomListEditSelect Callback for when a zoom level selection is made
OnZoomOut Callback for when the zoom out menu item is selected
OnZoomOutToolButton Callback for when the zoom out tool button is pushed
Translated text for open link in current window
Open link in current window menu item name
Translated text for open link in new active tab
Open link in new active tab menu item name
Translated text for open link in new inactive tab
Open link in new inactive tab menu item name
Translated text for open link in new window
Open link in new window menu item name
Set to 'true' if this group should be opened by default.
openExportFile Opens the passed export file. This is a NOOP in BUI.
Open toolpanel
Open the given toolpanel
The combine operator
Constant value which defines the AND
operator
Constant value which defines the OR
operator
Instance of the grid options class
Filter for getEvents() method: The order of the events returned in the result. Optional. The default is an unspecified, stable order. (string) Valid values are "startTime" and "updated"
Provide a template for 'loading' overlay if not happy with the default one.
#Configuration
#GridRenderer
Provide a template for 'no rows' overlay if not happy with the provided.
#Configuration
#GridRenderer
Page to display
Width of the page inputn, the default is 40
Page number inputn name
Page number inputn name
Translated text for page status
Filter for getEvents() method: Token specifying which result page to return. Optional. (string)
A number that indicates whether to paint a glossy layer on a flat bar chart
A field variable that contains the parent translations
The row parent key, if any
The parent BBJasperViewerControl
Password to use for authentication to the mail server
A regular expression that the input's value must match in order for the value to pass constraint validation
A regular expression that the input's value must match In order for the value to pass constraint validation
Constant that represents the PDF save contributor
Constant that represents the PDF save contributor
PDF exporter which contains export options
A number that sets whether or not to save out user settings for the dashboard and widgets, such as dashboard size and placement, widget visibility, refresh settings, etc. 0=Do Not Save Settings, 1 = Save Settings (default)
Note that settings will still be applied if they were previously saved, regardless of this setting as it only affects whether settings will be saved.
Pie chart widget type constant
PieChartWidget A Dashboard Utility Widget that displays a pie chart where the data values all add up to 100%
Create an empty Pie Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an empty Pie Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Pie Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create a BBjRecordSet-based Pie Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Pie Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Pins a column in the grid to the left or right margin
Pin a column of the grid to the left or the right margin
#API
Set to 'left' or 'right' to pin.
#Configuration
#ColumnsRenderer
Get pinned left constant
Get pinned right constant
The ResultSet instance which contains the bottom pinned rows
A cellRenderer for pinned rows.
Use to give pinned row cell a different CellRenderer to the other cells. If both CellRenderer and PinnedRowCellRenderer are provided, pinned rows will use PinnedRowCellRenderer over CellRenderer.
#Configuration
#ColumnsRenderer
The ResultSet instance which contains the top pinned rows
The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
#Configuration
#GridRenderer
The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
#Configuration
#GridRenderer
Set this in columns you want to pivot by. If only pivoting by one column, set this to any number (eg 0). If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (eg 0 for first, 1 for second, and so on).
#Configuration
#ColumnsRenderer
Set to true to enable pivot mode
#Configuration
#API
When to show the 'pivot panel' (where you drag rows to pivot) at the top.
Default is never. Set to either 'always' or 'onlyWhenPivoting'.
Note that the pivot panel will never show if pivotMode is off.
#Configuration
#GridRenderer
Placeholder text to be shown when the filter is of type FILTER_TYPE_LISTEDIT or FILTER_TYPE_EDITBOX and the control is empty
Translated text for png image
Translated text for png image
The desired height of the widget when popped out
The desired width of the widget when popped out
An internal method used by the WidgetControl to resize the window when the popout window's resize timer event fires
A string with HTML contents to be used for the popped-out version of the widget.
A string representation of the URL, such as "http://www.basis.cloud" to be used for the popped-out version of the widget.
The BBjPopupMenu to display when triggered by a user event.
Position of widget in category
A hashset of what is considered false
A hashset of what is considered true
Constant that represents the PPTX save contributor
Constant that represents the PPTX save contributor
PPTX exporter which contains export options
When true then the executor will try to executes the JavaScript in the BBjHtmlView and returns immediately without waiting for a return value from the client.
Enabling this option might boost the performance of the grid.
When true then the executor will try to executes the JavaScript in this BBjHtmlView and returns immediately without waiting for a return value from the client.
Enabling this option might boost the performance of the grid.
A prefix to append to the value after it is formatted
A prefix to append to the value after it is formatted
Returns the preview image of the widget
Returns the preview text of the widget
Translated text for previous page
Translated text for previous page
Previous page menu item name
Previous page menu item name
Previous page tool button name
Previous page tool button name
previousHighlight Finds the previous find element
previousPage Changes the view to display the previous page, if there is one
print Prints the report
print Prints the report
print Prints the current report
print Prints a report to a client printer with or without printer dialog
print Prints a report to a server printer with or without printer dialog
Translated text for print
Translated text for print
Print menu item name
Print menu item name
Constant that represents the PRINT save contributor
Constant that represents the PRINT save contributor
Print tool button name
Print tool button name
Print service exporter which contains export options
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (string)
ProcedureParam class
Constructor Constructs a ProcedureParam.
ProcedureType class
Constructor Constructs a ProcedureType for the given database and procedure name.
Method processRecord: Receives the DataRow about to be added to the visible grid page to allow custom formatting, etc. If NULL() is returned, the DataRow will not be added to the grid
Program directory
Prop directory which contains the resource bundle
A field variable that contains the properties
Mail server protocol, which can be smtp or smtps
see BBjControl
putParam Sets an individual report parameter
putParams Sets report parameters
Filter for getEvents() method: Free text search terms to find events that match these terms in any field, except for extended properties. Optional. (string)
A map of scripts which must be executed
QuickView Grid utility class
Constructs QVGrid component on passed parent window in existing child window.
Constructs QVGrid component on passed parent window using given id and dimensions.
Constructs QVGrid component on passed parent window in existing child window using given id and dimensions.
Defines the range of cells to be charted. A range is normally defined with start and end rows and a list of columns, If the start and end rows are omitted, the range covers all rows (ie entire columns are selected).
The number of milliseconds before the executor tries to flush the enqueued scripts on the client.
The number of milliseconds before the executor tries to flush the enqueued scripts on the client
Scope for read-only access to user's calendar. This is a static field that can be accessed for setting the scope of OAuth2.0 authorization.
Scope for read-write access to user's calendar. This is a static field that can be accessed for setting the scope of OAuth2.0 authorization.
Translated text for ready
Method rebuildGrid: Namespace event handler to rebuild grid from "ControlVariables" vector
Method rebuildGrid: Namespace event handler to rebuild the toolbar grid
Method rebuildLists: BBjNamespaceEvent event handler to rebuild the lists
A developer-provided BBjRecordSet used to provide data for the widget
A BBjRecordSet used to provide data for the widget
A BBjRecordSet used to provide data for the widget
A BBjRecordSet used to provide data for the widget
A BBjRecordSet used to provide data for the widget
An BBjRecordset-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.
URL or URI to which the authorization token will be sent.
Property for the application redirect URL. In the case of several applications using OAuth, this property can be overridden to look for a different property in BBj.properties. Note: This is the name of the property for the redirect URL, not the value of the redirect URL itself.
Initially draws or redraws the widget whenever it needs to be rendered.
Your application code won't ever have to call this method under normal conditions. It's typically only used internally
to redraw the calendar after the the setSize()
method has been called. However, if you may want to call
the render()
method if you modified the calendar's options inline (as opposed to using the setOptions()
method.
@Override
This method is called whenever the widget needs to be rendered
Gets the grid to remove a row from the DOM and recreate it again from scratch.
Causes the calendar to refetch entries from all sources and rerender.
If you've previously added events to the calendar from a remote source, such as a web service or Google Calendar, then the calendar will requery those sources for an updated entry set. If the entries on the backend have changed, such as some entries have been added and others deleted, then those changes will be reflected on the calendar after calling this method.
Refetches all CalendarEntrySource
objects in the calendar, causing them to retrieve their entries again.
Refetches the CalendarEntrySource
object in the calendar given its unique ID, causing it to retrieve its entries again.
Refreshes the entire DashboardWidget, updating the view for the object including the inner Widget as well as any DashboardWidgetFilters and DashboardWidgetLinks that have been defined. This method may be used in response to a callback event that executes custom code to modify one or more of the filters and links. If the custom code only modifies the inner widget, then it's faster to call the widget's refresh method as that only affects the widget and not the filters or links.
Refreshes the widgets in the currently selected category
Refreshes the control
Refreshes the widget control
Internal refresh routine that refreshes the widget control and sets the type of refresh based on what event initiated the event
This routine responds to the WidgetControl's refresh event and will either pass the refresh request on to the interior widget or, if the developer has set a callback for the refresh event, it creates a DashboardWidgetRefreshEvent object then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetRefreshEvent.
Called to refresh the widget
Refreshes the image, which results in the widget showing an up-to-date version of the images if it has changed on disk or from the URL
Refreshes the HtmlViewWidget contents by reloading the URL or setting the HTML text, and injecting/executing JavaScripts if applicable
Refreshes the grid, which results in the widget showing an up-to-date version of the grid. This is executed in response to a refresh event, and the grid is filled with curent data and all customizations are applied.
Refreshes the grid, which results in the widget showing an up-to-date version of the grid. This is executed in response to a refresh event, and the grid is filled with curent data and all customizations are applied.
Refreshes the chart, which results in the widget showing an up-to-date version of the chart based on the underlying dataset. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied.
Refreshes the chart, which results in the widget showing an up-to-date version of the chart. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied
Refreshes the chart, which results in the widget showing an up-to-date version of the chart. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied
Refreshes the StackedPercentageBarChartWidget chart, which results in the widget showing an up-to-date version of the chart. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied
Refreshes the chart, which results in the widget showing an up-to-date version of the chart. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied
Refreshes the chart, which results in the widget showing an up-to-date version of the chart. This is executed in response to a refresh event, and the chart is filled with curent data and all customizations are applied
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.
refresh Refreshes the image for the current report page and zoom level
refresh Refreshes the image for the current report page and zoom level
A constant for a refresh initiated by the widget's AutoRefresh timer, used in conjunction with the getRefreshType() method.
A constant for a refresh initiated by the category's Refresh button, used in conjunction with the getRefreshType() method.
A constant for a refresh initiated by the widget's Refresh menu or toolbutton, used in conjunction with the getRefreshType() method.
RefreshableWidget Interface that facilitates refreshing the widget
Refreshes the widgets in all categories
refreshFields Refreshes the fields in the fields grid
refreshProcedure Refreshes the procedure window
refreshToolbar Refreshes the toolbar in case controls have been added/removed outside the class
An internal method to refresh the widget control's links, filters, and inner widget
This is the result of the developer's custom code calling the DashboardWidget.refresh() method
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
Registers a BUI app given the provided parameters.
registerJDBCDriver Registers the passed JDBC driver class
Register the web service with the default name (GMWS) and publish it.
Register the web service with a specified name and publish it. The suggested and default service name is GMWS, but it can be any valid string.
Multipart object
When set to TRUE (1), the interpreter running the viewer window will release when closed by the user
reload Refills the report and refreshes the viewer
reload Refills the report and refreshes the view
Translated text for reload
Translated text for reload
Reload menu item name
Reload menu item name
Reload tool button name
Reload tool button name
When true, if you set new data into the grid and have groups open, the grid will keep groups open if they exist in the new dataset
#Configuration
#GridRenderer
Remove a column from the model
Add new row
Remove an added language
An array of row to remove
Disable the current grid alignment with the passed one
removeAllEmailContacts Removes all email contacts from the contact list
Removes all the entries in the calendar.
Note: Removing entries from the calendar via this method will trigger the
CalendarAPI.ON_CALENDAR_ENTRY_REMOVE()
event for each entry that was removed.
Removes all CalendarEntrySource
objects from the calendar.
Removes a control attribute from the grid control
Removes a widget
Removes a CSS style name from a grid cell
Disable a chart toolbar item
#Enterprise
#Configuration
#API
Removes a child translation from the translations
Removes all children BBTranslationBundles
Removes the provided class name string (or CSS style) from the entry's vector of class names.
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Removes a CSS style name from a grid column
Remove statusbar component
Remove statusbar component
Removes a dashboard category from the dashboard
Remove a dashboard category control
Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one
An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
removeEmailAddress Removes an email address from the appropriate list
removeEmailAddresses Removes email addresses from the appropriate list
removeEmailAttachment Removes an email attachment
removeEmailContact Removes an email contact from the contact list
removeEmailContact Removes an email contact from the appropriate list
removeEmailContacts Removes email contacts from the contact list
removeEmailContacts Removes email contacts from the appropriate list
Removes all the entries contained in the BBjVector from the calendar.
Note: Removing entries from the calendar via this method will trigger the
CalendarAPI.ON_CALENDAR_ENTRY_REMOVE()
event for each entry that was removed.
Removes an entry from the calendar.
Removes an entry from the calendar given its optional unique ID which must have previously been set.
Removes a CalendarEntrySource
and its entries from the calendar given its unique ID.
Removes the extended property from the entry's HashMap of extended properties given the property key.
removeField Removes a field to the database fields vector
removeParam Removes an individual report parameter
removeParams Removes all report parameters
Disable pivot for columns.
#Enterprise
#Configuration
#API
Removes a popup menu from the grid control
Remove a row from grid by the row reference
#API
Remove a row from grid by index
#API
Remove a row from grid by key
#API
Disable row grouping for columns.
#Enterprise
#Configuration
#API
Removes a CSS style name from a grid row
removeSaveContributor Removes a save contributor
removeSaveContributor Removes a save contributor
Removes the requested series
Removes a CSS style name from the grid control
Removes the provided CSS style name from the widget.
Remove Style Block
#API
Removes the provided tag from the entry's vector of tags.
Removes a translation given a key
Removes all translations
Disable value for columns.
#Enterprise
#Configuration
#API
removeViewerWindow Removes a viewer window from the vector of viewer windows
removeViewerWindow Removes a viewer window from the vector of viewer windows
Removes a widget
Removes a widget
Renders the calendar inside the HtmlView and applies the current calendar options.
This composes the calendar configuration and sends it to the client for a full rerendering. This is the
difference between the render()
and the redraw()
method - the redraw()
method
only instructs the calendar to repaint itself; it doesn't change or apply any configuration options.
You can call this method to force the calendar to be updated after you modify its setup configuration, as in:
rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render()
Note: You don't have to call the render()
method if you update the calendar's configuration via the setOptions()
method.
Render the grid
The method will compose the grid config and send it to the client for a full re-render. You can use this method to force the client render after you update a setup configuration (ex: column definitions)
Report child window name
Constant value that represents a error return code
Report image control name
ReportDir used to locate data such as images for the report
ReportPrefix used to locate data such as images for the report
Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher
An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
This method is called as a result of the user dragging and dropping a widget control into a new position. The method determines the new placement of the widget control, then calls the repositionDashboardWidgetControl() method with the control and destination position.
An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object and a destination position
An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name and a destination position
When true , then the input cannot be empty and a value is required to consider the input valid
When true , then the input cannot be empty and a value is required to consider the input valid
Property for the application require SSL when redirecting. In the case of several applications using OAuth, this property can be overridden to look for a different property in BBj.properties. Note: This is the name of the property for the require SSL, not the value of the require SSL itself. This property will only take effect when the RedirectURLProperty is not set. Its value should be set to true if require ssl.
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Resets the container height based on widget height, number of rows, and row spacing
Reset The row heights.
#API
The rows height is calculated once when the data is first given to the grid. If the data changes, or the width of a column changes, then you may require the grid to calculate the height again by calling this method
Set to true to allow column to be resized.
#Configuration
#ColumnsRenderer
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height if the BBjWidget's interior BBjControl has already been created
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height
Resizes the widget using the provided with and height
Resolve/build the suggestion list
Resolve/build the suggestion list
resolvePath
Given a dot-delimited JSON path and a JSON document as a Jackson JSON document,
traverses the JSON document to extract the value.
For example:
If I have the path "RestResponse.result[0].name" and my JSON document consists of
{ "RestResponse" : { "result" : [ { "name" : "Afghanistan" } ] } } ,
my result will be a JsonNode object containing "Afghanistan".
Method called by the other utility methods. This method recursively resolves a JSON path given the name of the parent node, the current JSON path, and the current JsonNode. As this method calls itself, it builds the name of the parent node, passes in the remaining path, and passes in the descendant of the JsonNode. Though this method may be called directly, it's really intended to be invoked by the utility class's other methods.
Re-sorts the grid If a user edits a grid cell after a grid is sorted, the row display order does not automatically change to reposition the edited cell. Calling resort() caused the grid to re-apply all sorting so that the newly edited data appears in the correct sort order. Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
Restores a cell to its previous value
Restores any custom colors assigned to the chart by the program (after removing user customized theme color)
Restores all cell values in a row
*** Programmatically configurable properties * **
Number of retries when sending the email
Reverses the order of the colors in a vector
Revokes access of the application to the currently signed in user. User will have to grant access to the application via a sign in process again. Any refresh or bearer tokens associated with this session's bearer token will not continue to work. This method sends the following request which can be duplicated in a browser: https://accounts.google.com/o/oauth2/revoke?token=token!
Revokes access of the current token!. (token! can be any Google token and need not be associated with the current application.) Any refresh or bearer tokens associated with token! will not continue to honored. This method sends the following request which can be duplicated in a browser: https://accounts.google.com/o/oauth2/revoke?token=token!
Translated text for right/down arrow
Ring chart widget type constant
RingChartWidget A Dashboard Utility Widget that displays a ring or doughnut chart, which is similar to a pie chart with the middle cut out
Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Ring Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create a BBjRecordSet-based Pie Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Create an SQL-based Ring Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
Method to rotate the BBXImage
The image will be rotated around the center point, and a positive rotation angle corresponds to rotating the image in a clockwise fashion. Note that the new image will be larger than the original image to avoid truncating rotated edges.
Rotate the colors in a vector forwards or backwards by a specified amount.
Supplying a positive number, such as +1, will cause the Colors to be rotated to the right, so the Color that was previously the last Color will now be the first Color. Suppliying a negative number, such as -1, will cause the Colors to be rotated to the left, so the Color that was previously the second Color will now be the first Color.
Method to round the bottom corners (knockout) of the BBXImage given a cornerRadius
Method to round the corners (knockout) of the BBXImage given a cornerRadius
Method to round the top corners (knockout) of the BBXImage given a cornerRadius
The row model
The Row being edited
The cell's row.
Property to set CSS class for all rows
#Configuration
#GridRenderer
Rules which can be applied to include certain CSS classes for rows.
These rules are provided as a JavaScript map where the keys are class names and the values are expressions that
if evaluated to true, the class gets used. The expression is a string which is treated as a shorthand for a
function by the grid.
#Configuration
#GridRenderer.
The expression has the following attributes available:
rowIndex | Maps the current row index |
data | Mapped from the DataRow |
ctx | The grid client context |
Set to true or false. If true, then rows will be deselected if you
hold down ctrl + click the row. Normal behaviour with the grid disallows
deselection of nodes (ie once a row is selected, it remains selected until
another row is selected in its place).
#Configuration
#GridRenderer
Set to true To group rows by this column
#Enterprise
#Configuration
#ColumnsRenderer
Set this in columns you want to group by. If only grouping by one column, set this to any number (eg 0). If grouping by multiple columns, set this to where you want this column to be in the group (eg 0 for first, 1 for second, and so on).
#Configuration
#ColumnsRenderer
When to show the 'row group panel' (where you drag rows to group) at the top. Default is never. Set to either 'always' or 'onlyWhenGrouping'
#Configuration
#GridRenderer
A number that detmines the grid's row height in pixels
Default Row Height in pixels. Default is 25 pixels.
#Configuration
#API
The row key of the data item
The RowListener interface can be implemented to allow access to the data rows on their way up to the grid.
Set to true to allow multiple rows to be selected with a single click.
E.g. if you click select one row, then click select another row, the first row will keep it's selection.
Clicking a selected row in this mode will deselect the row.
This is useful for touch devices where ctrl and shift clicking is
not an option.
#Configuration
#GridRenderer
Note that Despite the setting name, it works when MultipleSelection is enabled or disabled
The unique string to use as row index. default is __ROW_INDEX
Number of character rows to display. Default is 10.
An array of rows objects where every object is instance of GxClientRowModel
Event handler for a row selection
Space in pixels between rows of widgets
A grid expression which can be executed to perform row spanning.
The expression must return the number of rows to span , if no spanning should be applied , then
return 1
instead (ex: "data.SHOW ? 4 : 1")
By default, each cell will take up the height of one row. You can change this behaviour to allow cells to span multiple rows. This feature is similar to 'cell merging' in Excel or 'row spanning' in HTML tables.
To allow row spanning, the grid must have options SuppressRowTransform=true
To have a cell span more than one row, return how many rows to span in the RowSpanExpression.
The option SuppressRowTransform=true
is used to stop the grid positioning rows using CSS transform
and instead the grid will use CSS top.
The reason row span will not work with CSS transform is that CSS transform creates a stacking context
which constrains CSS z-index from placing cells on top of other cells in another row.
Having cells extend into other rows is necessary for row span which means it will not
work when using CSS transform.
The downside to not using transform is performance; row animation (after sort or filter) will be slower.
Constraints with Row Spanning :
Row Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Row Spanning, be aware of the following:
#Configuration
#ColumnsRenderer.
Property to set style for all rows. Set to an object of key (style names) and values (style values)
#Configuration
#GridRenderer
The ResultSet instance
Constant that represents the RTF save contributor
Constant that represents the RTF save contributor
RTF exporter which contains export options
run Runs bbjasper with the passed program args
Args are the following:
arg1 (required) = report source file name
arg2 (required) = connect string
arg3 (optional) = locale
arg4 (optional) = report params key/value pairs
run Runs the BBJasperDesigner
runDemo Runs a demo of BBJasper
runDemo Run a demo of BBJasperDesign with user selected parameters
runDemo Run a quick demo of BBJasperDesigner
Method that runs a sample demo program for the BBjDialChartProgress class
runDemo2 Run a demo of BBJasperDesign with fixed fields and a memory record set
runDemo3 Run a free-form demo of BBJasperDesign using hard-coded layout and the ChileCompany database
Constant which represents the fill operation is running
Make a color more or less saturated
Saves the widget as a image.
Saves the image
Saves an image representation of the HtmlViewWidget on the client's machine
Saves an image representation of the grid on the client's machine
Saves an image representation of the grid on the client's machine
Interactively saves a screenshot of the chart as a PNG file on the client
Translated text for save
Translated text for save
Translated text for save-as
Translated text for save-as
Translated text for save as google document
Translated text for save as google document
Save as google docment item name
Save as google document menu item name
Save as google docment item name
Save as menu item name
Save as menu item name
Save as menu item name
Translated text for save current page as image
Save image menu item name
Find previous menu item name
Save menu button name
Save menu button name
Width of the save menu button, the default is 39
Save menu item name
Save menu item name
Save menu item name
Save menu name
SaveableWidget Interface that facilitates saving of the widget
Method to save the BBXImage out to a .bmp file
Method to save the BBXImage out to a .gif file
Method to save the BBXImage out to a .jpg file
Method to save the BBXImage out to a 32-bit .png file with transparency
Saves a BBjImage screenshot of the BBjCalendarWidget
to the specified file path.
Method to save the BBXImage out to a .tiff file
Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog
Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog
Generates a series of PNG image files that are a visual representation of each Color Theme's palette
Generates a color palette PNG image file that is a visual representation of all Colors in the supplied vector
saveCurrentPageAsImage Saves the current report page as a image
saveEmailContacts Saves the email contacts to the user properties
Method to scale the BBXImage given a width and height Note: This method of scaling uses the java.awt.Image::getScaledInstance() method with the Image.SCALE_AREA_AVERAGING rendering hint.
Method to scale the BBXImage given a percentage
Method to scale the BBXImage preserving the aspect ratio given the width
Method to scale the BBXImage preserving the aspect ratio given the maximum width or height dimension.
This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a square of a particular size.
Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions.
This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a rectangle of a particular size.
Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, and then resize the canvas so that the image will be resized to the specified width and height. The original image will be centered in the final image and any extra space will be transparent.
This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a rectangle of a particular size.
Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, then resize the canvas so that the image will be resized to the specified width and height. The original image will be centered in the final image and any extra space will be transparent. The final image will then be used to set the contents of the specified BBjImageCtrl
This method is useful in the case where you'd like to resize the an image ensuring that it will maintain its original proportions and will fit within a BBjImageCtrl of a particular size.
Method to scale the BBXImage preserving the aspect ratio given the height
Method to scale the BBXImage given a width and height and HashMap of Graphics2D rendering hints
Java's RenderingHints allow you to specify the interpolation method used when scaling the image. The possible values are:
Generally speaking, the interpolations values shown above range from quickest with poorest quality (VALUE_INTERPOLATION_NEAREST_NEIGHBOR) to slowest with best quality (VALUE_INTERPOLATION_BICUBIC). In practice, bilinear and bicubic interpolation produce results that are very similar. Bicubic will be slightly sharper than bilinear, with a bit more emphasis on edges. That translates to bicubic often being a better choice for image reduction, whereas blinear is usually better for image enlargement.
Following is a short example showing how to use this method:
use java.util.HashMap use java.awt.RenderingHints hintsMap! = new HashMap() hintsMap!.put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC) xImage!.scaleWithHints(width, height, hintsMap!)
Translated text for scope
scopes for authorization. Starts out as an empty vector.
ScreenCapture
Screen Capture Class
A constant to define the scroll bar width
Height and width of the scroll bars, the defaults are set the UI
Scroll grid to a given position
Scrolls down in order to set the bottom row visible
The second filter condition
Constant for seconds
select all rows
#API
select all rows
#API
An array of selected rows
Indicates if the widget control is selectable
Select all values generated by the UI
#API
Select an item in the filter's Entries! LinkedHashMap by providing the item's key. If the key exists in the LinkedHashMap then the filter's Key$ and Value$ variables will be set to this item.
selectGoogleDefaultType Selects the default Google document type
selectGoogleDefaultType Selects the default Google document type
Clears the selection
#API
Selects a value
#API
Selects a value
#API
Selects the current view
send Sends an email message once it has been configured.
At the very least, a mail server, username, password, and the "to" field (specified by the setTo() or addTo() methods) must be set before an email message can be sent. Any errors will be thrown.
Sends a request to a webserver and retrieves a response. This is performed synchronously and is therefore blocking.
Translated text for case sensitive
A data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.
The series number of the data item
The series key of the data item
The published name of the web service, which defaults to GMWS.
Session object
Can be used to set JSON properties in the calendar.
Set specific Event properties
Set properties on the GEventAttendee corresponding to JSON properties.
Sets the pie depth as a percentage of the height of the plot area. Values range from 0 to 1.
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, this method is ignored in version 23 and higher.
Setting the value to 0 results in a flat, non-3D chart. Setting the valute to 1 results in a 3D chart that is so extruded that you can only see the side, not the top. Values in the 0 to 0.2 range are more reasonable.
Set access role.
Sets the status to active or inactive
Sets the active status of the widget control by setting the associated DashboardWidget's active flag
An internal method that sets the active status of the widget based on its parent
Sets the calendar's last visible day to the provided date string.
Note: This value is exclusive, as are all ending dates.
Sets the calendar's first visible day to the provided date string. In month view, this value is often before the 1st day of the month, because most months do not begin on the first day-of-week.
setActualSize Sets the report image to the actual size
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
setActualSize Sets the report image to the actual size
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
Number of guests attendee is bringing.
Sets the section's horizontal alignement to one of the three possible alignments, or positions, for the section that include:
CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START()
- The left-most section of the toolbar (in LeftToRight mode).CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER()
- The center section of the toolbar.CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END()
- The right-most section of the toolbar (in LeftToRight mode).Sets the default alignment for a column
Sets the default alignment for a column
Set the component alignment
Sets user-sortable indicator for all columns
Sets an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
Set event end time using 3 numbers to designate year, month, and day respectively. This method is used to specify the end time for an all-day event.
Set event end time using 3 numbers to designate year, month, and day respectively. This method is used to specify the end time for an all-day event.
Set event end time using a java.util.Date This method is used to specify the end time for an all-day event.
Set event end time using a java.util.Date This method is used to specify the end time for an all-day event.
Set event start time using 3 numbers to designate year, month, and day respectively. This method is used to specify the start time for an all-day event.
Set event start time using 3 numbers to designate year, month, and day respectively. This method is used to specify the start time for an all-day event.
Set event start time using a java.util.Date This method is used to specify the start time for an all-day event.
Set the allowed aggregation functions allowed on this column
Indicates whether people can invite themselves to the event regardless of ownership.
Sets the width-to-height aspect ratio of the calendar, where the default value is 1.35 but by default is overridden by the default Height option.
The calendar is a block-level element that fills its entire avaiable width. The calendar's height, however, is determined by this ratio of width to height. Because it's a ratio of the width to height, larger numbers result in smaller (or shorter) heights.
Note: The Height option, if set, will override the AspectRatio. Therefore, if you intend to set the calendar's height via the AspectRatio then you will need to unset the Height option by setting it to null() or an empty string.
Add a list of people who are going to attend a meeting.
Indicates whether attendees have been omitted from the event.
Sets a control attribute for the grid control
Adds an authorization header to the request.
Sets the enable status of the auto refresh configuration menu item in the options menu
Sets the auto refresh enabled or disabled
Sets the auto refresh enabled or disabled
Sets the enable status of the auto refresh menu item in the options menu
Sets the auto refresh rate
Sets the auto refresh rate
Sets the auto refresh unit
Sets the auto refresh unit
A number acting as a boolean that determines whether the grid should size its columns to fit within the widget. Setting AutoResizeColumns sizes the grid and columns to fit in the widget, potentially truncating the data if the widget is small. The default is 1.
Note that this method is a shortcut to calling the setColumnWidths() method specifying the COLUMN_WIDTHS_FROM_WIDGET constant for the sizing algorithm. It's also an alternative sizing model to the AutoResizeGrid scheme. If all columns should fit in the widget without scrolling and it doesn't matter if the cell data is truncated, then set AutoResizeColumns. If it's more important to show all data without truncation and it doesn't matter if the user has to horizontally scroll the grid to see all columns then set AutoResizeGrid.
A number acting as a boolean that determines whether the grid should size its columns to fit its data. Setting AutoResizeGrid sizes the grid and columns fit the data, potentially making it necessary to scroll the grid to see all data. The default is 0.
Note that this method is a shortcut to calling the setColumnWidths() method specifying the COLUMN_WIDTHS_FROM_HEADER_AND_DATA constant for the sizing algorithm. It's also an alternative sizing model to the AutoResizeColumns scheme. If all columns should fit in the widget without scrolling and it doesn't matter if the cell data is truncated, then set AutoResizeColumns. If it's more important to show all data without truncation and it doesn't matter if the user has to horizontally scroll the grid to see all columns then set AutoResizeGrid.
Sets the background color of the dashboard item
Sets the window background color
Sets the background color of the dashboard control
Sets the background color of the dashboard category control
Sets the background color of the widget control
Sets the background color for the grid control
Sets the background color of the calendar's containing window.
Sets the background color of a column
Sets the background color of a column
Set the background color of the calendar. param backgroundColor! String representing the color to set the calendar's background to.
Sets an entry's background color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the source's entry background color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the color and opacity for the outline of each bar
Sets the width of the outline for each bar in pixels with the default value set to 1. Notes:
setBcc Sets the recipient for the blind carbon copy field in an email's header before the email is sent. This value specifies the email address to receive a copy of the message. Other recipients of the message will not be able to see that the email was sent to the specified recipient.
This method takes one email address. To specify multiple recipients for the "bcc" field, use multiple invocations of the addBcc() method. Adding a recipient to the "bcc" field (and not including that address in the "to" and "cc" fields) hides that recipient's address from all other recipients.
Sets whether the grid should beep when the program calls 'accept(0)' in response to a validation event
Method to add a border to the BBXImage
Method to add a border to the BBXImage
Sets an entry's border color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the source's entry border color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the application icon for the specified BUI app.
The application will be shown in the browser's tab and will be used as the default icon on a mobile device when saving the BUI app to the home screen.
Sets the specified text to be displayed in the BUI BBjBusyIndicator when loading widgets into the DashboardCategory
Note that this is a convenience method on the DashboardWindow to access the DashboardControl's related public field variables.
Sets the custom CSS for the specified BUI app.
This is similar to the applyCss() method.
Sets the splash screen or loading image for the specified BUI app.
The image can be a static image, such as a PNG file, or an animated GIF image.
Sets the specified text to be displayed when loading widgets into the DashboardCategory
Note that this is a convenience method on the DashboardWindow to access the DashboardControl's setBusyText() method.
Sets the specified text to be displayed when loading widgets into the DashboardCategory
Sets the text of the provided button, where the button is identified via a constant like CalenarAPI.CALENDAR_TOOLBAR_BUTTON_TODAY.
Sets the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".
Sets a callback for a dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a dashboard widget filter event
After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a dashboard widget filter event
After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a menu item selection event from the DashboardWidgetMenu
After you create a DashboardWidgetMenu object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting a menu item from the popup menu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a menu item selection event from the DashboardWidgetMenu
After you create a DashboardWidgetMenu object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting a menu item from the popup menu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a dashboard widget link event
After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
Sets a callback for a dashboard widget link event
After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
setCallback Sets a callback for the HtmlViewWidget given a control event and a callback routine
Example:
myHtmlViewWdget!.setCallback(BBjAPI().ON_PAGE_LOADED, pgm(-2) + "::myHtmlPageLoadedRoutine")
The myHtmlPageLoadedRoutine would look similar to:
{@code myHtmlPageLoadedRoutine: event! = BBjAPI().getLastEvent() htmlViewWidgetEvent! = event!.getObject() dbWidget! = htmlViewWidgetEvent!.getDashboardWidget() widget! = htmlViewWidgetEvent!.getWidget()rem * * Do Custom Stuff Here * *
exit }
setCallback Sets a callback for the HtmlViewWidget, given a control event, callback object, and a callback routine
Sets a callback for a GridWidget event
Sets a callback for a GridWidget event
setCallback Sets a callback for the widget, given a control name, control event, and a callback routine
setCallback Sets a callback for the widget, given a control name, control event, callback object, and a callback routine
Registers a legacy callback routine for a specified event in the grid
Registers an object oriented callback routine for a specified event in the grid
Registers a callback in a procedural program for the provided event type.
These are the valid callback event type options:
CalendarAPI.ON_CALENDAR_READY
- the calendar is ready for interactionCalendarAPI.ON_CALENDAR_VIEW_CHANGE
- the calendar's view has changedCalendarAPI.ON_CALENDAR_ENTRIES_SET
- entries have been changed or initialized in any wayCalendarAPI.ON_CALENDAR_ENTRY_CLICK
- the user clicked on an entryCalendarAPI.ON_CALENDAR_ENTRY_ADD
- an entry was added to the calendarCalendarAPI.ON_CALENDAR_ENTRY_CHANGE
- the entry has been modifiedCalendarAPI.ON_CALENDAR_ENTRY_REMOVE
- the entry has been removed from the calendarCalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER
- the user moved the mouse on an entryCalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE
- the user moved the mouse off an entryCalendarAPI.ON_CALENDAR_ENTRY_DRAG_START
- the user began dragging an entire entryCalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP
- the user stopped dragging the entryCalendarAPI.ON_CALENDAR_ENTRY_DROP
- the user has completed dragging and dropping the entire entryCalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START
- the user began to resize the entry to change its durationCalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP
- the user stopped resizing the entryCalendarAPI.ON_CALENDAR_ENTRY_RESIZE
- the user completed resizing the entry resulting in a changed durationCalendarAPI.ON_CALENDAR_ENTRY_RECEIVE
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_ENTRY_LEAVE
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_DROP
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_DATES_SET
- the calendar's range has been initially set or changed in some wayCalendarAPI.ON_CALENDAR_DATE_CLICK
- the user clicked on a date or time in the calendarCalendarAPI.ON_CALENDAR_SELECT
- the user selected a date or time in the calendar (not an entry)CalendarAPI.ON_CALENDAR_UNSELECT
- the date/time selection has been clearedCalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS
- fetching a CalendarEntrySource has succededCalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE
- fetching a CalendarEntrySource has failedNote: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.
Registers a callback in an object-oriented program for the provided event type.
These are the valid callback event type options:
CalendarAPI.ON_CALENDAR_READY
- the calendar is ready for interactionCalendarAPI.ON_CALENDAR_VIEW_CHANGE
- the calendar's view has changedCalendarAPI.ON_CALENDAR_ENTRIES_SET
- entries have been changed or initialized in any wayCalendarAPI.ON_CALENDAR_ENTRY_CLICK
- the user clicked on an entryCalendarAPI.ON_CALENDAR_ENTRY_ADD
- an entry was added to the calendarCalendarAPI.ON_CALENDAR_ENTRY_CHANGE
- the entry has been modifiedCalendarAPI.ON_CALENDAR_ENTRY_REMOVE
- the entry has been removed from the calendarCalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER
- the user moved the mouse on an entryCalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE
- the user moved the mouse off an entryCalendarAPI.ON_CALENDAR_ENTRY_DRAG_START
- the user began dragging an entire entryCalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP
- the user stopped dragging the entryCalendarAPI.ON_CALENDAR_ENTRY_DROP
- the user has completed dragging and dropping the entire entryCalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START
- the user began to resize the entry to change its durationCalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP
- the user stopped resizing the entryCalendarAPI.ON_CALENDAR_ENTRY_RESIZE
- the user completed resizing the entry resulting in a changed durationCalendarAPI.ON_CALENDAR_ENTRY_RECEIVE
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_ENTRY_LEAVE
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_DROP
- Not Yet Implemented, deals with dragging and dropping entries from an external sourceCalendarAPI.ON_CALENDAR_DATES_SET
- the calendar's range has been initially set or changed in some wayCalendarAPI.ON_CALENDAR_DATE_CLICK
- the user clicked on a date or time in the calendarCalendarAPI.ON_CALENDAR_SELECT
- the user selected a date or time in the calendar (not an entry)CalendarAPI.ON_CALENDAR_UNSELECT
- the date/time selection has been clearedCalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS
- fetching a CalendarEntrySource has succededCalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE
- fetching a CalendarEntrySource has failedNote: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.
Register an event handler
Register an event handler
Method to resize the BBXImage's canvas, specifying transparent for the fill color.
Method to resize the BBXImage's canvas. If the canvas size is larger than the BBXImage's size, then the extra space will be filled with the specified color and the original image will be centered in the new canvas. If the canvas is smaller than the BBXImage then it will be centered and cropped to fit, resulting in the removal of the edges.
Method to resize the BBXImage's canvas. If the canvas size is larger than the BBXImage's size, then the extra space will be filled with the specified color and the original image will be centered in the new canvas. If the canvas is smaller than the BBXImage then it will be centered and cropped to fit, resulting in the removal of the edges.
Sets whether entering this grid control will trigger control validation on the control that previously had focus Note: This feature is typically used with controls like the Cancel button that should let the user exit without forcing valid data to be entered first.
setCc Sets the recipient for the carbon copy field in an email's header before the email is sent. This value specifies the email address to receive a copy of the message.
This method takes one email address. To specify multiple recipients for the "cc" field, use multiple invocations of the addCc() method. The cc field is visible to all email recipients. To hide addresses that emails are being sent to, consider the setBcc() and addBcc() methods.
Adding a recipient to the carbon copy field is the same as adding it to the "to" field. Entering the recipient in the "cc" field rather than the "to" field indicates that the message is relevant to them, but is not a direct correspondence with them.
Sets the alignment of a cell
Sets the background color of a cell
Sets both the displayed and related text of a cell
Sets whether a cell is editable Note: The QVGrid is non-editable, so this method does not change any state.
Set a cell editor selector to use for this column.
Sets the font of a cell
Sets the foreground color of a cell
Specifies whether a cell should have an associated query button
Sets the icon for a cell
Sets a cell image in a cell of the grid.
Sets the image displayed in a cell
Sets a list control for a cell so that the cell will display as a list control when edited
Sets the list selection for a list control in a cell
Sets the cell mask for both displaying and editing Note: Only applicable to InputD, InputE, and InputN style cells.
Sets the "related" text that is associated with a cell
Sets the "related" text that for a range of cells
Sets the restore value for a cell
Sets the checked state of a check box or button style cell
Sets the style of a cell
Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0).
Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right, beginning at the specified start row and column. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0).
Sets the text displayed in a cell
Sets vertical alignment in a cell
setCharacterEncoding Sets the character encoding for export operations
Sets a background color for the entire chart
Sets a background color for the entire chart
Sets a background paint for the entire chart
Sets the colors for the chart's background as a gradient
Sets a background image for the entire chart
Sets a background image for the entire chart
Sets the colors for the chart dynamically by generating a series of colors given a starting and ending color with opacities
The colors for the chart are considered to be dynamic, as the number of colors in the range will be regerated whenever the underlying dataset changes, such as in response to a refresh event.
Sets the colors for the chart dynamically by generating a series of divergent colors given a starting, middle, and ending color with opacities
The colors for the chart are considered to be dynamic, as the number of colors in the range will be regerated whenever the underlying dataset changes, such as in response to a refresh event.
Sets the colors for the chart by generating a series of colors given a starting and ending color
Sets the colors for the chart by generating a series of colors given starting and ending Java Colors which may include an opacity
Sets the colors for the chart given a fixed number of hex color descriptions in a string
Sets the colors for the chart given a fixed number of hex color descriptions in a string and an opacity value
Sets the colors for the chart given a fixed number of Java Colors in a BBjVector
Sets the colors for the chart given a color theme number
Sets a custom label format for the chart's label items - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis
Note that if you provide a format string that results in a label that cannot fit within the data entity, such as a bar in the BarChart, then the label may not be displayed. If this happens, you can either reduce the length of the string, reduce the font size for the chart's labels, or modify the label's placement. To change the label's font size, you can execute the ChartWidget::setChartFontSizes() method, specifying a smaller-than-default value for the label size. For example:
myBarChart!.setChartFontSizes(0, 0, 0, 9, 0, 0, 0)
will only set the label size to 9px while leaving the other chart fonts at their default sizes.
See the related ChartWidget::setChartDataItemLabels() method to modify the label's position.
Sets a custom label format for the chart's label items by providing a label string and NumberFormatters for the number and percentage fields - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis
A sample use case would be:
which would cause the label to display the key followed by the value formatted as currency. That way it would show up in a format similar to:myBarChart!.setChartDataItemLabelFormat("{1}: {2}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.Current: $218.10
Note that if you provide a format string that results in a label that cannot fit within the data entity, such as a bar in the BarChart, then the label may not be displayed. If this happens, you can either reduce the length of the string, reduce the font size for the chart's labels, or modify the label's placement. To change the label's font size, you can execute the ChartWidget::setChartFontSizes() method, specifying a smaller-than-default value for the label size. For example:
myBarChart!.setChartFontSizes(0, 0, 0, 9, 0, 0, 0)
will only set the label size to 9px while leaving the other chart fonts at their default sizes.
See the related ChartWidget::setChartDataItemLabels() method to modify the label's position.
Enables data item labels in a chart, displaying the range value in the specified color - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis
This method signature only specifies the label text color and uses default values for the label's position. See the other method signatures to control the label position.
Note that the legacy setLabelsInBarChartColor() method also enables data item labels but uses default positioning and only works with BarCharts.
See the related ChartWidget::setChartDataItemLabelFormat() method to modify the label's formatting.
Enables data item labels in a chart, displaying the range value in the specified color and position - note that this applies only to category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts that have a domain and range axis
This method signature offers a simplified positioning model that places the labels vertically relative to the data item. See the other method signature that offers complete control over the label position but uses the JFreeChart's custom classes for positioning parameters.
Note that the legacy setLabelsInBarChartColor() method also enables data item labels but uses default positioning and only works with BarCharts.
See the related ChartWidget::setChartDataItemLabelFormat() method to modify the label's formatting.
Enables data item labels in a chart, displaying the range value in the specified color and position - note that this applies only to category-based charts, such as BarCharts, LineCharts, AreaCharts, etc. that have a domain and range axis.
This method signature offers the developer complete control over the label's position, but uses the JFreeChart's custom classes for positioning. See other method signatures for simplified positioning.
Note that the legacy setLabelsInBarChartColor() method also enables data item labels but uses default positioning and only works with BarCharts.
See the related ChartWidget::setChartDataItemLabelFormat() method to modify the label's formatting.
The rectangle anchor will typically be a value like RectangleAnchor.TOP, RectangleAnchor.CENTER, RectangleAnchor.TOP_LEFT, RectangleAnchor.BOTTOM_RIGHT.
The text anchor will typically be a value like TextAnchor.TOP, TextAnchor.CENTER, TextAnchor.CENTER_LEFT, TextAnchor.CENTER_RIGHT, TextAnchor.TOP_LEFT, TextAnchor.BOTTOM_RIGHT.
Sets whether the font for the domain axis should be scaled down when the axis contains a large number of entries
Sets a format for the XYChart's domain axis (x-axis) numbers, allowing you for format numbers with digits, decimals, spaces, separators, currency symbols, and arbitrary text - note that this applies only to an XYChart
Internally the JFreeCharts use a Java NumberFormatter to define a custom format. This method bridges the gap and allows you to specify a format mask using BBj's masking characters, which will then be converted to a Java NumberFormat automatically. Special mask characters such as #, 0, ., $, and & should be successfully converted.
A few of the commly used special symbols are:
0
Digit#
Digit, zero shows as absent.
Decimal separator,
Grouping separator-
Minus sign%
Multiply by 100 and show as percentage&
Currency sign'
Escape any of the above special characters''
Single quote
Some examples would be:
widget!.setChartDomainAxisFormat("Total: $##0.00") -> Total: $12.34
widget!.setChartDomainAxisFormat("&##0M") -> $123M if the default locale of the JVM yields a dollar sign for the currency symbol
widget!.setChartDomainAxisFormat("&##0M") -> €123M if the default locale of the JVM yields a euro for the currency symbol
Sets a format for the XYChart's domain axis (x-axis) numbers, allowing you for format numbers with digits, decimals, spaces, separators, currency symbols, and arbitrary text - note that this applies only to an XYChart
Sets the lower and upper margins on the domain axis as a percentage of the length of the axis
Sets maximum number of lines used to display a label on the chart's domain (x axis) when applicable
The default number of lines is one. You can use this method to increase the number of lines available for a domain label. When two or more lines are specified, the label may wrap to fill the available space. Setting this value to an integer greater than one may cause the labels to be wrapped in unexpected places. Note that this only applies to charts that have a domain axes, so it will have no effect on a PieChart, for example.
Sets the title for the domain axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Note that for an XYChartWidget, setting the domain title via setDomainAxisLabels() will override this method.
Sets the title for the domain axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Note that for an XYChartWidget, setting the domain title via setDomainAxisLabels() will override this method.
Sets the title for the domain axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Note that for an XYChartWidget, setting the domain title via setDomainAxisLabels() will override this method.
Sets whether the domain axis is visible or not
Sets a threshold marker for the chart's domain. Markers are typically added to plots to highlight or draw attention to specific values.
Note that the addChartDomainMarker() method allows you to add multiple threshold markers specifying the value, color, label, label color, and label position.
Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer. Note that this does not apply to charts without a domain, such as a PieChart or RingChart
Sets a threshold marker for the chart's domain. Markers are typically added to plots to highlight or draw attention to specific values.
Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer. Note that this does not apply to charts without a domain, such as a PieChart or RingChart
Sets a threshold marker for the chart's domain. Markers are typically added to plots to highlight or draw attention to specific values.
Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis, however this is entirely up to the renderer. Note that this does not apply to charts without a domain, such as a PieChart or RingChart
Sets the image that will appear in the widget if the chart contains no data
Some charts, like the pie chart, do not display anything at all when the underlying dataset is empty. To avoid the widget from appearing blank, you may specify an image or text that will be placed on top of the empty widget. Note that all chart customizations, such as background images and gradients, will still be honored and the text will be placed on top of the regularly rendered chart.
See Also: ChartWidget::setChartEmptyDisplayText()
Sets the text that will appear in the widget if the chart contains no data.
Some charts, like the pie chart, do not display anything at all when the underlying dataset is empty. To avoid the widget from appearing empty, you may specify an image or text that will be placed on top of the empty widget. Note that all chart customizations, such as background images and gradients, will still be honored and the text will be placed on top of the regularly rendered chart.
See Also: ChartWidget::setChartEmptyDisplayImage()
Sets the color for the fonts used in the chart for the labels, legend, title, etc.
Sets the color for the fonts used in the chart for the labels, legend, title, etc.
Sets the colors for the fonts used in the chart for the labels, legend, title, etc. by providing hex color strings in the format of "#ff00cc" for each color.
Note that specifying specific font colors will override any colors that may have been set via the setChartFontColor() method.
Note if you specify an empty string for any element, then the default color will be used for that element. This makes it easy to modify individual element font colors in a single method. For example, the following code will set all fonts to black (hex 0) with an opacity of 50% resulting in a light gray color. The next line will then override those colors and set the title to a dark blue, the domain to a dark red, and the range to a dark green color.
Note that all colors are hex color strings. An example would be "#ff00cc" or "#f0c"widget!.setChartFontColor("#000000", .5) widget!.setChartFontColors("#1a4065, , , , #732626, #267326, ", 0.9)
Sets a font for the chart. This allows you to set the font used in the chart for the labels, legend, title, etc.
This method calls the setChartFontFile() method specifying true for the p_throwError parameter
Sets a font for the chart. This allows you to set the font used in the chart for the labels, legend, title, etc.
You may specify any font given a fully qualified path, a font name or path that can be found via the current PREFIX setting, or any font located in the
The following code sets the widget's font by specifying the name of the font file that's located in the dashboard utility's font directory:
The following code sets the widget's font by specifying the fully qualified font name:
widget!.setChartFontFile("SourceSansPro-Regular.ttf")
widget!.setChartFontFile("/Users/bbj/Fonts/TypewriterKeys.ttf")
Sets the size for the various fonts used in the chart for the labels, legend, title, etc.
Note that if you specify a font size of 0 for any element, then the default size will be used for that element. This makes it easy to modify individual element font sizes in a single method. For example, the following code will set the domain font size to 10, the range font size to 12, and will leave all other elements at their default font size.
widget!.setChartFontSizes(0, 0, 0, 0, 10, 12, 0)
Note that specifying specific element font sizes will still be affected by any font scaling that may have been set via the setFontScaling()
method.
Sets the style (plain/bold/italic) for the various fonts used in the chart for the labels, legend, title, etc.
Because the chart's fonts are ultimately used by the Java JFreeChart library, the values for the possible styles are the same constants used for the Java Font object, which are listed below:
If you specify a font style of -1 for any element in the parameter list, then the default style will be used for that element. This makes it easy to modify individual element font styles in a single method. For example, the following code will set the title font style to ITALIC, the label font to BOLD, and will leave all other elements at their default style.
widget!.setChartFontStyles(BBjFont.FONT_ITALIC, -1, -1, BBjFont.FONT_BOLD, -1, -1, -1)
Applies the background color for the legend
Applies the border width and color for the legend
Sets the padding between the legend border and the legend items
Sets the parameters for a chart's legend shape.
Note that due to the underlying JFreeChart implementation, this method works on all chart types EXCEPT for PieCharts and charts that extend a PieChart, such as a RingChart.
The possible values for the shape are
A sample use case would be to set the shape to a Capsule with a 2 pixel red border:
barChartWidget!.setChartLegendShape(ChartWidget.getLEGENDSHAPE_CAPSULE(), 2, ChartWidget.getJavaColor("#ff0000"))
Sets the parameters for a chart's legend shape.
Note that due to the underlying JFreeChart implementation, this method works on all chart types EXCEPT for PieCharts and charts that extend a PieChart, such as a RingChart.
The possible values for the shape are
A sample use case would be to set the shape to a Capsule with a 2 pixel red border:
barChartWidget!.setChartLegendShape(ChartWidget.getLEGENDSHAPE_CAPSULE(), 2, ChartWidget.getJavaColor("#ff0000"))
Sets the radius for a chart's legend shape (typically a circle) in pixels, overriding the default.
Sets a scaling factor for the radius of a chart's legend shape (typically a circle) as a percentage of the orginal value, overriding the default.
Specifying a scaling factor less than 1 decreases the size of the legend shapes. Specifying a scaling factor greater than 1 increases size of the legend shapes. Note that the legend shape must be an integer, although the scaling factor does not need to be an integer. This means that you may provide a floating point scaling factor, but the final shape radius will be rounded to the nearest integer.
Sets a scaling factor that affects the domain axis label width.
The default is 1.5, and higher values will cause the labels to be more likely to overrun each other instead of being truncated. Values from 1 to 3 should produce reasonably good results
Sets the padding between the chart border and the chart drawing area
Sets a diffused shadow for the plot, which adds a shadow to the plot contents (bars, lines, pie slices, etc.).
Note that this does not work properly with 3DPieCharts as of JFreeCharts 1.0.19
Sets a format for the chart's range axis (y-axis) numbers, allowing you to format numbers with digits, decimals, spaces, separators, currency symbols, and arbitrary text.
Note that this method overrides any other axis formatting such as the setChartRangeAxisToCurrency(), setChartRangeAxisToCurrencyWithFractionalDigits(), and setChartRangeAxisToPercent() methods. To clear this format and use another formatting style like setChartRangeAxisToCurrency(), call this method first specifying an empty string for the p_format$ parameter.
Internally the JFreeCharts use a Java NumberFormatter to define a custom format. This method bridges the gap and allows you to specify a format mask using BBj's masking characters, which will then be converted to a Java NumberFormat automatically. Special mask characters such as #, 0, ., $, and & should be successfully converted.
A few of the commonly used special symbols are:
0
Digit#
Digit, zero shows as absent.
Decimal separator,
Grouping separator-
Minus sign%
Multiply by 100 and show as a percentage&
Currency sign'
Escape any of the above special characters''
Single quote
Some examples would be:
widget!.setChartRangeAxisFormat("Total: $##0.00") -> Total: $12.34
widget!.setChartRangeAxisFormat("&##0M") -> $123M if the default locale of the JVM yields a dollar sign for the currency symbol
widget!.setChartRangeAxisFormat("&##0M") -> €123M if the default locale of the JVM yields a euro for the currency symbol
Sets a format for the chart's range axis (y-axis) numbers, allowing you for format numbers with digits, decimals, spaces, separators, currency symbols, and arbitrary text.
Note that this method overrides any other axis formatting such as the setChartRangeAxisToCurrency(), setChartRangeAxisToCurrencyWithFractionalDigits(), and setChartRangeAxisToPercent() methods. To clear this format and use another formatting style like setChartRangeAxisToCurrency(), call this method first specifying null() for the p_format! parameter.
Sets the minimum size allowed for the axis range when it is automatically calculated
Sets the title for the range axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Sets the title for the range axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Sets the title for the range axis
This can be used to dynamically change the axis title, such as in response to a refresh event. Even if the chart was originally created without this axis title, calling this method will add the title to the chart.
Sets the range axis to show its values formatted as currency for the current locale
Use the setChartRangeAxisToCurrencyWithFractionalDigits() method to use a currency format and specify how many fractional digits to display.
Sets the range axis to show its values formatted as currency for the current locale with the provided number of fractional digits.
The number of fractional digits will usually be in the range of 0 to 3.
Sets the range axis to show its values formatted as a percentage, which multiplies the values by 100 and appends the percent sign
Sets whether the range axis is limited to integer values or not
Sets whether the range axis is visible or not
Sets the range Paint for each bar in the chart
Sets the colors for the chart's bars as a gradient going across the range
Sets the colors for the chart's bars as a gradient going across the range
Sets the range Paint for each bar in the chart
Sets a threshold marker for the chart's range. Markers are typically added to plots to highlight or draw attention to specific values.
Note that the addChartRangeMarker() method allows you to add multiple threshold markers specifying the value, color, label, label color, and label position.
Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer. Note that this does not apply to charts without a range, such as a PieChart or RingChart.
Sets a threshold marker for the chart's range. Markers are typically added to plots to highlight or draw attention to specific values.
Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer. Note that this does not apply to charts without a range, such as a PieChart or RingChart
Sets the title of the chart
Sets the main chart title, domain title, and range title for all category charts (bar, line, area, etc.)
This can be called at any time on the widget and facilitates changing the titles on a chart in response to a filter or click event which may cause the SQL and data to change. This method may be called on a PieChartWidget as well, but only the main title will be changed.
setChromaticity Sets the chromaticity
DEPRECATED Sets an entry's class name string (or CSS style) such as "myclass1"
, that determines the HTML class that's associated with the entry.
See the setClassNames()
methods to set multiple class names.
Sets the source's entry class name string (or CSS style).
Sets an entry's class names (or CSS styles) from a BBjVector that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be work
or personal
.
Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the addClassName()
method.
To remove a single class name from the entry, you can call the removeClassName()
method, or get all the class names in a vector, remove the undesired classes, then set the class names.
Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS()
method to affect a calendar entry's display:
rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!)
rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
Sets an entry's class names (or CSS styles) from a comma-delimited string that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be work
or personal
.
This is similar to the setClassNames()
method that takes a BBjVector except that it takes a comma-delimted string of class names for succinctness.
Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the addClassName()
method.
To remove a single class name from the entry, you can call the removeClassName()
method, or get all the class names in a vector, remove the undesired classes, then set the class names.
Here's an example of how you can use custom class names and the BBjCalendarWidget's injectCSS()
method to affect a calendar entry's display:
rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.addClassName("small-text") myCal!.addEntry(myEntry!)
rem Inject custom CSS to change the event's text size myCal!.injectCss(" .small-text div { font-size: 7px; } ")
Sets a callback for a left click event that occurs on the passed dashboard widget
An internal method used by the Dashboard WidgetControl that sets the ClickTarget
field variable that indicates where the user last clicked on the GridWidget.
An internal method used by the Dashboard WidgetControl that sets the ClickTarget
field variable that indicates where the user last clicked on the GridWidget.
Sets the grid control to have a client (lowered) border
Sets the enable status of the close button in the widget control
Sets the close enabled or disabled
setCloseOnSend Sets whether dialog should be closed on a send
Sets an entry's combined background and border color.
Note: For a quick way to set a CalendarEvent
's colors, see the setColors(backgroundColor!, borderColor!, textColor!)
method.
Note: This is a shorthand way of specifying the backgroundColor and borderColor at the same time. The color will be passed
to the FullCalendar, but it internally sets the backgroundColor
and borderColor
to the value of the
specified color and discards the given color. Therefore, you can set colors with this method, but the corresponding getColor()
method may not return anything if you're working with a CalendarEvent
object that was returned from the FullCalendar.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the source's entry combined background and border color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Set color id
Gets the color id of the event.
A convenience method that sets an entry's background, border, and text colors in a single method call.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Set the working column
Set an aggregation function for the passed column field
#Enterprise
#Configuration
#ColumnsRenderer
Sets the alignment of a grid's column
Sets the alignment of a grid's column
Sets the default horizontal alignment for a column
Sets the default alignment for a column
#Configuration
#ColumnsRenderer
setColumnAttributes Sets all of a column's attributes
Sets the background color for the specified grid column.
To more easily set the colors of multiple columns at once, see the setColumnBackColors() method.
Sets the default background color of a column
Sets the background color of a column
#Configuration
#ColumnsRenderer
Sets the background color of a column
#Configuration
#ColumnsRenderer
Sets the background colors for grid's columns given a fixed number of hex color descriptions in a string.
This is a convenience method to set the colors for multiple columns at once, compared to using the setColumnBackColor() method which sets the background color of a single, specified column.
Sets whether a column is editable Note: The QVGird is not editable, so this method has no effect.
setColumnExpression Sets a column's expression
Sets the default font of a column
Sets the foreground color for the specified grid column.
To more easily set the colors of multiple columns at once, see the setColumnForeColors() method.
Sets the default foreground color for a colum
Sets the foreground color for a column
#Configuration
#ColumnsRenderer
Sets the foreground color for a column
#Configuration
#ColumnsRenderer
Sets the foreground colors for grid's columns given a fixed number of hex color descriptions in a string
This is a convenience method to set the colors for multiple columns at once, compared to using the setColumnForeColor() method which sets the foreground color of a single, specified column.
Sets the number of pixels separating the column header and the main grid area
Specifies whether all cells in the specified column should have associated query buttons
Sets the alignment of a grid's column header
Sets the alignment of a grid's column header
Sets the default column header horizontal alignment
Sets the default alignment for a column's header
#Configuration
#ColumnsRenderer
Sets the alignment for all column headers in the grid
Sets the alignment for all column headers in the grid
Sets the default background color of the column header
Sets the horizontal alignment for the column header cell
Sets the background color of a column header cell
Sets the foreground color of a column header cell
Sets the icon in a column header cell
Sets an image in a column header of the grid.
Sets the image displayed in a column header cell
Sets the cell style used for a column header cell
Sets the text to be displayed in a column header cell
Sets the vertical alignment for a column header cell
Sets the grid's column header data using the passed vector, providing a way to override the default column header text in the grid with custom strings
Sets the grid's column header data using the passed vector
Sets the default font of the column header
Sets the default foreground color of the column header
Sets the row height for the grid's header cells
Sets the height of the column header
Sets the style used by default for the column headers
Sets multiple column header cell text The first element will go in column 0, the second in column 1, etc., up to the lesser of the number of header columns or the number of strings in the vector.
Sets the default vertical alignment for the column header
Set an image list for a given column using GxRendererImageRenderer.
#Configuration
#ColumnsRenderer
Note: This method will override the CellRenderer of the column. The column has to contain the values "1", "2", "3" to x to reference the slices in the BBjImage list
setColumnJustification Sets a column's justification
setColumnLabel Sets a column's label
setColumnLength Sets a column's output length
Sets a list control for a column so that each cell in the column will display as a list button when editing
Sets the selected index for the list control in the specified column
Sets the output mask for the all cells in a grid's column, similar to CommonGrid::setColumnMask()
Sets the default mask for all cells in a column
setColumnMask Sets a column's output mask
Set the mask of a column using value formatter expression.
#Configuration
#ColumnsRenderer
Note: This method will override the ValueFormatterExpression of the column.The method depends on the column type to determine the correct value formatter (number, date, ...)
Set the mask of a column in all supported components (filters , formatters , ...)
In case the column has no value formatter expression , then the method will create one
Add columns as comma separated string
Specifies whether a particular column is to be sorted by related data rather than by the text in the cells
Create a GxExpression from string and set it as column span expression
Apply the grid's columns , sorbing and filtering state
#API
Sets the control style of a grid's column, similar to CommonGrid::setColumnStyle()
Sets the default style of a column in the grid
setColumnType Sets a column's type
Causes the grid to sort a specified column when the user clicks in the header of that column
Sets the default vertical alignment for all of the cells in a particular column
Sets a column in the grid to be visible
Sets the visibility of column(s)
Sets the visibility of a column
Sets the width of a grid's column given the 0-based column index
Sets the width of a grid's column
Sets the width of a column
Sets the width of a column
#Configuration
#API
Sets the default column width for all columns
#Configuration
#ColumnsRenderer
Sets the widths of all grid columns by providing a string containing width percentages - note that sizing columns in this manner works best, especially when the widget is popped out and resized.
Sets the widths of all grid columns by providing a vector containing width percentages - note that sizing columns in this manner works best, especially when the widget is popped out and resized.
Sets the widths of all grid columns by providing a string containing width percentages
Sets the widths of all grid columns by providing a vector containing width percentages
Sets the widths of the grid's columns based on an algorithm determined by the provided parameter.
Parameter options:
This method explicity sets the grid's columns based on the provided parameter. It provides ultimate control over how the grid's columns are sized and is an alternative to setting AutoResizeGrid or AutoResizeColumns.
An example use case would be:
gridWidget!.setColumnWidths(gridWidget!.getCOLUMN_WIDTHS_FROM_HEADER_AND_DATA())
This code sizes the GridWidget's columns to be wide enough so that the grid's header text and cell text will not be truncated
and potentially results in a horizontally scrollable grid.
Calculating the column widths may add a nominal amount time to the GridWidget's refresh() routine, depending on how much text is processed to determine the optimum width. Specifying the COLUMN_WIDTHS_FROM_HEADER constant should be the fastest given an average grid, as the GridWidget does not have to measure many strings. However, specifying the COLUMN_WIDTHS_FROM_DATA will take longer as the GridWidget measures several rows of data to determine the optimum width. The COLUMN_WIDTHS_FROM_HEADER_AND_DATA parameter causes the GridWidget to measure both the header text and the text in the first few rows of data. It may not be as accurate as COLUMN_WIDTHS_FROM_DATA, as it does not analyze all data in the interest of performance.
Attendee's comment for the event. Example: "I am bringing cherry cobbler to the party."
Hide/show statusbar component
Hide/show statusbar component
Method setContainter Sets the build container
Method to set multiple string-based user preferences via a HashMap to reduce client-server round trips
The get/setCookies() methods bypasses the effort of creating string templates and BBjTemplatedStrings as well as encoding
information for safety and portability. You only have to provide a unique key value that's used to
store the information (usually the app's name, but it can be virtually any string) and a HashMap filled
with the information to store. The method iterates through the HashMap's keys and builds a string
that consists of the HashMap's key/value pairs joined by the "-, -"
characters in an
attempt to provide a reasonable separator that won't interfere with the stored data.
Both get/setCookies() methods throw errors, so you may want to add an , err=
branch when
calling these methods. The getCookies() method will return a Hashmap filled with key/value pairs if
the cookie exists. If it does not exist, it will return null()
.
The corresponding getCookies()
method is used to retrieve the stored information from the
client's computer (GUI) or browser (BUI). You only need to provide the unique key value when getting
the saved cookies, greatly simplifying the reading/writing of user properties
setCopies Sets the number of copies
Method to add a watermark logo to the BBXImage
Sets the number of times a recurring event should recur. This field is mutually exclusive of untildate and untildatetime. If you set this field, it will set the other two to null().
setCreateContactsOnSend Sets whether contacts should be created for new email addresses on a send
Sets the creation time of the event.
Sets the creator of the event.
setCSVExporter Sets the CSV exporter which contains export options
Sets the calendar's date that is the end of the interval the view is trying to represent. For example, in month view, this will be the day after the last day of the month. This value disregards hidden days.
Note: This value is exclusive, as are all ending dates.
Sets the calendar's start date of the interval the view is trying to represent. For example, in month view, this will be the first of the month. This value disregards hidden days.
Sets the cursor style on the grid control
Sets the color for the 3D axis (the left and bottom walls in the plot background) on a Bar Chart
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, this method is ignored in 23 and higher.
Sets the color for the 3D axis (the left and bottom walls in the plot background) on a Line Chart
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, this method is ignored in 23 and higher.
Feed the grid with data
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Feed the grid with data
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Adds a new dataset entry to the chart's underlying dataset. This method is typically used to fill a chart with data values one at a time programmatically, instead of filling it with the resultset of an SQL query which is done via the fill() method.
Adds a new dataset entry to the chart's underlying dataset. This method is typically used to fill a chart with data values one at a time programmatically, instead of filling it with the resultset of an SQL query which is done via the fill() method.
Adds a new dataset entry to the chart's underlying dataset. This method is typically used to fill a chart with data values one at a time programmatically, instead of filling it with the resultset of an SQL query which is done via the fill() method.
Add an XY data point to the specified series in the XYSeriesCollection for the chart. This method is the same as setSeriesXYValue(), and exists to be consistent with other chart types.
If the chart has multiple series, they will be rendered in reverse order. So the last series added will be the first series rendered. This matters if you're mixing filled and non-filled series data.
Sets the general debug flag and brings up the BBjSysConsole, if not running in BUI
Enable remote debugging on the given port
Enable remote debugging on the 9222 port
Sets the default horizontal alignment for all of the cells in the grid
Sets the default text that is displayed in a column
Sets the default width of all columns
Sets the default style of all the cells in the grid
Set the initial value of the hour element.
Set the initial value of the minute element.
setDefaults Sets the default X, Y, width, height for the window
setDefaultSave Sets the default save location
setDefaultSaveContributor Sets the default save contributor
setDefaultSaveContributor Sets the default save contributor
setDefaultSaveFile Sets the default save file
setDefaultSaveFile Sets the default save file
setDefaultSaveFolder Sets the default save folder
setDefaultSaveFolder Sets the default save folder
Sets the fallback duration for timed entries that do not have a specified end time, where the default value is "01:00" or one hour.
This only applies to entries that are not designated as all-day entries.
Sets the default vertical alignment for all of the cells in the grid
Set calendar's "deleted" attribute
Enable/disable DeltaColumn Mode
Method to set the description of the BBXImage
Set calendar's description
Sets the event's description.
Sets an entry's extended information that can be used to further describe the entry beyond the title text. Note that the description property is not one of the standard FullCalendar fields. The BBjCalendarWidget will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods in order to work with this property.
Sets the source's extended information that can be used to further describe the source.
A BBjNumber identifying the screen's pixel ratio. Any real number between 0.5 and 4.0 is allowed.
This numeric field variable may be set as desired to any real number, although a minimum of 0.5 and maximum of 4 will be enforced
by the utility to avoid rendering enormous images that consume a huge amount of memory. If it is not modified, it will be set
according to the pixel ratio of the current screen. Here is an example showing how to set the DevicePixelRatio via a widget:
widget!.setDevicePixelRatio(2)
Note that you may also set the "BASIS_UTILITY_DEVICE_PIXEL_RATIO" global string entry
either via code or in a configuration file in order to control the pixel ratio used when generating images, such as
charts or reports. Here are two examples:
1) Setting the global string entry in code, before creating any widgets or reports:
temp$ = STBL("BASIS_UTILITY_DEVICE_PIXEL_RATIO", "2")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_UTILITY_DEVICE_PIXEL_RATIO=2
Sets the screen's device pixel ratio used for modifying ChartWidgets
Sets an entry's alternate rendering style. This overrides the calendar's master EntryDisplay option for this specific entry.
The display style may be one of the following constants:
CalendarAPI.CALENDAR_ENTRY_DISPLAY_AUTO()
- (default) When in daygrid, renders the event as a solid rectangle if it is all-day or multi-day. If a timed event, will render it with a dot. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_BLOCK()
- When in daygrid, renders the event as a solid rectangle. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_LIST_ITEM()
- When in daygrid, renders the event with a dot. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_BACKGROUND()
- Highlights the background of the entry's container.CalendarAPI.CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND()
- Hightlights the spans of time not occupied by an entry, or the opposite of the background.CalendarAPI.CALENDAR_ENTRY_DISPLAY_NONE()
- Won't render the event at all.Sets a source's alternate rendering style. This overrides the calendar's master EntryDisplay option for this specific entry.
The display style may be one of the following constants:
CalendarAPI.CALENDAR_ENTRY_DISPLAY_AUTO()
- (default) When in daygrid, renders the event as a solid rectangle if it is all-day or multi-day. If a timed event, will render it with a dot. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_BLOCK()
- When in daygrid, renders the event as a solid rectangle. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_LIST_ITEM()
- When in daygrid, renders the event with a dot. When in other views, will render normally.CalendarAPI.CALENDAR_ENTRY_DISPLAY_BACKGROUND()
- Highlights the background of the entry's container.CalendarAPI.CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND()
- Hightlights the spans of time not occupied by an entry, or the opposite of the background.CalendarAPI.CALENDAR_ENTRY_DISPLAY_NONE()
- Disables the rendering of the event.The attendee's name, if available.
setDOCXExporter Sets the DOCX exporter which contains export options
Sets the color and opacity for the grid band that's shown when the chart is configured with a custom domain axis label via the setDomainAxisLabels() method.
Configure a custom domain title and label set
Important: Note that the new Axis label set dramatically impacts the display of the data. If the dataset contains 10 items, but the new axis only contains 3 items, then the chart will only show 3 items. If the dataset contains 10 items, but the new axis contains 20 items, then the right half of the chart will be empty without any data plotted on it since there is no data that corresponds to the axis item. Also, the new axis items are zero-based, meaning that your dataset should be adjusted to be zero-based as well. Therefore, if the dataset used values like 2010, 2011, but the new axis used values like "Year 2010, Year 2011", then the plot would be empty. This is because the plot will now start with the X value of 0 and continue on for as many axis labels you provided. However, the dataset used values starting with 2010, so they will be rendered out of bounds, and would only show up if you provided more that two thousand axis label items.
Sets the angle of the labels on the domain axis
An example would be:
widget!.setDomainLabelAngle(widget!.getLABEL_POSITION_DOWN_45())
This code causes the domain labels to display in a downward 45 degree angle
Sets the angle of the labels on the domain axis
Sets whether the grid will accept drag and drop operations
Sets the available drag actions for the grid control
Sets whether the grid control should allow drag operations
Sets the dragging enable status of the widget control
Sets an optional type string that an individual grid cell advertises to potential drop targets when the grid acts as a drag source
Sets an optional type string that an individual grid column advertises to potential drop targets when the grid acts as a drag source
Sets an optional type string that the grid control advertises to potential drop targets when it acts as a drag source
Sets the actions that will be allowed when the grid control acts as a drop target
Method to add a drop shadow to the BBXImage
Stipulates the types that an individual grid column is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type.
Stipulates the types that an individual grid cell is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type.
Sets the types that the grid control is willing to accept from a drag source when it acts as a drop target. If no drop types are set, it will accept data of any type.
Sets whether the cells in the grid are editable Note: The QVGrid is not editable, so this method has no effect.
Enable / disable column editing
#Configuration
#ColumnsRenderer
Create a GxExpression from string and set it as editable expression
Sets the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.
The attendee's email address, if available. This field must be present when adding an attendee.
setEmailCallback Sets a callback routine to call when email is requested
setEmailCallback Sets a callback routine to call when email is requested
setEmailCallback Sets a callback routine to call when email is requested
setEmailCallback Sets a callback routine to call when email is requested
Sets the email enabled or disabled
setEmailFrom Sets the email from address
Sets the enable status of the email menu item in the options menu
setEmailMessage Sets the email message
setEmailServerHost Sets the email server host
setEmailServerPassword Sets password that will be used to authenticate to the email server
setEmailServerPort Sets the email server port
setEmailServerSSL Sets the email server ssl protocol on or off
setEmailServerUserName Sets user name that will be used to authenticate to the email server
setEmailSubject Sets the email subject
Turn on simple (embedded) labels. Calling this method will cause the pie plot to be rendered with the labels inside each pie slice instead of outside of the plot.
Enable / disable time 24 format.
Sets whether the grid control is to be enabled or disabled
Sets whether the widget should be enabled.
Sets whether the day headers should appear for the Month, TimeGrid, and DayGrid views (1) or not(0), where the default value is 1.
Applicable views: CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(), CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK(),
CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
.
Sets whether the BBjCalendarWidget
should run in debug mode (1) or not (0), where the default is 0.
When this is set to true (1), the BBjCalendarWidget
will:
!CHROMIUM_SWITCHES
global string entry is properly set before instantiating the BBjCalendarWidget
, as in: chromium_switches$ = stbl("!CHROMIUM_SWITCHES", "--remote-debugging-port=9223")
Sets an entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing). This overrides the calendar's master EnableDurationEditable option for this specific entry.
Note: See the setEnableEditable()
method if you wish to set the
setEnableStartEditable()
and setEnableDurationEditable()
parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
Sets the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
Sets whether the user can modify entries on the calendar (1) or not (0), where the default value is 0.
Setting this variable to 1 causes the entries to be both draggable and resizable. If you don't want both behaviors,
use the setEnableEntryStartEditable()
or setEnableEntryDurationEditable()
methods instead.
Note: See the top of the CalendarOptions()
class docs for an overview of the options that affect entry editabililty.
Sets an entry's editable status that determines if the user can modify the entry, i.e. change the entry's starting date/time and duration.
This overrides the calendar's master EnableEditable option for this specific entry.
Note: This determines if the events can be dragged and resized and enables or disables both settings simultaneously. IOW, it's a shorhand way of setting both
the EnableStartEditable and EnableDurationEditable properties at the same time. If you don’t want to set both, use the more specific
setEnableStartEditable()
or setEnableDurationEditable()
methods instead.
rem Example 1: The user can move and resize the entry, i.e. change the starting time/date and the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableEditable(1)
rem Example 2: The user can move and resize the entry, i.e. change the starting time/date and the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableStartEditable(1) myEntry!.setEnableDurationEditable(1)
rem Example 3: The user can change the entry's starting time/date but not the duration myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableStartEditable(1)
rem Example 4: The user can change the entry's duration but not the starting time/date myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00") myEntry!.setEnableDurationEditable(1)
Sets the source's entry editable status that determines if the entry can be modified by the user. This overrides the calendar's master EnableEditable option for this specific entry.
Sets whether the user can modify entry durations on the calendar (1) or not (0), where the default value is 1.
Note: See the top of the CalendarOptions()
class docs for an overview of the options that affect entry editabililty.
Sets whether entries being dragged and resized are allowed to overlap one other (1) or not (0), where the default value is 1.
Note: This may be overridden on a per-entry basis.
Sets an entry's overlap status that determines if the entries may be dragged/resized over one another.
Sets whether the user can resize an entry from its starting edge (1) or not (0), where the default value is 0.
Note: See the top of the CalendarOptions()
class docs for an overview of the options that affect entry editabililty.
Sets whether the user can modify event start times through dragging (1) or not (0), where the default value is 1.
Note: See the top of the CalendarOptions()
class docs for an overview of the options that affect entry editabililty.
Sets whether a calendar view's rows will expand to fit the available height (1) or not (0), where the default value is 0.
Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
Sets whether the calendar will always show 6 weeks in month view (1) or not (0), where the default value is 1.
Setting this variable to 0 changes the calendar to show 4, 5, or 6 weeks in the month view, depending on how many days the month has. With the default value of 1, the calendar may show an empty sixth week at the bottom of the month view, depending on the number of days in the month.
Applicable views: CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
Sets whether day and week names are clickable (1) or not (0), causing the associated view to be loaded on click, where the default value is 0.
Sets whether the calendar will display a marker indicating the current time (1) or not (0), where the default value is 0.
Setting this to 1 causes the calendar to display a marker showing the current time in applicable time grid views.
Applicable views: CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
Sets whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0), where the default value is 1.
Sets whether the user can highlight multiple days or timeslots by clicking and dragging (1) or not (0), where the default value is 0.
This is used with the CalendarAPI.ON_CALENDAR_SELECT
and CalendarAPI.ON_CALENDAR_UNSELECT
callbacks
to monitor selection events. You must set the calendar's options to enable selectability in order for the events to be fired.
The CalendarOptions::setEnableUnselectAuto()
impacts what causes the CalendarAPI.ON_CALENDAR_SELECT
event to be fired.
How the calendar reacts to the user selecting a date or range of dates all depends on what your callback code does in response to the events. It could prompt the user to enter a new event title, or display a contextual popup-menu that allows the user to move/copy/edit/delete any events within the selected range.
Sets whether the previous or next month's dates should display in the calendar's month view (1) or not (0), where the default value is 1.
Applicable views: CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
Sets whether entries should visually overlap one another (1) or not (0) where the default value is 1.
Setting this value to 0 prevents the entries from overlapping one another. This applies to entries in the
CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY()
and CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
view types.
Sets an entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing). This overrides the calendar's master EnableStartEditable option for this specific entry.
Note: See the setEnableEditable()
method if you wish to set the
setEnableStartEditable()
and setEnableDurationEditable()
parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
Sets the source's entry start time editable status that determines if the source's entry start time can be modified by the user by dragging (resizing).
Sets whether clicking elsewhere on calendar/window causes the current selection to be cleared (1) or not (0), where the default value is 1.
This is only applicable if EnableSelectable() is set to 1.
Sets whether to include Saturday/Sunday columns in any of the calendar views (1) or not (0), where the default value is 1.
Sets whether week numbers should be displayed on the calendar (1) or not (0), where the default value is 0.
Set the end time for the event using an EventDateTime object
Set event end time using 6 numbers to designate year, month, day, hour, minute, and second respectively. This method is used to set the end time for a timed event.
Set event end time using 6 numbers to designate year, month, day, hour, minute, and second respectively. This method is used to set the end time for a timed event.
Set event end time using 3 numbers to designate year, month, and day respectively. This method is used to specify the end time for an all-day event.
Set event end time using 3 numbers to designate year, month, and day respectively. This method is used to specify the end time for an all-day event.
Set event end time using a java.util.Date This method is used to specify the end time for a timed event.
Set event end time using a java.util.Date This method is used to specify the end time for a timed event.
Sets an entry's exclusive ending date/time. If the entry is explicitly all-day, then the time portion will be ignored.
setEndPageIndex Sets the ending page index for export operations
Sets whether the end time for the event is unspecified.
Sets whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]
Sets the background color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryBackgroundColor()
method that takes a BBjString except that it takes a BBjColor object for convenience.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the background color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryBackgroundColor()
method that takes a BBjColor except that it takes any valid CSS color string for succinctness.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the border color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryBorderColor()
method that takes a BBjString except that it takes a BBjColor object for convenience.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the border color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryBorderColor()
method that takes a BBjColor except that it takes any valid CSS color string for succinctness.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the combined background and border color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryColor()
method that takes a BBjString except that it takes a BBjColor object for convenience.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the background and border color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryColor()
method that takes a BBjColor except that it takes any valid CSS color string for succinctness.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets how entries are rendered on the calendar, where the default value is "auto".
Valid options are for the entry display are:
Sets the text color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryTextColor()
method that takes a BBjString except that it takes a BBjColor object for convenience.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Sets the text color for all calendar entries, unless overridden by the CalendarEntry
object itself.
This is similar to the setEntryTextColor()
method that takes a BBjColor except that it takes any valid CSS color string for succinctness.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Note: This can be overridden for specific calendar entries via the CalendarEntry
's methods.
Set calendar's "deleted" attribute
ETag for the event. ETags are used in caching to determine whether a resource has changed.
Offset all pie slices by exploding them out from the center of the pie. Due to a limitation in JFreeCharts (as of version 1.0.19), this does not work with a 3D pie chart
Offset a pie slice by exploding it out from the center of the pie. Due to a limitation in JFreeCharts (as of version 1.0.19), this does not work with a 3D pie chart
Sets the export data enabled or disabled
Sets the enable status of the export data menu item in the options menu
ExtendedProperties for the event.
Sets an entry's extended properties, i.e. custom properties.
Throw an error when called because the field becomes immutable after the column's definition creation
setFileSaveAsCallback Sets a callback routine to call after a file save-as occurs
setFileSaveAsCallback Sets a callback routine to call when a file save-as occurs
setFileSaveAsCallback Sets a callback routine to call after a file save-as occurs
setFileSaveAsCallback Sets a callback routine to call when a file save-as occurs
setFileSaveCallback Sets a callback routine to call when a file save occurs
setFileSaveCallback Sets a callback routine to call when a file save occurs
setFileSaveCallback Sets a callback routine to call after a file save occurs
setFileSaveCallback Sets a callback routine to call when a file save occurs
setFileSaveCallback Sets a callback routine to call after a file save occurs
setFileSaveCallback Sets a callback routine to call when a file save occurs
Sets the image that will appear in the widget if it experiences an error upon creation or filling its dataset
As of BBj 18.20, it's possible for a dashboard to continue after a widget experiences a fill error. Given the nature of the fill error, the widget may be entirely empty or may contain only partial data. To signify that the widget has incomplete data, you may specify an image or text that will be placed on top of the widget. If a custom error image or text is not set then the widget will display a default error indicator.
See Also: BaseWidget::setFillErrorDisplayText()
Sets the text that will appear in the widget if it experiences an error filling its underlying dataset
As of BBj 18.20, it's possible for a dashboard to continue after a widget experiences a fill error. Given the nature of the fill error, it may be entirely empty or may contain only partial data. To signify that the widget has incomplete data, you may specify an image or text that will be placed on top of the widget. Note that all chart customizations, such as background images and gradients, will still be honored and the text will be placed on top of the regularly rendered chart.
See Also: BaseWidget::setFillErrorDisplayImage()
Method to filter the BBXImage and increase the blurriness
Method to adjust the brightness of the BBXImage
Method to adjust the contrast of the BBXImage
Method to filter the BBXImage and convert it to grayscale (completely desaturated)
Set and apply filter model for the given column
Method to filter the BBXImage and increase the sharpness
Change on the fly the available options
#API
setFindCaseSensitivity Sets case sensitivity of the find
setFindHighlight Sets highlight option for the find
setFindIncremental Sets incremental find option for the find
setFindMatch Sets match option for the find
setFindScope Sets scope option for the find
setFindText Sets the find text
setFindWindowVisible Set the find window visibility
Set the first condition
Sets the day on which each week begins where the value is a 0-based number starting with Sunday, where the default value is 0.
The value is zero-based and ranges from 0 (Sunday) to 6 (Saturday).
setFitPage Sets the report image to the fit the page
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
setFitPage Sets the report image to the fit the page
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
Specifies whether to fit all columns into the displayed width of the grid
Make the currently visible columns fit the screen.
The columns will scale (growing or shrinking) to fit the available width. If you don't want a particular column to be included in the auto resize, then set the column setting SuppressSizeToFit=true. This is helpful if, for example, you want the first column to remain fixed with, but all other columns to fill the width of the table.
#API
Gets the grid to size the columns to the specified with
#API
setFitType 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().
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()
setFitType Sets the report image to fit based on the provided fit type
The fit type can be set using static field variables like BBJasperView.getFIT_TYPE_ACTUAL(), BBJasperView.getFIT_TYPE_PAGE(), or BBJasperView.getFIT_TYPE_WIDTH().
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
setFitWidth Sets the report image to the fit the width of the container
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
setFitWidth Sets the report image to the fit the width of the container
All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()
Sets whether the grid control can be focused
Sets the font for the grid control
Sets a font scaling factor for the chart via a dashboard program. This allows you to increase or decrease the size of all fonts used in the chart for the labels, legend, title, etc.
Specifying a scaling factor less than 1 decreases the fonts. Specifying a scaling factor greater than 1 increases the fonts.
Sets the footer toolbar that's displayed on the calendar given a previously-defined
CalendarToolbar
object. To disable (remove or hide) the toolbar from the calendar, call this
method providing null()
for the CalendarToolbar
object.
Note that the calendar's option do NOT define a footer toolbar by default.
Create a GxExpression from string and set it a footer value getter
Sets the foreground (text) color for the grid control
Sets the foreground color for a column
Sets the foreground color for a column
Create a GxExpression from string and set it as FormatterExpression
Describes the regularity with which the event occurs. Possible values include every second, every minute, every hour, every day, every week, every month, and every year. Sorry, no values are available for every decade, century, and millenium.
setFrom Sets the "from" field in an email's header before the email is sent. The "from" field indicates the sending email address.
Depending on the mail service provider, it may not be necessary to set this field. The value can be determined from the email account from which the mail was sent.
If true, then row group, pivot and value aggregation will be read only from the Ui. The grid will display what values are used for each, but will not allow the use to change the selection
#Enterprise
#Configuration
#API
Sets the Gadget for the event.
Called when the visibiliy of the glass pane
Sets the API key that is used to access public Goolge Calendars programmatically, where the default value can only be used for testing and should be changed before use in a production environment.
Note: THIS KEY WON'T WORK IN PRODUCTION! Before accessing a public Google calendar, you must create your own developer API key and set this option to your key's value.
setGoogleDefaultDocument Sets the default Google document
setGoogleDefaultDocument Sets the default Google document
setGoogleDefaultFolder Sets the default Google folder
setGoogleDefaultFolder Sets the default Google folder
setGoogleDefaultType Sets the default Google document type
setGoogleDefaultType Sets the default Google document type
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
setGoogleDocSaveCallback Sets a callback routine to call after a Google Doc save occurs
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
setGoogleDocSaveCallback Sets a callback routine to call after a Google Doc save occurs
setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs
Sets the gradient shanding amount for the entire chart. The default is 0.5, so values greater than this will have a more pronounced gradient on the chart (the bars, for instance). Setting it to zero removes the gradient effect entirely.
This method is deprecated. Use setEditable() instead. Note: The QVGrid is not editable, so this has no effect.
Set the default label used when a new group is created
#Configuration
#ColumnsRenderer
see BBjControl
Sets an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
Throw an error when called because the group id becomes immutable after the column group's definition creation
Sets whether participants can invite other participants to the event.
@guestsCanInviteOthers! 0 or 1: 0 means participants can not invite other participants . 1 means participants can invite other participants.
Sets whether participants can modify the event.
Sets whether participants can see what other participants are invited to the meeting.
Sets the hangout link associated with the meeting.
Sets whether the grid has a column header
Sets whether the grid has a row header
Sets whether the widget should use a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar
setHeader Sets various attributes of the email header
The basic attributes of an email header are laid out in RFC 822, which can be found at http://www.faqs.org/rfcs/rfc822.html.
Sets the default alignment for a column's header
Set the tooltip for the column group header
Sets whether a header cell will display as recessed if the row/column is selected
Sets the header toolbar that's displayed on the calendar given a previously-defined
CalendarToolbar
object. To disable (remove or hide) the toolbar from the calendar, call this
method providing null()
for the CalendarToolbar
object.
Note that the calendar's option define a header toolbar by default.
Sets the height of the calendar, where the default value is "100%".
Note that you may set the calendar's height in multiple ways. The Height option defaults to "100%",
meaning that it will match the height of its container, which is the BBjCalendarWidget
's height.
Valid options for the height values are:
BBjCalendarWidget
's height.Note: The Height option, if set, will override the AspectRatio. Therefore, if you intend to set the calendar's height via the AspectRatio then you will need to unset the Height option by setting it to null() or an empty string.
Sets which days of the week should be hidden in the calendar, and defaults to an empty vector [] which means that none of the days will be hidden.
The vector is filled with the day-of-week indices to hide, where each index is zero-based and ranges
from 0 (Sunday) to 6 (Saturday). For example, by adding the numbers 1, 3, and 5 to the vector then Mondays,
Wednesdays, and Fridays will be hidden. Note that you can also hide weekends via the EnableWeekends()
method.
Sets which days of the week should be hidden in the calendar
This is similar to the setHiddenDays()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Sets one or more optional, custom tags that determine which calendar
entries should be hidden. The CalendarEntry
custom class offers
setTags() methods that give you the opportunity to add custom tags to any entry. After
adding tags to one or more entries, you can call methods on the calendar to show or
hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags()
and
BBjCalendarWidget::setHiddenTags()
methods.
This is similar to the setHiddenTags()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Sets one or more optional, custom tags that determine which calendar
entries should be hidden. The CalendarEntry
custom class offers
setTags() methods that give you the opportunity to add custom tags to any entry. After
adding tags to one or more entries, you can call methods on the calendar to show or
hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags()
and
BBjCalendarWidget::setHiddenTags()
methods.
Sets the selection highlight method
setHighResolutionReportImages Causes the BBJasperViewerControl to display high resolution images to take advantage of high density pixel (retina) displays when available
Note that the report images will be sharper but will take longer to generate.
Sets the amount of horizontal space between the columns
Sets whether the horizontal lines between the rows are to be visible
Sets whether the grid will display a horizontal scrollbar. Turning on a horizontal scrollbar also has the effect of turning off the AutoResizeColumns options as the two configurations are mutually exclusive.
Sets whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid
Sets whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed
setHtml Sets the html for the email
setHTMLExporter Sets the HTML exporter which contains export options
Gets the HTML Link for the meeting
Sets the iCalendar User ID for the meeting.
Construct an html image to use as an icon
Construct an html image to use as an icon
Set the grid icons
Set the grid icons
#Configuration
#GridRenderer
Sets the Google Event ID. This is what you would use to access a particular event from the list of events associated with a Google Calendar.
The attendee's Profile ID, if available.
Sets an entry's optional unique ID that can be used later to identify the entry. If the entry's ID is not provided, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
Sets whether the pie chart should ignore entries in the dataset that have a zero value.
When set to 1, entries with a value of zero will not be displayed in the plot or legend. When set to 0, they will. The default is set to 1, which ignores entries with a zero value.
Sets the image for the widget. This method is typically used when you want to set the widget's image in response to a refresh or filter event.
Sets the image for the widget. This method is typically used when you want to set the widget's image in response to a refresh or filter event.
Method to set the ImageIcon for the BBXImage
Enable/disable DeltaColumn Mode
Sets the initial date that the calendar displays, where the default value is the current date.
The value can be anything that can parse into a date, including a simple ISO8601 date string like "2014-02-01" or an advanced string like "2018-06-01T12:30:00-05:00" that specifies a date, time, and has a -05:00 UTC offset.
Sets the initial view type when the calendar loads, where the default value is CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
.
The initial view can be set to any of the CalendarAPI.CALENDAR_VIEW_*
types.
Determines whether InputN style cells will beep when the user enters an invalid character public void QVGrid.setInputNBeep(BBjNumber) throws BBjException
Sets the 'thousands' replacement character for all InputN style grid cells
Sets the decimal character for all InputN style grid cells
Determines whether InputN style cells in the grid will display a character at each 'thousands' position
Controls whether the editor is in insert mode Note: The QVGrid is not editable, so this method has no effect.
Method setInterspace: Note: This method has been deprecated since BBj 5.0. Use setHorizontalCellSpacing().
setJasperReport Sets the working JasperReport object
setJobName Sets the job name
setJobPriority Sets the job priority
Sets the Google resource kind. This method is a no-op.
param kind! Kind of resource to set the event to. Should always be "calendar#event"
Sets the label's background color for the pie chart
Define a custom label format for the pie chart
Define a custom label format for the pie chart by providing a label string and NumberFormatters for the number and percentage fields.
A sample use case would be:
which would cause the label to display the key followed by the value formatted as currency. That way it would show up in a format similar to:widget!.setLegendLabelFormat("{0}: {1}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.Current: $218.10
Turns on embedded labels with default positioning in the bar chart (so the bar's range value is displayed) and sets the label's text color
Note that this method uses default positioning for the labels and only works with BarCharts. The ChartWidget::setChartDataItemLabels() methods work with all category-based charts (BarCharts, LineCharts, AreaCharts) and XYCharts and some of those method signatures allow you to specify the label position relative to the data item.
Turns off the pie chart's labels (the labels for the pie's slices, not the legend)
setLastExportDir Sets the last export directory used. In BUI, this is a NOOP.
setLastFieldDelimiter Sets the last field delimiter used.
setLastRecordDelimiter Sets the last record delimiter used.
setLastSaveAsDefault Sets the last save as default used.
setLastSaveDir Sets the last save directory used. In BUI, this is a NOOP.
setLastTextQualifier Sets the last text qualifier used.
Sets the bar chart to layer all bars in each series over one another. Turning this on will force the chart to be flat, as the layered style overrides settings like 3D and PaintGlossOnFlatChart.
Sets a callback for a left click event that occurs on the passed dashboard widget
Sets a column in the grid to be the left-most visible column
Sets a background color for the legend
Sets a background paint for the legend
Define a custom label format for chart's legend items
Define a custom label format for the chart's legend items by providing a label string and NumberFormatters for the number and percentage fields.
A sample use case would be:
which would cause the label to display the key followed by the value formatted as currency. That way it would show up in a format similar to:widget!.setLegendLabelFormat("{0}: {1}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.Current: $218.10
Sets the position of the legend in the chart
Use code like widget!.getSideLeft(), widget!.getHAlignLeft(), widget!.getVAlignTop(), etc.
Sets the line color of the vertical and horizontal lines
Sets the radius for the line's data point shape (typically a circle) in pixels when it is set to Flat instead of 3D mode.
The default radius is 3 pixels
Sets the width for the line or lines in the chart. Previous to version 16.21, this method was only valid for Flat LineCharts. As of 16.21, it is also valid for 3D LineCharts.
setLocale Sets the report locale parameter given a Java Locale object
setLocale Sets the report locale parameter given a string
Sets the locale for the calendar. Setting the calendar's affects the toolbar button text, month and day-of-week-strings, date formatting, week number calcuation, and the first day of the week. The locale is set to null() by default.
Sets the location of the widget control
Sets the location of the EmbeddedWidgetWindow
Sets the location of the EmbeddedWidgetSetWindow
setLocation Sets the screen location of the dialog
setLocation Sets the X, Y location of the dialog
Sets a string representing the event location
Sets the location of the QVGrid component child window
setLocation Sets the location of the viewer control
setLocation Sets the location of the tabbed view
setLocation Sets the location of the viewer control
Sets the location of the calendar widget given the provided X and Y coordinates.
Sets an entry's location that can be used to define a location for the entry. Note that the location property is not one of the standard FullCalendar fields. The BBjCalendarWidget will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods in order to work with this property.
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
Sets the text that appears in the status bar when the mouse pointer hovers over the grid control
Sets the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
Sets the default background color of the grid
Sets the default font used in the grid
Sets the default foreground color of the grid
Sets the background stripe color of the grid
Sets the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
Sets the enable status of the manual refresh menu item in the options menu
Set the mask of a column in all supported components (filters , formatters , ...)
In case the column has no value formatter expression , then the method will create one
Sets the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated as it is not necessary to set a maximum number of columns. Any calls to it will be ignored.
setMaxPages Sets the max number of report pages
Sets the maximum number of rows allowed in the data set
setMediaSizeName Sets the media size name
setMediaTray Sets the media tray
Sets the filter at the top of the filter (the 'quick search' in the popup)
#API
Sets the filter at the top of the filter (the 'quick search' in the popup)
#API
Sets whether to capture mouse movement events
setMouseClickCallback Sets a callback routine to call when the mouse is clicked
setMouseClickCallback Sets a callback routine to call when the mouse is clicked
Sets whether multiple cells/rows/columns can be selected
Sets the name of the dashboard item
Sets the name of the grid control
Sets the widget's name, which can later be retrieved via the getName()
method.
This value is propagated to the CSS class attribute of the HTML element representing the control in BUI.
Sets the grid control to have no border
Sets the number of columns in the grid
Sets the number of rows in the grid Note: The QVGrid sets the number of grid rows to be at most those that are visible, so this method has no influence.
setOAuthAccessToken Set the OAuth access token for authentication when sending an email
Sets the objects to be included in this toolbar section via a comma-separated list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*
.
Note: If you choose to set the toolbar section objects via a BBjVector see the other setObjects() method.
Sets the objects to be included in this toolbar section via a list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*
contained in a BBjVector.
Note: If you choose to set the toolbar section objects via a BBjString see the other setObjects() method.
setODSExporter Sets the ODS exporter which contains export options
setODTExporter Sets the ODT exporter which contains export options
Method to set the transparency of the BBXImage
Sets the opaque property of the grid control
Whether this is an optional attendee. Optional. The default is False (0).
Sets the calendar's options given an instance of the CalendarOptions
class.
Note: After setting the calendar's options inline (see example #1 below), you will need to call the calendar's render()
method to apply the changes to the calendar in order for them to take effect.
There are a couple of ways to set options for the calendar:
rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render()
rem Get the calendar's options object, then call the desired set methods, then apply the updated options to the calendar: opts! = myCal!.getOptions() opts!.setEnableEntryDurationEditable(1) opts!.setEnableEntryResizableFromStart(1) opts!.setEnableEntryStartEditable(1) opts!.setEnableSlotEntryOverlap(0) myCal!.setOptions(opts!)
Sets the enable status of the options button in the widget control
Sets the options enabled or disabled
The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
Whether this attendee is also the organizer. Default is 0.
setOrientation Sets the orientation
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
Sets the padding, or spacing around the calendar control, to the same number of pixels for all four sides.
Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels.
Sets the padding, or spacing around the calendar control, to the specified number of pixels for the top, right, bottom, and left sides.
Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels.
setPage Sets the current page
setPage Sets the current page
setPageIndex Sets the page index for export operations
setPageRange Sets the page range
Sets whether the BBjGrid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no effect
Sets number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no effect
setParameter Set a report parameter value
setPDFExporter Sets the PDF exporter which contains export options
Set a result set of pinned rows on bottom
Set a result set of pinned rows on bottom
Set a result set of pinned rows on top
Set a result set of pinned rows on top
Disable pivot for all columns and enable it for the passed columns
#Enterprise
#Configuration
#API
Enable / disable pivot mode
#Configuration
#API
Sets a background color for the plot, not the entire chart
Sets a background color for the plot, not the entire chart
Sets a background paint for the plot, not the entire chart
Sets a background image for the plot, not the whole chart
Sets a background image for the plot, not the whole chart
Sets the amount of padding, or space, between the pie plot and the edges of the chart itself.
This controls the space between the edges of the pie plot and the plot area itself (the region where the section labels appear). Increasing the padding will ensure that labels will not be accidentally truncated.
Sets the enable status of the popout button in the widget control
Sets the popout enabled or disabled
Sets the desired size of the widget when it's popped out
Binds a pre-existing popup menu to the grid control
Sets the position of the calendar's toolbar to the top or bottom of the calendar, which defaults to the top position.
setPPTXExporter Sets the PPTX exporter which contains export options
Sets the preview image for the widget control that will be displayed in the customize dialog
setPrintCallback Sets a callback routine to call after report is printed
setPrintCallback Sets a callback routine to call when report is printed
setPrintCallback Sets a callback routine to call after report is printed
setPrintCallback Sets a callback routine to call when report is printed
setPrinterName Sets the printer name
setPrintQuality Sets the print quality
setPrintServiceExporter Sets the PrintService exporter which contains export options
Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False (0).
Registers a legacy custom event callback routine for a specified 'processing' event
Registers an object oriented custom event callback routine for a specified 'processing' event
Perform throw columns search
#API
Perform throw columns search
#API
Sets the grid control to have a raised border
Sets the minimum and maximum values for the range of the chart's plot
Note that this does not apply to charts without a range, such as a PieChart or RingChart
Makes an event a recurring event.
For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
Method to add a reflection to the BBXImage
Sets a callback for a refresh event that occurs on the passed dashboard widget
Sets the enable status of the refresh configuration menu in the options menu
Sets the refresh enabled or disabled
Sets the enable status of the refresh menu item in the options menu
setReloadCallback Sets a callback routine to call after report is reloaded
setReloadCallback Sets a callback routine to call when report is reloaded
setReloadCallback Sets a callback routine to call after report is reloaded
setReloadCallback Sets a callback routine to call when report is reloaded
Sets information about reminders such as email and popup notifications.
setReplyTo Sets the "reply to" field in an email's header before the email is sent. The "reply to" field indicates to what email address a reply should be sent.
This method is optional. Replies will be directed to the from address if this value is not set
setReport Sets the BBJasperReport for the widget
setReportConfiguration Sets a simple report configuration from parameters
setReportConfiguration Sets a simple report configuration from parameters
setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected
Whether the attendee is a resource. Read-only. The default is False (0)
The attendee's response status. Possible values are: "needsAction" - The attendee has not responded to the invitation. "declined" - The attendee has declined the invitation. "tentative" - The attendee has tentatively accepted the invitation. "accepted" - The attendee has accepted the invitation.
Registers the underlying BASIS Components ResultSet
Sets a callback for a right click event that occurs on the passed dashboard widget
Sets the depth of the rings.
The smaller the value the thinner the rings. A value of 0 will prevent the rings from being drawn at all, and a value of 1 is equivalent to a pie chart where the slices take up the full radius of the plot.
Sets the horizontal alignment of a row
Sets the background color of a row
Sets the grid's row data using the passed vector
Update row data
#API
Update row data
#API
Sets whether a row is editable Note: The QVGrid is not editable, so this has no effect.
Sets the default font of a row
Sets the foreground color of a row
Disable row grouping for all columns and enable it for the passed columns
#Enterprise
#Configuration
#API
Sets the number of pixels separating the row header and the main grid area
Sets the default alignment of the row header
Sets the default background color of the row header
Sets the alignment of a row header cell
Sets the background color of a row header cell
Sets the foreground color of a row header cell
Sets the icon in a row header cell
Sets the image displayed in a row header cell
Sets the style of a row header cell
Sets the text to be displayed in a row header cell
Sets the vertical alignment of the row header cell
Sets the default font of the row header
Sets the default foreground color of the row header
Sets the style of the row header
Sets the row header text
Sets the vertical alignment of the row header
Sets the width of the row header
Sets the row height for the grid's body cells
Sets the height of the rows in the grid Note: The QVGrid only uses this method signature, i.e. setRowHeight(int index, int height) is not offered.
Set all rows height
#API
Set the given row height
#API
Set the given row height
#API
Registers row listener to CALL when processing a data row on its way to the grid
Registers row listener object to invoke when processing a data row on its way to the grid
Feed the grid with a new ResultSet
Unlike the setData method, this one will update the grid with a new rows set(ResultSet) without doing a full re-render. The column definition will not be synced from the passed ResultSet in this case.
Use this method in case you want to replace the whole data in the grid at once. Please note that All row and range selection will be lost.
#API
Create a GxExpression from string and set it as row span expression
Sets the default style of a row
Sets the default vertical alignment for a row
Sets a row to be visible in the grid If the row is not already visible, then it will be made the top row or made visible if on the last grid page.
setRTFExporter Sets the RTF exporter which contains export options
Sets the save enabled or disabled
Sets the enable status of the save menu item in the options menu
Sets whether the grid scrolls during a drag and drop operation when the mouse cursor is moved outside the bounds of the grid Note: The QVGrid handles scrolling itself, so this method has no effect.
Sets whether the grid updates the display of data in the cells while being scrolled Note: The QVGrid uses the default of "off", so this method has no effect.
Configures under what situations the grid control will respond to the mouse scroll wheel
Set the first condition
Sets a callback for a select event that occurs on the passed dashboard widget
Sets the DashboardWidget to be selected or deselected
Sets the widget's selected status. This modifies the widget's appearance by changing the titlebar color and setting a CSS selector on the control to distinguish it visually from the other, non-selected dashboard widgets.
Selects a cell
Selects a column
Selects multiple columns
Selects a row
Select a row by its index
#API
Select a row by its key
#API
Selects multiple rows in the grid
Select a vector of rows. The vector can contain a mix of row indices and row keys
#API
Sets the selectability of the widget control
Sets the method to select cells Note: The QVGrid always uses row selection (GRID_SELECT_ROW), so this method has no effect
setSentDate Sets the "sent date" field in an email's header before the email is sent.
It is not necessary to call this method unless some date other than the current date needs to be specified as the sent date. Changing this date will not change the actual time at which the email is sent. i.e., setting the sent date forward a day in the future will not cause the sending of the email to be delayed a day.
iCalendar sequence number.
Configure a series in the XYSeriesCollection for the chart by setting various parameters
Add an XY data point to the specified series in the XYSeriesCollection for the chart.
If the chart has multiple series, they will be rendered in reverse order. So the last series added will be the first series rendered. This matters if you're mixing filled and non-filled series data.
Sets the pie chart's shadow with sharp edges
Note that this only appears to work on a flat (non-3D PieChart) as of JFreeCharts 1.0.19 You may want to use setChartPlotShadow() instead as it provides a diffused shadow with more control over the parameters
Sets the bar chart's shadow with sharp edges
You may want to use setChartPlotShadow() instead as it provides a diffused shadow with more control over the parameters
Sets the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as setToolTipText().
Sets whether the grid will highlight the entire column containing the currently selected cell
Sets whether the grid should highlight the entire row containing the currently selected cell
Sets whether to show a BUI BBjBusyIndicator when loading widgets into the DashboardCategory
Note that this is a convenience method to access the DashboardControl's related public field variables.
setShowFileDialogOnInitDefaultSave Sets if the file save dialog should be shown on the intitial save
setShowGoogleDialogOnInitDefaultSave Sets if the Google save dialog should be shown on the intitial save
Enable / disable showing row counts beside group labels
#Configuration
#ColumnsRenderer
Enable/ disable checkbox selection on groups
#Configuration
#ColumnsRenderer
Controls whether the input style cells display decoration characters of their mask in non-edit mode Note: This method has been deprecated.
setSides Sets the sides
Sets the window size
Sets the control size
Sets the size of the dashboard category control
Sets the size of the widget control
Sets the size of the EmbeddedWidgetWindow
Sets the size of the EmbeddedWidgetSetControl
Sets the size of the EmbeddedWidgetSetWindow
setSize Sets the size of the dialog
Sets the size of the QVGrid component child window
setSize Sets the size of the viewer window and control
setSize Sets the sizes of the viewer control
setSize Sets the size of the tabbed view
setSize Sets the size of the view
Sets the size of the calendar widget given the provided width and height.
setSize - set the size of the control
#API
Sets the color and opacity for the outline of each pie slice and its corresponding legend item
Sets the width of the outline for each pie slice and its corresponding legend with the default value set to 1.
Notes:
Sets the frequency for displaying time slots, where the default value is "00:30:00" which translates to 30 minutes.
You can increase or decrease the slot duration in certain views by modifying this value. The format of the string is "HH:MM:SS" where H=hours, M=minutes, and S=seconds. For example, to increase the granularity of the timeslots on the calendar you can set each slot to be 5 minutes by passing in the value "00:05:00".
Applicable views: CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
Sets the maximum time slot (latest time) that will be displayed for each day, where the default value is "24:00:00" (midnight).
You can affect the ending time displayed on the calendar by modifying this value. The format of the string is "HH:MM:SS" where H=hours, M=minutes, and S=seconds. For example, to have the day end at, and include, 9:30 PM you can set this variable to "21:31:00".
Note: This should be specified as an exclusive end time, meaning that it indicates the ending time up to, but not including, this value. Therefore, the default of "24:00:00" means that time slots up to and including "23:59:59" will be displayed, but "24:00:00" will not be displayed.
Sets the minimum time slot (earliest time) that will be displayed for each day, where the default value is "00:00:00" (midnight).
You can affect the starting time displayed on the calendar by modifying this value. The format of the string is "HH:MM:SS" where H=hours, M=minutes, and S=seconds. For example, to have the day start at 6:30 AM you can set this variable to "06:30:00".
Sets the time slot that the calendar initially scrolls to, where the default value is "06:00:00" or 6 AM.
This only affects the initial position and does not prevent users from scrolling forwards and backwards from this time slot. If you need to prevent users from seeing earlier or later timeslots, use the SlotMinTime and/or SlotMaxTime options instead.
Valid options are:
Sets whether the grid will adjust its height so that it does not display any partial rows Note: The QVGird always shows only complete rows, so this method has no effect.
Sets whether a grid allows sorting by multiple columns
Set a sorting for one or more columns
#API
Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
Method setSourceFile: Sets the source file
Set the start time for the event using an EventDateTime object
Set event start time using 6 numbers to designate year, month, day, hour, minute, and second respectively. This method is used to set the end time for a timed event.
Set event start time using 6 numbers to designate year, month, day, hour, minute, and second respectively. This method is used to set the end time for a timed event.
Set event start time using 3 numbers to designate year, month, and day respectively. This method is used to specify the start time for an all-day event.
Set event start time using 3 numbers to designate year, month, and day respectively. This method is used to specify the start time for an all-day event.
Set event start time using a java.util.Date This method is used to specify the start time for a timed event.
Set event start time using a java.util.Date This method is used to specify the start time for a timed event.
Sets an entry's starting date/time. If the entry is explicitly all-day, then the time portion will be ignored.
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Sets the selection mode that will be used when a cell is edited Note: The QVGrid is not editable, so this method as no effect.
setStartPageIndex Sets the starting page index for export operations
Apply the grid's columns , sorbing and filtering state
#API
Whether the event is occurring. Values are "confirmed", "tenative", and "cancelled". The default is "confirmed".
setStatusBarText Sets the text in the status bar
Sets the number of grid rows to alternate between the stripe color and the default background color
see BBjControl
Sets a CSS property on the widget.
setSubject Sets the subject of the email message represented by the email object
Set the title of the event.
Sets the current tab action of the grid
When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method has no effect.
setTabOnParentHyperlinkTarget Sets whether a tabe will be created when hyperlink targets are set to blank, othwerwise a window will be created
Sets a value indicating whether or not the user can navigate to the grid control using the tab key
Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
This is similar to the setTags()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Sets the HTML text for the HtmlViewWidget. If you want the popped-out version of the widget to have different HTML you should use the setTexts() method.
setText Sets the text for the body of the email message
Alias of addText(). Can be called multiple times to add multiple text parts to the email message.
Sets the control text for the grid control Note: The relevance of this method for a grid control is questionable, but provided for compatibility.
Sets an entry's text color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the source's entry text color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
Sets the HTML text for the HtmlViewWidget. By specifying a different string for the p_poppedOutText$ parameter you can change the contents and behavior of the popped-out version or simply rename unique elements, such as DIV IDs.
Sets the calendar's theme to one of the installed Boostrap themes, which modifies the calendar's fonts and color scheme.
To determine which themes are available, you can call the getThemes()
method which returns a BBjVector filled with the installed theme names.
Note that the installed themes are located in the BBjCalendarWidget's lib/bootstrap/themes/
directory. The installed themes
are free Bootstrap themes from https://bootswatch.com/
, although free
Bootstrap themes are available from many other sites such as
https://startbootstrap.com/themes
.
If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the bootstrap.css
and
bootstrap.min.css
files in the newly-created subdirectory. The calendar will attempt to find and use the
bootstrap.min.css
first due to its reduced size.
Sets the theme that the calendar uses.
The BBjCalendarWidget
has several options for modifying its appearance via themes. By default,
the calendar uses a standard default theme. However, it's possible to change its appearance by applying
a theme, which is a Bootstrap-compatible CSS file. Therefore, you can change the calendar's default
appearance by applying the default Bootstrap theme, or a custom Bootstrap theme. The BBjCalendarWidget
comes pre-installed with several free Bootstrap themes that were obtained from
https://bootswatch.com/ and are installed in the
BBjCalendarWidget
's lib/bootstrap/themes/
directory. Each theme consists of a
subdirectory based on the name of the theme with two files in the directory: bootstrap.css
and
bootstrap.min.css
. The minimized version is used unless the calendar is set to debug mode.
Note that there are many more freely-available Bootstrap-compatible themes besides those that come
pre-installed with the BBjCalendarWidget
. You many choose to download other free themes,
or purchase a theme, and use it with the calendar. To do so, ensure that the CSS files are installed
in a directory named after the theme under the BBjCalendarWidget/lib/bootstrap/themes/
directory.
The calendar widget will use the appropriate CSS file, bootstrap.css
or bootstrap.min.css
from that directory based on whether the calendar is in debug mode or not.
Possible values for the theme are:
"standard"
- The default calendar theme, which doesn't use Bootstrap."bootstrap"
- The default Bootstrap theme."<theme_name>"
- A custom bootstrap-compatible theme such as "slate", which is the name of the theme directory under the BBjCalendarWidget/lib/bootstrap/themes/
directory.Set the grid theme
#Configuration
#API
Sets the calendar's timezone, where the default value is "local" for the user's local timezone.
Whereas the local timezone will vary from browser to browser, the "UTC" time zone is guaranteed to be the same in every browser. It will also not experience daylight savings times. The UTC time zone was designed this way and it serves as a time zone that other time zones define themselves relative to.
Valid options are "local", "UTC", or a named timezone like "MST" or "America/New_York".
Sets the title of the dashboard item
Sets the dashboard window's title
Sets the title of the dashboard control
Sets the title of the dashboard category control
Sets the title for the widget control
Sets the title of the EmbeddedWidgetWindow
setTitle Sets the title of the dialog
Sets entry's title that is the description/summary text that will appear on an entry.
setTo Sets the "to" field in an email's header before the email is sent. This value specifies the email address to which the message will be delivered.
This method only supports one email address. Add additional recipients using the addTo() method.
Sets a CalendarToolbarSection
on the toolbar. Note that each CalendarToolbarSection
object
already contains a toolbar position (start, center, end) so the position does not need to be provided in this method call.
Sets all three CalendarToolbarSection
s on the toolbar in a single method call.
Sets the tooltip text (also known as short cue) for a cell
Sets the tooltip text (also known as short cue) for a column
Sets the tooltip text (also known as short cue) for the grid control
Create a GxExpression from string and set it as tooltip value getter
Sets a row to be the top visible row or at least shown if on the last grid page.
Sets a translation value
Indicates whether the event blocks time on the calendar. "transparent" means other events may take place at the same time. "opaque" blocks other events on the calendar. The default is "opaque".
When a grid is larger in size than the size required to display the data and all required headers and scrollbars, this method controls whether the grid will be trimmed to the minimum size to display everything.
setTXTExporter Sets the TXT exporter which contains export options
Sets the calendar's view type using one of the view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
, CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
, etc.
Set the column type
Set the column type
Sets a date for a recurring event to end. This field is mutually exclusive of count and untildatetime. If you set this field, it will set the other two to null().
Sets a date and time for a recurring event to end. This field is mutually exclusive of count and untildate. If you set this field, it will set the other two to null().
Sets whether the grid sends table update notification events when cells already have data
The time the event was last updated.
setupVirtualization
Sets virtualization on.
Virtualization can be used to avoid an out of memory condition when filling a report with a
very large amount of data. Virtualization will offload this data to temporary files.
Using virutalization makes the generation of the report a bit slower but it will avoid
out of memory conditions.
The method cleanupVirtualization should be called when a report that uses virtualization
is no longer needed. This will remove the temporary files that were created during
the virtualization process. If the leanupVirtualization method is not called, these
temporary files will be removed when BBjServices is stopped.
The VIRTUALIZATION_THRESHOLD_SIZE, which by default is 300, specifies the number of pages
of the filled report created in memory before virutalization will begin.
The "bbjasper" directory under the directory that is specified by Java System property
"java.io.tmpdir" will be used to store virtualized files.
setupVirtualization
Sets when virtualization will occur.
Virtualization can be used to avoid an out of memory condition when filling a report with a
very large amount of data. Virtualization will offload this data to temporary files.
Using virutalization makes the generation of the report a bit slower but it will avoid
out of memory conditions.
The method cleanupVirtualization should be called when a report that uses virtualization
is no longer needed. This will remove the temporary files that were created during
the virtualization process. If the leanupVirtualization method is not called, these
temporary files will be removed when BBjServices is stopped.
The "bbjasper" directory under the directory that is specified by Java System property
"java.io.tmpdir" will be used to store virtualized files.
setupVirtualization
Sets when virtualization will occur and where the temporary files will be created.
Virtualization can be used to avoid an out of memory condition when filling a report with a
very large amount of data. Virtualization will offload this data to temporary files.
Using virutalization makes the generation of the report a bit slower but it will avoid
out of memory conditions.
The method cleanupVirtualization should be called when a report that uses virtualization
is no longer needed. This will remove the temporary files that were created during
the virtualization process. If the leanupVirtualization method is not called, these
temporary files will be removed when BBjServices is stopped.
Sets the URL for the HtmlViewWidget. If you wish the popped-out version of the widget to have a different URL you should use the setUrls() method.
The string parameter should include the protocol, so "http://www.basis.cloud" is one example. Note that you must call the refresh() method after this method to force the HtmlViewWidget to load the new URL.
Sets the URL for the HtmlViewWidget. If you wish the popped-out version of the widget to have a different URL you should use the setUrls() method.
The string parameter should include the protocol, so "http://www.basis.cloud" is one example. Note that you must call the refresh() method after this method to force the HtmlViewWidget to load the new URL.
Sets an entry's associated URL that may be visited when this entry is clicked by the user.
Sets the source's URL parameter.
Sets the URL for the HtmlViewWidget. By specifying a different string for the p_poppedOutUrl$ parameter you can change the contents and behavior of the popped-out version of the widget.
The string parameter should include the protocol, so "http://www.basis.cloud" is one example. Note that you must call the refresh() method after this method to force the regular (non-popped-out) HtmlViewWidget to load the new URL.
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
Set The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a true value.
Sets the user agent string for the HtmlViewWidget
This requires a BBj 15 or greater interpreter
Sets the user data object of the dashboard item
Associates an object as user data with the grid control
Sets a custom, arbitrary object to be associated with the widget which can be retrieved later via the getUserData()
method.
Sets a font scaling factor for the chart based on the user's preferences. This method is used by the Customize screen to affect the user's choice of font scaling. Dashboard programs should not call this method, and should call the setFontScalingFactor() method instead.
Specifying a scaling factor less than 1 decreases the fonts. Specifying a scaling factor greater than 1 increases the fonts.
setUserName Sets the user name
Sets whether the columns in the grid can be resized by the user
Sets the calendar's ending date that the user sees and interact with, where the default value is unset (null()) as setting it limits the dates shown.
The value can be anything that can parse into a date, including a simple ISO8601 date string like "2014-02-01". If your application needs to limit the timeframes for an appointment, you can provide a starting and/or ending date to set a valid modification range. That way, the calendar displays the invalid dates differently and the user may only move an entry inside the valid range. If they attempt to move an entry outside of the valid range, the entry will move back to its original position and the calendar cancels the user's modification. This has several benefits, including:
rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setValidRangeStart(date(jul(0, 0, 0), "%Yl-%Mz-%Dz")) myCal!.render()
Sets the calendar's starting date that the user sees and interact with, where the default value is unset (null()) as setting it limits the dates shown.
The value can be anything that can parse into a date, including a simple ISO8601 date string like "2014-02-01". If your application needs to limit the timeframes for an appointment, you can provide a starting and/or ending date to set a valid modification range. That way, the calendar displays the invalid dates differently and the user may only move an entry inside the valid range. If they attempt to move an entry outside of the valid range, the entry will move back to its original position and the calendar cancels the user's modification. This has several benefits, including:
rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setValidRangeStart(date(jul(0, 0, 0), "%Yl-%Mz-%Dz")) myCal!.render()
Method to set the dial chart's value where the acceptible value ranges from 0 to 100, indicating percentage complete
Method to set the value of the dial chart
Create a GxExpression from string and set it as value formatter
Create a GxExpression from string and set it as value getter
Create a GxExpression from string and set it as value parser
Create a GxExpression from string and set it as value setter
Sets the amount of vertical space between the rows
Sets whether the vertical lines between the columns are to be visible
Sets whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid Note: The QVGrid maintains a separate vertical scrollbar control. Setting 'scrollable' to 0 (false) here, disables the scrollbar.
Sets whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so this method has no effect.
setView Set the current view for the viewer control
Sets the current view
Sets the view data enabled or disabled
Sets the enable status of the view data menu item in the options menu
Sets the calendar's view type.
Note: Calling this method causes the calendar to change its view, which then results in a
CalendarAPI.ON_CALENDAR_VIEW_CHANGE
event.
The provided view type should be one of the following constants:
CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()
.CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()
.CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY()
.CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()
.CalendarAPI.CALENDAR_VIEW_LIST_DAY()
.CalendarAPI.CALENDAR_VIEW_LIST_WEEK()
.CalendarAPI.CALENDAR_VIEW_LIST_MONTH()
.CalendarAPI.CALENDAR_VIEW_LIST_YEAR()
.Visibility of the event. Can be the following values: "default": default visibility. This is the default value. "public": Anyone who can see the calendar can see the event. "private": Only participants can see the event. "confidential": alias to "private" provided for compatibility reasons.
Sets the window visibility
Sets the control visibility
Sets the control visibility
Sets the widget control's visibility
Sets the visiblity of the EmbeddedWidgetWindow
Sets the visiblity of the EmbeddedWidgetSetWindow
Sets whether the QVGrid component child window is visible
setVisible Sets the visibility of the viewer control
setVisible Sets the visibility of the tabbed view
setVisible Sets the visibility of the view
Sets whether the widget should be visible or hidden.
Set Visible
Enable / Disable the grid sidebar
Method to set the dial chart's window visible
Ensures the column is visible, scrolling the table if needed.
#API
Ensures the row index is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Sets one or more optional, custom tags that determine which calendar
entries should be displayed. The CalendarEntry
custom class offers
setTags() methods that give you the opportunity to add custom tags to any entry. After
adding tags to one or more entries, you can call methods on the calendar to show or
hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags()
and
BBjCalendarWidget::setHiddenTags()
methods.
This is similar to the setVisibleTags()
method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
Sets one or more optional, custom tags that determine which calendar
entries should be displayed. The CalendarEntry
custom class offers
setTags() methods that give you the opportunity to add custom tags to any entry. After
adding tags to one or more entries, you can call methods on the calendar to show or
hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags()
and
BBjCalendarWidget::setHiddenTags()
methods.
Set the widget instance
Sets the border color of the widgets
Sets the border selected color of the widgets
Sets the WidgetControl (view) that's associated with the DashboardWidget (model)
Sets the title bar decoration background color of the widgets
Sets the title bar decoration selected background color of the widgets
Sets the title bar name background color of the widgets
Sets the title bar font of the widgets
Sets the title bar font of the widgets
You may specify any font given a fully qualified path, a font name or path that can be found via the current PREFIX setting, or any font located in the
Sets the title bar name foreground color of the widgets
Sets the title bar name selected background color of the widgets
Sets the title bar separator background color of the widgets
Sets the title bar separator selected background color of the widgets
setWindowOnBlankHyperlinkTarget Sets whether a window will be created when hyperlink targets are set to blank, othwerwise a tab will be created
setWindowTitle Sets the title of the viewer window
Method setWizardWindowEnabled: Sets the Wizard Window enabled or not
setXHTMLExporter Sets the XHTML exporter which contains export options
setXLSExporter Sets the XLS exporter which contains export options
setXLSXExporter Sets the XLSX exporter which contains export options
setXMLExporter Sets the XML exporter which contains export options
setZoomLevel Sets the report image to the specifed zoom level
setZoomLevel Sets the report image to the specifed zoom level
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
Translated text for shift
A number that acts as a boolean, determining whether the grid should highlight the selected row
Method show: Show frame
Method show: Display frame
Method show: Display frame
Method show: Display frame
Method show: Shows the frame
Method show: Shows the frame
Method show: Shows the frame
Method show: Shows the frame
Method show: Shows the frame
Method show: Shows the frame
Method show: Display frame
Method show: Show frame
show Shows the viewer window for non empty reports, and optionally process events for the window
show Shows the viewer window for empty or non empty reports, and optionally process events for the window
A number acting as a boolean that determines whether the DashboardControl should show the BUI BBjBusyIndicator when loading the widgets.
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. (boolean)
Set to TRUE if the file save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE
Flag to show overwrite save warning, by default this is TRUE
Flag to show overwrite save warning, by default this is TRUE
Set to TRUE if the Google save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE
When true, selection box will be show on the first column's header
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the tHeaderCheckboxSelection to true
Note This option will ignore multi row selection option by default so it is always enabled
Whether to include hidden invitations in the result. Optional. The default is False. (boolean)
Show loading overlay
#API
Show 'no rows' overlay
#API
Displays suggestions on focus of the input element.
Note that if true, the MinLength
option will be ignored and it will
always call the resolver.
When true, A selection box will be shown on the first column
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the CheckboxSelection to true
Shows the chart's tip after clicking on a data entity.
This method is called automatically by default when the user left-clicks on a chart if the program hasn't registered a callback for the click event. Note that you can have your program register for the click event, create a custom message for the tip, then use this method to tell the widget to display your custom message.
Shows the tooltip text (also known as short cue) for the grid control
Shows the tooltip text (also known as short cue) for the grid control
run Shows the BBJasper usage
Shuffles the order of the colors in a vector
The grid sidebar
A constant to define the bottom edge used when setting the position of the chart legend
A constant to define the left edge used when setting the position of the chart legend
A constant to define the right edge used when setting the position of the chart legend
A constant to define the top edge used when setting the position of the chart legend
Represents an exception date Not implemented. Subject to change or removal.
Represents an exception rule
Represents a recurrence date
Represents a recurrence rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.
Represents a base rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.
Constant that represents the single sheet XLS save contributor
Constant that represents the single sheet XLS save contributor
Set to true to enable Single Click Editing for cells, to start editing with a single click.
#Configuration
#GridRenderer
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. (boolean)
Method skipFrame: Skips a frame param@ p_frame The frame number to skip param@ p_skip Indicates if the frame is to be skipped or not. 0=Do not skip, 1=Skip
Set this to true to skip the headerName when autoSize is called by default
#Configuration
#GridRenderer
A number that acts as a boolean, determining whether the grid should snap to the row height
Set to 'asc' or 'desc' to sort by this column by default.
#Configuration
#ColumnsRenderer
Get sort direction constant
Get sort direction constant
Set to true to allow sorting on this column.
#Configuration
#ColumnsRenderer
Sorts the grid by the content of a given column Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
A number that acts as a boolean, determining whether the grid should sort by multiple columns
Sort the given column with the given direction
#API
spacesValid Determines if spaces are valid on the client OS as part a file name.
A developer-provided SQL query used to provide data for the widget
A SQL query used to provide data for the widget
A SQL query used to provide data for the widget
A SQL query used to provide data for the widget
A SQL query used to provide data for the widget
An SQL-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.
Stacked area chart widget type constant
Stacked Bar chart widget type constant
Stacked Percentage Bar chart widget type constant
AreaChartWidget A Dashboard Utility Widget that displays a stacked area chart which is similar to an area chart except that each series is drawn directly above the previous series
Create an empty Stacked Area Chart specifying all parameters to be filled after creation with setDataSetValue()
Create an SQL-based Stacked Area Chart specifying all parameters
Create a BBjRecordSet-based Stacked Area Chart specifying all parameters
Create an SQL-based Stacked Area Chart specifying all parameters
StackedBarChartWidget A Dashboard Utility Widget that displays a stacked bar chart where the bars for each column key are stacked upon one another
Create an empty Stacked Bar Chart specifying all parameters to be filled after creation with setDataSetValue()
Create an SQL-based Stacked Bar Chart specifying all parameters
Create a BBjRecordSet-based Stacked Bar Chart specifying all parameters
Create an SQL-based Stacked Bar Chart specifying all parameters
StackedPercentageBarChartWidget A Dashboard Utility Widget that displays a stacked percentage-based bar chart where you provide a data value and the remainder of the bar will be filled in up to 100% with a translucent version of the bar
Create an empty Stacked Bar Chart specifying all parameters to be filled after creation with setDataSetValue()
Create an SQL-based Stacked Bar Chart specifying all parameters
Create a BBjRecordSet-based Stacked Bar Chart specifying all parameters
Create an SQL-based Stacked Bar Chart specifying all parameters
Start row id or index
A number indicating the starting angle of the pie chart. The initial default value is 90 degrees, which corresponds to 12 o'clock. A value of zero corresponds to 3 o'clock.
Begins editing an editable cell in the grid Note: The QVGrid is not editable, so this method has no effect.
Navigates the grid focus to the next cell, as if tabbing.
#API
Navigates the grid focus to the previous cell, as if shift-tabbing.
#API
Translated text for starts with
Height of the status bar, the default is 20
Status bar name
Status bar name
The grid statusbar
The increment / decrement step
Stop editing and accepts changes
#API
Stop Editing
#API
Set this to true to stop cell editing when grid loses focus. The default is the grid stays editing until focus goes onto another cell. For inline (non-popup) editors only.
#Configuration
#GridRenderer
Stores the find options
Stores the properties of all DashboardCategories and Widgets in the current Dashboard
if this menu is a submenu, contains a list of submenu item definitions
Constant value that represents a successful return code
A suffix to append to the value after it is formatted
A suffix to append to the value after it is formatted
An HTML template to be used for rendering the suggestion groups
ex:
template! = "<%= groupName %>" editor!.setSuggestionItemTemplate(template!)
An HTML template to be used for rendering the suggestion items
ex:
template! = "<%= item.label %> - <%= item.value %> - <%= item.group %>" editor!.setSuggestionItemTemplate(template!)
Check if the filter supported the combined model
When true, the aggregations won't be computed for root node of the grid
#Configuration
#GridRenderer
When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
#Configuration
#GridRenderer
If true, the filter will only offer Condition 1.
If true, the filter will only offer Condition 1.
When true, the grid will not use animation frames when drawing rows while scrolling.
Use this if the grid is working fast enough that you don't need animations frame and you don't want the grid to flicker.
#Configuration
#GridRenderer
Suppresses auto-sizing columns for columns. In other words, double-clicking a column header's edge will not auto-size.Default is false
#Configuration
#GridRenderer
Supresses JavaScript debouncing for BUI.
Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in BUI.
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI context
By default this options is set to "0"
A BBjNumber acting as a boolean that determines whether the executor should override script debouncing in BUI. Defaults to "0", meaning scripts will be batched instead of executed immediately. Setting this to "0" may help to increase the communication performance between BBj and the JavaScript library/object inside the BBjHtmlView control in BUI.
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI context
By default this options is set to "0"
If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. Default: false
Normally when a chart is displayed using the grid, the grid will highlight the range the chart is charting when the chart gets focus, to suppress this behaviour, set the field to false
Set to true so that neither single or double-click starts editing.
#Configuration
#GridRenderer
suppress Expand / Collapse all widget.
suppress Column Filter section.
Suppress Column Move section
If true, the ag-column-moving class is not added to the grid while columns are moving. In the default themes, this transpires to no animation for moving columns.
#Configuration
#GridRenderer
suppress Select / Un-select all widget.
Set to true so that the grid doesn't virtualize the columns. S o if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
#Configuration
#GridRenderer
When true , the logger will not output messages in the console
Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
#Configuration
#GridRenderer
When true show row counts, hide otherwise
Supressesss JavaScript debouncing for both GUI and BUI.
Suppress scripts debouncing for GUI and BUI
When true , the logger will not output messages in debug file
When true disable double-click for expand, enable otherwise
If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
#Configuration
#GridRenderer
To suppress Expand / Collapse All
To suppress the Filter Search
Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.
#Configuration
#ColumnsRenderer
Supresses JavaScript debouncing when running in GUI.
Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in GUI.
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in GUI context
By default this options is set to "1"
A BBjNumber acting as a boolean that determines whether the executor should override script debouncing in GUI. Defaults to "0", meaning scripts will be batched instead of executed immediately. Setting this to "0" will help to increase the communication performance between BBj and the JavaScript library/object inside the BBjHtmlView control in GUI.
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in GUI context
By default this options is set to "1"
Set to true to never show the horizontal scroll.
#Configuration
#GridRenderer
Disables the 'loading' overlay.
#Configuration
#GridRenderer
Set to true to suppress sorting of un-sorted data to match original row data
#Configuration
#GridRenderer
By default when a column is un-grouped, it is made visible.
This property stops the column becoming visible again when un-grouping.
#Configuration
#GridRenderer
Set to true if no menu should be shown for this column header.
#Configuration
#ColumnsRenderer
Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
#Configuration
#GridRenderer
If true, then middle clicks will result in 'click' events for cell and row. Otherwise the browser will use middle click to scroll the grid.
#Configuration
#GridRenderer
Set to true to hide the mini filter.
Set to true if you do not want this column to be movable via dragging.
#Configuration
#ColumnsRenderer
Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
#Configuration
#GridRenderer
Enable / disable one range selection even if ctrl key is held down
#Enterprise
#Configuration
Set to true to suppress multi-sort when the user shift-clicks a column header.
#Configuration
#GridRenderer
Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
#Configuration
#ColumnsRenderer
Disables the 'no rows' overlay.
#Configuration
#GridRenderer
suppress Pivot Mode section.
suppress Column Labels (Pivot) section.
Set to true to stop the filter from removing values that are no longer available (like what Excel does).
since version 1.7.0. This option has been deprecated with no replacement.
If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
Suppress Row Groups section.
Set to true to not highlight rows by adding the ag-row-hover
CSS class.
#Configuration
#GridRenderer
Uses CSS top instead of CSS transform for positioning rows.
Useful if the transform function is causing issues such as used in row spanning. Default: false
#Configuration
#GridRenderer
When true, the grid will not scroll to the top when new row data is provided.
Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
#Configuration
#GridRenderer
Set to true to remove the "select all" checkbox.
Set to true to suppress column events being raised when state is changed throw the API methods
#Configuration
#GridRenderer
Set to true if you want this columns width to be fixed during 'size to fit' operation.
#Configuration
#ColumnsRenderer
If true, sorting will not be done on the set filter values. Use this if providing your own values and don't want them sorted as you are providing in the order you want.
When true , then the suggestion will not be triggered for invalid inputs
Suppress updating the layout of columns as they are rearranged in the grid
Suppress updating the layout of columns as they are rearranged in the grid
Set to true to have the values inside the set filter NOT refresh after values are changed inside the grid.
Set to true if you do not want this column or group to appear in the tool panel.
#Configuration
#ColumnsRenderer
Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
#Configuration
#GridRenderer
Suppresses update requests to the program while the user scrolls
suppress Values section
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI & DWC context
By default this options is set to "0"
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI & DWC context
By default this options is set to "0"
A special html string which uses the switch button to render true/false values
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: ICalUID OrderBy PrivateExtendedProperty Q SharedExtendedProperty TimeMin TimeMax UpdatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Optional. The default is to return all entries. (string)
The BBjSysGuiEvent that occurred
Event that occurred
TableType class
Constructor Constructs a TableType for the given database and table name.
Tab Title
Navigates the grid focus to the next cell, as if tabbing.
#API
Navigates the grid focus to the previous cell, as if shift-tabbing.
#API
String template which will be compiled in the client.
<%= '' + (params.valueFormatted || params.value) + '' %>
The search term
Text of link
A string with HTML contents
Translated text for text
The grid's theme where the default is a custom 'BBjGrid' emulation and other values are 'balham', 'material', 'fresh', 'blue', 'dark', and 'bootstrap' - note that setting a theme may invalidate other parameters, e.g. RowHeight, that conflict with the theme
Set the grid theme
#Configuration
#API
BBjThinClient object
throwError Throws the passed error message and error number
throwError Throws the passed error message and error number. Adds the line number, line code, and last exception (if available)
Filter for getEvents() method: Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. (string)
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. (string)
Authentication timeout in seconds. Default is 120 seconds, 0 means "forever."
The date / timezone timezone to use.
Filter for getEvents() method: Time zone used in the response. Optional. The default is the time zone of the calendar. (string)
The background color of the chart's tip, specified as a hex color string
The background color's opacity of the chart's tip, specified as a number between 0 and 1 (0=transparent, 1=opaque)
The display time in seconds of the chart's tip
The foreground color of the chart's tip, specified as a hex color string
The foreground color's opacity of the chart's tip, specified as a number between 0 and 1 (0=transparent, 1=opaque)
Returns the title of the widget
Returns the title of the widget
The input title , when null and the textMask options is defined , then we use the mask as title , when set to default we the browser's default title , other wise the value defined in this option
The input title , when set to null() or "default" then we use the browser's default title , other wise the value defined in this option
Title of the dashboard category control
The alignment of the titlebar's text, based on one of the ALIGN_* constants. The default is ALIGN_CENTER.
Background color of the widget titlebar's window decoration section
Background color of the widget titlebar's window decoration section when it is selected
Height of the title bar
Background color of the widget titlebar's name section
Font for the text in the widget titlebar's name section
Color of the text in the widget titlebar's name section
Background color of the widget titlebar's name section when it is selected
Background color of the widget titlebar's window decoration section separator
Background color of the widget titlebar's window decoration section separator when it is selected
toJSON Converts the email to a JSON string.
Tool bar child window name
Tool bar child window name
Height of the tool bar controls, the default is 22
The space between controls on the tool bar, the default is 2
Y location of the tool bar controls, the default is 3
Height of the tool bar, the default is the TOOL_BAR_CONTROL_HEIGHT + 7
Width of the tool bar spacer, the default is 8
Constant that represents a tool button error
Width of the tool buttons, the default is 22
Height of the tool bar
CSS class(es) to use for the tool panel cell.
#Configuration
#ColumnsRenderer
A map for the registered toolpanels
Optional tooltip for the menu item
Tooltip to be displayed when the mouse is hovered over the filter
Tool tip to be displayed when the mouse is hovered over the link
The field of the tooltip to apply to the cell.
#Configuration
#ColumnsRenderer
The delay in milliseconds that it takes for tooltips to show up once an element is hovered.
Note: This property does not work if enableBrowserTooltips is true.
#Configuration
#GridRenderer
A Grid expression which can be executed to return the tooltip value to display for each cell.
#Configuration
#ColumnsRenderer.
Creates a formatted string from the populated fields. In order for the string to constitute a valid rule, the following fields must be set: Frequency and one of Count, UntilDate, or UntilDateTime.
Convert row to string
Convert column to string
Convert the menu to a JSON string
Convert the item to String
Convert the item to String
Get the expression as string
Convert the statusbar into a parsable json string
Method to convert a given string to Title Case, meaning that the first letter of each word is capitalized and the rest is set to lowercase
Note that this is a convenience method to the more full-featured toTitleCase() method that allows you to optionally set whether the remainder strings are set to lowercase.
Method to convert a given string to Title Case, meaning that the first letter of each word is capitalized and the rest is optionally set to lowercase
A field variable that defines the TRANSLATION_KEY_ERROR error number
Translator used to obtain translations
Enable / Disable Tree Data mode
#Enterprise
#Configuration
#GridRenderer
True value translation
The value to use when when the component needs to render true values. in case it is null() then we use the first item in PossibleTrueValues!
Constant that represents the TXT save contributor
Constant that represents the TXT save contributor
TXT exporter which contains export options
The type of chart to create
One of the filter options
The Field Type.
#Configuration
#ColumnsRenderer
Note : Not all sql types are supported, for example it does not make sense to declare a colum type as STRUCT.
Constant value to define area chart
Constant value to define doughnut chart
Constant value to define groupedBar chart
Constant value to define groupedColumn chart
Constant value to define line chart
Constant value to define normalizedArea chart
Constant value to define normalizedBar chart
Constant value to define normalizedColumn chart
Constant value to define pie chart
Constant value to define stackedArea chart
Constant value to define stackedBar chart
Constant value to define stackedColumn chart
Unselects a value
#API
Unselects a value
#API
Removes all sorting directives and displays the grid in its unsorted row order. This method is equivalent to unsort(TRUE, FALSE). Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
Removes all sorting directives and displays the grid in its unsorted row order Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
Set to true if you want the unsorted icon to be shown when no sort is applied to this column.
#Configuration
#ColumnsRenderer
Set to true to show the 'no sort' icon.
#Configuration
#GridRenderer
Until date for recurrence or exception. Required if not using Count or UntilDateTime
Until date and time for recurrence or exception. Required if not using Count or UntilDate
Update a row
Update the filter on the client and execute it.
Update the filter on the client and execute it.
Update the column definition from a meta map
An array of rows to update
Update Access Control List. (Not implemented. Subject to removal or relocating.)
Update Calendar. (Not implemented. Subject to removal or relocating.)
Re-render the column definitions on the client.
#API
The method will collect the new changes in columns and column groups and force the client to reflect the change.
Force the context object update
updateControls Updates the controls based on the current view
Updates a dashboard category in the dashboard
Updates a dashboard widget in the dashboard category
Feed the grid with a new ResultSet
Unlike the setData method, this one will update the grid with a new rows set(ResultSet) without doing a full re-render. The column definition will not be synced from the passed ResultSet in this case.
Use this method in case you want to replace the whole data in the grid at once. Please note that All row and range selection will be lost.
#API
Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. (string)
Updates several JsonObject entries in a JsonArray to the calendar at once for improved performance.
This method iterates through the CalendarEntry
objects and calls the same code as the updateEntry()
method does. Therefore, it
uses the CalendarEntry
's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the
old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the
CalendarAPI.ON_CALENDAR_ENTRY_ADD
or
CalendarAPI.ON_CALENDAR_ENTRY_REMOVE
events then your callback
code will executed once for each entry in the array as a result of calling this method.
Updates several entries of type CalendarEntry
to the calendar at once for improved performance.
This method iterates through the CalendarEntry
objects and calls the same code as the updateEntry()
method does. Therefore, it
uses the CalendarEntry
's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the
old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the
CalendarAPI.ON_CALENDAR_ENTRY_ADD
or
CalendarAPI.ON_CALENDAR_ENTRY_REMOVE
events then your callback
code will executed once for each CalendarEntry
in the BBjVector as a result of calling this method.
Updates an entry in the calendar.
This method uses the CalendarEntry
's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the
old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the
CalendarAPI.ON_CALENDAR_ENTRY_ADD
or
CalendarAPI.ON_CALENDAR_ENTRY_REMOVE
events then your callback
code will executed as a result of calling this method.
Update an event in the calendar.
The method will merge the row data coming from the client with the current DataRow.
updateNavButtons Updates the navigation button to enabled/disabled states
updatePageControls Updates the page controls
Update row data
#API
Update row data
#API
Forces the calendar to resize itself based on the available space in the container DIV.
Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. Whenever you modify the container DIV in such a way that it affects the calendar's size, such as dynamically changing its margin CSS, you may want to call this method afterwards to cause the calendar to adjust to the new container size.
Note: If you call one of the setPadding() methods then this will be executed automatically after the padding has been added to the container DIV, so this method isn't likely to be needed very often.
Updates a widget
Updates a widget
updateZoomControl Updates the zoom control to the current report zoom
@description: Creates a new file on Drive with the contents of a file on the local drive. This will create a new file in Google Drive even if a file with the exact same name and contents already exists in Google Drive. (Titles are not unique.)
The requested web address. Example: "http://www.basis.cloud"
Target URL of link
A string representation of the URL, such as "http://www.basis.cloud"
When true , then the user will be able to sort by multiple columns by holding down the ctrl
key (or Command key on Apple) while clicking the column header. By default this action is possible using the shift
key.
The value to use when when the component needs to return a false value. in case it is null() then we use the first item in PossibleFalseValues!
The value to use when when the component needs to return a false value.
The value to use when when the component needs to return a false value.
The value to use when when the component needs to render false values. in case it is null() then we use the first item in PossibleFalseValues!
The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
The value to use when when the component needs to return a true value. in case it is null() then we use the first item in PossibleTrueValues!
The value to use when when the component needs to return a true value.
The value to use when when the component needs to return a true value.
The value to use when when the component needs to render true values. in case it is null() then we use the first item in PossibleTrueValues!
Contains user-settable data for the widget
If set to true then the grid will use the provided cell formatter if one is provided.
User name to use for authentication to the mail server
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
Method validate: Frame validation
validateForm Validates the form data
A constant to define vertical alignment of the chart legend's container
A constant to define vertical alignment of the chart legend's container
A constant to define vertical alignment of the chart legend's container
The value of the data item
The value of the data item
The value of the header attribute.
The cell's value
Filter value
An Ag Grid expression which can be executed to format the value for display.
#Configuration
#ColumnsRenderer.
An Ag Grid expression which can be executed before getting the value from your data for display
#Configuration
#ColumnsRenderer.
An Ag Grid expression which can be executed to parse the value for saving.
#Configuration
#ColumnsRenderer.
An array of values to allow the user to select from
The values to display in the filter. If this is not set, then the filter will takes its values from what is loaded in the table. Setting it allows you to set values where the value may not be present in the list for example, if you want to show all states in America so that the user is not confused by missing states, even though states are missing from the data set in the grid
The values to display in the filter. If this is not set, then the filter will takes its values from what is loaded in the table. Setting it allows you to set values where the value may not be present in the list (for example, if you want to show all states in America so that the user is not confused by missing states, even though states are missing from the data set in the grid)
An Ag Grid expression which can be executed before setting the value into your data for saving.
#Configuration
#ColumnsRenderer.
A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable
A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable
A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable
A number that determines the default vertical alignment for cells in the grid. The default value is BBjGrid.CENTER_ALIGNMENT
A number that determines whether the vertical scrollbar will appear if there are more rows than can be displayed in the grid's client area. The default value is 1.
Translated text for view
View menu name
Creates a table representation of the supplied DefaultCategoryDataset and displays it in a message box.
This is primary aimed at debugging by providing a view into what a bar or line chart's dataset looks like.
Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine
Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine
Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine
Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine
Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine
Creates a table representation of the chart's DefaultPieDataset and displays it in a message box.
This is primary aimed at debugging by providing a view into what a pie or ring chart's dataset looks like.
A sample use case would be:
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's datasetmyPieChartWidget!.viewDataSet()
Creates a table representation of the chart's DefaultCategoryDataset and displays it in a message box.
This is primary aimed at debugging by providing a view into what a bar or line chart's dataset looks like.
A sample use case would be:
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's datasetmyBarChartWidget!.viewDataSet()
Creates a table representation of the chart's DefaultCategoryDataset and displays it in a message box.
This is primary aimed at debugging by providing a view into what a bar or line chart's dataset looks like.
A sample use case would be:
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's datasetmyLineChartWidget!.viewDataSet()
Constant which represents the viewer window name
Viewer window
Creates a table representation of the supplied DefaultCategoryDataset and displays it in a message box.
This is primary aimed at debugging by providing a view into what a pie or ring chart's dataset looks like.
Views tab control name
Specifies the number of pages of the filled report created in memory before virutalization will begin.
Scroll event handler for the vertical scrollbar
Scroll timer event handler
Output a warning message on the console and Debug.log file
Output a warning message on the console and Debug.log file
Constant value to define "warning" log messages
Widget Interface that comprises all the functionality required to be a widget
Widget that the event occurred on
Widget that the event occurred on
BBjGridExWidget instance
BBjGridExWidget instance
The widget instance
A constant used with WidgetSizingModel to define dynamic widget sizing
A constant used with WidgetSizingModel to define fixed widget sizing
Custom object containing the method to be called when the DashboardWidgetClick event is processed
Name of the subroutine or method that is to be called when the DashboardWidgetClick event is processed
Unique name to identify the DashboardWidgetClick event
WidgetControl UI class that displays a widget
Contructs a widget control
The WidgetControl (UI class) that's associated with the DashboardWidget (Data class). You can query the WidgetControl for UI specifics, such as size and location that may be useful when responding to the click event.
Custom object containing the method to be called when the DashboardWidgetLeftClick event is processed
Name of the subroutine or method that is to be called when the DashboardWidgetLeftClick event is processed
Unique name to identify the DashboardWidgetLeftClick event
BBjVector containing the midpoints for the widgets
Refresh event callback object
Refresh event callback object.
Refresh event callback routine
Refresh event callback routine.
Refresh event name
Refresh event name.
Custom object containing the method to be called when the DashboardWidgetRightClick event is processed
Name of the subroutine or method that is to be called when the DashboardWidgetRightClick event is processed
Unique name to identify the DashboardWidgetRightClick event
The text to display when initializing the categories and widgets.
The text to display when displaying the BUI BBjBusyIndicator.
Select event callback object
Select event callback routine
Select event name
Determines how the dashboard will size the widgets in a category. The WIDGIT_SIZING constants define the options, which include fixed sizing and dynamic sizing.
WidgetSizingModel attribute
X location of the window that houses the widget control
Y location of the window that houses the widget control
Wizard uses to create widgets and dashboards
Constructor WidgetWizard
Wizard Frame Class
Constructor WidgetWizardFrame
Dashboard/Widget Type Selection Frame (Frame 1)
Constructor WidgetWizardFrame1
Generate Container Type Frame (Frame 2)
Constructor WidgetWizardFrame2
Title, Name, and Source File Frame (Frame 3)
Constructor WidgetWizardFrame3
Generate Dashboard Category Frame (Frame 4)
Constructor WidgetWizardFrame4
Generate Dashboard Widgets Frame (Frame 5)
Constructor WidgetWizardFrame5
Generate Frame
Constructor WidgetWizardFrame6
Generate Frame
Constructor WidgetWizardFrame7
Generate Frame
Constructor WidgetWizardFrame8
Wizard Frame Factory Class
Constructor WidgetWizardFrameFactory
Wizard Frame Interface
Width
Setup the suggestion list width in pixels
Initial width in pixels
#Configuration
#ColumnsRenderer
Note: setting the width to zero will not hide the column, use setHidden() instead. And if the width is null()
this means the grid will auto set the width for this column
The image's width
Constant which represents that an error occured in the window
Constant that represents a window error
Window Title
Programmatically saves a screenshot of the chart as a PNG file on the server with the specified path after the chart has been created
Programmatically saves a screenshot of the chart at the desired width and height as a PNG file on the server with the specified path after the chart has been created
writeToClientFile Creates a client export file and set it's contents to the passed string
writeToServerFile Creates a server export file and set it's contents to the passed string
The X value of the data item
XHMTL exporter which contains export options
XLS exporter which contains export options
Constant that represents the multiple sheet XLSX save contributor
Constant that represents the multiple sheet XLSX save contributor
XLSX exporter which contains export options
Handle web connections and execute a command via a provided XML string
Constant that represents the XML save contributor
Constant that represents the XML save contributor
XML exporter which contains export options
XY chart widget type constant
XYChartWidget A Dashboard Utility Widget that displays an XY line chart that can display multiple data series simultaneously
Create an empty XY Chart specifying all parameters to be filled after creation with setSeriesXYValue()
Create an SQL-based XY Chart specifying all parameters
Create a BBjRecordSet-based XY Chart specifying all parameters
Create an SQL-based XY Chart specifying all parameters
XYSeriesDataItem An XYSeriesDataItem extends the base DataItem class and is used for XYCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity.
A XYSeriesDataItem describes a dataset item comprising of one or more series (with a series number and associated key), the item in the series, and the X and Y values for the item.
Contructs a XYSeriesDataItem
The Y value of the data item
Translated text for zoom in
Translated text for zoom in
Zoom in menu item name
Zoom in menu item name
Zoom in tool button name
Zoom in tool button name
Width of the zoom list edit, the default is 80
Zoom list edit name
Zoom list edit name
Translated text for zoom out
Translated text for zoom out
Zoom out menu item name
Zoom out menu item name
Zoom out tool button name
Zoom out tool button name
Translated text for zoom ratio
Translated text for zoom ratio
Zoom level