Other  A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

Other

" - field in class BBJasper.BBJasperView

Translated text for find results


"." - field in class BBJasper.BBJasperView

Translated text for found


"." - field in class BBJasper.BBJasperView

Translated text for not found


"." - field in class BBJasper.BBJasperView

Translated text for selected


"..." - field in class BBJasper.BBJasperView

Translated text for default find text


Other

_break_ - field in class GxClientEvents.GxClientEventsCell

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()


A

AccentedSort! - field in class GxOptions.GxOptions

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


accept(BBjNumber valid) - method in class QVGrid.QVGrid

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.


actionPerformed(ActionEvent@ p_event!) - method in class BBLaunchDock

activate(BBjNumber p_activate) - method in class Dashboard.WidgetControl

Activate or deactivates the widget control by setting its visibility and creating the Widget if necessary


activate(BBjNumber p_activate) - method in class Dashboard.DashboardWidgetControl

Activates/Deactivates the dashboard widget control


activateWidget(DashboardWidgetControl p_dashboardWidgetControl!, BBjNumber p_activate) - method in class Dashboard.DashboardCategoryControl

Sets the active dashboard widget control that is part of the dashboard category control


Active - field in class Dashboard.DashboardWidgetAttribute

Active status attribute


active() - method in class Dashboard.BaseWidget

Returns the active status of the widget


ACTUAL_SIZE$=#Translations!.getTranslation("actual.size") - field in class BBJasper.BBJasperViewerControl

Translated text for actual size


ACTUAL_SIZE$=#Translations!.getTranslation("actual.size") - field in class BBJasper.BBJasperView

Translated text for actual size


ACTUAL_SIZE_MENU_ITEM_NAME$="BBJVActualSizeMenuItem" - field in class BBJasper.BBJasperView

Actual size menu item name


ACTUAL_SIZE_MENU_ITEM_NAME$=BBJasperView.getACTUAL_SIZE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Actual size menu item name


ActualSize=-1 - field in class Dashboard.JasperViewerWidget

Actual size


add(BBjString column!, BBjString sorting!) - method in class GxClientModels.GxClientSortModel

Add new column sorting to the model


add(DataRow row!) - method in class GxClientModels.GxClientTransactionModel

Add new row


add(BBjString language$, BBjString path$) - method in class BBjGridExWidget.GxLanguageManager

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


Add! - field in class GxClientModels.GxClientTransactionModel

An array of rows to add


ADD_USER - field in class Admin

addACL(GACL acl!) - method in class gappsv3.GCalendarAPI

or relocating.)


addAlignedGrid(BBjGridExWidget widget!) - method in class BBjGridExWidget.BBjGridExWidget

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.


addAppServerResource(BBjString p_file$, BBjString p_mimetype$) - method in class BBUtils.BBUtils

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:

  • text/css
  • image/png
  • image/jpg
  • image/gif

Example


 BBUtils.addAppServerResource(myPngFilePath$, BBUtils.getMIME_TYPE_PNG())
 

addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

Creates and returns an AreaChartWidget dashboard widget


addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

Creates and returns an AreaChartWidget dashboard widget


addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

Creates and returns an AreaChartWidget dashboard widget


addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

Creates and returns an AreaChartWidget dashboard widget


addAttendee(GEventAttendee attendee!) - method in class gappsv3.GEvent

Add one participant to the list of people who are attending the meeting.


addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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(BBjString bcc$) - method in class Email.Email

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(BBjVector bccAddresses!) - method in class Email.Email

addBcc Adds recipients to the "bcc" field in an email's header before the email is sent.


addBuildItemCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class WidgetWizard

addBuildItemWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetWizard

addCalendar(GCalendar calendar!) - method in class gappsv3.GCalendarAPI

Add Calendar. (Not implemented. Subject to removal or relocating.)


addCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class BuildItem

addCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class WidgetBuildItem

addCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class WidgetSetBuildItem

addCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class WidgetDashboardBuildItem

addCc(BBjString cc$) - method in class Email.Email

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(BBjVector ccAddresses!) - method in class Email.Email

addCc Adds recipients to the "cc" field in an email's header before the email is sent.


addCDATANode(Element p_parentElement!, BBjString p_cdata$) - method in class BBXMLDoc

addCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$) - method in class QVGrid.QVGrid

Adds a CSS style name to a grid cell


addChartDomainMarker(BBjString p_key$, BBjString p_markerColorDesc$, BBjNumber p_markerOpacity, BBjString p_label$, BBjString p_labelColorDesc$, BBjNumber p_labelOpacity, RectangleAnchor p_rectangleAnchor!, TextAnchor p_textAnchor!) - method in class Dashboard.ChartWidget

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.


addChartRangeMarker(BBjNumber p_value, BBjString p_colorDesc$, BBjNumber p_opacity, BBjString p_label$, BBjString p_labelColorDesc$, BBjNumber p_labelOpacity, RectangleAnchor p_rectangleAnchor!, TextAnchor p_textAnchor!) - method in class Dashboard.ChartWidget

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.


addChartToolbarItem(BBjString item!) - method in class BBjGridExWidget.BBjGridExWidget

Enable a chart toolbar item


#Enterprise
#Configuration
#API


addChild(TreeNode p_child!) - method in class TreeNode

addChild(Locale p_locale!, BBTranslations p_translations!) - method in class BBTranslator.BBTranslations

Adds a child translation to the translations


addClassName(BBjString className!) - method in class BBjCalendarWidget.CalendarEntry

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; } ")


addColorOverlay(BBjColor p_color!) - method in class BBXImage.BBXImage

Method to overlay the BBXImage with a BBjColor (which usually has an alpha component)


addColorOverlay(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity) - method in class BBXImage.BBXImage

Method to overlay the BBXImage with a color (which usually has an alpha component)


addColumn(BBjString column_name$) - method in class BBJasper.BBJasperDesign

addColumn Adds a column given just its name


addColumn(BBjString column$, BBjString label$, BBjNumber length, BBjString type$, BBjString mask$, BBjString justification$, BBjString expression$) - method in class BBJasper.BBJasperDesign

addColumn Adds a column with all of its attributes


addColumn(GxColumn definition!) - method in class BBjGridExWidget.BBjGridExWidget

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjNumber type!) - method in class BBjGridExWidget.BBjGridExWidget

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!) - method in class BBjGridExWidget.BBjGridExWidget

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!, BBjNumber type!) - method in class BBjGridExWidget.BBjGridExWidget

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!) - method in class BBjGridExWidget.BBjGridExWidget

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(GxColumn definition!) - method in class GxColumns.GxColumnsManagerInterface

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjNumber type!) - method in class GxColumns.GxColumnsManagerInterface

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!) - method in class GxColumns.GxColumnsManagerInterface

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!, BBjNumber type!) - method in class GxColumns.GxColumnsManagerInterface

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!) - method in class GxColumns.GxColumnsManagerInterface

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(GxColumn definition!) - method in class GxColumns.GxColumnsManager

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjNumber type!) - method in class GxColumns.GxColumnsManager

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!) - method in class GxColumns.GxColumnsManager

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!, BBjNumber type!) - method in class GxColumns.GxColumnsManager

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!) - method in class GxColumns.GxColumnsManager

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(GxColumn definition!) - method in class GxColumns.GxColumnGroup

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjNumber type!) - method in class GxColumns.GxColumnGroup

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!) - method in class GxColumns.GxColumnGroup

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!, BBjString label!, BBjNumber type!) - method in class GxColumns.GxColumnGroup

Add new column definition


#Configuration
#ColumnsRenderer


addColumn(BBjString field!) - method in class GxColumns.GxColumnGroup

Add new column definition


#Configuration
#ColumnsRenderer


addColumnGroup(GxColumnGroup definition!) - method in class BBjGridExWidget.BBjGridExWidget

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!) - method in class BBjGridExWidget.BBjGridExWidget

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!) - method in class BBjGridExWidget.BBjGridExWidget

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!, BBjVector columns!, BBjNumber marryChildren!, BBjString headerClass! ) - method in class BBjGridExWidget.BBjGridExWidget

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!, BBjVector columns!, BBjNumber marryChildren!) - method in class BBjGridExWidget.BBjGridExWidget

Group Vector of Columns


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!, BBjVector columns!) - method in class BBjGridExWidget.BBjGridExWidget

Group Vector of Columns


#Configuration
#ColumnsRenderer


addColumnGroup(GxColumnGroup definition!) - method in class GxColumns.GxColumnsManagerInterface

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManagerInterface

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!) - method in class GxColumns.GxColumnsManagerInterface

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(GxColumnGroup definition!) - method in class GxColumns.GxColumnsManager

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManager

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!) - method in class GxColumns.GxColumnsManager

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(GxColumnGroup definition!) - method in class GxColumns.GxColumnGroup

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!) - method in class GxColumns.GxColumnGroup

Add column group


#Configuration
#ColumnsRenderer


addColumnGroup(BBjString id!, BBjString label!) - method in class GxColumns.GxColumnGroup

Add column group


#Configuration
#ColumnsRenderer


addColumnStyleName(BBjNumber column, BBjString styleName$) - method in class QVGrid.QVGrid

Adds a CSS style name to a grid column


addCommentNode(Element p_parentElement!, BBjString p_comment$) - method in class BBXMLDoc

addComponent(GxStatusBarComponentInterface component!) - method in class GxStatusBar.GxStatusBar

Add statusbar component


addDashboardCategory(BBjString p_categoryName$, BBjString p_categoryTitle$) - method in class Dashboard.Dashboard

Adds a dashboard category, which is used to group widgets, to the dashboard


addDashboardWidget(Widget p_widget!) - method in class Dashboard.DashboardCategory

Creates an active DashboardWidget based on the provided widget and adds it to the current category


addDashboardWidget(Widget p_widget!, BBjNumber p_active) - method in class Dashboard.DashboardCategory

Creates an active or inactive DashboardWidget based on the provided widget and adds it to the current category


addDashboardWidget(DashboardWidget p_dashboardWidget!) - method in class Dashboard.DashboardCategory

Adds a dashboard widget to the end of the dashboard category


addData(BBjString data$, BBjString mime$) - method in class Email.Email

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(FileInputStream fis!, BBjString mime$) - method in class Email.Email

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


addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius) - method in class BBjBUIDialChart.BBjBUIDialChart

addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius, Color needleColor!, Color pointerFillColor!, Color pointerOutlineColor!) - method in class BBjBUIDialChart.BBjBUIDialChart

addDocument(BBjString documentPath$) - method in class FaxJob

addDocument(BBjString documentPath$) - method in class FaxJobBase

addDocument(BBjString documentPath$) - method in class PDFFaxJob

addDocuments(BBjVector documents!) - method in class FaxJob

addDocuments(BBjVector documents!) - method in class FaxJobBase

addElement(Element p_parentElement!, BBjString p_tagName$) - method in class BBXMLDoc

addElementWithAttribute(Element p_parentElement!, BBjString p_tagName$, BBjString p_attrName$, BBjString p_attrValue$) - method in class BBXMLDoc

addElementWithAttributes(Element p_parentElement!, BBjString p_tagName$, HashMap p_attributes!) - method in class BBXMLDoc

addElementWithCDATA(Element p_parentElement!, BBjString p_tagName$, BBjString p_cdata$) - method in class BBXMLDoc

addElementWithTextNode(Element p_parentElement!, BBjString p_tagName$, BBjString p_nodeText$) - method in class BBXMLDoc

addEmail(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_emailAddress$, BBjString p_firstName$, BBjString p_lastName$) - method in class BUS

addEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType) - method in class Email.EmailDialog

addEmailAddress Adds an email address to the appropriate list


addEmailAddress(BBjString p_firstName$, BBjString p_lastName$, BBjString p_emailAddress$, BBjNumber p_emailType) - method in class Email.EmailDialog

addEmailAddress Adds an email address to the appropriate list


addEmailAttachment(BBjString p_emailAttachment$) - method in class Email.EmailDialog

addEmailAttachment Adds a file as an email attachment


addEmailContact(EmailContact p_emailContact!) - method in class Email.EmailDialog

addEmailContact Adds an email contact to the contact list


addEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType) - method in class Email.EmailDialog

addEmailContact Adds an email contact to the appropriate list


addEmailContacts(BBjVector p_emailContacts!) - method in class Email.EmailDialog

addEmailContacts Adds email contacts to the contact list


addEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType) - method in class Email.EmailDialog

addEmailContacts Adds email contacts to the appropriate list


addEmbeddedWidget(EmbeddedWidget p_embeddedWidget!) - method in class Dashboard.EmbeddedWidgetSet

Adds an embedded widget to the embbeded widget set


addEntries(JsonArray entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


addEntries(BBjVector entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


addEntry(JsonObject entry!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


addEntry(CalendarEntry entry!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


addEntrySource(CalendarEntrySource entrySource!) - method in class BBjCalendarWidget.BBjCalendarWidget

Adds entries to the calendar from a CalendarEntrySource.


addEvent(GEvent event!) - method in class gappsv3.GCalendar

Add an event to the calendar.


addEvent(GEvent gevent!) - method in class gappsv3.GEvents

addExtendedProperty(BBjString key!, BBjString value!) - method in class BBjCalendarWidget.CalendarEntry

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(BBjString p_field$) - method in class BBJasper.DatabaseType

addField Adds a field to the database fields vector


addFile(BBjString filename$) - method in class Email.Email

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(BBjString filename$, BBjString contentID$) - method in class Email.Email

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(BBjString filename$, BBjString contentID$, BBjString mime$) - method in class Email.Email

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.


addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation) - method in class Dashboard.DashboardWidget

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.


addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) - method in class Dashboard.DashboardWidget

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.


addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation) - method in class Dashboard.DashboardWidget

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.


addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) - method in class Dashboard.DashboardWidget

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.


addFilter(DashboardWidgetFilter p_dashboardWidgetFilter!) - method in class Dashboard.WidgetControl

Adds a filter to the dashboard control to filter values


addFilter(BBjString p_filterName$, BBjString p_filter$) - method in class GDocSelectionDialog

addFilter(BBjString p_filterName$, BBjVector p_filter!) - method in class GDocSelectionDialog

addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - method in class Dashboard.DashboardCategory

Creates and returns a GridWidget dashboard widget


addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

Creates and returns a GridWidget dashboard widget


addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

Creates and returns a GridWidget dashboard widget


addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

Creates and returns a GridWidget dashboard widget


addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.DashboardCategory

Creates and returns a GridWidget dashboard widget


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - method in class Dashboard.DashboardCategory

Creates and returns an empty GridWidget dashboard widget


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, ResultSet p_resultSet!) - method in class Dashboard.DashboardCategory

Creates and returns a GridExWidget dashboard widget based on a BASIS Components ResultSet that contains the data for the widget


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_file$, BBjString p_template$, DataRow p_filter!) - method in class Dashboard.DashboardCategory

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


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

Creates and returns a GridExWidget dashboard widget using a connection string and SQL query


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

Creates and returns a GridExWidget dashboard widget using a connection string, SQL query, and mode


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

Creates and returns a GridExWidget dashboard widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data


addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.DashboardCategory

Creates and returns a GridExWidget dashboard widget using BBjVectors for the column header data and row data


addGroup(BBjString column_name$) - method in class BBJasper.BBJasperDesign

addGroup Adds a group given just its column name (ie. group has to be a column)


addHeader(BBjString key!, BBjString value!) - method in class BBWebClient.BBWebRequest

Adds the specified header to the request.


addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - method in class Dashboard.DashboardCategory

Creates and returns an HtmlViewWidget dashboard widget


addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_text$) - method in class Dashboard.DashboardCategory

Creates and returns an HtmlViewWidget dashboard widget


addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - method in class Dashboard.DashboardCategory

Creates and returns an ImageWidget dashboard widget


addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$) - method in class Dashboard.DashboardCategory

Creates and returns an ImageWidget dashboard widget


addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!) - method in class Dashboard.DashboardCategory

Creates and returns an ImageWidget dashboard widget


addImageInline(BBjString filename$, BBjString contentID$, BBjString mime$) - method in class Email.Email

addImageInline Adds an image to the email in such a way that it can be inlined into the HTML content.


AddIndex! - field in class GxClientModels.GxClientTransactionModel

Index for rows to add


AddingCategory - field in class WidgetDashboardBuildItem

addItem(BBjString label!, BBjString value!, BBjString group!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

add a new suggestion item


addItem(BBjString label!, BBjString value!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Add a new suggestion item


addItem(BBjString label!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Add a new suggestion item


addItem(GxContextMenuItemInterface item!) - method in class GxContextMenu.GxContextMenu

Add new context menu item


addItem(BBjString item!) - method in class GxContextMenu.GxContextMenu

Add a predefined context menu item


addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!) - method in class Dashboard.DashboardCategory

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.


addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) - method in class Dashboard.DashboardCategory

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.


addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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.


addLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect) - method in class Dashboard.DashboardWidget

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.


addLink(DashboardWidgetLink p_dashboardWidgetLink!) - method in class Dashboard.WidgetControl

Adds a link that can be used to invoke a URL for the dashboard control


addLocale(Locale p_locale!) - method in class BBTranslator.BBTranslationBundle

addMenu(BBjPopupMenu p_menu!, BBjNumber p_triggerType) - method in class Dashboard.DashboardWidget

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.


addNotification(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_emailAddress$) - method in class BUS

addParameter(ProcedureParam p_param!) - method in class BBJasper.ProcedureType

addParameter Adds a ProcedureParam object to the procedure parameters vector


addPhoneNumber(BBjString phoneNo$) - method in class FaxJob

addPhoneNumber(BBjString phoneNo$) - method in class FaxJobBase

addPhoneNumbers(BBjVector phoneNos!) - method in class FaxJob

addPhoneNumbers(BBjVector phoneNos!) - method in class FaxJobBase

addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - method in class Dashboard.DashboardCategory

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.


addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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.


addPivotColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Enable pivot for columns


#Enterprise
#Configuration
#API


addPopupMenu() - method in class QVGrid.QVGrid

Adds a popup menu to the grid control


addPrintAttribute(PrintRequestAttribute p_printRequestAttribute!) - method in class BBJasper.BBJasperPrintServiceExporter

addPrintAttribute Adds a print attribute


addRangeChart(GxClientAddRangeChartModel model!) - method in class BBjGridExWidget.BBjGridExWidget

Clear already created charts. Note that this method does not clear user created charts


#API


addRangeSelection(GxClientAddRangeSelectionModel model!) - method in class BBjGridExWidget.BBjGridExWidget

Add new range selection


#API


addRangeSelection(BBjString columns!, BBjString start!, BBjString end!) - method in class BBjGridExWidget.BBjGridExWidget

Add new range selection


#API


addRangeSelection(BBjString columns!, BBjNumber start!, BBjNumber end!) - method in class BBjGridExWidget.BBjGridExWidget

Add new range selection


#API


addRangeSelection(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Add new range selection


#API


addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - method in class Dashboard.DashboardCategory

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.


addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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.


addRootElement(BBjString p_nodeTag$) - method in class BBXMLDoc

addRow(BBjNumber index!, DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Add new row


#API


addRow(DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Add new row at the beginning of the grid


#API


addRowGroupColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Enable row grouping for columns


#Enterprise
#Configuration
#API


addRowStyleName(BBjNumber row, BBjString styleName$) - method in class QVGrid.QVGrid

Adds a CSS style name to a grid row


addSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperViewerControl

addSaveContributor Adds a save contributor


addSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperView

addSaveContributor Adds a save contributor


addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

Creates and returns a StackedAreaChartWidget dashboard widget


addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

Creates and returns a StackedAreaChartWidget dashboard widget


addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

Creates and returns a StackedAreaChartWidget dashboard widget


addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

Creates and returns a StackedAreaChartWidget dashboard widget


addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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.


addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

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.


addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

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.


addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

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.


addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

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.


addStyle(String styleName!) - method in class QVGrid.QVGrid

Adds a CSS style name to the grid control


addStyle(BBjString style!) - method in class BBjCalendarWidget.BBjCalendarWidget

Adds the provided CSS style name to the widget.


addStyle(BBjString selector$, JsonObject rules! ) - method in class BBjGridExWidget.BBjGridExWidget

Add Style block


#API


addStyle(BBjString selector$, BBjString rules! ) - method in class BBjGridExWidget.BBjGridExWidget

Add Style block


#API


addTag(BBjString tag!) - method in class BBjCalendarWidget.CalendarEntry

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(BBjString text$) - method in class Email.Email

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


addTextNode(Element p_parentElement!, BBjString p_text$) - method in class BBXMLDoc

addTo(BBjString to$) - method in class Email.Email

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(BBjVector toAddresses!) - method in class Email.Email

addTo Adds recipients to the "to" field in an email's header before the email is sent.


addToolbarButton(BBjString p_image$, BBjString p_shortCue$) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button at the end of the tool bar


addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button at the end of the tool bar


addToolbarButton(BBjNumber p_IconImageListIndex, BBjString p_shortCue$, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button at the end of the tool bar


addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar at the specified index


addToolbarButton(BBjString p_image$, BBjString p_shortCue$, BBjNumber p_width, BBjNumber p_height, BBjString p_text$, BBjNumber p_id, BBjNumber p_index, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar at the specified index


addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index) - method in class BBJasper.BBJasperViewerControl

addToolbarChildWindow Adds a child window to the tool bar at the specified index


addToolbarChildWindow(BBjNumber p_width, BBjNumber p_height, BBjString p_title$, BBjString p_flags$, BBjNumber p_index, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolbarChildWindow Adds a child window to the tool bar at the specified index


addToolbarSpacer() - method in class BBJasper.BBJasperViewerControl

addToolbarSpacer Adds a tool bar spacer at the end of the tool bar


addToolbarSpacer(BBjNumber p_index) - method in class BBJasper.BBJasperViewerControl

addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar


addToolbarSpacer(BBjNumber p_index, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolbarSpacer Adds a tool bar spacer at the specified index of the tool bar


addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar


addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar


addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar


addToolButton(BBjNumber p_id, BBjString p_text$, BBjString p_shortCue$, BBjString p_image$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_index, BBjString p_name$) - method in class BBJasper.BBJasperViewerControl

addToolButton Adds a tool button to the tool bar


addToPgmCallbacks(BBjNumber selectedIndex) - method in class DialogWizard.DialogWizardFrame3

Method addToPgmCallbacks: Add event to program callbacks, if not already existing


addTranslation(BBjString p_key$, HashMap p_values!) - method in class BBTranslator.BBTranslationBundle

addTranslation(BBjString p_key$, HashMap p_values!, BBjNumber p_skip_existing) - method in class BBTranslator.BBTranslationBundle

addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$) - method in class BBTranslator.BBTranslationBundle

addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing) - method in class BBTranslator.BBTranslationBundle

addTranslation(BBjString p_key$, BBjString p_value$) - method in class BBTranslator.BBTranslations

Adds a translation to the translations given a key and value


addTranslation(BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing) - method in class BBTranslator.BBTranslations

Adds a translation to the translations given a key and value, optionally skipping existing keys


addTranslations(HashMap p_translations!) - method in class BBTranslator.BBTranslations

Adds the translations provided in the passed hash map to the translations


addTranslations(HashMap p_translations!, BBjNumber p_skip_existing) - method in class BBTranslator.BBTranslations

Adds the translations provided in the passed hash map to the translations, optionally skipping existing entries


addType(BBjString p_typeName$, BBjString p_type$) - method in class GDocSaveDialog

addUpdate(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjString p_location$, BBjString p_date$, BBjInt p_size%, BBjString p_comment$, BBjInt p_active%) - method in class BUS

addUser(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$, BBjString p_password$, BBjInt p_adminUpdates%, BBjInt p_adminDatabase%, BBjInt p_adminEmail%, BBjInt p_adminNotifications%, BBjInt p_adminUsers%) - method in class BUS

addValueColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Enable value for columns


#Enterprise
#Configuration
#API


addView(BBJasperReport p_report!) - method in class BBJasper.BBJasperTabbedView

Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport using the report name for the window and tab titles


addView(BBJasperReport p_report!, BBjString p_windowTitle$, BBjString p_tabTitle$) - method in class BBJasper.BBJasperTabbedView

Adds and returns a BBJasperView object (tab and child window) for the passed BBJasperReport


addViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) - method in class BBJasper.BBJasperViewerControl

addViewerWindow Adds a viewer window to the vector of viewer windows


addViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) - method in class BBJasper.BBJasperView

addViewerWindow Adds a viewer window to the vector of viewer windows


addViews(BBjVector p_reports!) - method in class BBJasper.BBJasperTabbedView

Adds and returns a vector of BBJasperView objects (tab and child window) for the passed vector of BBJasperReport objects


addWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class BuildItem

addWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetBuildItem

Adds a widget


addWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetSetBuildItem

addWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetDashboardBuildItem

Adds a widget


addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DashboardCategory

Creates and returns an XYChartWidget dashboard widget


addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.DashboardCategory

Creates and returns an XYChartWidget dashboard widget


addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DashboardCategory

Creates and returns an XYChartWidget dashboard widget


addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.DashboardCategory

Creates and returns an XYChartWidget dashboard widget


adjustColorBrightness(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Lighten or Darken a Color by a specified amount


adjustColorOpacity(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Sets the opacity for a Color to a specified amount


adjustColorSaturation(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Saturate or Desaturate a Color by a specified amount


adjustColorVectorBrightness(BBjVector p_colorVector!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Lighten or Darken every color in the vector by a specified amount


adjustColorVectorOpacity(BBjVector p_colorVector!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Increase or decrease the opacity for every color in the vector to a specified amount


adjustColorVectorOpacityToFixedAmount(BBjVector p_colorVector!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets the opacity to a fixed amount for every color in the vector


adjustColorVectorSaturation(BBjVector p_colorVector!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Saturate or Desaturate every color in the vector by a specified amount


adjustSpacesWhenDisplaying(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces) - method in class QVGrid.QVGrid

Adjusts, for a given column, the spaces contained in data before displaying within a cell


adjustSpacesWhenSaving(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces) - method in class QVGrid.QVGrid

Adjusts, for a given column, the spaces the user entered before returning it to the program


Admin - class in this project

Admin() - constructor in class Admin

AdminLoginDialog - class in this project

AdminLoginDialog(Admin p_admin!) - constructor in class AdminLoginDialog

AdminPassword$ - field in class GoldMineIntegration.GoldMineIntegrationWebService

The default admin password which is needed to publish the service.


AggFunc! - field in class GxColumns.GxDefaultColumnDefinition

Name of function to use for aggregation. One of [sum, min, max, first, last].


#Configuration
#ColumnsRenderer


AggFuncs! - field in class GxStatusBar.GxStatusBarAggregationComponent

agg functions to show on the panel. possible values are: 'count', 'sum', 'min', 'max', 'avg'


Aggregate! - field in class GxClientModels.GxClientAddRangeChartModel

When set to true, series values will be summed for each category before charting.


ALIGN_BOTTOM() - method in class BBXImage.BBXImage

A constant value that's used to denote bottom vertical alignment


ALIGN_CENTER() - method in class BBXImage.BBXImage

A constant value that's used to denote center horizontal alignment


ALIGN_CENTER=1 - field in class Dashboard.DashboardWidget

Constant specifying that the DashboardWidget's title should be aligned in the center.


ALIGN_LEFT() - method in class BBXImage.BBXImage

A constant value that's used to denote left horizontal alignment


ALIGN_LEFT=0 - field in class Dashboard.DashboardWidget

Constant specifying that the DashboardWidget's title should be aligned left.


ALIGN_MIDDLE() - method in class BBXImage.BBXImage

A constant value that's used to denote middle vertical alignment


ALIGN_RIGHT() - method in class BBXImage.BBXImage

A constant value that's used to denote right horizontal alignment


ALIGN_RIGHT=2 - field in class Dashboard.DashboardWidget

Constant specifying that the DashboardWidget's title should be aligned right.


ALIGN_TOP() - method in class BBXImage.BBXImage

A constant value that's used to denote top vertical alignment


Alignment! - field in class GxStatusBar.GxStatusBarComponent

The component alignment


ALL_DOCUMENTS_FILTER_NAME$="ALL_DOCUMENTS" - field in class GDocSelectionDialog

ALL_FILES$=#Translations!.getTranslation("all.files") - field in class BBJasper.BBJasperViewerControl

Translated text for all files


ALL_FILES$=#Translations!.getTranslation("all.files") - field in class BBJasper.BBJasperView

Translated text for all files


ALL_PERMISSIONS - field in class Admin

AllColumnsUserSortable - field in class Dashboard.GridWidget

A number that acts as a boolean, determining whether the grid should configure all columns to be sortable


ALLOW_ADMIN - field in class Admin

AllowCustomValues! - field in class GxCellEditors.GxCellEditorSuggestion

When true , then input values which are not part of the suggestion list will be accepted , rejected otherwise


AllowedAggFuncs! - field in class GxColumns.GxDefaultColumnDefinition

Aggregation functions allowed on this column eg ['sum', 'avg'].


#Configuration
#ColumnsRenderer


AllowInput! - field in class GxOptions.GxOptionsDateTime

When true then accepts direct user's input from the input field.


AlphaColor - class in Dashboard

AlphaColor(BBjNumber p_opacity) - constructor in class Dashboard.AlphaColor

ALREADY_EXISTS_ERROR=307 - field in class GDocsService

ALT$=#Translations!.getTranslation("alt") - field in class BBJasper.BBJasperView

Translated text for alt


AlwaysIncludeEmail!=null() - field in class gappsv3.GCalendar

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)


AlwaysShowVerticalScroll! - field in class GxOptions.GxOptions

Set to true to always show the vertical scrollbar.
#Configuration
#GridRenderer


AnimateRows! - field in class GxOptions.GxOptions

Set to true to enable Row Animation.
#Configuration
#GridRenderer


appendReport(BBJasperReport p_report!) - method in class BBJasper.BBJasperReport

appendReport Appends the passed BBJasperReport to the current report


apply(BBjNumber send!) - method in class GxClientModels.GxClientFilterModel

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() - method in class GxClientModels.GxClientFilterModel

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(BBjNumber send!) - method in class GxClientModels.GxClientFilterAbstractModel

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() - method in class GxClientModels.GxClientFilterAbstractModel

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)


ApplyButton! - field in class GxFilters.GxColumnFilterAG

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.


ApplyButton! - field in class GxFilters.GxFilterBasicBoolean

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.


ApplyButton! - field in class GxFilters.GxFilterBasicDateTime

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.


applyCss(BBjString p_app$, BBjString p_cssFile$, BBjNumber p_overwrite) - method in class BBUtils.BBUtils

Sets the custom CSS for the specified BUI app.

This is similar to the setBUICSS() method.


ApplyMiniFilterWhileTyping! - field in class GxFilters.GxFilterSetFilter

Set to true to apply the Set Filter immediately when the user is typing in the Mini Filter. Default: false


approve(BBjFileChooserApproveEvent ev!) - method in class FileChooser

approve(BBjFontChooserApproveEvent ev!) - method in class FontChooser

AREA_CHART$ - field in class WidgetWizard

AREA_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Area chart widget type constant


AreaChartWidget - class in Dashboard

AreaChartWidget A Dashboard Utility Widget that displays an area chart which is similar to a filled Line Chart


AreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.AreaChartWidget

Create an empty Area Chart specifying all parameters to be filled after creation with setDataSetValue()


AreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.AreaChartWidget

Create an SQL-based Area Chart specifying all parameters


AreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.AreaChartWidget

Create a BBjRecordSet-based Area Chart specifying all parameters


AreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.AreaChartWidget

Create an SQL-based Area Chart specifying all parameters


asDataRow() - method in class GxClientModels.GxClientRowModel

Convert the client row to a DataRow


asyncExecute(BBjString script!) - method in class BBjGridExWidget.GxExecutor

Executes the specified JavaScript in this BBjHtmlView control and returns immediately


ATTACH_EXISTING_DB - field in class Admin

AUTH_ERROR=304 - field in class BUS

AUTHENTICATED=1 - field in class AdminLoginDialog

AuthorizationToken! - field in class gappsv3.GAppsAuthorization

An authorization token obtained via Google OAuth 2.0


AUTO_SIZE_ALL() - method in class GxContextMenu.GxContextMenuItem

AutoGroupColumnDefinition! - field in class GxOptions.GxOptions

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


AutoHeight! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to have the grid calculate height of row based on contents of this column.


#Configuration
#ColumnsRenderer


AutoRefreshEnabled - field in class Dashboard.DashboardWidgetAttribute

Auto refresh enabled


AutoRefreshRate - field in class Dashboard.DashboardWidgetAttribute

Auto refresh rate


AutoRefreshUnit - field in class Dashboard.DashboardWidgetAttribute

Auto refresh unit


AutoRefreshUnit - class in Dashboard

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.


AutoResizeColumns - field in class Dashboard.GridWidget

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.


AutoResizeGrid - field in class Dashboard.GridWidget

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.


autoSizeColumns(HashSet columns!, BBjNumber skipHeader!) - method in class BBjGridExWidget.BBjGridExWidget

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


autoSizeColumns(HashSet columns!) - method in class BBjGridExWidget.BBjGridExWidget

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


autoSizeColumns(BBjString columns!, BBjNumber skipHeader!) - method in class BBjGridExWidget.BBjGridExWidget

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


autoSizeColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

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


autoSizeColumns(BBjNumber skipHeader!) - method in class BBjGridExWidget.BBjGridExWidget

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


autoSizeColumns() - method in class BBjGridExWidget.BBjGridExWidget

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


AutoSizePadding! - field in class GxOptions.GxOptions

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


AUX_FILES_DIR$ - field in class BBJasper.BBJasperExporter

Directory to store aux files such as images for exports


B

BAR_CHART$ - field in class WidgetWizard

BAR_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Bar chart widget type constant


BarChartWidget - class in Dashboard

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


BarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.BarChartWidget

Create an empty Bar Chart specifying all parameters to be filled after creation with setDataSetValue()


BarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.BarChartWidget

Create an SQL-based Bar Chart specifying all parameters


BarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.BarChartWidget

Create a BBjRecordSet-based Bar Chart specifying all parameters


BarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.BarChartWidget

Create an SQL-based Bar Chart specifying all parameters


BaseBuildItem - class in this project

BaseURL$ - field in class GDocsService

BaseWidget - class in Dashboard

BaseWidget Creates a widget base class that implements the Widget interface


BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION_KEY_NAME$ - field in class Dashboard.BaseWidget

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.


BASIS_UTILITY_DEVICE_PIXEL_RATIO_KEY_NAME$ - field in class Dashboard.BBjWidget

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


BASIS_UTILITY_DEVICE_PIXEL_RATIO_KEY_NAME$ - field in class BBJasper.BBJasperView

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


BBConfig - class in this project

BBDialog - class in DialogWizard

BBDialog

Base Class for General Dialog Handler


BBHeader - class in BBWebClient

An HTTP Request header, which consists of a name/value pair. For example: name="Content-Type" value="text/html"


BBHeader(BBjString Name!, BBjString Value!) - constructor in class BBWebClient.BBHeader

Constructor


BBJ_HOME_PROPERTY$="basis.BBjHome" - field in class BBConfig

BBjAdmin.CONNECTION_POOLS - field in class Admin

BBJasper - class in BBJasper

Provides utility functions for BBJasper modules


BBJASPER_TAB_ON_PARENT_HYPERLINK_TARGET_KEY_NAME$ - field in class BBJasper.BBJasperTabbedView

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.


BBJASPER_TABBED_VIEW_KEY_NAME$="BBJASPER_TABBED_VIEW" - field in class BBJasper.BBJasperViewerControl

Name of STBL key to globally specify if a tabbed view should be used


BBJASPER_WINDOW_ON_BLANK_HYPERLINK_TARGET_KEY_NAME$ - field in class BBJasper.BBJasperTabbedView

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 in BBJasper

BBJasperColumnarTemplate class

Lays out the report in a columnar fashion.


BBJasperColumnarTemplate() - constructor in class BBJasper.BBJasperColumnarTemplate

Constructor Constructs a BBJasperColumnarTemplate based on the 'basis_columnar.jrxml' template file


BBJasperColumnarTemplate(BBjString p_template$) - constructor in class BBJasper.BBJasperColumnarTemplate

Constructor Constructs a BBJasperColumnarTemplate using a specific template file


BBJasperCSVExporter - class in BBJasper

Provides BBJasper CSV exporter operations


BBJasperCSVExporter() - constructor in class BBJasper.BBJasperCSVExporter

Constructor Constructs a empty BBJasperCSVExporter object


BBJasperDesign - class in BBJasper

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'


BBJasperDesign(BBJasperTemplate p_template!) - constructor in class BBJasper.BBJasperDesign

Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate


BBJasperDesign(BBJasperTemplate p_template!, BBjString p_connectString$, BBjString p_query$) - constructor in class BBJasper.BBJasperDesign

Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string and SQL query


BBJasperDesign(BBJasperTemplate p_template!, BBjString p_connectString$, BBjString p_query$, BBjVector p_fields!) - constructor in class BBJasper.BBJasperDesign

Constructor Constructs a BBJasperDesign object with a given BBJasperTemplate, connect string, SQL query and fields vector


BBJasperDesigner - class in BBJasper

Simple example of a dynamic BBJasper report designer.


BBJasperDesigner() - constructor in class BBJasper.BBJasperDesigner

Constructor Constructs a BBJasperDesigner


BBJasperDesigner(BBjString p_user$, BBjString p_password$) - constructor in class BBJasper.BBJasperDesigner

Constructor Constructs a BBJasperDesigner using the given user name and password. Defaults to host 'localhost' and port 2001


BBJasperDesigner(BBjString p_host$, BBjNumber p_port, BBjString p_user$, BBjString p_password$) - constructor in class BBJasper.BBJasperDesigner

Constructor Constructs a BBJasperDesigner using the given host, post, user name and password


BBJasperDOCXExporter - class in BBJasper

Provides BBJasper DOCX exporter operations


BBJasperDOCXExporter() - constructor in class BBJasper.BBJasperDOCXExporter

Constructor Constructs a empty BBJasperDOCXExporter object


BBJasperExporter - class in BBJasper

Provides more granular control of BBJasper export operations


BBJasperExporter() - constructor in class BBJasper.BBJasperExporter

Constructor Creates a empty BBJasperExporter object


BBJasperExporterParameter - class in BBJasper

Provides control of BBJasper exporter paramter operations. Replaces net.sf.jasperreports.engine.JRExporterParameter


BBJasperFill - class in BBJasper

Fills a JasperReport with data


BBJasperFill(JasperReport p_jasperReport!, HashMap p_params!) - constructor in class BBJasper.BBJasperFill

Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters


BBJasperFill(JasperReport p_jasperReport!, HashMap p_params!, Connection p_connection!) - constructor in class BBJasper.BBJasperFill

Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters


BBJasperFill(JasperReport p_jasperReport!, HashMap p_params!, BBjResultSet p_bbjResultSet!) - constructor in class BBJasper.BBJasperFill

Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters


BBJasperFill(JasperReport p_jasperReport!, HashMap p_params!, BBjCollection p_bbjCollection!) - constructor in class BBJasper.BBJasperFill

Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters


BBJasperFill(JasperReport p_jasperReport!, HashMap p_params!, BBJRDataSource p_jrDataSource!) - constructor in class BBJasper.BBJasperFill

Constructor Constructs a BBJasperFill object given a JasperReort object and report parameters


BBJasperHTMLExporter - class in BBJasper

Provides BBJasper HTML exporter operations


BBJasperHTMLExporter() - constructor in class BBJasper.BBJasperHTMLExporter

Constructor Constructs a empty BBJasperHTMLExporter object


BBJasperHtmlResourceHandler - class in BBJasper

BBJasperHtmlResourceHandler() - constructor in class BBJasper.BBJasperHtmlResourceHandler

BBJasperHyperlink - class in BBJasper

BBJasperHyperlink(JRPrintHyperlink p_hyperlink!) - constructor in class BBJasper.BBJasperHyperlink

BBJasperODSExporter - class in BBJasper

Provides BBJasper ODS exporter operations


BBJasperODSExporter() - constructor in class BBJasper.BBJasperODSExporter

Constructor Constructs a empty BBJasperODSExporter object


BBJasperODTExporter - class in BBJasper

Provides BBJasper ODT exporter operations


BBJasperODTExporter() - constructor in class BBJasper.BBJasperODTExporter

Constructor Constructs a empty BBJasperODTExporter object


BBJasperPDFExporter - class in BBJasper

Provides BBJasper PDF exporter operations


BBJasperPDFExporter() - constructor in class BBJasper.BBJasperPDFExporter

Constructor Constructs a empty BBJasperPDFExporter object


BBJasperPPTXExporter - class in BBJasper

Provides BBJasper PPTX exporter operations


BBJasperPPTXExporter() - constructor in class BBJasper.BBJasperPPTXExporter

Constructor Constructs a empty BBJasperPPTXExporter object


BBJasperPrint - class in BBJasper

Provides methods to print and export both server and client JasperPrint objects


BBJasperPrintChromaticity - class in BBJasper

Provides print chromaticity operations


BBJasperPrintChromaticity(Chromaticity p_chromaticity!) - constructor in class BBJasper.BBJasperPrintChromaticity

Constructor Constructs a BBJasperPrintChromaticity object given a Chromaticity object


BBJasperPrintMediaSizeName - class in BBJasper

Provides for print media size operations


BBJasperPrintMediaSizeName(MediaSizeName p_mediaSizeName!) - constructor in class BBJasper.BBJasperPrintMediaSizeName

Constructor Constructs a BBJasperMediaSizeName given a MediaSizeName object


BBJasperPrintMediaSizeName(BBjNumber p_x, BBjNumber p_y, BBjNumber p_units) - constructor in class BBJasper.BBJasperPrintMediaSizeName

Constructor Constructs a BBJasperMediaSizeName given an x, y, and units


BBJasperPrintMediaTray - class in BBJasper

Provides print media tray operations


BBJasperPrintMediaTray(MediaTray p_mediaTray!) - constructor in class BBJasper.BBJasperPrintMediaTray

Constructor Constructs a BBJasperPrintMediaTray object given a MediaTray object


BBJasperPrintOrientation - class in BBJasper

Provides print orientation operations


BBJasperPrintOrientation(OrientationRequested p_orientation!) - constructor in class BBJasper.BBJasperPrintOrientation

Constructor Constructs a BBJasperPrintOrientation object given a OrientationRequested object


BBJasperPrintQuality - class in BBJasper

Provides print quality operations


BBJasperPrintQuality(PrintQuality p_printQuality!) - constructor in class BBJasper.BBJasperPrintQuality

Constructor Constructs a BBJasperPrintQuality object given a PrintQuality object


BBJasperPrintServiceExporter - class in BBJasper

Provides for print service export operations


BBJasperPrintServiceExporter() - constructor in class BBJasper.BBJasperPrintServiceExporter

Constructor Creates a empty BBJasperPrintServiceExporter object


BBJasperPrintServiceExporterParameter - class in BBJasper

Provides control of BBJasper print server exporter paramter operations. Replaces net.sf.jasperreports.engine.export.JRPrintServiceExporterParameter


BBJasperPrintSides - class in BBJasper

Provides print sides operations


BBJasperPrintSides(Sides p_sides!) - constructor in class BBJasper.BBJasperPrintSides

Constructor Constructs a BBJasperPrintSides object given a Sides object


BBJasperProgress - class in BBJasper

Shows a cancelable progress window while a JasperReport is being filled with data


BBJasperProgress(BBjString p_reportName$, BBjString p_bbJasperProgressKey$) - constructor in class BBJasper.BBJasperProgress

Constructor Constructs a BBJasperProgress object given a report name and a progress key


BBJasperReport - class in BBJasper

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.


BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file and connect string


BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file and result set


BBJasperReport(BBjString p_reportFile$, Collection p_collection!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, result set, and report parameters


BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters


BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, connect string, and report parameters


BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, result set, and report parameters


BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, result set, and report parameters


BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters


BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!, BBjString p_locale$) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, connect string, report parameters, and locale


BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!, BBjString p_locale$) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale


BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!, BBjString p_locale$) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale


BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!, BBjString p_locale$) - constructor in class BBJasper.BBJasperReport

Constructor Constructs a BBJasperReport given a report file, JRDataSource, report parameters, and locale


BBJasperRTFExporter - class in BBJasper

Provides BBJasper RTF exporter operations


BBJasperRTFExporter() - constructor in class BBJasper.BBJasperRTFExporter

Constructor Constructs a empty BBJasperRTFExporter object


BBJasperTabbedView - class in BBJasper

Displays a JasperReport in a tabbed view


BBJasperTabbedView(BBJasperViewerControl p_viewerControl!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperTabbedView

Constructor Constructs a BBJasperTabbedView given a BBJasperViewerControl object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperTabbedView(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperTabbedView

Constructor Constructs a BBJasperTabbedView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperTabbedView(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperTabbedView

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 in BBJasper

BBJasperTabularLandscapeTemplate class

Lays out the report in a landscape tabular fashion.


BBJasperTabularLandscapeTemplate() - constructor in class BBJasper.BBJasperTabularLandscapeTemplate

Constructor Constructs a BBJasperTabularLandscapeTemplate based on the 'basis_landscape.jrxml' template file


BBJasperTabularLandscapeTemplate(BBjString p_template$) - constructor in class BBJasper.BBJasperTabularLandscapeTemplate

Constructor Constructs a BBJasperTabularLandscapeTemplate using a specific template file


BBJasperTabularTemplate - class in BBJasper

BBJasperTabularTemplate class

Lays out the report in a portrait tabular fashion.


BBJasperTabularTemplate() - constructor in class BBJasper.BBJasperTabularTemplate

Constructor Constructs a BBJasperTabularTemplate based on the 'basis.jrxml' template file


BBJasperTabularTemplate(BBjString p_template$) - constructor in class BBJasper.BBJasperTabularTemplate

Constructor Constructs a BBJasperTabularTemplate using a specific template file


BBJasperTemplate - class in BBJasper

BBJasperTemplate base class

A template is a .jrxml file which is used as a layout basis for further report design.


BBJasperTemplate(BBjString p_file$) - constructor in class BBJasper.BBJasperTemplate

Constructor Constructs a BBJasperTemplate object using a given template file path


BBJasperTXTExporter - class in BBJasper

Provides BBJasper TXT exporter operations


BBJasperTXTExporter() - constructor in class BBJasper.BBJasperTXTExporter

Constructor Constructs a empty BBJasperTXTExporter object


BBJasperView - class in BBJasper

Displays a JasperReport in a view


BBJasperView(BBJasperTabbedView p_tabbedView!, BBJasperReport p_report!) - constructor in class BBJasper.BBJasperView

Constructor Constructs a BBJasperView given a BBJasperReport and BBJasperViewerControl objects


BBJasperView(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperView

Constructor Constructs a BBJasperView given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperView(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperView

Constructor Constructs a BBJasperView given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type


BBJasperViewerControl - class in BBJasper

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


BBJasperViewerControl(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, and control height


BBJasperViewerControl(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a BBjVector containing BBJasperReport objects, BBjWindow object, control id, control x, control y, control width, and control height


BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, and control height


BBJasperViewerControl(BBJasperReport p_report!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperViewerControl(BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperViewerControl(JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a JasperPrint object, BBjWindow object, control id, control x, control y, control width, control height, and fit type


BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, BBjVector p_reports!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerControl

Constructor Constructs a BBJasperViewerControl given a BBJasperViewerWindow object, BBJasperReport object, BBjWindow object, control id, control x, control y, control width, control height and fit type


BBJasperViewerControl(BBJasperViewerWindow p_viewerWindow!, JasperPrint p_jasperPrint!, BBjWindow p_window!, BBjNumber p_id, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerControl

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


BBJasperViewerWindow - class in BBJasper

Displays a JasperReport in a window where the user can view it, save it to disk in various formats, and print it


BBJasperViewerWindow(BBJasperReport p_report!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object


BBJasperViewerWindow(BBjVector p_reports!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects


BBJasperViewerWindow(JasperPrint p_jasperPrint!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a JasperPrint object


BBJasperViewerWindow(BBJasperReport p_report!, BBjString p_title!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object and a window title


BBJasperViewerWindow(BBjVector p_reports!, BBjString p_title!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects and a window title


BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjString p_title!) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a JasperPrint object and a window title


BBJasperViewerWindow(BBJasperReport p_report!, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window title, and window flags


BBJasperViewerWindow(BBjVector p_reports!, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window title, and window flags


BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window title, and window flags


BBJasperViewerWindow(BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, and window flags


BBJasperViewerWindow(BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, and window flags


BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, and window flags


BBJasperViewerWindow(BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, window flags, and fit type


BBJasperViewerWindow(BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

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


BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type


BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags


BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

Constructor Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags


BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) - constructor in class BBJasper.BBJasperViewerWindow

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


BBJasperXHTMLExporter - class in BBJasper

Provides BBJasper XHTML exporter operations


BBJasperXHTMLExporter() - constructor in class BBJasper.BBJasperXHTMLExporter

Constructor Constructs a empty BBJasperXHTMLExporter object


BBJasperXLSExporter - class in BBJasper

Provides BBJasper XLS exporter operations


BBJasperXLSExporter() - constructor in class BBJasper.BBJasperXLSExporter

Constructor Constructs a empty BBJasperXLSExporter object


BBJasperXLSXExporter - class in BBJasper

Provides BBJasper XLSX exporter operations


BBJasperXLSXExporter() - constructor in class BBJasper.BBJasperXLSXExporter

Constructor Constructs a empty BBJasperXLSXExporter object


BBJasperXMLExporter - class in BBJasper

Provides BBJasper XML exporter operations


BBJasperXMLExporter() - constructor in class BBJasper.BBJasperXMLExporter

Constructor Constructs a empty BBJasperXMLExporter object


BBjBUIDialChart - class in BBjBUIDialChart

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 in class BBjBUIDialChart.BBjBUIDialChart

BBjBUIDialChart constructor that creates the object with default values


BBjBUIDialChart(BBjString p_backgroundImage$) - constructor in class BBjBUIDialChart.BBjBUIDialChart

BBjBUIDialChart constructor that creates the object with a custom background image


BBjBUIDialChart(BBjColor p_borderColor!, BBjNumber p_dialVisible) - constructor in class BBjBUIDialChart.BBjBUIDialChart

BBjBUIDialChart constructor that creates the object with a custom background image and a number indicating whether the dial should be initially visible


BBjBUIDialChart(BBjString p_title$, BBjNumber p_value) - constructor in class BBjBUIDialChart.BBjBUIDialChart

BBjBUIDialChart constructor that creates the object with a custom title string and value


BBjBUIDialChart(BBjString p_title$, BBjNumber p_value, BBjColor p_bgColor!, BBjColor p_fgColor!, BBjFont p_font!) - constructor in class BBjBUIDialChart.BBjBUIDialChart

BBjBUIDialChart constructor that creates the object with all available parameters


BBjCalendarWidget - interface in BBjCalendarWidget

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.

THROWn 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 - class in BBjDialChartProgress

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.

THROWn Error Codes:

  • 700: Missing background image file. The specified file does not exist.

BBjDialChartProgress() - constructor in class BBjDialChartProgress.BBjDialChartProgress

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(BBjString p_backgroundImagePath!) - constructor in class BBjDialChartProgress.BBjDialChartProgress

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


BBjEventName$ - field in class DialogWizard.Event

BBjFileRepositoryService - class in BBJasper

BBjFileRepositoryService(JasperReportsContext jasperReportsContext!, BBjString reportDir$, BBjString reportPrefix$) - constructor in class BBJasper.BBjFileRepositoryService

BBjGridExWidget - class in BBjGridExWidget

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

BBjGridExWidget() - constructor in class BBjGridExWidget.BBjGridExWidget

disabled default constructor


BBjGridExWidget(BBjChildWindow wnd!) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget in the ChildWindow


BBjGridExWidget(BBjChildWindow wnd!, BBjString template$) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget in the ChildWindow


BBjGridExWidget(BBjString rootId!, BBjChildWindow wnd!) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget in the ChildWindow


BBjGridExWidget(BBjString rootId!, BBjChildWindow wnd!, BBjString template$) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget in the ChildWindow


BBjGridExWidget(BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h!) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget on wnd!


BBjGridExWidget(BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h! , BBjString template$) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget on wnd!


BBjGridExWidget(BBjString rootId!, BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h!) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget on wnd!


BBjGridExWidget(BBjString rootId!, BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h! , BBjString template$) - constructor in class BBjGridExWidget.BBjGridExWidget

The constructor that creates the widget on wnd!


BBjJavaScriptExecutor - class in BBjCalendarWidget

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.

Definition of terms:

- 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:

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;")

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.

BBjJavaScriptExecutor(BBjWidget widget!) - constructor in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


BBjJavaScriptExecutor(BBjWidget widget!, BBjNumber rate!) - constructor in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


BBjMouseUpEvent! - field in class Dashboard.DashboardWidgetClickEvent

The BBjMouseUp event that triggered this event


BBjMouseUpEvent! - field in class Dashboard.DashboardWidgetLeftClickEvent

The BBjMouseUp event that triggered this event


BBjMouseUpEvent! - field in class Dashboard.DashboardWidgetRightClickEvent

The BBjMouseUp event that triggered this event


BBjPopupSelectEvent! - field in class Dashboard.DashboardWidgetMenuSelectEvent

The BBjPopupSelectEvent event that triggered this event


BBJSONResolver - class in BBJSONResolver

Utility class for extracting values from a JSON document given a dot-delimited path.


BBjWidget - class in Dashboard

BBjWidget Creates a widget that is implemented as a BBjControl


BBLaunchDock - class in this project

BBLaunchDock(BBjString p_Archive$) - constructor in class BBLaunchDock

BBLaunchDock(BBjString p_archive$, BBjNumber p_allowClientConfig, BBjNumber p_visible) - constructor in class BBLaunchDock

BBLaunchDock(Admin admin!, BBjString p_archive$, BBjNumber p_allowClientConfig, BBjNumber p_visible) - constructor in class BBLaunchDock

BBTranslationBundle - class in BBTranslator

BBTranslationBundle The BBTranslationBundle class is a BBj CustomObject used to get and add translations with backend Java properties files for localization support.


BBTranslations - class in BBTranslator

BBTranslations The BBTranslations class is a BBj CustomObject that gets and adds translations for localization support.


BBTranslations(BBTranslationBundle p_bundle!, BBTranslations p_parent!, Locale p_locale!) - constructor in class BBTranslator.BBTranslations

BBTranslations constructor


BBTranslator - class in BBTranslator

BBTranslator The BBTranslator utility is a BBj CustomObject that utilizes a translation bundle for localization support


BBUtils - class in BBUtils

In BBj 12.0 and higher, the BBUtils utility is a generalized utility that provides information and interactivity with the Jetty web server, registers BUI applications, and more.


BBWebClient - class in BBWebClient

A simple class for retrieving content from web servers. A Wrapper for Apache's HttpClient class


BBWebRequest - class in BBWebClient

Object containing the necessary information for a web request, including URL, method, authorization, and headers.


BBWebRequest() - constructor in class BBWebClient.BBWebRequest

BBWebResponse - class in BBWebClient

A response to a web request, which includes a status code, a reason phrase, body, and headers.


BBWebResponse(CloseableHttpResponse response!) - constructor in class BBWebClient.BBWebResponse

Constructor Generally, rather than invoking this constructor directly, you can get BBWebResponse by sending a request with BBWebClient.send()


BBWindowUtils - class in this project

BBXImage - class in BBXImage

Description

In BBj 9.00 and higher, the 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
  • Adjust the brightness of the image
  • Adjust the contrast of the image
  • Blur the image
  • Sharpen the image
  • Convert the image to grayscale

In BBj 16.0 and higher, the BBXImage Utility provides methods to

  • Modify the canvas size and facilitate scaling an image while maintaining the original aspect ratio
  • Create an image object by drawing text on a graphics context with customized fonts, colors, and alignment

In BBj 17.0 and higher, the BBXImage Utility provides a method to

  • Get a base64-encoded ASCII string version of an image

In BBj 18.0 and higher, the BBXImage Utility provides methods to

  • Crop an image to a specified rectangular region
  • Return a subimage defined by a specified rectangular region
  • Draw bordered or filled rectangles and ovals in a specified color
  • Add borders to the image
  • Resize the image's canvas
  • Add a color overlay to the image

In BBj 19.0 and higher, the BBXImage Utility provides methods to

  • Save the image in the GIF, BMP, and TIFF image formats

In BBj 21.12 and higher, the BBXImage Utility has been updated with the following features:

  • The manipulation methods have been updated to return the BBXImage. This makes it possible to chain multiple method calls, as in:
        xImage!.scale(100, 100).rotate(90).saveAsPNG("myScaledAndRotatedeImage.png")
  • The new drawText() method allows you to draw single or multiline text on the BBXImage providing values for foreground/background color, font, alignment, and offsets.

 

How to use the BBXImage Utility

Here's a quick rundown of what you need to do to use it in your program:
  1. Ensure the <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.
  2. Add a 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

To use the BBXImage class in your application, the process goes something like this:
  1. Create a BBXImage object from something like a BBjImage, a Java Image or ImageIcon, URL, etc:
    
     declare BBXImage xImage!
     xImage! = new BBXImage(mySource!)
     
  2. Manipulate the image in some way, such as resizing the image using one of the scale methods:
    
     xImage!.scaleProportionally(maxWidth, maxHeight)
     
  3. Do something with the resultant image, like setting the contents of a BBjImageCtrl or saving it out as a compressed JPG file:
    
     myImageCtrl!.setImage(xImage!.getBBjImage())
     xImage!.saveAsJPG(fullPathToJpgFile$, compressionLevel75)
     

 

THROWn Error Codes:

  • 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(BBXImage p_bbximage!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying another BBXImage for the source image


BBXImage(ImageIcon p_imageIcon!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying an ImageIcon for the source image


BBXImage(Image p_image!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying a Java Image object for the source image


BBXImage(URL p_imageURL!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying a Java URL object for the source image


BBXImage(File p_imageFile!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying a Java File object for the source image's file path


BBXImage(BBjString p_imageFile!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying a string for the source image's file path


BBXImage(BBjImage p_image!) - constructor in class BBXImage.BBXImage

BBXImage Constructor specifying a BBjImage for the source image


BBXImage(BBjString p_text$, BBjString p_foreColor$, BBjNumber p_foreOpacity, BBjString p_backColor$, BBjNumber p_backOpacity, Font p_font!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_hAlign, BBjNumber p_vAlign, BBjNumber p_hPadding, BBjNumber p_vPadding) - constructor in class BBXImage.BBXImage

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.


BBXImageFactory - class in BBXImage

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.


BBXMLDoc - class in this project

BBXMLDoc()_break_ - constructor in class BBXMLDoc

BBXMLDoc(BBjString p_xmlString!) - constructor in class BBXMLDoc

BBXMLDoc(URL p_url!) - constructor in class BBXMLDoc

BBXMLDoc(BBjString p_xmlFileName$, BBjNumber p_ignoreWhitespace) - constructor in class BBXMLDoc

BorderColor! - field in class Dashboard.DashboardWidget

Border color of the dashboard widget


BorderSelectedColor! - field in class Dashboard.DashboardWidget

Border color of a dashboard widget when it is selected


BrowseOnSelect - field in class Dashboard.DashboardWidgetLink

Indicates if the link should be browsed to when selected


BUFFER_SIZE=10240 - field in class BBJasper.BBJasper

Buffer size use to read in jrxml and jasper report files, default is 10 K


BUFFER_SIZE=10240 - field in class BBTranslator.BBTranslator

A field variable that defines the buffer size


BUFFER_SIZE=32768 - field in class BBUtils.BBUtils

A constant to define the maximum buffer size when copying files to the Web Server


buildColumnsFromResultSet(ResultSet rs!, BBjNumber addAll!) - method in class BBjGridExWidget.BBjGridExWidget

Build the column definitions from the passed ResultSet


buildDialogProperties(BBTranslator pTranslator!, BBjVector pCtrlVect!) - method in class DialogWizard.DialogUtils

Method buildDialogProperties: Create property files given a BBTranslator object and a set of controls


buildGrid() - method in class QVGrid.QVGrid

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


BuildItem - interface in this project

BUS - class in this project

BUS() - constructor in class BUS

C

CachedImage! - field in class Dashboard.BaseWidget

Saves out the last known good state of the widget into a BBjImage for use later on when loading the widget/dashboard


CALENDAR_ENTRY_DISPLAY_AUTO() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_AUTO() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_ENTRY_DISPLAY_BACKGROUND() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_BACKGROUND() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_ENTRY_DISPLAY_BLOCK() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_BLOCK() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_ENTRY_DISPLAY_LIST_ITEM() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_LIST_ITEM() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_ENTRY_DISPLAY_NONE() - method in class BBjCalendarWidget.CalendarEntry

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.


CALENDAR_ENTRY_DISPLAY_NONE() - method in class BBjCalendarWidget.CalendarAPI

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.


CALENDAR_TOOLBAR_ALIGNMENT_CENTER() - method in class BBjCalendarWidget.CalendarToolbar

A constant value that's used with the CalendarToolbarSection constructor that indicates the center section of the toolbar to be defined.


CALENDAR_TOOLBAR_ALIGNMENT_CENTER() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarToolbarSection constructor that indicates the center section of the toolbar to be defined.


CALENDAR_TOOLBAR_ALIGNMENT_END() - method in class BBjCalendarWidget.CalendarToolbar

A constant value that's used with the CalendarToolbarSection constructor that indicates the ending, or right, section of the toolbar to be defined.


CALENDAR_TOOLBAR_ALIGNMENT_END() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarToolbarSection constructor that indicates the ending, or right, section of the toolbar to be defined.


CALENDAR_TOOLBAR_ALIGNMENT_START() - method in class BBjCalendarWidget.CalendarToolbar

A constant value that's used with the CalendarToolbarSection constructor that indicates the starting, or left, section of the toolbar to be defined.


CALENDAR_TOOLBAR_ALIGNMENT_START() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarToolbarSection constructor that indicates the starting, or left, section of the toolbar to be defined.


CALENDAR_TOOLBAR_BUTTON_DAY() - method in class BBjCalendarWidget.CalendarOptions

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'day' toolbar button.


CALENDAR_TOOLBAR_BUTTON_DAY() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'day' toolbar button .


CALENDAR_TOOLBAR_BUTTON_LIST() - method in class BBjCalendarWidget.CalendarOptions

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'list' toolbar button.


CALENDAR_TOOLBAR_BUTTON_LIST() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'list' toolbar button .


CALENDAR_TOOLBAR_BUTTON_MONTH() - method in class BBjCalendarWidget.CalendarOptions

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'month' toolbar button.


CALENDAR_TOOLBAR_BUTTON_MONTH() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'month' toolbar button .


CALENDAR_TOOLBAR_BUTTON_TODAY() - method in class BBjCalendarWidget.CalendarOptions

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'today' toolbar button.


CALENDAR_TOOLBAR_BUTTON_TODAY() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'today' toolbar button .


CALENDAR_TOOLBAR_BUTTON_WEEK() - method in class BBjCalendarWidget.CalendarOptions

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'week' toolbar button.


CALENDAR_TOOLBAR_BUTTON_WEEK() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the CalendarOptions::setButtonText() method that uniquely identifies the 'week' toolbar button .


CALENDAR_TOOLBAR_OBJECT_NEXT() - method in class BBjCalendarWidget.CalendarToolbar

A constant value for the toolbar's next button object that's used for moving the calendar forward one month/week/day.


CALENDAR_TOOLBAR_OBJECT_NEXT() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's next button object that's used for moving the calendar forward one month/week/day.


CALENDAR_TOOLBAR_OBJECT_NEXT_YEAR() - method in class BBjCalendarWidget.CalendarToolbar

A constant value for the toolbar's next year button object that's used for moving the calendar forward one year.


CALENDAR_TOOLBAR_OBJECT_NEXT_YEAR() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's next year button object that's used for moving the calendar forward one year.


CALENDAR_TOOLBAR_OBJECT_PREV() - method in class BBjCalendarWidget.CalendarToolbar

A constant value for the toolbar's previous button object that's used for moving the calendar back one month/week/day.


CALENDAR_TOOLBAR_OBJECT_PREV() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's previous button object that's used for moving the calendar back one month/week/day.


CALENDAR_TOOLBAR_OBJECT_PREV_YEAR() - method in class BBjCalendarWidget.CalendarToolbar

A constant value for the toolbar's previous year button object that's used for moving the calendar back one year.


CALENDAR_TOOLBAR_OBJECT_PREV_YEAR() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's previous year button object that's used for moving the calendar back one year.


CALENDAR_TOOLBAR_OBJECT_TITLE() - method in class BBjCalendarWidget.CalendarToolbar

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.


CALENDAR_TOOLBAR_OBJECT_TITLE() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's title object that contains the current month/week/day.


CALENDAR_TOOLBAR_OBJECT_TODAY() - method in class BBjCalendarWidget.CalendarToolbar

A constant value for the toolbar's today button object that moves the calendar to the current month/week/day.


CALENDAR_TOOLBAR_OBJECT_TODAY() - method in class BBjCalendarWidget.CalendarAPI

A constant value for the toolbar's today button object that moves the calendar to the current month/week/day.


CALENDAR_TOOLBAR_POSITION_BOTTOM() - method in class BBjCalendarWidget.CalendarToolbar

A constant value that's used with the setPosition() method that indicates that the toolbar should be below the calendar.


CALENDAR_TOOLBAR_POSITION_BOTTOM() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the setPosition() method that indicates that the toolbar should be below the calendar.


CALENDAR_TOOLBAR_POSITION_TOP() - method in class BBjCalendarWidget.CalendarToolbar

A constant value that's used with the setPosition() method that indicates that the toolbar should be above the calendar.


CALENDAR_TOOLBAR_POSITION_TOP() - method in class BBjCalendarWidget.CalendarAPI

A constant value that's used with the setPosition() method that indicates that the toolbar should be above the calendar.


CALENDAR_VIEW_DAY_GRID_MONTH() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the dayGridMonth (grid view for the month) calendar view.


CALENDAR_VIEW_DAY_GRID_MONTH() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the dayGridMonth (grid view for the month) calendar view.


CALENDAR_VIEW_DAY_GRID_WEEK() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the dayGridWeek (grid view for the week) calendar view.


CALENDAR_VIEW_DAY_GRID_WEEK() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the dayGridWeek (grid view for the week) calendar view.


CALENDAR_VIEW_LIST_DAY() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the listDay (agenda for the day) calendar view.


CALENDAR_VIEW_LIST_DAY() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the listDay (agenda for the day) calendar view.


CALENDAR_VIEW_LIST_MONTH() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the listMonth (agenda for the month) calendar view.


CALENDAR_VIEW_LIST_MONTH() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the listMonth (agenda for the month) calendar view.


CALENDAR_VIEW_LIST_WEEK() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the listWeek (agenda for the week) calendar view.


CALENDAR_VIEW_LIST_WEEK() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the listWeek (agenda for the week) calendar view.


CALENDAR_VIEW_LIST_YEAR() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the listYear (agenda for the year) calendar view.


CALENDAR_VIEW_LIST_YEAR() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the listYear (agenda for the year) calendar view.


CALENDAR_VIEW_TIME_GRID_DAY() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the timeGridDay (time grid view for the day) calendar view.


CALENDAR_VIEW_TIME_GRID_DAY() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the timeGridDay (time grid view for the day) calendar view.


CALENDAR_VIEW_TIME_GRID_WEEK() - method in class BBjCalendarWidget.CalendarView

A constant value that defines the timeGridWeek (time grid view for the week) calendar view.


CALENDAR_VIEW_TIME_GRID_WEEK() - method in class BBjCalendarWidget.CalendarAPI

A constant value that defines the timeGridWeek (time grid view for the week) calendar view.


CalendarAPI - class in BBjCalendarWidget

The CalendarAPI is a BBj Custom Class that facilitates creating calendar objects, accessing constants, and is used in combination with the BBjCalendarWidget.


CalendarAPI! - field in class gappsv3.GCalendarAPI

The Java Google Calendar API Object for direct access to the API.


CalendarDateClickEvent - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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.


CalendarEntrySourceGoogle - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

CalendarEvent is a BBj Interface that contains event information for a BBjCalendarWidget. This is the base class for all BBjCalendarWidget events.


CalendarEventWithJavaScriptEvent - interface in BBjCalendarWidget

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:

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.


CalendarOptions - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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 - interface in BBjCalendarWidget

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.


CalendarToolbar - interface in BBjCalendarWidget

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:

LocationConstantDisplaysExample
startCalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START()date navigation buttons[today] [previous year][previous][next][next year]
centerCalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER()title"December 2020"
endCalendarAPI.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.


CalendarToolbarSection - interface in BBjCalendarWidget

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:


CalendarUnselectEvent - interface in BBjCalendarWidget

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.


CalendarView - interface in BBjCalendarWidget

The CalendarView is a BBj Interface that defines different calendar views and is used in combination with the BBjCalendarWidget.


CalendarViewChangeEvent - interface in 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.


CallbackInfo - class in Dashboard

CallbackInfo(BBjString p_name$, BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - constructor in class Dashboard.CallbackInfo

CallbackObject! - field in class Dashboard.CallbackInfo

CallbackRoutine$ - field in class Dashboard.CallbackInfo

cancel(BBjFileChooserCancelEvent ev!) - method in class FileChooser

cancel(BBjFontChooserCancelEvent ev!) - method in class FontChooser

CANCELED=0 - field in class AdminLoginDialog

CANCELED=0 - field in class GAppsLoginDialog

CANCELED=0 - field in class GDocSelectionDialog

CANCELED=2 - field in class BBJasper.BBJasperProgress

Constant which represents the fill operation has been canceled


capture() - method in class ScreenCapture.ScreenCapture

Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog


capture(BBjString p_filepath$) - method in class ScreenCapture.ScreenCapture

Method capture: Capture entire screen directly to the given client file path, without the file save dialog


capture(BBjString p_filepath$, BBjNumber p_show) - method in class ScreenCapture.ScreenCapture

Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog


capture(BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog


capture(BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture entire screen to the given file path, optionally showing the file save dialog


capture(BBjWindow p_win!) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog


capture(BBjWindow p_win!, BBjString p_filepath$) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog


capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog


capture(BBjWindow p_win!, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog


capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog


capture(BBjMDI p_mdi!) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog


capture(BBjMDI p_mdi!, BBjString p_filepath$) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog


capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog


capture(BBjMDI p_mdi!, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a MDI, defaulting the file path, without showing the save dialog


capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog


CASE$=#Translations!.getTranslation("case") - field in class BBJasper.BBJasperView

Translated text for case


CaseSensitive! - field in class GxFilters.GxFilterText

Set to true to make text filtering case sensitive, otherwise the filtering will be case insensitive


Category$ - field in class Dashboard.DashboardWidgetAttribute

Category attribute


CATEGORY_SELECT_EVENT$ - field in class BaseBuildItem

CategoryDataItem - class in Dashboard

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:

  • BBjString rowKey$
  • BBjString colKey$
  • Number value!

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:
  • rowKey$ -> What is displayed in the chart's legend
  • colKey$ -> What is displayed in the chart's domain axis
  • value! -> What is displayed in the chart's range axis

So if the dataset consists of 3 CategoryDataItems, all with unique row and column keys, there will be a total of 9 bars drawn on the chart. That is because there are 3 columns, and there will be 3 bars per column - one for each row.
It is also possible to make all row keys the same in a dataset. In this case the sample dataset still consists of 3 CategoryDataItems, but only the column keys are unique. This results in a chart with only 3 bars instead of 9. In this case, since the row keys are all the same, there will be a single item in the chart's legend. Because of this, it is common to hide the legend since it does not provide any additional value. The domain axis will have 3 entries, one for each column key, containing a single bar.

CategoryDataItem(BBjString p_rowKey$, BBjString p_colKey$, Number p_value!) - constructor in class Dashboard.CategoryDataItem

Contructs a CategoryDataItem


Cell! - field in class GxClientEvents.GxClientEventsContextMenu

The current cell where the context menu is triggered


CELL_STYLE_CHECKED - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CELL_STYLE_INPUTD - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CELL_STYLE_INPUTE - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CELL_STYLE_INPUTN - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CELL_STYLE_TEXT - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CELL_STYLE_UNCHECKED - field in class Dashboard.GridWidget

A constant to define grid column style, used in conjunction with the setColumnStyle() method


CellClass! - field in class GxColumns.GxDefaultColumnDefinition

CSS class(es) to use for the cell.


#Configuration
#ColumnsRenderer


CellClassRules! - field in class GxColumns.GxDefaultColumnDefinition

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! - field in class GxColumns.GxDefaultColumnDefinition

CellEditor to use for this column


#Configuration
#ColumnsRenderer


CellRenderer! - field in class GxCellEditors.GxCellEditorRichSelect

Provide a cell renderer for each value


CellRenderer! - field in class GxColumns.GxDefaultColumnDefinition

A cellRenderer to use for this column


#Configuration
#ColumnsRenderer


CellRenderer! - field in class GxFilters.GxFilterSetFilter

Provide a cell renderer for each value


CellStyle! - field in class GxColumns.GxDefaultColumnDefinition

A map of css values.


#Configuration
#ColumnsRenderer


center() - method in class BBJasper.BBJasperViewerWindow

center Centers the viewer window on either the MDI window or client desktop


centerWindow(BBjWindow p_window!) - method in class BBWindowUtils

centerWindow(BBjWindow p_window!, BBjNumber p_centerOnActiveWindow) - method in class BBWindowUtils

centerWindow(BBjWindow p_window!, BBjWindow p_basewin!) - method in class BBWindowUtils

centerWindow(BBjWindow p_window!) - method in class BBJasper.BBJasper

centerWindow Centers the passed window on either the MDI window or client desktop


centerWindow(BBjWindow p_window!, BBjNumber p_centerOnActiveWindow) - method in class BBJasper.BBJasper

centerWindow Centers the passed window on either the MDI window, client desktop, or optionally on the active window (if there is one)


CHARACTER_ENCODING$ - field in class BBJasper.BBJasperExporterParameter

CharacterEncoding!="UTF-8" - field in class gappsv3.GOAuth2

Character encoding for authentication requests. Default is UTF-8.


CHART_RANGE() - method in class GxContextMenu.GxContextMenuItem

CHART_TOOLBAR_DATA() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that chart toolbar data item


CHART_TOOLBAR_DOWNLOAD() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that chart toolbar download item


CHART_TOOLBAR_FORMAT() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that chart toolbar format item


CHART_TOOLBAR_SETTINGS() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that chart toolbar settings item


CHART_TYPE_CATEGORY() - method in class GxColumns.GxDefaultColumnDefinition

A constant which defines column chart category


CHART_TYPE_EXCLUDED() - method in class GxColumns.GxDefaultColumnDefinition

A constant which defines column chart excluded, columns which set chart type to excluded will be excluded from charts


CHART_TYPE_SERIES() - method in class GxColumns.GxDefaultColumnDefinition

A constant which defines column chart series


ChartColorThemeIndex - field in class Dashboard.DashboardWidgetAttribute

Color Theme Index for Charts


ChartFontFile$ - field in class Dashboard.DashboardWidgetAttribute

FontFile attribute


ChartFontScalingFactor - field in class Dashboard.DashboardWidgetAttribute

FontScalingFactor attribute


ChartType! - field in class GxColumns.GxDefaultColumnDefinition

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 - class in Dashboard

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(BBjNumber p_onClient) - method in class BBJasper.BBJasperPrintServiceExporter

checkAvailablePrinters Determines if there are avialable printers


Checkbox! - field in class GxRenderers.GxRendererGroupCellRenderer

When true enable checkbox selection, disable otherwise


CheckboxSelection! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to render a selection checkbox in the column.


#Configuration
#ColumnsRenderer


checkFile(BBjControl pControl!, BBjString pFilePath$, BBjNumber pMustExist, BBjNumber pFileOnly, BBjNumber pQuiet) - method in class DialogWizard.DialogUtils

Method checkFile: Validity check for a given file path


ChildIndex! - field in class GxClientModels.GxClientRowModel

The row child index. if the childIndex is -1 then the row is pinned to top or bottom


Children! - field in class TreeNode

CLASS_LOADER$ - field in class BBJasper.BBJasperExporterParameter

cleanupVirtualization() - method in class BBJasper.BBJasperReport

cleanupVirtualization Removes temporary files that are created when virtualization is used.


CLEAR_FIND$=#Translations!.getTranslation("clear.find") - field in class BBJasper.BBJasperView

Translated text for clear find text


ClearButton! - field in class GxFilters.GxColumnFilterAG

Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.


ClearButton! - field in class GxFilters.GxFilterBasicBoolean

Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.


ClearButton! - field in class GxFilters.GxFilterBasicDateTime

Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.


clearCache() - method in class BBTranslator.BBTranslator

Clears the namespace cache used by the BBTranslator


clearCache() - method in class BBTranslator.BBTranslationBundle

clearCallback(int eventType!) - method in class QVGrid.QVGrid

Unregisters the callback routine for a specified event


clearCallback(BBjNumber event!) - method in class BBjCalendarWidget.BBjCalendarWidget

Removes the callback given the callback number.


clearCallback(int type!) - method in class BBjGridExWidget.BBjGridExWidget

Remove callback


clearCellStyleNames(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Clears CSS styles from a grid cell


clearChart(BBjString id!) - method in class BBjGridExWidget.BBjGridExWidget

Clear already created chart by its id


#API Note that this method does not clear user created charts


clearChart() - method in class BBjGridExWidget.BBjGridExWidget

Clear already created charts. Note that this method does not clear user created charts


#API


clearColumnDefinitions() - method in class BBjGridExWidget.BBjGridExWidget

Alias for resetAllColumns()


#Configuration
#ColumnsRenderer


clearColumnStyleNames(BBjNumber column) - method in class QVGrid.QVGrid

Clears CSS styles from a grid column


clearColumnWidthPercentages() - method in class Dashboard.GridWidget

Clears the grid widget's column width percentages HashMap


clearData() - method in class BBjGridExWidget.BBjGridExWidget

Clear row data (Empty the grid )


#API


clearDataSet() - method in class Dashboard.DataFillableWidget

Clears the widget's underlying dataset


clearDataSet() - method in class Dashboard.GridExWidget

Clears the widget's underlying dataset


clearDataSet() - method in class Dashboard.GridWidget

Clears the widget's underlying dataset


clearDataSet() - method in class Dashboard.PieChartWidget

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().


clearDataSet() - method in class Dashboard.BarChartWidget

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().


clearDataSet() - method in class Dashboard.LineChartWidget

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().


clearDataSet() - method in class Dashboard.XYChartWidget

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().


clearFilter() - method in class GxClientModels.GxClientFilterModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterAbstractModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterCombinedModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterSimpleModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterTextModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterNumberModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterDateTimeModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterBooleanModel

Clear the filter


clearFilter() - method in class GxClientModels.GxClientFilterSetFilterModel

Clear the filter


clearFilters() - method in class BBjGridExWidget.BBjGridExWidget

Clear all active filters on columns


#API


clearGrid() - method in class QVGrid.QVGrid

Removes all data from the cells


clearMainGrid() - method in class QVGrid.QVGrid

Removes all data from the main grid cells, leaving headers intact


clearProcCallback(BBjNumber eventType) - method in class QVGrid.QVGrid

Unregisters the custom event callback routine for a specified 'processing' event


clearRangeSelection() - method in class BBjGridExWidget.BBjGridExWidget

Clears the selected range.


#API


clearRowsData() - method in class BBjGridExWidget.BBjGridExWidget

Clear row data (Empty the grid )


#API


clearRowStyleNames(BBjNumber row) - method in class QVGrid.QVGrid

Clears CSS styles from a grid row


clearStyles() - method in class QVGrid.QVGrid

Clears CSS styles from the grid control


clearStyles() - method in class BBjCalendarWidget.BBjCalendarWidget

Clears all the CSS styles from the widget.


CLICK_TARGET_CELL - field in class Dashboard.GridWidget

A constant to define where the user clicked on the grid.


CLICK_TARGET_COLUMN_HEADER - field in class Dashboard.GridWidget

A constant to define where the user clicked on the grid.


CLICK_TARGET_CORNER - field in class Dashboard.GridWidget

A constant to define where the user clicked on the grid. Top left corner adjacent to column and row headers.


CLICK_TARGET_ROW_HEADER - field in class Dashboard.GridWidget

A constant to define where the user clicked on the grid.


CLICK_TARGET_SCROLLBAR - field in class Dashboard.GridWidget

A constant to define where the user clicked on the grid. This is currently only valid in BUI.


ClickTarget - field in class Dashboard.GridWidget

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.


CLIENT_FILE_NAME_PROPERTY$ - field in class BBJasper.BBJasperExporter

Property name for the client file for exports


CLIENT_OBJECT_ERROR=306 - field in class BBJasper.BBJasperReport

Constant value that represents a client object error


ClientContext! - field in class GxOptions.GxOptions

A json object which is used as context to configure the grid and it various components on the client


clientFileExists(BBjString p_clientFileName$) - method in class BBJasper.BBJasper

clientFileExists Determines is a client file exists or not


ClientIDProperty!="com.basis.util.goauth2.clientid" - field in class gappsv3.GOAuth2

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.


ClientLocale$ - field in class Dashboard.ExportData

Locale of the client


ClientRow! - field in class GxClientModels.GxClientRowModel

The client row data as JsonObject.


ClientSecretProperty!="com.basis.util.goauth2.clientsecret" - field in class gappsv3.GOAuth2

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.


clone() - method in class BBXImage.BBXImage

Method to get a copy of the BBXImage


clone() - method in class Dashboard.DashboardWidget

Clones the DashboardWidget


clone() - method in class Dashboard.DashboardWidgetFilter

Creates and returns a clone of the DashboardWidgetFilter


clone() - method in class Dashboard.DashboardWidgetMenu

Creates and returns a clone of the DashboardWidgetMenu


clone() - method in class Dashboard.DashboardWidgetLink

Creates and returns a clone of the DashboardWidgetLink


clone() - method in class Dashboard.Widget

Creates and returns a clone of the widget


clone() - method in class Dashboard.ImageWidget

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() - method in class Dashboard.HtmlViewWidget

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() - method in class Dashboard.GridExWidget

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() - method in class Dashboard.GridWidget

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() - method in class Dashboard.PieChartWidget

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() - method in class Dashboard.RingChartWidget

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() - method in class Dashboard.BarChartWidget

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() - method in class Dashboard.StackedBarChartWidget

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() - method in class Dashboard.StackedPercentageBarChartWidget

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() - method in class Dashboard.LineChartWidget

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() - method in class Dashboard.AreaChartWidget

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() - method in class Dashboard.StackedAreaChartWidget

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() - method in class Dashboard.XYChartWidget

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() - method in class Dashboard.JasperViewerWidget

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() - method in class Dashboard.AlphaColor

clone() - method in class Dashboard.ColorWithOpacity

clone() - method in class Dashboard.ShadowColor

clone() - method in class BBJasper.BBJasperReport

clone Creates and returns a copy of the current BBJasperReport object


cloneCommonChartWidgetParameters(ChartWidget widget!) - method in class Dashboard.ChartWidget

A method used internally to propagate a chart widget's properties to a cloned version of the chart


ClonedState - field in class Dashboard.DashboardWidget

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.


close() - method in class FaxJob

close() - method in class FaxJobBase

close() - method in class PDFFaxJob

close() - method in class BBWebClient.BBWebResponse

Explicitly closes the response once necessary information has been retrieved.


CLOSE_LEFT_TABS_MENU_ITEM_NAME$="BBJVCloseLeftTabsMenuItem" - field in class BBJasper.BBJasperTabbedView

Close left tabs menu item name


CLOSE_OTHER_TABS_MENU_ITEM_NAME$="BBJVCloseOtherTabsMenuItem" - field in class BBJasper.BBJasperTabbedView

Close other tabs menu item name


CLOSE_RIGHT_TABS_MENU_ITEM_NAME$="BBJVCloseRightTabsMenuItem" - field in class BBJasper.BBJasperTabbedView

Close right tabs menu item name


CLOSE_TAB_MENU_ITEM_NAME$="BBJVCloseTabMenuItem" - field in class BBJasper.BBJasperTabbedView

Close tab menu item name


closeAllViewerWindows() - method in class BBJasper.BBJasperViewerControl

closeAllViewerWindows Closes and destroys all windows that were created from this control


closeAllViewerWindows() - method in class BBJasper.BBJasperView

closeAllViewerWindows Closes and destroys all windows that were created from this control


CloseButton! - field in class Dashboard.WidgetControl

Button in the in the widget control's titlebar that closes the widget control


closeToolpanel(BBjString id!) - method in class GxSidebar.GxSidebar

Close toolpanel

Close the given toolpanel


closeWindow(BBjCloseEvent ev!) - method in class FileChooser

closeWindow(BBjCloseEvent ev!) - method in class FontChooser

Code! - field in class GxClientModels.GxClientKeypressModel

A DOMString with the code value of the physical key represented by the event.


ColKey! - field in class Dashboard.CategoryDataItem

The column key of the data item


collapseAll() - method in class BBjGridExWidget.BBjGridExWidget

collapse all groups


#API


ColorHexString$ - field in class Dashboard.ColorWithOpacity

Colors - class in Colors

Colors In BBj 20.10 and higher, Colors is a BBj Custom Class that provides commonly-used routines to convert and format colors in a variety of models including Java Color, BBjColor, and RGB, HSL, 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:

  • The hue component of the color is a floating point number from 0-360 indicating the hue degree in the color circle (0=red, 120=green, 240=blue, 360=red)
  • The saturation component of the color is a floating point number from 0-1 indicating the saturation percentage (0=grey or no color, 1=full color)
  • The lightness component of the color is a floating point number from 0-1 indicating the lightness percentage (0=black, 1 = white)
  • The alpha component of the color is a floating point number from 0-1 indicating the alpha percentage (0=transparent, 1=opaque)

For all Hue, Saturation, Brightness, and Alpha methods, all parameters are floating point number with the following numerical ranges:

  • The hue component of the color is a floating point number from 0-360 indicating the hue degree in the color circle (0=red, 120=green, 240=blue, 360=red)
  • The saturation component of the color is a floating point number from 0-1 indicating the saturation percentage (0=grey or no color, 1=full color)
  • The brightness component of the color is a floating point number from 0-1 indicating the lightness percentage (0=black, 1 = white)
  • The alpha component of the color is a floating point number from 0-1 indicating the alpha percentage (0=transparent, 1=opaque)

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.

THROWn 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


ColorThemeAgate - field in class Dashboard.ChartWidget

ColorThemeAntiquePewter - field in class Dashboard.ChartWidget

ColorThemeAntler - field in class Dashboard.ChartWidget

ColorThemeBamboo - field in class Dashboard.ChartWidget

ColorThemeBeachStrata - field in class Dashboard.ChartWidget

ColorThemeBerryPreserves - field in class Dashboard.ChartWidget

ColorThemeBerryTart - field in class Dashboard.ChartWidget

ColorThemeBiscayneBay - field in class Dashboard.ChartWidget

ColorThemeBlackberries - field in class Dashboard.ChartWidget

ColorThemeBloodOrange - field in class Dashboard.ChartWidget

ColorThemeBlue - field in class Dashboard.ChartWidget

ColorThemeBlueFrost - field in class Dashboard.ChartWidget

ColorThemeBlueJewel - field in class Dashboard.ChartWidget

ColorThemeBluesAndBrowns - field in class Dashboard.ChartWidget

ColorThemeBreezy - field in class Dashboard.ChartWidget

ColorThemeBreezyToo - field in class Dashboard.ChartWidget

ColorThemeBrown - field in class Dashboard.ChartWidget

ColorThemeBrownFur - field in class Dashboard.ChartWidget

ColorThemeCamo - field in class Dashboard.ChartWidget

ColorThemeCampsite - field in class Dashboard.ChartWidget

ColorThemeCanary - field in class Dashboard.ChartWidget

ColorThemeChocolateRaspberry - field in class Dashboard.ChartWidget

ColorThemeCitrus - field in class Dashboard.ChartWidget

ColorThemeCoastline - field in class Dashboard.ChartWidget

ColorThemeColorful1 - field in class Dashboard.ChartWidget

ColorThemeColorful2 - field in class Dashboard.ChartWidget

ColorThemeColorful3 - field in class Dashboard.ChartWidget

ColorThemeColorful4 - field in class Dashboard.ChartWidget

ColorThemeColorful5 - field in class Dashboard.ChartWidget

ColorThemeColorful6 - field in class Dashboard.ChartWidget

ColorThemeColorful7 - field in class Dashboard.ChartWidget

ColorThemeCoral - field in class Dashboard.ChartWidget

ColorThemeCranberry - field in class Dashboard.ChartWidget

ColorThemeCranberryTart - field in class Dashboard.ChartWidget

ColorThemeDarkToLight - field in class Dashboard.ChartWidget

ColorThemeDeepBlueSea - field in class Dashboard.ChartWidget

ColorThemeDefault - field in class Dashboard.ChartWidget

ColorThemeDismal - field in class Dashboard.ChartWidget

ColorThemeDivergentBlueTanGreen - field in class Dashboard.ChartWidget

ColorThemeDivergentBlueTanRed - field in class Dashboard.ChartWidget

ColorThemeDivergentBlueWhiteRed - field in class Dashboard.ChartWidget

ColorThemeDivergentRedOrangeRed - field in class Dashboard.ChartWidget

ColorThemeDriedRoses - field in class Dashboard.ChartWidget

ColorThemeEarlyAmerican - field in class Dashboard.ChartWidget

ColorThemeEarthTones1 - field in class Dashboard.ChartWidget

ColorThemeEarthTones2 - field in class Dashboard.ChartWidget

ColorThemeEarthTones3 - field in class Dashboard.ChartWidget

ColorThemeEscape - field in class Dashboard.ChartWidget

ColorThemeEveningThunder - field in class Dashboard.ChartWidget

ColorThemeFeathers - field in class Dashboard.ChartWidget

ColorThemeFlorida - field in class Dashboard.ChartWidget

ColorThemeGray - field in class Dashboard.ChartWidget

ColorThemeGrayscaleTransparent - field in class Dashboard.ChartWidget

ColorThemeGreen - field in class Dashboard.ChartWidget

ColorThemeHeirloom - field in class Dashboard.ChartWidget

ColorThemeHomestyle - field in class Dashboard.ChartWidget

ColorThemeIcyLeaves - field in class Dashboard.ChartWidget

ColorThemeIndex - field in class Dashboard.ChartWidget

The index of the color theme associated with the widget, if applicable


ColorThemeLakeside - field in class Dashboard.ChartWidget

ColorThemeLavender - field in class Dashboard.ChartWidget

ColorThemeMargarita - field in class Dashboard.ChartWidget

ColorThemeMistyGarden - field in class Dashboard.ChartWidget

ColorThemeMountainMist - field in class Dashboard.ChartWidget

ColorThemeMountainSunset - field in class Dashboard.ChartWidget

ColorThemeOliveBranch - field in class Dashboard.ChartWidget

ColorThemeOrange - field in class Dashboard.ChartWidget

ColorThemePeacock - field in class Dashboard.ChartWidget

ColorThemePetals - field in class Dashboard.ChartWidget

ColorThemePomegranate - field in class Dashboard.ChartWidget

ColorThemePowderedCookie - field in class Dashboard.ChartWidget

ColorThemePurple - field in class Dashboard.ChartWidget

ColorThemePurpleBerry - field in class Dashboard.ChartWidget

ColorThemeRed - field in class Dashboard.ChartWidget

ColorThemeRetro - field in class Dashboard.ChartWidget

ColorThemeRooster - field in class Dashboard.ChartWidget

ColorThemeRope - field in class Dashboard.ChartWidget

ColorThemeRosemary - field in class Dashboard.ChartWidget

ColorThemeSandyBeach - field in class Dashboard.ChartWidget

ColorThemeSeaFoam - field in class Dashboard.ChartWidget

ColorThemeSepia - field in class Dashboard.ChartWidget

ColorThemeSky - field in class Dashboard.ChartWidget

ColorThemeTomorrowDark - field in class Dashboard.ChartWidget

ColorThemeTomorrowLight - field in class Dashboard.ChartWidget

ColorThemeTropicalSunset - field in class Dashboard.ChartWidget

ColorThemeWatermelon - field in class Dashboard.ChartWidget

ColorThemeWinterRobin - field in class Dashboard.ChartWidget

ColorWithOpacity - class in Dashboard

ColorWithOpacity(BBjString p_colorHexString$, BBjNumber p_opacity) - constructor in class Dashboard.ColorWithOpacity

Cols! - field in class GxCellEditors.GxCellEditorLargeText

Number of character columns to display. Default is 60.


ColSpacing - field in class Dashboard.DashboardCategory

Space in pixels between columns of widgets


Column! - field in class GxCellEditors.GxCellEditorSuggestionResolver

The column model


Column! - field in class GxClientModels.GxClientCellModel

The cell's column


Column! - field in class GxClientModels.GxClientFilterAbstractModel

The working column


COLUMN_GROUP_CLOSED() - method in class GxColumns.GxColumnDefinition

A constant which defines the group state as opened


COLUMN_GROUP_CLOSED() - method in class GxColumns.GxDefaultColumnDefinition

A constant which defines the group state as opened


COLUMN_GROUP_OPENED() - method in class GxColumns.GxColumnDefinition

A constant which defines the group state as opened


COLUMN_GROUP_OPENED() - method in class GxColumns.GxDefaultColumnDefinition

A constant which defines the group state as opened


COLUMN_WIDTHS_FROM_DATA - field in class Dashboard.GridWidget

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.


COLUMN_WIDTHS_FROM_HEADER - field in class Dashboard.GridWidget

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.


COLUMN_WIDTHS_FROM_HEADER_AND_DATA - field in class Dashboard.GridWidget

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.


COLUMN_WIDTHS_FROM_WIDGET - field in class Dashboard.GridWidget

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.


ColumnGroupShow! - field in class GxColumns.GxColumnDefinition

Whether to show the column when the group is open / closed.


#Configuration
#ColumnsRenderer


ColumnHeaderHeight - field in class Dashboard.GridWidget

A number that detmines the grid's column header height in pixels


columnHeaderSelectColumn(BBjGridMouseUpEvent ev!) - method in class QVGrid.QVGrid

Grid column header mouse up handler


ColumnHoverHighlight! - field in class GxOptions.GxOptions

Set to true to highlight columns by adding the ag-column-hover CSS class.
#Configuration
#GridRenderer


Columns! - field in class Dashboard.GridExWidget

A developer-provided vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget


Columns! - field in class Dashboard.GridWidget

A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget


Columns! - field in class Dashboard.PieChartWidget

A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget


Columns! - field in class Dashboard.BarChartWidget

A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget


Columns! - field in class Dashboard.LineChartWidget

A vector of columns indicating which fields in the BBjRecordSet will be used to provide data for the widget


Columns! - field in class Dashboard.RecordsetSeries

Columns! - field in class GxClientModels.GxClientRangeSelectionModel

An array of column objects where every object is instance of GxClientColumnModel


Columns! - field in class GxClientModels.GxClientAddRangeSelectionModel

A list of column ids to use. Note that none existing columns will be ignored silently


Columns! - field in class GxColumns.GxColumnsManager

Column & column groups definitions map


ColumnsDefinition! - field in class GxColumns.GxColumnsManager

The column definitions map


ColumnsGroupsDefinition! - field in class GxColumns.GxColumnsManager

The column groups definitions map


ColumnsManager! - field in class BBjGridExWidget.BBjGridExWidget

Columns Manager instance


ColumnSpanExpression! - field in class GxColumns.GxDefaultColumnDefinition

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:

  1. Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.


#Configuration
#ColumnsRenderer.


Command$ - field in class BBJasper.BBJasperHyperlink

COMMAND_HYPERLINK_TYPE - field in class BBJasper.BBJasperHyperlink

compare(GxCellEditorInterface one!, GxCellEditorInterface two!) - method in class GxCellEditors.GxCellEditorComparator

Compare two cell editors


compare(GxFilterInterface one!, GxFilterInterface two!) - method in class GxFilters.GxFilterComparator

Compare two filters


compare(GxRendererInterface one!, GxRendererInterface two!) - method in class GxRenderers.GxCellRendererComparator

Compare two cell renderers


compareTo(Object other!) - method in class GDoc

compareTo(Object p_treeNode!) - method in class TreeNode

connect() - method in class BUS

CONNECT_ERROR=303 - field in class BUS

CONNECTION_ERROR=302 - field in class BBJasper.BBJasperReport

Constant value that represents a connection error


CONNECTION_TYPE=2 - field in class BBJasper.DesignType

ConnectString$ - field in class Dashboard.GridExWidget

A developer-provided JDBC connect string used to connect to the database


ConnectString$ - field in class Dashboard.GridWidget

A JDBC connect string used to connect to the database


ConnectString$ - field in class Dashboard.PieChartWidget

A JDBC connect string used to connect to the database


ConnectString$ - field in class Dashboard.BarChartWidget

A JDBC connect string used to connect to the database


ConnectString$ - field in class Dashboard.LineChartWidget

A JDBC connect string used to connect to the database


ConnectString$ - field in class Dashboard.SQLSeries

consoleLog(BBjString msg!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


constructName(HashMap controlMap!) - method in class DialogWizard.DialogUtils

Method constructName: Construct a valid control name


contactsDialogChange(BBjNumber p_newContact) - method in class Email.EmailDialog

contactsDialogChange Brings up the contacts dialog


CONTAINS() - method in class GxFilters.GxColumnFilterTextFilterOptions

CONTAINS$=#Translations!.getTranslation("contains") - field in class BBJasper.BBJasperView

Translated text for contains


containsAllTags(BBjVector tags!) - method in class BBjCalendarWidget.CalendarEntry

Returns whether an entry contains all the provided tags in the entry's vector of tags.


containsAllTags(BBjString tags!) - method in class BBjCalendarWidget.CalendarEntry

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.


containsAnyTag(BBjVector tags!) - method in class BBjCalendarWidget.CalendarEntry

Returns whether an entry contains any of the provided tags in the entry's vector of tags.


containsAnyTag(BBjString tags!) - method in class BBjCalendarWidget.CalendarEntry

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.


containsExtendedPropertyKey(BBjString key!) - method in class BBjCalendarWidget.CalendarEntry

Returns whether the provided extended property key exists the entry's HashMap of extended properties.


containsTag(BBjString tag!) - method in class BBjCalendarWidget.CalendarEntry

Returns whether the provided tag exists the entry's vector of tags.


Content! - field in class BBWebClient.BBWebRequest

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.


ContextMenu! - field in class GxOptions.GxOptions

The grid context menu
#Configuration
#GridRenderer


CONTRACT_ALL() - method in class GxContextMenu.GxContextMenuItem

ContractColumnSelection! - field in class GxSidebar.GxColumnsToolpanel

By default, column groups start expanded. Pass true to default to contracted groups


Control - class in DialogWizard

Control

Control Class


Control(BBjNumber pType) - constructor in class DialogWizard.Control

Constructor Control


Control(BBjNumber pType, BBjNumber pEvents) - constructor in class DialogWizard.Control

Constructor Control


CONTROL_CHILD_WINDOW_NAME$="BBJVControlChildWindow" - field in class BBJasper.BBJasperViewerControl

Viewer control child window name


CONTROL_CHILD_WINDOW_NAME$=BBJasperViewerControl.getCONTROL_CHILD_WINDOW_NAME() - field in class Dashboard.JasperViewerWidget

Viewer control child window name


CONTROL_CONTAINER - field in class BaseBuildItem

CONTROL_ERROR=502 - field in class BBJasper.BBJasperViewerControl

Constant that represents a control error


convertEntriesArrayToBBjVector(JsonArray entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


convertEntriesArrayToBBjVector(BBjString entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


convertEntriesBBjVectorToJsonArray(BBjVector entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

A utility method that converts a BBjVector filled with CalendarEntry object to a JSON array of calendar entries.


convertToDataAware(BBjNumber channel, BBjString template$) - method in class QVGrid.QVGrid

Converts grid to a BBjDataAwareGrid


CookieGroup!=null() - field in class gappsv3.GOAuth2

Specifies type of cookie. (Session, etc.) default is null.


CookieRefreshTokenVariable!="GOAuth2RefreshToken" - field in class gappsv3.GOAuth2

Indicates the name of the variable that stores the refresh token in the cookie.


CookieScopeVariable!="GOAuth2Scope" - field in class gappsv3.GOAuth2

Indicates the name of the variable that stores scopes in the cookie. Typically does not need to be modified.


CookieTokenVariable!="GOAuth2Token" - field in class gappsv3.GOAuth2

Indicates the name of the variable that is used to store the token in the cookie. Typically does not need to be modified.


COPY() - method in class GxContextMenu.GxContextMenuItem

COPY_JOBS - field in class Admin

COPY_WITH_GROUP_HEADERS() - method in class GxContextMenu.GxContextMenuItem

COPY_WITH_HEADERS() - method in class GxContextMenu.GxContextMenuItem

copyFile(BBjString p_source$, BBjString p_target$) - method in class DemoUtils.DemoUtils

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.


copyFileToWebServer(BBjString p_srcFile$) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjString p_destFile$) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjString p_destFile$, BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjString p_destFile$, BBjNumber p_requireSSL, BBjNumber p_obfuscatePath) - method in class BBUtils.BBUtils

copyFileToWebServer(BBjString p_srcFile$) - method in class BBLaunchDock

copyFileToWebServer(BBjString p_srcFile$, BBjNumber p_requireSSL) - method in class BBLaunchDock

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$) - method in class BBLaunchDock

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjNumber p_requireSSL) - method in class BBLaunchDock

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjString p_destFile$) - method in class BBLaunchDock

copyFileToWebServer(BBjString p_srcFile$, BBjString p_destSubDir$, BBjString p_destFile$, BBjNumber p_requireSSL) - method in class BBLaunchDock

copyToClient(BBjString p_serverFileName$, BBjString p_clientFileName$) - method in class BBJasper.BBJasper

copyToClient Copies the passed server file to the passed client file


copyWebAssets(BBjString script!) - method in class BBjGridExWidget.BBjGridExWidget

Inject a js Script.


Count!=null() - field in class gappsv3.SimpleRULE

Number of times for event recurrence. Required if not using UntilDate or UntilDateTime.


Create() - method in class BBWebClient.BBWebRequest

Creates an HttpRequestBase object from the fields of this object.


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.Widget

Called to create the widget


create(BBjControl p_widgetControlWindow!) - method in class Dashboard.BBjWidget

Creates a BBjWidget in the specified BBjChildWindow


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.ImageWidget

Creates the ImageWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.HtmlViewWidget

Creates the HtmlViewWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.GridExWidget

Called to create the widget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.GridWidget

Creates the GridWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.PieChartWidget

Creates the PieChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.RingChartWidget

Creates the RingChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.BarChartWidget

Creates the BarChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.StackedBarChartWidget

Creates the StackedBarChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.StackedPercentageBarChartWidget

Creates the StackedPercentageBarChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.LineChartWidget

Creates the LineChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.AreaChartWidget

Creates the AreaChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.StackedAreaChartWidget

Creates the StackedAreaChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.XYChartWidget

Creates the XYChartWidget


create(BBjChildWindow p_widgetControlWindow!) - method in class Dashboard.JasperViewerWidget

Creates the JasperViewerWidget


CREATE_ERROR=301 - field in class BUS

CREATE_ERROR=306 - field in class GDocsService

CREATE_IMAGE$=#Translations!.getTranslation("create.image") - field in class BBJasper.BBJasperViewerControl

Translated text for create image


CREATE_IMAGE_TOOL_BUTTON_NAME$="BBJVCreateImageToolButton" - field in class BBJasper.BBJasperViewerControl

Create imaage tool button name


CREATE_IMAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getCREATE_IMAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Create imaage tool button name


CREATE_NEW_DB - field in class Admin

CREATE_NEW_TRIGGER - field in class Admin

createAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createBBjCalendarWidget(BBjWindow wnd!) - method in class BBjCalendarWidget.CalendarAPI

Creates a BBjCalendarWidget given a BBjWindow where the widget takes up the full size of the window.


createBBjCalendarWidget(BBjWindow wnd!, BBjNumber debug!) - method in class BBjCalendarWidget.CalendarAPI

Creates a BBjCalendarWidget given a BBjWindow where the widget takes up the full size of the window.


createBBjCalendarWidget(BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h!) - method in class BBjCalendarWidget.CalendarAPI

Creates a BBjCalendarWidget given a BBjWindow and control ID, and the calendar's size and position.


createBBjCalendarWidget(BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h!, CalendarOptions options!) - method in class BBjCalendarWidget.CalendarAPI

Creates a BBjCalendarWidget given a BBjWindow and control ID, the calendar's size and position, and a CalendarOptions object.


createBBjCalendarWidget(BBjWindow wnd!, BBjNumber id!, BBjNumber x!, BBjNumber y!, BBjNumber w!, BBjNumber h!, CalendarOptions options!, BBjString template!, BBjNumber debug!) - method in class BBjCalendarWidget.CalendarAPI

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.


createBuildItem(BBjNumber p_buildItemType) - method in class WidgetWizard

Method createBuildItem: Creates the build item


createBuildItemPreview(BBjChildWindow p_frameChildWindow!) - method in class WidgetWizard

Method getDashboardControl: Creates and returns a dashboard control


createCalendarEntry(JsonObject json!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarEntry given a JsonObject representation of the CalendarEntry object.


createCalendarEntry(BBjString title!, BBjString start!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarEntry given an entry title and starting date/time string.


createCalendarEntry(BBjString title!, BBjString start!, BBjString end!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarEntry given an entry title, starting date/time string, and ending date/time string.


createCalendarEntrySource() - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarEntrySource with default values.


createCalendarEntrySource(BBjString id!, BBjString url!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarEntrySource(BBjString id!, BBjString url!, BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarEntrySourceGoogle(BBjString id!, BBjString calendarId!) - method in class BBjCalendarWidget.CalendarAPI

Contructs a CalendarEntrySourceGoogle object for the provided Google Calendar ID.


createCalendarEntrySourceGoogle(BBjString id!, BBjString calendarId!, BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarEntrySourceiCalendar(BBjString id!, BBjString url!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarEntrySourceiCalendar(BBjString id!, BBjString url!, BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarOptions() - method in class BBjCalendarWidget.CalendarAPI

Creates an instance of the CalendarOptions class with default values.


createCalendarToolbar() - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarToolbar using the default toolbar position of CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP().


createCalendarToolbar(BBjString position!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarToolbar given the desired toolbar position, e.g. CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP() or CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM().


createCalendarToolbar(BBjString position!, CalendarToolbarSection startSection!, CalendarToolbarSection centerSection!, CalendarToolbarSection endSection!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarToolbar given the desired toolbar position, e.g. CalendarAPI.CALENDAR_TOOLBAR_POSITION_TOP() or CalendarAPI.CALENDAR_TOOLBAR_POSITION_BOTTOM().


createCalendarToolbar(BBjString position!, BBjString startSection!, BBjString centerSection!, BBjString endSection!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarToolbarSection(BBjString alignment!) - method in class BBjCalendarWidget.CalendarAPI

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.

createCalendarToolbarSection(BBjString alignment!, BBjString objects!) - method in class BBjCalendarWidget.CalendarAPI

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.

createCalendarView(BBjString type!) - method in class BBjCalendarWidget.CalendarAPI

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.


createCalendarView(JsonObject json!) - method in class BBjCalendarWidget.CalendarAPI

Creates a CalendarView given a JsonObject representation of the view object.


createCombinedImage(BBjImage p_imageBottom!, BBjImage p_imageTop!, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Creates a BBjImage by overlaying one image on top of another, specifying the final image dimensions


createCombinedImagesWithText(BBjImage p_imageBottom!, BBjImage p_imageMiddle!, BBjString p_text$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

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.


createCombinedImageWithText(BBjImage p_image!, BBjString p_text$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

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.


createDB(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_host$, BBjInt p_port%, BBjString p_user$, BBjString p_password$, BBjString p_path$, BBjString p_dbAdminPassword$, BBjString p_encryptKey$) - method in class BUS

createEmbeddedWidget(Widget p_widget!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a embedded widget


createEmbeddedWidgetSet(BBjString p_name$, BBjString p_title$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a embedded widget set


createFile(BBjString p_parentFolderID$, BBjString p_title$, BBjString p_mimeType$, BBjString p_description$) - method in class GDocsService

createFileFromStream(BBjString p_filepath$, ByteArrayOutputStream p_baos!) - method in class BBJasper.BBJasper

createFileFromStream


createFolder(BBjString p_folder$) - method in class GDocsService

createFolder(BBjString p_folder$, BBjString p_parentId$) - method in class GDocsService

createFolder(BBjString p_title$, BBjString p_parentFolderID$, BBjString p_description$) - method in class GDocsService

createGridEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a grid embedded widget


createGridEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a grid embedded widget


createGridEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a grid embedded widget


createGridEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a grid embedded widget


createGridEmbeddedWidget(BBjString p_name$, BBjString p_title$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns an empty GridWidget as an embedded widget


createGridExEmbeddedWidget(BBjString p_name$, BBjString p_title$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns an empty GridExWidget as an embedded widget


createGridExEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a GridExWidget as an embedded widget using a connection string and SQL query


createGridExEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a GridExWidget as an embedded widget using a connection string, SQL query, and mode


createGridExEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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


createGridExEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a GridExWidget as an embedded widget using BBjVectors for the column header data and row data


createHtmlViewEmbeddedWidget(BBjString p_name$, BBjString p_title$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a html view embedded widget


createHtmlViewEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_text$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a html view embedded widget


createImageEmbeddedWidget(BBjString p_name$, BBjString p_title$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns an image embedded widget


createImageEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_imageName$) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns an image embedded widget


createImageEmbeddedWidget(BBjString p_name$, BBjString p_title$, URL p_imageURL!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns an image embedded widget


createImageFromBBjImage(BBjImage p_image!) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a BBjImage


createImageFromImage(Image p_image!) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a Java Image Object


createImageFromImageIcon(ImageIcon p_image!) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a Java ImageIcon object


createImageFromServerFile(BBjString p_serverFileName$) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a server file


createImageFromText(BBjString p_text$, BBjString p_foreColor$, BBjNumber p_foreOpacity, BBjString p_backColor$, BBjNumber p_backOpacity, BBjString p_fontFile$, BBjString p_fontStyle$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

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.


createImageFromText(BBjString p_text$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

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.


createImageFromText(BBjString p_text$, BBjString p_foreColor$, BBjNumber p_foreOpacity, BBjString p_backColor$, BBjNumber p_backOpacity, Font p_font!, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Creates a BBjImage by drawing text on a graphics context

You can use a linefeed character ($0A$) to split the text into multiple lines


createImageFromText(BBjString p_text$, BBjString p_foreColor$, BBjNumber p_foreOpacity, Font p_font!, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Creates a BBjImage by drawing text on a transparent background

You can use a linefeed character ($0A$) to split the text into multiple lines


createImageFromURL(BBjString p_imageURL$) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a string represetatin of a URL


createImageFromURL(URL p_imageURL!) - method in class BBXImage.BBXImageFactory

Creates a BBXImage from a URL


createItem(BBjString label!, BBjString value!, BBjString group!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Create a new suggestion item


createItem(BBjString label!, BBjString value!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Create a new suggestion item


createItem(BBjString label!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Create a new suggestion item


createJasperViewerEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBJasperReport p_report!) - method in class Dashboard.EmbeddedWidgetFactory

Creates and returns a jasper viewer embedded widget by passing in a BBJasperReport object


createJasperViewerEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) - method in class Dashboard.EmbeddedWidgetFactory

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


createJDBCURL(BBjString p_host$, BBjInt p_port%, BBjString p_database$, BBjString p_user$, BBjString p_password$) - method in class BUS

createLineChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createLineChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createLineChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createLineChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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(BBjString p_localeString!) - method in class BBJasper.BBJasper

createLocale


createLocale(BBjString p_localeString!) - method in class BBTranslator.BBTranslator

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


createNewFrame(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pFrame, HashMap pDataMap!) - method in class WidgetWizardFrameFactory

Method createNewFrame: Instantiate a wizard frame


createNewFrame(BBjTopLevelWindow pWndWizard!, BBjNumber pFrame, HashMap pDataMap!) - method in class DialogWizard.DialogWizardFrameFactory

Method createNewFrame: Instantiate a wizard frame


createParentDirs(BBjString p_fileName!) - method in class BBTranslator.BBTranslationBundle

createPgmFile() - method in class DialogWizard.DialogWizard

Method createPgmFile: Generate program file


createPieChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createPieChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createPieChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createPieChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - method in class Dashboard.EmbeddedWidgetFactory

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.


createPieChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createPreview(BBjChildWindow p_frameChildWindow!) - method in class BuildItem

createPreview(BBjChildWindow p_frameChildWindow!) - method in class WidgetBuildItem

createPreview(BBjChildWindow p_frameChildWindow!) - method in class WidgetSetBuildItem

createPreview(BBjChildWindow p_frameChildWindow!) - method in class WidgetDashboardBuildItem

createRadialGradientPaint(Color p_color1!, Color p_color2!, Point2D p_center!) - method in class Dashboard.ChartWidget

Gets a radial gradient paint based off of two colors and the center point relative to the entire chart


createReport(BBjString p_reportName$, BBjString p_reportFile$) - method in class BBJasper.BBJasperDesign

createReport Creates and returns a BBJasperReport using no SQL result set


createReport(BBjString p_reportName$, BBjString p_reportFile$, java.sql.ResultSet p_rs!) - method in class BBJasper.BBJasperDesign

createReport Creates and returns a BBJasperReport using an SQL result set


createRingChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createRingChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createRingChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createRingChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - method in class Dashboard.EmbeddedWidgetFactory

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.


createRingChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createServlet() - method in class GoldMineIntegration.GoldMineIntegrationWebServiceFactory

Static method to create the GoldMineIntegrationWebService servlet

@result The servlet as an object


createStackedAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedAreaChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedPercentageBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedPercentageBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedPercentageBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createStackedPercentageBarChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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(BBjString p_reportFile$, HashMap p_params!) - method in class BBJasper.BBJasperReport

createSubReport Creates a sub report, which inherits parameters from this report


createTempDir() - method in class BBJasper.BBJasper

createTempDir Creates a temp directory and returns the path


createVector(Object p_object!) - method in class BBJasper.BBJasper

createVector Creates and returns a BBjVector for the passed object


createXYChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createXYChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.EmbeddedWidgetFactory

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.


createXYChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.EmbeddedWidgetFactory

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.


createXYChartEmbeddedWidget(BBjString p_name$, BBjString p_title$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - method in class Dashboard.EmbeddedWidgetFactory

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.


crop(BBjNumber p_x, BBjNumber p_y, BBjNumber p_w, BBjNumber p_h) - method in class BBXImage.BBXImage

Method to crop the BBXImage to a specified rectangular region


cropBackground() - method in class BBXImage.BBXImage

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.


cropTransparent() - method in class BBXImage.BBXImage

Method to return the smallest image possible by cropping out the transparent edges of the original image


CssClasses! - field in class GxContextMenu.GxContextMenuItem

Additional CSS classes to be applied to the menu item


CSV_EXPORT() - method in class GxContextMenu.GxContextMenuItem

CSV_SAVE_CONTRIBUTOR=10 - field in class BBJasper.BBJasperView

Constant that represents the CSV save contributor


CSV_SAVE_CONTRIBUTOR=BBJasperView.getCSV_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the CSV save contributor


CSVExporter! - field in class BBJasper.BBJasperView

CSV exporter which contains export options


CTRL$=#Translations!.getTranslation("ctrl") - field in class BBJasper.BBJasperView

Translated text for ctrl


CURRENT_PAGE$=#Translations!.getTranslation("current.page") - field in class BBJasper.BBJasperView

Translated text for currrent page


CURRENT_WINDOW_HYPERLINK_TARGET - field in class BBJasper.BBJasperHyperlink

CUSTOM_PAGE$=#Translations!.getTranslation("custom.page") - field in class BBJasper.BBJasperView

Translated text for custom page


CUSTOM_PAGE_INPUTN_NAME$="BBJVCustomPageInputN" - field in class BBJasper.BBJasperView

Custom page inputn name


CUSTOM_PAGE_MENU_ITEM_NAME$="BBJVCustomPageMenuItem" - field in class BBJasper.BBJasperView

Custom page menu item name


CUSTOM_PAGE_MENU_ITEM_NAME$=BBJasperView.getCUSTOM_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Custom page menu item name


CUSTOM_PAGE_STATIC_TEXT_NAME$="BBJVCustomPageStaticText" - field in class BBJasper.BBJasperView

Custom page static text name


CUSTOM_PAGE_WINDOW_NAME$="BBJVCustomPageWindow" - field in class BBJasper.BBJasperView

Custom page window name


CUSTOM_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Custom widget type constant


CUSTOM_ZOOM$=#Translations!.getTranslation("custom.zoom") - field in class BBJasper.BBJasperView

Translated text for custom zoom


CUSTOM_ZOOM_LIST_EDIT_NAME$="BBJVCustomZoomListEdit" - field in class BBJasper.BBJasperView

Custom zoome list edit name


CUSTOM_ZOOM_MENU_ITEM_NAME$="BBJVCustomZoomMenuItem" - field in class BBJasper.BBJasperView

Custom zoom menu item name


CUSTOM_ZOOM_MENU_ITEM_NAME$=BBJasperView.getCUSTOM_ZOOM_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Custom zoom menu item name


CUSTOM_ZOOM_RATIO$=#Translations!.getTranslation("custom.zoom") - field in class BBJasper.BBJasperViewerControl

Translated text for custom zoom


CUSTOM_ZOOM_STATIC_TEXT_NAME$="BBJVCustomZoomStaticText" - field in class BBJasper.BBJasperView

Custom zoom static text name


CUSTOM_ZOOM_WINDOW_NAME$="BBJVCustomZoomWindow" - field in class BBJasper.BBJasperView

Custom zoom window name


CustomChartColors! - field in class Dashboard.ChartWidget

A BBjVector containing one or more Java Color objects to be used when customizing the ChartWidget's colors


CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$="dashboardCustomizeControlBarBackground" - field in class Dashboard.DashboardControl

Customize control bar background name


CUSTOMIZE_DONE_BUTTON_NAME$="dashboardCustomizeWindowDoneButton" - field in class Dashboard.DashboardControl

Customize done button name


CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$="dashboardCustomizePreviewAddButton1" - field in class Dashboard.DashboardControl

Customize preview add button 1 name


CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$="dashboardCustomizePreviewHtmlView1" - field in class Dashboard.DashboardControl

Customize preview html view 1 name


CUSTOMIZE_PREVIEW_IMAGE_1_NAME$="dashboardCustomizePreviewImage1" - field in class Dashboard.DashboardControl

Customize preview image 1 name


CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$="dashboardCustomizeWindowNextButton" - field in class Dashboard.DashboardControl

Customize Next button name


CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$="dashboardCustomizeWindowPrevButton" - field in class Dashboard.DashboardControl

Customize Previous button name


CUSTOMIZE_PREVIEW_STATUS_TEXT$="dashboardCustomizeWindowStatus" - field in class Dashboard.DashboardControl

Customize status text


CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$="dashboardCustomizePreviewWidgetFontScalingCheckBox" - field in class Dashboard.DashboardControl

Customize preview Fixed Widget Size Checkbox


CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$="dashboardCustomizePreviewWidgetFontScalingSlider" - field in class Dashboard.DashboardControl

Customize preview widget window name


CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$="dashboardCustomizePreviewWidgetSizeCheckBox" - field in class Dashboard.DashboardControl

Customize preview Fixed Widget Size Checkbox


CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$="dashboardCustomizePreviewWidgetSizeSlider" - field in class Dashboard.DashboardControl

Customize preview widget window name


CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$="dashboardCustomizePreviewWidgetTitle" - field in class Dashboard.DashboardControl

Customize preview widget title name


CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$="dashboardCustomizePreviewWidgetWindow" - field in class Dashboard.DashboardControl

Customize preview widget window name


CUSTOMIZE_WINDOW_NAME$="dashboardCustomizeWindow" - field in class Dashboard.DashboardControl

Customize window name


D

darkenColor(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Make a color darker


Dashboard - class in Dashboard

Dashboard Data class that encapsulates the entities that comprise a dashboard


Dashboard(BBjString p_name$, BBjString p_title$) - constructor in class Dashboard.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$="dashboardCategoryControlTitleBar" - field in class Dashboard.DashboardCategoryControl

Dashboard category control title bar name


DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$="dashboardCategoryControlTitleText" - field in class Dashboard.DashboardCategoryControl

Dashboard category control title text name


DASHBOARD_CATEGORY_WINDOW_NAME$="dashboardCategoryWindow" - field in class Dashboard.DashboardCategoryControl

Dashboard category window name


DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$="dashboardControlCustomizeButton" - field in class Dashboard.DashboardControl

Dashboard control customize button name


DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$="dashboardControlRefreshButton" - field in class Dashboard.DashboardControl

Dashboard control refresh button name


DASHBOARD_CONTROL_TAB_CTRL_NAME$="dashboardControlTabCtrl" - field in class Dashboard.DashboardControl

Dashboard control tab ctrl name


DASHBOARD_CONTROL_TITLE_BAR_NAME$="dashboardControlTitleBar" - field in class Dashboard.DashboardControl

Dashboard control title bar name


DASHBOARD_CONTROL_TITLE_TEXT_NAME$="dashboardControlTitleText" - field in class Dashboard.DashboardControl

Dashboard control title text name


DASHBOARD_CONTROL_TOOL_BAR_NAME$="dashboardControlToolBar" - field in class Dashboard.DashboardControl

Dashboard control tool bar name


DASHBOARD_CONTROL_WINDOW_NAME$="dashboardControlWindow" - field in class Dashboard.DashboardControl

Dashboard control window name


DASHBOARD_EXIT_BUTTON_NAME$="dashboardExitButton" - field in class Dashboard.DashboardWindow

Dashboard exit button name


DASHBOARD_GLASS_PANE_NAME$="dashboardGlassPane" - field in class Dashboard.DashboardControl

Dashboard glass pane name


DASHBOARD_WIDGET_AUTO_REFRESH_CONFIG_NAME$ - field in class Dashboard.WidgetControl

Auto refresh config menu name


DASHBOARD_WIDGET_AUTO_REFRESH_DONE_BUTTON_NAME$ - field in class Dashboard.WidgetControl

Auto refresh done button name


DASHBOARD_WIDGET_AUTO_REFRESH_NAME$ - field in class Dashboard.WidgetControl

Auto refresh menu item name


DASHBOARD_WIDGET_AUTO_REFRESH_RATE_NAME$ - field in class Dashboard.WidgetControl

Auto refresh rate name


DASHBOARD_WIDGET_AUTO_REFRESH_TEXT_NAME$ - field in class Dashboard.WidgetControl

Auto refresh text name


DASHBOARD_WIDGET_AUTO_REFRESH_UNITS_NAME$ - field in class Dashboard.WidgetControl

Auto refresh units name


DASHBOARD_WIDGET_AUTO_REFRESH_WINDOW_NAME$ - field in class Dashboard.WidgetControl

Auto refresh window name


DASHBOARD_WIDGET_CLOSE_BUTTON_NAME$ - field in class Dashboard.WidgetControl

Widget close button name


DASHBOARD_WIDGET_DECORATION_WINDOW_NAME$ - field in class Dashboard.WidgetControl

Widget decoration window name


DASHBOARD_WIDGET_MANUAL_REFRESH_NAME$ - field in class Dashboard.WidgetControl

Manual refresh menu item name


DASHBOARD_WIDGET_OPTIONS_BUTTON_NAME$ - field in class Dashboard.WidgetControl

Widget options button name


DASHBOARD_WIDGET_POPOUT_BUTTON_NAME$ - field in class Dashboard.WidgetControl

Widget popout button name


DASHBOARD_WIDGET_REFRESH_MENU_NAME$ - field in class Dashboard.WidgetControl

Refresh menu name


DASHBOARD_WIDGET_TITLE_BAR_NAME$ - field in class Dashboard.WidgetControl

Widget title bar name


DASHBOARD_WIDGET_TITLE_TEXT_NAME$ - field in class Dashboard.WidgetControl

Widget title text name


DASHBOARD_WIDGET_WINDOW_NAME$ - field in class Dashboard.WidgetControl

Widget window name


DASHBOARD_WINDOW_NAME$="dashboardWindow" - field in class Dashboard.DashboardWindow

Dashboard window name


DashboardCategory - class in Dashboard

DashboardCategory Data class that encapsulates the entities which comprise a dashboard category


DashboardCategory(BBjString p_name$, BBjString p_title$) - constructor in class Dashboard.DashboardCategory

DashboardCategory Constructs a DashboardCategory


DashboardCategory! - field in class Dashboard.DashboardWidget

DashboardCategory which a part of


DashboardCategoryAttribute - class in Dashboard

DashboardCategoryAttribute Data class for attributes of a dashboard category


DashboardCategoryAttribute() - constructor in class Dashboard.DashboardCategoryAttribute

Constructs a DashboardCategoryAttribute with default values. Note that the name must be set to a unique value later for the DashboardCategoryAttribute to be valid.


DashboardCategoryAttribute(DashboardCategory p_category!) - constructor in class Dashboard.DashboardCategoryAttribute

Constructs a DashboardCategoryAttribute given an existing DashboardCategory. The DashboardCategoryAttribute's fields are populated automatically from the DashboardCategory.


DashboardCategoryAttribute(BBjString p_stringTemplateString!) - constructor in class Dashboard.DashboardCategoryAttribute

Constructs a DashboardCategoryAttribute given a string template. The DashboardCategoryAttribute's fields are populated automatically from the values stored in the string template.


DashboardCategoryAttribute(BBjString p_name$, BBjNumber p_widgetSizingModel, BBjNumber p_minWidgetWidth, BBjNumber p_maxWidgetWidth, BBjNumber p_fixedWidgetWidth) - constructor in class Dashboard.DashboardCategoryAttribute

Constructs a DashboardCategoryAttribute given all the field values


DashboardCategoryControl - class in Dashboard

DashboardCategoryControl UI class that displays a dashboard category


DashboardCategoryControl(DashboardCategory p_dashboardCategory!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.DashboardCategoryControl

Constructs a DashboardCategoryControl


DashboardCategoryControl(DashboardCategory p_dashboardCategory!, DashboardControl p_dashboardControl!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.DashboardCategoryControl

Constructs a DashboardCategoryControl


DashboardCategoryControl(DashboardCategory p_dashboardCategory!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$, BBjNumber p_titleBar) - constructor in class Dashboard.DashboardCategoryControl

Constructs a DashboardCategoryControl


DashboardControl - class in Dashboard

DashboardControl UI class that displays a dashboard in a BBjChildWindow


DashboardControl(Dashboard p_dashboard!, DashboardWindow p_dashboardWindow!, BBjWindow p_parentWindow!, BBjString p_flags$) - constructor in class Dashboard.DashboardControl

Constructs a DashboardControl


DashboardControl(Dashboard p_dashboard!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.DashboardControl

Constructs a DashboardControl


DashboardControl(Dashboard p_dashboard!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$, BBjNumber p_titleBar, BBjNumber p_toolBar) - constructor in class Dashboard.DashboardControl

Constructs a DashboardControl


DashboardItem - class in Dashboard

DashboardItem The base dashboard class that all of the other dashboard data classes extend


DashboardItem(BBjString p_name$, BBjString p_title$) - constructor in class Dashboard.DashboardItem

DashboardItem Constructs a DashboardItem


DashboardWidget - class in Dashboard

DashboardWidget Data class that encapsulates the entities which comprise a dashboard widget


DashboardWidget(Widget p_widget!) - constructor in class Dashboard.DashboardWidget

DashboardWidget Constructs a DashboardWidget


DashboardWidget(DashboardCategory p_dashboardCategory!, Widget p_widget!) - constructor in class Dashboard.DashboardWidget

DashboardWidget Constructs a DashboardWidget


DashboardWidget! - field in class Dashboard.BaseWidget

Internal field variable used to associate the parent DashboardWidget with this widget.


DashboardWidget! - field in class Dashboard.HtmlViewWidgetEvent

DashboardWidget that the event occurred on


DashboardWidgetAttribute - class in Dashboard

DashboardWidgetAttribute Data class for attributes of a dashboard widget


DashboardWidgetAttribute(BBjString p_name$, BBjString p_category$, BBjNumber p_active, BBjNumber p_position, BBjNumber p_autoRefreshEnabled, BBjNumber p_autoRefreshRate, BBjNumber p_autoRefreshUnit, BBjNumber p_chartColorThemeIndex, BBjString p_chartFontFile$, BBjNumber p_chartFontScalingFactor) - constructor in class Dashboard.DashboardWidgetAttribute

Constructs a DashboardWidgetAttribute


DashboardWidgetClickEvent - class in Dashboard

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.


DashboardWidgetClickEvent(DashboardWidget p_dashboardWidget!, BBjMouseUpEvent p_event!) - constructor in class Dashboard.DashboardWidgetClickEvent

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 - class in Dashboard

DashboardWidgetControl UI class that displays a dashboard widget


DashboardWidgetControl(DashboardCategoryControl p_dashboardCategoryControl!, DashboardWidget p_dashboardWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.DashboardWidgetControl

Contructs a dashboard widget control


DashboardWidgetEvent - class in Dashboard

DashboardWidgetEvent Class that contains event information for a DashboardWidget. This is the base class for all dashboard widget events.


DashboardWidgetEvent(DashboardWidget p_dashboardWidget!) - constructor in class Dashboard.DashboardWidgetEvent

Contructs a DashboardWidgetEvent

The dashboard utility uses this method internally to create dashboard widget events


dashboardWidgetExists(BBjString p_widgetName$) - method in class Dashboard.DashboardCategory

Determines if a dashboard widget exists given its name


DashboardWidgetFilter - class in Dashboard

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


DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation) - constructor in class Dashboard.DashboardWidgetFilter

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


DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) - constructor in class Dashboard.DashboardWidgetFilter

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 in Dashboard

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.


DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$) - constructor in class Dashboard.DashboardWidgetFilterSelectEvent

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.


DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$, BBjNumber p_filterType) - constructor in class Dashboard.DashboardWidgetFilterSelectEvent

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.


DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$, BBjNumber p_filterType, BBjControl p_filterControl!) - constructor in class Dashboard.DashboardWidgetFilterSelectEvent

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 in Dashboard

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.


DashboardWidgetLeftClickEvent(DashboardWidget p_dashboardWidget!, BBjMouseUpEvent p_event!) - constructor in class Dashboard.DashboardWidgetLeftClickEvent

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 - class in Dashboard

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


DashboardWidgetLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect) - constructor in class Dashboard.DashboardWidgetLink

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 in Dashboard

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.


DashboardWidgetLinkSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_url$) - constructor in class Dashboard.DashboardWidgetLinkSelectEvent

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 - class in Dashboard

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


DashboardWidgetMenu(BBjPopupMenu p_bbjPopupMenu!, BBjNumber p_triggerType) - constructor in class Dashboard.DashboardWidgetMenu

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 in Dashboard

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.


DashboardWidgetMenuSelectEvent(DashboardWidget p_dashboardWidget!, BBjPopupSelectEvent p_event!) - constructor in class Dashboard.DashboardWidgetMenuSelectEvent

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 in Dashboard

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.


DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!) - constructor in class Dashboard.DashboardWidgetRefreshEvent

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.


DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!, BBjNumber p_refreshType) - constructor in class Dashboard.DashboardWidgetRefreshEvent

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 in Dashboard

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.


DashboardWidgetRightClickEvent(DashboardWidget p_dashboardWidget!, BBjMouseUpEvent p_event!) - constructor in class Dashboard.DashboardWidgetRightClickEvent

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 in Dashboard

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.


DashboardWidgetSelectEvent(DashboardWidget p_dashboardWidget!, WidgetControl p_widgetControl!) - constructor in class Dashboard.DashboardWidgetSelectEvent

Contructs a DashboardWidgetSelectEvent


DashboardWindow - class in Dashboard

DashboardWindow UI class that displays a dashboard in a BBjTopLevelWindow


DashboardWindow(Dashboard p_dashboard!) - constructor in class Dashboard.DashboardWindow

Constructs a DashboardWindow


DATA_ITEM_LABEL_POSITION_INSIDE_BOTTOM - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_INSIDE_CENTER - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_INSIDE_LEFT - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_INSIDE_RIGHT - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_INSIDE_TOP - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_OUTSIDE_BOTTOM - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_OUTSIDE_LEFT - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_OUTSIDE_RIGHT - field in class Dashboard.ChartWidget

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.


DATA_ITEM_LABEL_POSITION_OUTSIDE_TOP - field in class Dashboard.ChartWidget

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.


DATABASE_TYPE=4 - field in class BBJasper.DesignType

DATABASES_LABEL_TYPE=3 - field in class BBJasper.DesignType

DatabaseType - class in BBJasper

DatabaseType class


DatabaseType(BBjString p_databaseName$) - constructor in class BBJasper.DatabaseType

Constructor Constructs a DatabaseType for the given database.


DatabaseType(BBjNumber p_type, BBjString p_databaseName$) - constructor in class BBJasper.DatabaseType

Constructor Constructs a DatabaseType for the given type and database.


DataFillableWidget - interface in Dashboard

DataFillableWidget Interface that facilitates the filling of the underlying dataset of the widget


DataItem - class in Dashboard

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


DataItem() - constructor in class Dashboard.DataItem

Contructs a DataItem


DataPathTemplate! - field in class GxOptions.GxOptions

A string template which will be compiled on the client to return an array for the tree hierarchy.


#Enterprise
#Configuration
#GridRenderer


DataType$ - field in class BBJasper.ProcedureParam

DBAdminPassword$="admin123" - field in class BUS

DBEncryptKey$="secret" - field in class BUS

DBHost$="localhost" - field in class BUS

DBPassword$="admin123" - field in class BUS

DBPath$ - field in class BUS

DBPort%=2001 - field in class BUS

DBUser$="admin" - field in class BUS

DebounceMs! - field in class GxFilters.GxColumnFilterAG

The number of milliseconds to debounce by before applying the filter


Debug - field in class BBTranslator.BBTranslator

A field variable that turns on and off debug capability


Debug! - field in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


Debug! - field in class BBjGridExWidget.BBjGridExWidget

When true the grid will use the unmingled version of the Javascript code then open the debugger in a new window.


DebugFileName! - field in class BBTranslator.BBTranslator

A field variable that contains the location of the debug file. It defaults to 'TranslatorDebug.txt' in the current directory.


debugLog(BBjString msg!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


Decimals! - field in class GxExpressions.GxExpressionBytesFormatter

Number of decimal to use when parsing the size. default is 2


DecimalSeparator! - field in class GxCellEditors.GxCellEditorBasicNumber

The number's decimal separator to use. by default the bbj decimal separator will be used


DecimalSeparator! - field in class GxExpressions.GxExpressionNumbersFormatter

The number's decimal separator to use. by default the bbj decimal separator will be used


DEFAULT_CONNECT_STRING$ - field in class BaseBuildItem

DEFAULT_HOST$ - field in class Admin

DEFAULT_PASSWORD$ - field in class Admin

DEFAULT_PERMISSIONS - field in class Admin

DEFAULT_PORT% - field in class Admin

DEFAULT_REMEMBER% - field in class Admin

DEFAULT_SAVE_DISK=0 - field in class BBJasper.BBJasperView

Constant which represents the default save location as the disk


DEFAULT_SAVE_DISK=BBJasperView.getDEFAULT_SAVE_DISK() - field in class BBJasper.BBJasperViewerControl

Constant which represents the default save location as the disk


DEFAULT_SAVE_GOOGLE=1 - field in class BBJasper.BBJasperView

Constant which represents the default save location as Google docs


DEFAULT_SAVE_GOOGLE=BBJasperView.getDEFAULT_SAVE_GOOGLE() - field in class BBJasper.BBJasperViewerControl

Constant which represents the default save location as Google docs


DEFAULT_SCOPE=0 - field in class GDoc

DEFAULT_SSL% - field in class Admin

DEFAULT_TIMEOUT% - field in class Admin

DEFAULT_USER$ - field in class Admin

DefaultColumnDefinition! - field in class GxOptions.GxOptions

Contains column properties all columns will inherit.
#Configuration
#GridRenderer


DefaultColumnGroupDefinition! - field in class GxOptions.GxOptions

Contains column group properties all column groups will inherit.
#Configuration
#GridRenderer


DefaultDatesMask! - field in class GxColumns.GxDefaultColumnDefinition

The default dates mask to use. by default %Dz.%Mz.%Yd


DefaultDocument$ - field in class GDocSelectionDialog

DefaultFolder$ - field in class GDocSelectionDialog

DefaultHour! - field in class GxOptions.GxOptionsDateTime

Initial value of the hour element.


DefaultMinute! - field in class GxOptions.GxOptionsDateTime

Initial value of the minute element.


DefaultNumbersMask! - field in class GxColumns.GxDefaultColumnDefinition

The default numbers mask to use. by default null()


DefaultOption! - field in class GxFilters.GxColumnFilterAG

The default Filter Options to be selected. By default it is Equals


DefaultOption! - field in class GxFilters.GxFilterBasicDateTime

The default Filter Options to be selected. By default it is Equals


DefaultSave=#DEFAULT_SAVE_DISK - field in class BBJasper.BBJasperView

Sets the default save location, which is either DEFAULT_SAVE_DISK or DEFAULT_SAVE_GOOGLE. Default is DEFAULT_SAVE_DISK


DefaultSaveContributor=-1 - field in class Dashboard.JasperViewerWidget

Contributor that will be used by default on a save


DefaultSaveFile! - field in class Dashboard.JasperViewerWidget

File that will be used by default on a save


DefaultSaveFolder! - field in class Dashboard.JasperViewerWidget

Folder that will be used by default on a save


DefaultStringsMask! - field in class GxColumns.GxDefaultColumnDefinition

The default strings mask to use. by default null()


DefaultTimesMask! - field in class GxColumns.GxDefaultColumnDefinition

The default dates mask to use. by default %Dz.%Hz:%mz:%sz


DefaultTimestampsMask! - field in class GxColumns.GxDefaultColumnDefinition

The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz


DefaultToNothingSelected! - field in class GxFilters.GxFilterSetFilter

Set this to true to instead show all values as de-selected by default. Default: false


DefaultToolpanel$ - field in class GxSidebar.GxSidebar

The id of the default panel


DefaultType$ - field in class GDocSelectionDialog

DELETE_DB - field in class Admin

DELETE_USER - field in class Admin

deleteACL(BBjString aclId!) - method in class gappsv3.GCalendarAPI

Delete Access Control List. (Not implemented. Subject to removal or relocating.)


deleteCalendar(BBjString calendarId!) - method in class gappsv3.GCalendarAPI

Delete Calendar. (Not implemented. Subject to removal or relocating.)


deleteColumn(BBjNumber column) - method in class QVGrid.QVGrid

Deletes a column


deleteEvent(GEvent event!) - method in class gappsv3.GCalendar

Delete an event in the calendar.


deleteFromWebServer(BBjString p_url!) - method in class BBUtils.BBUtils

deleteRow(BBjNumber row) - method in class QVGrid.QVGrid

Deletes a row Note: The QVGrid completely handles the grid content displayed, so this method has no effect.


deleteWebServerFilesOlderThanNDays(BBjString p_destSubDir$, BBjNumber p_numDaysOld) - method in class BBUtils.BBUtils

DeltaColumnMode! - field in class GxOptions.GxOptions

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 - class in DemoUtils

DemoUtils In BBj 20.01 and higher, the DemoUtils is a BBj Custom Class that provides commonly-used routines for demo programs

THROWn Error Codes:

  • 700: Missing file. The specified file does not exist.
  • 705: Error during file operation, such as reading in a source file to copy to target file.
  • 710: Invalid BBjControl. The BBjControl is null(), invalid, does not exist, or does not implement required method.
  • 715: Invalid control/object provided. The control or object is null(), invalid, does not exist, or is empty.
  • 720: Error reading or writing a cookie. The get/setUserProperty() method failed with the provided error information.
  • 725: Error getting the BBjThinClient.

deselectAll() - method in class BBjGridExWidget.BBjGridExWidget

deselect all rows


#API


deselectAll(BBjNumber x!) - method in class BBjGridExWidget.BBjGridExWidget

deselect all rows


#API


deselectAllCells() - method in class QVGrid.QVGrid

Deselects all of the cells in the grid


deselectWidgetControl() - method in class Dashboard.DashboardCategoryControl

Deselects the current widget control


DesignType - class in BBJasper

DesignType base class


DesignType(BBjNumber p_type) - constructor in class BBJasper.DesignType

Constructor Constructs a DesignType for the given type.


destroy() - method in class Dashboard.Dashboard

Destroys the dashboard


destroy() - method in class Dashboard.DashboardCategory

Destroys the dashboard category and destroys all dashboardWidgets contained in the category


destroy() - method in class Dashboard.DashboardWidget

Destroys the DashboardWidget


destroy() - method in class Dashboard.DashboardWidgetFilter

Destroys the filter


destroy() - method in class Dashboard.DashboardWidgetMenu

Destroys the DashboardWidgetMenu


destroy() - method in class Dashboard.DashboardWidgetLink

Destroys the link


destroy() - method in class Dashboard.DashboardWindow

Destroys the dashboard window


destroy() - method in class Dashboard.DashboardControl

Destroys the dashboard control


destroy() - method in class Dashboard.DashboardCategoryControl

Destroys the dashboard category control


destroy() - method in class Dashboard.WidgetControl

Destroys the widget control


destroy() - method in class Dashboard.DashboardWidgetControl

Destroys the dashboard widget control


destroy() - method in class Dashboard.EmbeddedWidgetWindow

Destroys the EmbeddedWidgetWindow


destroy() - method in class Dashboard.EmbeddedWidgetSetWindow

Destroys the EmbeddedWidgetSetWindow


destroy() - method in class Dashboard.Widget

Destroys the widget


destroy() - method in class Dashboard.BaseWidget

Destroys the widget


destroy() - method in class Dashboard.BBjWidget

Destroys the BBjWidget and its interior BBjControl


destroy() - method in class Dashboard.ImageWidget

Destroys the ImageWidget


destroy() - method in class Dashboard.HtmlViewWidget

Destroys the HtmlViewWidget


destroy() - method in class Dashboard.GridExWidget

Destroys the GridExWidget


destroy() - method in class Dashboard.GridWidget

Destroys the GridWidget


destroy() - method in class Dashboard.PieChartWidget

Destroys the PieChartWidget


destroy() - method in class Dashboard.BarChartWidget

Destroys the BarChartWidget


destroy() - method in class Dashboard.LineChartWidget

Destroys the LineChartWidget


destroy() - method in class Dashboard.JasperViewerWidget

Destroys the JasperViewerWidget


destroy() - method in class BuildItem

destroy() - method in class BaseBuildItem

destroy() - method in class WidgetBuildItem

destroy() - method in class WidgetSetBuildItem

destroy() - method in class WidgetDashboardBuildItem

destroy() - method in class WidgetWizardFrameIntf

Method destroy: Frame destruction


destroy() - method in class WidgetWizardFrame

Method destroy: Frame destruction


destroy() - method in class DialogWizard.DialogWizardFrame

Method destroy: Frame destruction


destroy() - method in class DialogWizard.DialogWizardFrameIntf

Method destroy: Frame destruction


destroy() - method in class GDocSelectionDialog

destroy() - method in class BBLaunchDock

destroy() - method in class QVGrid.QVGrid

Destroys the QVGrid component child window


destroy() - method in class BBJasper.BBJasperReport

destroy Destroys the BBJasperReport object


destroy() - method in class BBJasper.BBJasperViewerWindow

destroy Removes self from any parent viewer control, then destroys the viewer control and the viewer window


destroy() - method in class BBJasper.BBJasperViewerControl

destroy Destroys the viewer control


destroy(BBjNumber p_closeAllViewerWindows) - method in class BBJasper.BBJasperViewerControl

destroy Destroys the control and optionally all viewer windows that were created by this control


destroy() - method in class BBJasper.BBJasperTabbedView

destroy Destroys the tabbed view and all contained views


destroy() - method in class BBJasper.BBJasperView

destroy Destroys the view


destroy(BBjNumber p_closeAllViewerWindows) - method in class BBJasper.BBJasperView

destroy Destroys the view and optionally all viewer windows that were created by this control


destroy() - method in class BBJasper.BBJasperProgress

destroy Destroys the progress window


destroy() - method in class BBjGridExWidget.BBjGridExWidget

Destroy the grid


destroy() - method in class BBjDialChartProgress.BBjDialChartProgress

Method to destroy the dial chart, used when you are finished using it


DevicePixelRatio! - field in class Dashboard.BBjWidget

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


DialogName$ - field in class AdminLoginDialog

DialogUtils - class in DialogWizard

DialogUtils

Dialog Utilities Class


DialogWizard - class in DialogWizard

DialogWizard

Dialog Wizard Class


DialogWizard() - constructor in class DialogWizard.DialogWizard

Constructor DialogWizard


DialogWizard(BBjString pFilePath$, BBjNumber pIsResource) - constructor in class DialogWizard.DialogWizard

Constructor DialogWizard


DialogWizardFrame - class in DialogWizard

DialogWizardFrame

Dialog Wizard Frame Class


DialogWizardFrame(BBjTopLevelWindow pWndWizard!, BBjNumber pFrameCwdId, HashMap pDataMap!) - constructor in class DialogWizard.DialogWizardFrame

Constructor DialogWizardFrame


DialogWizardFrame1 - class in DialogWizard

DialogWizardFrame1

Resource/Program Paths Frame


DialogWizardFrame1(BBjTopLevelWindow pWndWizard!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class DialogWizard.DialogWizardFrame1

Constructor DialogWizardFrame1


DialogWizardFrame2 - class in DialogWizard

DialogWizardFrame2

Control/Programm Variable Assignments Frame


DialogWizardFrame2(BBjTopLevelWindow pWndWizard!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class DialogWizard.DialogWizardFrame2

Constructor DialogWizardFrame2


DialogWizardFrame3 - class in DialogWizard

DialogWizardFrame3

Control/Event Callback Assignments Frame


DialogWizardFrame3(BBjTopLevelWindow pWndWizard!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class DialogWizard.DialogWizardFrame3

Constructor DialogWizardFrame3


DialogWizardFrame4 - class in DialogWizard

DialogWizardFrame4

Toolbar Wizard Frame


DialogWizardFrame4(BBjTopLevelWindow pWndWizard!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class DialogWizard.DialogWizardFrame4

Constructor DialogWizardFrame4


DialogWizardFrameFactory - class in DialogWizard

DialogWizardFrameFactory

Dialog Wizard Frame Factory Class


DialogWizardFrameFactory() - constructor in class DialogWizard.DialogWizardFrameFactory

Constructor DialogWizardFrameFactory


DialogWizardFrameIntf - interface in DialogWizard

DialogWizardFrameIntf

Dialog Wizard Frame Interface


DialogWizardRun - class in DialogWizard

DialogWizardRun

Run Type Selection Dialog


DialogWizardRun(BBjString pFilePath$) - constructor in class DialogWizard.DialogWizardRun

Constructor DialogWizardRun


DIR_ERROR=258 - field in class BBTranslator.BBTranslationBundle

Dirty - field in class BBTranslator.BBTranslations

A field variable that specifies the BBTranslations have been modified


DisableMobile! - field in class GxOptions.GxOptionsDateTime

Set disableMobile to true to always use the non-native picker.


disconnect() - method in class BUS

display(BBjNumber p_display) - method in class Dashboard.Widget

Called to display or hide the widget


display(BBjNumber p_display) - method in class Dashboard.BBjWidget

If the BBjWidget's interior BBjControl has already been created, then this method sets its visibiity


display(BBjNumber p_display) - method in class Dashboard.GridExWidget

Sets the widget's visibility


display(BBjNumber p_display) - method in class Dashboard.JasperViewerWidget

Sets the widget's visibility


DISPLAY_PAGE_DIALOG$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

DISPLAY_PAGE_DIALOG_ONLY_ONCE$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

DISPLAY_PRINT_DIALOG$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

DISPLAY_PRINT_DIALOG_ONLY_ONCE$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

DOC_NOT_FOUND_ERROR=304 - field in class GDocsService

DocID$ - field in class TreeNode

DOCK_LEFT=0 - field in class Dashboard.DashboardWidget

Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method


DOCK_RIGHT=1 - field in class Dashboard.DashboardWidget

Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method


DockLocation - field in class Dashboard.DashboardWidgetFilter

Dock location of the filter


DockLocation - field in class Dashboard.DashboardWidgetLink

Dock location of the link


DOCUMENT_TYPE$=#MIME$+"document" - field in class GDoc

DOCUMENT_TYPE_NAME$="DOCUMENT" - field in class GDocSaveDialog

DocumentFolder$ - field in class GDocFolderSelectionDialog

DocumentFolder$ - field in class GDocSaveDialog

DocumentFolderPath$ - field in class GDocSaveDialog

DocumentTitle$ - field in class GDocSaveDialog

DocumentType$ - field in class GDocSaveDialog

DOCX_SAVE_CONTRIBUTOR=12 - field in class BBJasper.BBJasperView

Constant that represents the DOCX save contributor


DOCX_SAVE_CONTRIBUTOR=BBJasperView.getDOCX_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the DOCX save contributor


DOCXExporter! - field in class BBJasper.BBJasperView

DOCX exporter which contains export options


doEmailDialog() - method in class BBJasper.BBJasperView

doEmailDialog Runs the email dialog


doFinish() - method in class WidgetWizard

Method doFinish: Finish work


doFinish() - method in class DialogWizard.DialogWizard

Method doFinish: Finish work


doLoginDialog() - method in class GAppsService

doLowerCaseWhenDisplaying(BBjNumber column) - method in class QVGrid.QVGrid

Adjusts, for a given column, the data to lowercase before displaying to the user


doLowerCaseWhenSaving(BBjNumber column) - method in class QVGrid.QVGrid

Adjusts, for a given column, the data to lowercase before returning it to the program


DOMAIN_SCOPE=1 - field in class GDoc

doModal() - method in class AdminLoginDialog

doModal() - method in class Dashboard.DashboardWindow

Shows the dashboard window modally, returns when the dashboard window is closed


doModal() - method in class Dashboard.EmbeddedWidgetWindow

Shows the embedded widget window modally, returns when the window is closed


doModal() - method in class Dashboard.EmbeddedWidgetSetWindow

Shows the embedded widget set window modally, returns when the window is closed


doModal() - method in class WidgetWizard

Runs the widget wizard modally. Control will return when the widget wizard is closed


doModal() - method in class Dashboard.ExportDataDialog

doModal Shows and runs the export data dialog modally


doModal() - method in class Email.EmailDialog

doModal Runs the email dialog


doModal() - method in class GAppsLoginDialog

doModal() - method in class GDocSelectionDialog

doModal() - method in class BBJasper.BBJasperProgress

doModal Shows the progress window and runs process events


doSave() - method in class BBJasper.BBJasperView

doSave Saves the report


doSaveAs() - method in class BBJasper.BBJasperView

doSaveAs Save as the report


doSaveGoogleDoc() - method in class BBJasper.BBJasperView

OnSaveGoogleDoc Callback for when the save google doc menu item is selected


doUpperCaseWhenDisplaying(BBjNumber column) - method in class QVGrid.QVGrid

Adjusts, for a given column, the data to uppercase before displaying to the user


doUpperCaseWhenSaving(BBjNumber column) - method in class QVGrid.QVGrid

Adjusts, for a given column, the data to uppercase before returning it to the program


download(BBjString p_fileName$) - method in class GDoc

DOWNLOAD_ERROR=308 - field in class GDoc

DraggingEnabled=1 - field in class Dashboard.WidgetControl

Indicates if dragging is enabled for the widget control


drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!) - method in class BBXImage.BBXImage

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.


drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_outlineColor!, BBjColor p_fillColor!, BBjNumber p_rotation) - method in class BBXImage.BBXImage

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.


drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!, BBjNumber p_rotation) - method in class BBXImage.BBXImage

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.


drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_outlineColor!, BBjColor p_fillColor!, BBjNumber p_rotation) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!, BBjNumber p_rotation) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


DRAWING_TYPE$=#MIME$+"drawing" - field in class GDoc

DRAWING_TYPE_NAME$="DRAWING" - field in class GDocSaveDialog

DRAWINGS_FILTER_NAME$="DRAWINGS" - field in class GDocSelectionDialog

drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_color!) - method in class BBXImage.BBXImage

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.


drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_color!) - method in class BBXImage.BBXImage

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.


drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity) - method in class BBXImage.BBXImage

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.


drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity, BBjNumber p_rotation) - method in class BBXImage.BBXImage

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.


drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_color!) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_color!) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity, BBjNumber p_rotation) - method in class BBXImage.BBXImage

Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.


drawText(BBjString p_text$, BBjString p_foreColorHexString$, BBjString p_backColorHexString$, Font p_javaFont!, BBjNumber p_offsetX, BBjNumber p_offsetY, BBjNumber p_hAlign, BBjNumber p_vAlign) - method in class BBXImage.BBXImage

Draws the specified text on the current BBXImage object. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.


DROP_ERROR=302 - field in class BUS

dropDB(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

DSUDDB - class in this project

DSUDDB() - constructor in class DSUDDB

DSUDDB(BBjString dsuddb!) - constructor in class DSUDDB

E

Editable! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if the column is editable, otherwise false.


#Configuration
#ColumnsRenderer


EditableExpression! - field in class GxColumns.GxDefaultColumnDefinition

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


EditType! - field in class GxOptions.GxOptions

Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
#Configuration
#GridRenderer


Email - class in Email

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.


Email() - constructor in class Email.Email

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.

  • BASIS_UTILITY_EMAIL_SERVER
  • BASIS_UTILITY_EMAIL_PORT
  • BASIS_UTILITY_EMAIL_USER
  • BASIS_UTILITY_EMAIL_PASSWORD
  • BASIS_UTILITY_EMAIL_SMTP
  • BASIS_UTILITY_EMAIL_FROM

Here are two examples:

  1) Setting the global string entry in code, before using the Email class:
      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:

  1. The BASIS_UTILITY_EMAIL_FROM parameter is only used with the EmailDialog class. You must call the setFrom() method when using the Email class.
  2. The values for the 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.


Email(BBjString mailhost$, BBjNumber mailport) - constructor in class Email.Email

Constructor Constructs a EMail given a host and a port


Email(BBjString mailhost$, BBjNumber mailport, BBjString username$, BBjString accessToken$) - constructor in class Email.Email

Constructor Constructs a Email given a host, port, user name, and access token


Email(BBjString mailhost$, BBjNumber mailport, BBjString username$, BBjString password$, BBjString smtp$) - constructor in class Email.Email

Constructor Constructs a Email given a host, port, user name, password, and protocol


email(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.EmailableWidget

Called to display a email dialog in order to email the widget


email(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.HtmlViewWidget

Displays a dialog that facilitates emailing a screenshot of the HtmlViewWidget as an attachment to one or more recipients


email(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.GridExWidget

Displays a dialog that facilitates emailing a screenshot of the grid as an attachment to one or more recipients


email(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.GridWidget

Displays a dialog that facilitates emailing a screenshot of the grid as an attachment to one or more recipients


email(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.ChartWidget

Displays a dialog that facilitates emailing a screenshot of the chart as an attachment to one or more recipients


email(Email p_email!) - method in class BBJasper.BBJasperReport

email Emails the report as an attachment

An error will be thrown if not successful.


EMAIL$=#Translations!.getTranslation("email") - field in class BBJasper.BBJasperViewerControl

Translated text for email


EMAIL$=#Translations!.getTranslation("email") - field in class BBJasper.BBJasperView

Translated text for email


EMAIL_BCC_TYPE=2 - field in class Email.EmailDialog

Constant that represents a email BCC address type


EMAIL_CC_TYPE=1 - field in class Email.EmailDialog

Constant that represents a email CC address type


EMAIL_MENU_ITEM_NAME$="BBJVEmailMenuItem" - field in class BBJasper.BBJasperView

Email menu item name


EMAIL_MENU_ITEM_NAME$=BBJasperView.getEMAIL_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Email menu item name


EMAIL_TO_TYPE=0 - field in class Email.EmailDialog

Constant that represents a email To address type


EMAIL_TOOL_BUTTON_NAME$="BBJVEmailToolButton" - field in class BBJasper.BBJasperViewerControl

Email tool button name


EMAIL_TOOL_BUTTON_NAME$=BBJasperViewerControl.getEMAIL_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Email tool button name


EmailableWidget - interface in Dashboard

EmailableWidget Interface that facilitates emailing of the widget


EmailAddress$ - field in class Email.EmailContact

Contact email address


EmailCC$ - field in class BUS

EmailContact - class in Email

EmailContact Used to keep track of email contact information including first and last names and email addresses


EmailContact() - constructor in class Email.EmailContact

Default Constructor Creates an empty EmailContact object


EmailContact(BBjString p_emailAddress$) - constructor in class Email.EmailContact

Constructor Creates an EmailContact object given an email address


EmailContact(BBjString p_firstName$, BBjString p_lastName$, BBjString p_emailAddress$) - constructor in class Email.EmailContact

Constructor Creates an EmailContact object given a first name, last name, and email address


EmailDialog - class in Email

EmailDialog Displays a dialog which allows users to send emails and maintain email settings and contacts


EmailDialog() - constructor in class Email.EmailDialog

Default Constructor Creates an empty EmailDialog object


EmailFrom$ - field in class BUS

EmailHeaderType$ - field in class BUS

EmailHeaderValue$ - field in class BUS

EmailHost$ - field in class BUS

EmailPassword$ - field in class BUS

EmailPort% - field in class BUS

EmailProtocol$ - field in class BUS

EmailReplyTo$ - field in class BUS

EmailSubject$ - field in class BUS

EmailText$ - field in class BUS

EmailUser$ - field in class BUS

EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR=7 - field in class BBJasper.BBJasperView

Constant that represents the embedded images XML save contributor


EMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR=BBJasperView.getEMBEDDED_IMAGES_XML_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the embedded images XML save contributor


EmbeddedCode$ - field in class BaseBuildItem

EmbeddedWidget - class in Dashboard

EmbeddedWidget Class that is used to embedded widget


EmbeddedWidget(Widget p_widget!) - constructor in class Dashboard.EmbeddedWidget

Constructs a EmbeddedWidget


EmbeddedWidgetControl - class in Dashboard

EmbeddedWidgetControl Class that is used to display a embedded widget in a control


EmbeddedWidgetControl(EmbeddedWidget p_embeddedWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.EmbeddedWidgetControl

Constructs a EmbeddedWidgetControl


EmbeddedWidgetFactory - class in Dashboard

EmbeddedWidgetFactory Factory class that is used to create embedded widgets


EmbeddedWidgetSet - class in Dashboard

EmbeddedWidgetSet Class that is used to embedded a widget set


EmbeddedWidgetSet(BBjString p_name$, BBjString p_title$) - constructor in class Dashboard.EmbeddedWidgetSet

Constructs a EmbeddedWidgetSet


EmbeddedWidgetSetControl - class in Dashboard

EmbeddedWidgetSetControl Class that is used to display a embedded widget set in a control


EmbeddedWidgetSetControl(EmbeddedWidgetSet p_embeddedWidgetSet!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.EmbeddedWidgetSetControl

Constructs a EmbeddedWidgetSetControl


EmbeddedWidgetSetControl(EmbeddedWidgetSet p_embeddedWidgetSet!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$, BBjNumber p_titleBar) - constructor in class Dashboard.EmbeddedWidgetSetControl

Constructs a EmbeddedWidgetSetControl


EmbeddedWidgetSetWindow - class in Dashboard

EmbeddedWidgetSetWindow Class that is used to display a embedded widget set in a window


EmbeddedWidgetSetWindow(EmbeddedWidgetSet p_embeddedWidgetSet!) - constructor in class Dashboard.EmbeddedWidgetSetWindow

Constructs a EmbeddedWidgetSetWindow


EmbeddedWidgetSetWindow(EmbeddedWidgetSet p_embeddedWidgetSet!, BBjNumber p_width, BBjNumber p_height) - constructor in class Dashboard.EmbeddedWidgetSetWindow

Constructs a EmbeddedWidgetSetWindow passing in a desired width and height


EmbeddedWidgetWindow - class in Dashboard

EmbeddedWidgetWindow Class that is used to display a embedded widget in a window


EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!) - constructor in class Dashboard.EmbeddedWidgetWindow

Constructs a EmbeddedWidgetWindow


EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!, BBjNumber p_width, BBjNumber p_height) - constructor in class Dashboard.EmbeddedWidgetWindow

Constructs a EmbeddedWidgetWindow passing in a desired width and height


EmptyMessage! - field in class GxCellEditors.GxCellEditorSuggestion

The message that will be showed when there are no suggestions that match the entered value.


Enable24HR! - field in class GxOptions.GxOptionsDateTime

Enable / disable time 24 format.


EnableBrowserTooltips! - field in class GxOptions.GxOptions

Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
#Configuration
#GridRenderer


EnableCalendar! - field in class GxOptions.GxOptionsDateTime

Enable / disable Calendar input.


EnableCharts! - field in class GxOptions.GxOptions

Set to true to enable charting


#Enterprise
#Configuration


EnableFilter! - field in class GxColumns.GxDefaultColumnDefinition

When true the filter is enabled, disabled otherwise


#Configuration
#ColumnsRenderer


EnableFloatingFilter! - field in class GxOptions.GxOptions

When true enables the floating filters, disable otherwise


#Configuration
#GridRenderer


EnablePivot! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you want to be able to pivot by this column via the UI.


#Enterprise
#Configuration
#ColumnsRenderer


EnableRangeSelection! - field in class GxOptions.GxOptions

Set to true to enable Range Selection


#Enterprise
#Configuration


enableRefreshButton() - method in class Dashboard.DashboardControl

Enables/Disables the refresh button


EnableRowGroup! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you want to be able to row group by this column via the UI.


#Enterprise
#Configuration
#ColumnsRenderer


EnableRtl! - field in class GxOptions.GxOptions

Set to true to operate grid in RTL (Right to Left) mode.
#Configuration
#GridRenderer


EnableSeconds! - field in class GxOptions.GxOptionsDateTime

Enable / disable seconds selection


EnableTime! - field in class GxOptions.GxOptionsDateTime

Enable / disable time selection


EnableValue! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you want to be able to aggregate by this column via the UI.


#Enterprise
#Configuration
#ColumnsRenderer


EnableWeekNumber! - field in class GxOptions.GxOptionsDateTime

Enables display of week numbers in calendar.


End! - field in class GxClientModels.GxClientAddRangeSelectionModel

End row id or index


END$=#Translations!.getTranslation("end") - field in class BBJasper.BBJasperView

Translated text for end


END_PAGE_INDEX$ - field in class BBJasper.BBJasperExporterParameter

endEdit(BBjNumber suppress) - method in class QVGrid.QVGrid

Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.


endEdit() - method in class QVGrid.QVGrid

Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.


ENDS_WITH() - method in class GxFilters.GxColumnFilterTextFilterOptions

EndTime! - field in class gappsv3.GTimePeriod

ensureColumnVisible(BBjString columnId!) - method in class BBjGridExWidget.BBjGridExWidget

Ensures the column is visible, scrolling the table if needed.


#API


ensureIndexVisible(BBjString key!, BBjString position!) - method in class BBjGridExWidget.BBjGridExWidget

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


ensureIndexVisible(BBjNumber index!, BBjString position!) - method in class BBjGridExWidget.BBjGridExWidget

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


EnterMovesDown! - field in class GxOptions.GxOptions

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


EnterMovesDownAfterEdit! - field in class GxOptions.GxOptions

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


ENTIRE_REPORT$=#Translations!.getTranslation("entire.report") - field in class BBJasper.BBJasperView

Translated text for entire report


Entries! - field in class Dashboard.DashboardWidgetFilter

LinkedHashMap that contains filter key/value pairs


EQUALS() - method in class GxFilters.GxColumnFilterTextFilterOptions

EQUALS() - method in class GxFilters.GxColumnFilterDateTimeFilterOptions

equals(GxCellEditorInterface cellEditor!) - method in class GxCellEditors.GxCellEditorInterface

Compare two filters


equals(GxCellEditorInterface cellEditor!) - method in class GxCellEditors.GxCellEditorAbstract

Compare two filters


equals(GxCellEditorInterface cellEditor!) - method in class GxCellEditors.GxCellEditorBasicBoolean

Compare two filters


equals(GxCellEditorInterface cellEditor!) - method in class GxCellEditors.GxCellEditorBasicDateTime

Compare two filters


equals(GxExpressionInterface expression!) - method in class GxExpressions.GxExpressionInterface

Compare two expressions


equals(GxExpressionInterface expression!) - method in class GxExpressions.GxExpressionAbstract

Compare two expressions


equals(GxFilterInterface filter!) - method in class GxFilters.GxFilterInterface

Compare two filters


equals(GxFilterInterface filter!) - method in class GxFilters.GxColumnFilterAG

Compare two filters


equals(GxFilterInterface filter!) - method in class GxFilters.GxFilterBasicBoolean

Compare two filters


equals(GxFilterInterface filter!) - method in class GxFilters.GxFilterBasicDateTime

Compare two filters


equals(GxRendererInterface cellRenderer!) - method in class GxRenderers.GxRendererInterface

Compare two cell renderers


equals(GxRendererInterface cellRenderer!) - method in class GxRenderers.GxRendererAbstract

Compare two cell renderers


equals(GxRendererInterface cellRenderer!) - method in class GxRenderers.GxRendererBoolean

Compare two cell renderers


ERROR=0 - field in class GApps

ERROR_SAVING$=#Translations!.getTranslation("error.saving") - field in class BBJasper.BBJasperView

Translated text for error saving


ErrorMessage$ - field in class BBJasper.BBJasperFill

Error message


Event - field in class Dashboard.CallbackInfo

Event - class in DialogWizard

Event

Event Class


Event - field in class DialogWizard.Event

Event(BBjNumber pEvent) - constructor in class DialogWizard.Event

Constructor Event


EventName$ - field in class DialogWizard.Event

EXCEL_EXPORT() - method in class GxContextMenu.GxContextMenuItem

execute(BBjString key!, BBjString script!, BBjNumber debounced!, BBjNumber priority!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes the provided JavaScript code on the client, specifying all available parameters.


execute(BBjString script!, BBjNumber debounced!, BBjNumber priority!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes the provided JavaScript code on the client and uses the script itself as a key with the specified priority.


execute(BBjString key!, BBjString script!, BBjNumber debounced!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes the provided JavaScript code on the client without a priority, which is a more typical use case.


execute(BBjString script!, BBjNumber debounced!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes the provided JavaScript code on the client using the script itself as a key and without priority, which is the typical use case.


execute(BBjString key!, BBjString script!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes and debounces the provided JavaScript code on the client without a priority.


execute(BBjString script!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes and debounces the provided JavaScript code on the client using the script itself as a key and without a priority.


execute() - method in class GxClientModels.GxClientTransactionModel

Execute the transaction on the widget model (ResultSet)


execute(BBjNumber send!) - method in class GxClientModels.GxClientFilterModel

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() - method in class GxClientModels.GxClientFilterModel

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(BBjNumber send!) - method in class GxClientModels.GxClientFilterAbstractModel

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() - method in class GxClientModels.GxClientFilterAbstractModel

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(BBjNumber send!) - method in class GxClientModels.GxClientFilterSetFilterModel

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(BBjString key!, BBjString script!, BBjNumber debounced!, BBjNumber priority!) - method in class BBjGridExWidget.GxExecutor

Execute a Javascript code on the client


execute(BBjString script!, BBjNumber debounced!, BBjNumber priority!) - method in class BBjGridExWidget.GxExecutor

Execute a Javascript code on the client and use the script itself as a key


execute(BBjString key!, BBjString script!, BBjNumber debounced!) - method in class BBjGridExWidget.GxExecutor

Execute a Javascript code on the client with an auto calculated priority


execute(BBjString script!, BBjNumber debounced!) - method in class BBjGridExWidget.GxExecutor

Execute a Javascript code on the client , use the script itself as a key and auto calculate priority


execute(BBjString key!, BBjString script!) - method in class BBjGridExWidget.GxExecutor

Execute and debounce a Javascript code on the client and auto calculate priority


execute(BBjString script!) - method in class BBjGridExWidget.GxExecutor

Execute and debounce a Javascript code on the client , use the script itself as a key and auto calculate priority


executeAsyncScript(BBjString p_script$) - method in class Dashboard.HtmlViewWidget

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.


executeAsyncScripts(BBjString p_script$, BBjString p_poppedOutScript$) - method in class Dashboard.HtmlViewWidget

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.


executeFilterTransaction(LinkedHashMap transaction!) - method in class BBjGridExWidget.BBjGridExWidget

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


executeImmediately(BBjString script!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

Executes the provided JavaScript directly in the BBjHtmlView control without debouncing so that it can return a valid return object as a generic Object.


executeScript(BBjString p_script$) - method in class Dashboard.HtmlViewWidget

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.


executeScript(BBjString script!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


executeScript(BBjString script$) - method in class BBjGridExWidget.BBjGridExWidget

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


executeScriptImmediately(BBjString script!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


executeScripts(BBjString p_script$, BBjString p_poppedOutScript$) - method in class Dashboard.HtmlViewWidget

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.


executeUpdateTransaction(GxClientTransactionModel transaction!, BBjNumber batchUpdate!) - method in class BBjGridExWidget.BBjGridExWidget

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


executeUpdateTransaction(GxClientTransactionModel transaction!) - method in class BBjGridExWidget.BBjGridExWidget

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


Executor! - field in class BBjGridExWidget.BBjGridExWidget

Instance of he scripts executor


exists() - method in class BBXImage.BBXImage

Method to determine whether the BBXImage exists or not


ExitMenuButtonWidth=80 - field in class Dashboard.DashboardWindow

Width of the exit button


EXPAND_ALL() - method in class GxContextMenu.GxContextMenuItem

expandAll() - method in class BBjGridExWidget.BBjGridExWidget

Expand all groups


#API


EXPORT() - method in class GxContextMenu.GxContextMenuItem

ExportData - class in Dashboard

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.


exportData(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.DataFillableWidget

Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options


exportData(BBjNumber p_parentX, BBjNumber p_parentX, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.GridExWidget

Called to display a export dialog in order to export widget data


exportData(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.GridWidget

Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options


exportData(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.ChartWidget

Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options


exportData(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) - method in class Dashboard.XYChartWidget

Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options


ExportDataDialog - class in Dashboard

ExportDataDialog Provides a dialog which displays a UI to faciliate the exportation the data.


ExportDataDialog(BBjRecordSet p_recordSet!, BBjString p_exportFile$) - constructor in class Dashboard.ExportDataDialog

Constructor for the ExportDataDialog


ExportDataDialog(DefaultPieDataset p_pieDataSet!, BBjString p_exportFile$) - constructor in class Dashboard.ExportDataDialog

Constructor for the ExportDataDialog


ExportDataDialog(DefaultCategoryDataset p_categoryDataSet!, BBjString p_exportFile$) - constructor in class Dashboard.ExportDataDialog

Constructor for the ExportDataDialog


ExportDataDialog(XYSeriesCollection p_xySeriesCollection!, BBjString p_exportFile$) - constructor in class Dashboard.ExportDataDialog

Constructor for the ExportDataDialog


ExportDataDialog(BBjVector p_colData!, BBjVector p_rowData!, BBjString p_exportFile$) - constructor in class Dashboard.ExportDataDialog

Constructor for the ExportDataDialog


exportToClientFile(BBjVector p_colData!, BBjVector p_rowData!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToClientFile Exports column and row (grid) data to a client file


exportToClientFile(BBjRecordSet p_recordSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToClientFile Exports data from a BBjRecordSet to a client file


exportToClientFile(DefaultPieDataset p_pieDataSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToClientFile Exports data from a DefaultPieDataset to a client file


exportToClientFile(DefaultCategoryDataset p_categoryDataSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToClientFile Exports data from a DefaultCategoryDataset to a client file


exportToClientFile(XYSeriesCollection p_xySeriesCollection!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToClientFile Exports data from a XYSeriesCollection to a client file


exportToCSV(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToCSV Exports the report in CSV file format


exportToCSV(BBjNumber p_onClient, BBjString p_filepath$, BBJasperCSVExporter p_bbjasperCSVExporter!) - method in class BBJasper.BBJasperReport

exportToCSV Exports the report in CSV file format


exportToCSV(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperCSVExporter p_bbjasperCSVExporter!) - method in class BBJasper.BBJasperPrint

exportToCSV Exports a client report to a client CSV file


exportToCSV(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperCSVExporter p_bbjasperCSVExporter!) - method in class BBJasper.BBJasperPrint

exportToCSV Exports a server report to a server CSV file


exportToDOCX(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToDOCX Exports the report in DOCX file format


exportToDOCX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperDOCXExporter p_bbjasperDOCXExporter!) - method in class BBJasper.BBJasperReport

exportToDOCX Exports the report in DOCX file format


exportToDOCX(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperDOCXExporter p_bbjasperDOCXExporter!) - method in class BBJasper.BBJasperPrint

exportToDOCX Exports a client report to a client DOCX file


exportToDOCX(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperDOCXExporter p_bbjasperDOCXExporter!) - method in class BBJasper.BBJasperPrint

exportToDOCX Exports a server report to a server DOCX file


exportToHTML(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToHTML Exports the report in HTML file format


exportToHTML(BBjNumber p_onClient, BBjString p_filepath$, BBJasperHTMLExporter p_bbjasperHTMLExporter!) - method in class BBJasper.BBJasperReport

exportToHTML Exports the report in HTML file format


exportToHTML(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperHTMLExporter p_bbjasperHTMLExporter!) - method in class BBJasper.BBJasperPrint

exportToHTML Exports a client report to a client HTML file


exportToHTML(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperHTMLExporter p_bbjasperHTMLExporter!) - method in class BBJasper.BBJasperPrint

exportToHTML Exports a server report to a server HTML file


exportToJRPRINT(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToJRPRINT Exports the report in JRPRNT file format


exportToJRPRINT(JasperPrint@ p_jasperPrint!, BBjString p_filepath$) - method in class BBJasper.BBJasperPrint

exportToJRPRINT Exports a client report to a client JRPRINT file


exportToJRPRINT(JasperPrint p_jasperPrint!, BBjString p_filepath$) - method in class BBJasper.BBJasperPrint

exportToJRPRINT Exports a server report to a server JRPRINT file


exportToODS(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToODS Exports the report in ODS file format


exportToODS(BBjNumber p_onClient, BBjString p_filepath$, BBJasperODSExporter p_bbjasperODSExporter!) - method in class BBJasper.BBJasperReport

exportToODS Exports the report in ODS file format


exportToODS(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperODSExporter p_bbjasperODSExporter!) - method in class BBJasper.BBJasperPrint

exportToODS Exports a client report to a client ODS file


exportToODS(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperODSExporter p_bbjasperODSExporter!) - method in class BBJasper.BBJasperPrint

exportToODS Exports a server report to a server ODS file


exportToODT(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToODT Exports the report in ODT file format


exportToODT(BBjNumber p_onClient, BBjString p_filepath$, BBJasperODTExporter p_bbjasperODTExporter!) - method in class BBJasper.BBJasperReport

exportToODT Exports the report in ODT file format


exportToODT(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperODTExporter p_bbjasperODTExporter!) - method in class BBJasper.BBJasperPrint

exportToODT Exports a client report to a client ODT file


exportToODT(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperODTExporter p_bbjasperODTExporter!) - method in class BBJasper.BBJasperPrint

exportToODT Exports a server report to a server ODT file


exportToPDF(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToPDF Exports the report in PDF file format


exportToPDF(BBjNumber p_onClient, BBjString p_filepath$, BBJasperPDFExporter p_bbjasperPDFExporter!) - method in class BBJasper.BBJasperReport

exportToPDF Exports the report in PDF file format


exportToPDF(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperPDFExporter p_bbjasperPDFExporter!) - method in class BBJasper.BBJasperPrint

exportToPDF Exports a client report to a client PDF file


exportToPDF(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperPDFExporter p_bbjasperPDFExporter!) - method in class BBJasper.BBJasperPrint

exportToPDF Exports a server report to a server PDF file


exportToPPTX(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToPPTX Exports the report in PPTX file format


exportToPPTX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperPPTXExporter p_bbjasperPPTXExporter!) - method in class BBJasper.BBJasperReport

exportToPPTX Exports the report in PPTX file format


exportToPPTX(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperPPTXExporter p_bbjasperPPTXExporter!) - method in class BBJasper.BBJasperPrint

exportToPPTX Exports a client report to a client PPTX file


exportToPPTX(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperPPTXExporter p_bbjasperPPTXExporter!) - method in class BBJasper.BBJasperPrint

exportToPPTX Exports a server report to a server PPTX file


exportToRTF(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToRTF Exports the report in RTF file format


exportToRTF(BBjNumber p_onClient, BBjString p_filepath$, BBJasperRTFExporter p_bbjasperRTFExporter!) - method in class BBJasper.BBJasperReport

exportToRTF Exports the report in RTF file format


exportToRTF(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperRTFExporter p_bbjasperRTFExporter!) - method in class BBJasper.BBJasperPrint

exportToRTF Exports a client report to a client RTF file


exportToRTF(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperRTFExporter p_bbjasperRTFExporter!) - method in class BBJasper.BBJasperPrint

exportToRTF Exports a server report to a client RTF file


exportToServerFile(BBjVector p_colData!, BBjVector p_rowData!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToServerFile Exports column and row (grid) data to a server file


exportToServerFile(BBjRecordSet p_recordSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToServerFile Exports data from a BBjRecordSet to a server file


exportToServerFile(DefaultPieDataset p_pieDataSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToServerFile Exports data from a DefaultPieDataset to a server file


exportToServerFile(DefaultCategoryDataset p_categoryDataSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToServerFile Exports data from a DefaultCategoryDataset to a server file


exportToServerFile(XYSeriesCollection p_seriesCollection!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) - method in class Dashboard.ExportData

exportToServerFile Exports data from a XYSeriesCollection to a server file


exportToTXT(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight) - method in class BBJasper.BBJasperReport

exportToTXT Exports the report in TXT file format


exportToTXT(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight, BBJasperTXTExporter p_bbjasperTXTExporter!) - method in class BBJasper.BBJasperReport

exportToTXT Exports the report in TXT file format


exportToTXT(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight, BBJasperTXTExporter p_bbjasperTXTExporter!) - method in class BBJasper.BBJasperPrint

exportToTXT Exports a client report to a client TXT file


exportToTXT(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight, BBJasperTXTExporter p_bbjasperTXTExporter!) - method in class BBJasper.BBJasperPrint

exportToTXT Exports a server report to a server TXT file


exportToXLS(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToXLS Exports the report in XLS file format


exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_multipleSheets) - method in class BBJasper.BBJasperReport

exportToXLS Exports the report in XLS file format


exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBJasperXLSExporter p_bbjasperXLSExporter!) - method in class BBJasper.BBJasperReport

exportToXLS Exports the report in XLS file format


exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_multipleSheets, BBJasperXLSExporter p_bbjasperXLSExporter!) - method in class BBJasper.BBJasperReport

exportToXLS Exports the report in XLS file format


exportToXLS(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBjNumber p_multipleSheets, BBJasperXLSExporter p_bbjasperXLSExporter!) - method in class BBJasper.BBJasperPrint

exportToXLS Exports a client report to a client XLS file


exportToXLS(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBjNumber p_multipleSheets, BBJasperXLSExporter p_bbjasperXLSExporter!) - method in class BBJasper.BBJasperPrint

exportToXLS Exports a server report to a server XLS file


exportToXLSX(BBjNumber p_onClient, BBjString p_filepath$) - method in class BBJasper.BBJasperReport

exportToXLSX Exports the report in XLSX file format


exportToXLSX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperXLSXExporter p_bbjasperXLSXExporter!) - method in class BBJasper.BBJasperReport

exportToXLSX Exports the report in XLSX file format


exportToXLSX(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBJasperXLSXExporter p_bbjasperXLSXExporter!) - method in class BBJasper.BBJasperPrint

exportToXLSX Exports a client report to a client XLSX file


exportToXLSX(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBJasperXLSXExporter p_bbjasperXLSXExporter!) - method in class BBJasper.BBJasperPrint

exportToXLSX Exports a server report to a server XLSX file


exportToXML(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_isEmbeddingImages) - method in class BBJasper.BBJasperReport

exportToXML Exports the report in XML file format


exportToXML(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_isEmbeddingImages, BBJasperXMLExporter p_bbjasperXMLExporter!) - method in class BBJasper.BBJasperReport

exportToXML Exports the report in XML file format


exportToXML(JasperPrint@ p_jasperPrint!, BBjString p_filepath$, BBjNumber p_isEmbeddingImages, BBJasperXMLExporter p_bbjasperXMLExporter!) - method in class BBJasper.BBJasperPrint

exportToXML Exports a client report to a client XML file


exportToXML(JasperPrint p_jasperPrint!, BBjString p_filepath$, BBjNumber p_isEmbeddingImages, BBJasperXMLExporter p_bbjasperXMLExporter!) - method in class BBJasper.BBJasperPrint

exportToXML Exports a server report to a server XML file


Expression! - field in class GxExpressions.GxExpression

Expression string


F

fadeIn() - method in class BBLaunchDock

FALSE=BBjAPI().FALSE - field in class BBConfig

FalseValue! - field in class GxFilters.GxFilterBasicBoolean

False value translation


FalseValue! - field in class GxRenderers.GxRendererBoolean

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!


FaxJob - interface in this project





FaxJobBase - class in this project



FEED_ERROR=308 - field in class GDocsService

Field! - field in class GxColumns.GxColumn

The field of the row to get the cells data from
Note: Once the field name is set, it becomes immutable


FIELD$=#Translations!.getTranslation("field") - field in class BBJasper.BBJasperView

Translated text for field


FieldVector! - field in class BBJasper.DatabaseType

File$ - field in class BBJasper.BBJasperTemplate

FILE_DESC_CSV$=#Translations!.getTranslation("file.desc.csv") - field in class BBJasper.BBJasperView

Translated text for CSV file description


FILE_DESC_DOCX$=#Translations!.getTranslation("file.desc.docx") - field in class BBJasper.BBJasperView

Translated text for DOCX file description


FILE_DESC_HTML$=#Translations!.getTranslation("file.desc.html") - field in class BBJasper.BBJasperView

Translated text for HTML file description


FILE_DESC_JRPRINT$=#Translations!.getTranslation("file.desc.jrprint") - field in class BBJasper.BBJasperView

Translated text for JRPRINT file description


FILE_DESC_ODS$=#Translations!.getTranslation("file.desc.ods") - field in class BBJasper.BBJasperView

Translated text for ODS file description


FILE_DESC_ODT$=#Translations!.getTranslation("file.desc.odt") - field in class BBJasper.BBJasperView

Translated text for ODT file description


FILE_DESC_PDF$=#Translations!.getTranslation("file.desc.pdf") - field in class BBJasper.BBJasperView

Translated text for PDF file description


FILE_DESC_PPTX$=#Translations!.getTranslation("file.desc.pptx") - field in class BBJasper.BBJasperView

Translated text for PPTX file description


FILE_DESC_RTF$=#Translations!.getTranslation("file.desc.rtf") - field in class BBJasper.BBJasperView

Translated text for RTF file description


FILE_DESC_TXT$=#Translations!.getTranslation("file.desc.txt") - field in class BBJasper.BBJasperView

Translated text for TXT file description


FILE_DESC_XLS_MULTIPE_SHEETS$=#Translations!.getTranslation("file.desc.xls.multiple.sheets") - field in class BBJasper.BBJasperView

Translated text for multiple sheets XLS file description


FILE_DESC_XLS_SINGLE_SHEET$=#Translations!.getTranslation("file.desc.xls.single.sheet") - field in class BBJasper.BBJasperView

Translated text for single sheet XLS file description


FILE_DESC_XLSX$=#Translations!.getTranslation("file.desc.xlsx") - field in class BBJasper.BBJasperView

Translated text for single sheet XLSX file description


FILE_DESC_XML$=#Translations!.getTranslation("file.desc.xml") - field in class BBJasper.BBJasperView

Translated text for XML file description


FILE_DESC_XML_EMBEDDED_IMAGES$=#Translations!.getTranslation("file.desc.xml.embedded.images") - field in class BBJasper.BBJasperView

Translated text for embedded images XML file description


FILE_NOT_FOUND_ERROR=303 - field in class GDocsService

FILE_OVERWRITE$=#Translations!.getTranslation("file.overwrite") - field in class BBJasper.BBJasperView

Translated text for file overwrite


FILE_SAVE_NAME$ - field in class Dashboard.JasperViewerWidget

File save name


FILE_TYPE$=#MIME$+"file" - field in class GDoc

FILE_TYPE_NAME$="FILE" - field in class GDocSaveDialog

FileChooser - class in this project

FileChooser(BBjString startDir$, BBjString nsVar$) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjString nsVar$, BBjNumber useClient) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel, BBjNumber useSaveDialog) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel, BBjNumber useSaveDialog) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel, BBjNumber useSaveDialog, BBjVector filterVectMap!) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel, BBjNumber useSaveDialog, BBjString filtername$, BBjString filter$) - constructor in class FileChooser

FileChooser(BBjString startDir$, BBjNumber startX, BBjNumber startY, BBjString nsVar$, BBjNumber useClient, BBjNumber dirOnly, BBjNumber multiSel, BBjNumber useSaveDialog, BBjString filtername$, BBjVector filters!) - constructor in class FileChooser

fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.DataFillableWidget

Fills the widget's underlying dataset with data from an SQL query


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.DataFillableWidget

Fills the widget underlying dataset with data from a BBjRecordSet


fill(ResultSet p_resultSet!) - method in class Dashboard.GridExWidget

Fills the grid's underlying dataset with a BASIS Components ResultSet


fill(BBjString p_file$, BBjString p_template$, DataRow p_filter!) - method in class Dashboard.GridExWidget

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:

  • a range of values(from-to)
  • an exact primary key value
  • the KNUM to use

The filter should use one of the following static fields:

  • JLibResultSetImporter.FILTER_KNUM
  • JLibResultSetImporter.FILTER_RANGE_FROM
  • JLibResultSetImporter.FILTER_RANGE_TO
  • JLibResultSetImporter.FILTER_VALUE

Example:


filter! = new DataRow()
filter!.setFieldValue("FILTER_KNUM", "1")
filter!.setFieldValue("FILTER_RANGE_FROM", "000002")
filter!.setFieldValue("FILTER_RANGE_TO", "000010")


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.GridExWidget

Fills the grid's underlying dataset with data from an SQL query


fill(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.GridExWidget

Fills the grid's underlying dataset with data from an SQL query and a mode string


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.GridExWidget

Fills the grid's underlying dataset with data from BBjRecordSet and BBjVector specifying the columns to use


fill(BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.GridExWidget

Fills the grid's underlying dataset with data with passed vectors BBjVector specifying the columns to use


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.GridWidget

Fills the grid's underlying dataset with data from an SQL query


fill(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.GridWidget

Fills the grid's underlying dataset with data from an SQL query and a mode string


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.GridWidget

Fills the grid's underlying dataset with data from BBjRecordSet and BBjVector specifying the columns to use


fill(BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.GridWidget

Fills the grid's underlying dataset with data with passed vectors BBjVector specifying the columns to use


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.PieChartWidget

Fills the pie chart's underlying dataset with data from an SQL query


fill(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.PieChartWidget

Fills the pie chart's underlying dataset with data from an SQL query and a mode string


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.PieChartWidget

Fills the pie chart's underlying dataset with data from a BBjRecordSet


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.BarChartWidget

Fills the bar chart's underlying dataset with data from an SQL query


fill(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.BarChartWidget

Fills the bar chart's underlying dataset with data from an SQL query and a mode string


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.BarChartWidget

Fills the bar chart's underlying dataset with data from a BBjRecordSet


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.LineChartWidget

Fills the line chart's underlying dataset with data from an SQL query


fill(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.LineChartWidget

Fills the line chart's underlying dataset with data from an SQL query and a mode string


fill(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.LineChartWidget

Fills the bar chart's underlying dataset with data from a BBjRecordSet


fill(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.XYChartWidget

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


fill(BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.XYChartWidget

Create an XYSeries, fill it with data from a query, and add it to the XYSeriesCollection for the chart


fill(BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.XYChartWidget

Create an XYSeries, fill it with data from a query, and add it to the XYSeriesCollection for the chart


fill(BBjString p_seriesName$, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.XYChartWidget

Create an XYSeries, fill it with data from a BBjRecordSet and vector of columns, and add it to the XYSeriesCollection for the chart


fill() - method in class BBJasper.BBJasperReport

fill Fills the report with data


fill(BBjNumber p_showProgress) - method in class BBJasper.BBJasperReport

fill Fills the report with data


fill() - method in class BBJasper.BBJasperFill

fill Fills the report with data using a JDBC connection object or Result Set object and returns a JasperPrint object


FILL_CANCELED=305 - field in class BBJasper.BBJasperReport

Constant value that represents that the fill operation was canceled


FILL_ERROR=304 - field in class BBJasper.BBJasperReport

Constant value that represents a fill error


FillErrorAction - field in class Dashboard.Dashboard

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


FillErrorAction - field in class Dashboard.DashboardCategory

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


FillErrorAction - field in class Dashboard.BaseWidget

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


fillGridWithColumns(BBjNumber fit) - method in class QVGrid.QVGrid

Specifies whether to fit all columns into the displayed width of the grid


fillJDBCXYSeries(XYSeries p_series!, BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.ChartWidget

Given an SQL query, fill an XYSeries with the resultant two columns of numerical data


fillJDBCXYSeries(XYSeries p_series!, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.ChartWidget

Given an SQL query, fill an XYSeries with the resultant two columns of numerical data


fillJDBCXYSeries(XYSeries p_series!, BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.ChartWidget

Given a BBjRecordSet and a vector of columns, fill an XYSeries with the resultant two columns of numerical data


Filter! - field in class GxClientModels.GxClientFilterTextModel

The value associated with the filter.


Filter! - field in class GxClientModels.GxClientFilterNumberModel

The value associated with the filter.


Filter! - field in class GxClientModels.GxClientFilterDateTimeModel

The value associated with the filter.


Filter! - field in class GxClientModels.GxClientFilterBooleanModel

The value associated with the filter.


Filter! - field in class GxColumns.GxDefaultColumnDefinition

The filter component to use for this column


#Configuration
#ColumnsRenderer


FILTER$ - field in class BBJasper.BBJasperExporterParameter

FILTER_TYPE_EDITBOX=2 - field in class Dashboard.DashboardWidget

Constant for Editbox-based filter used in the addFilter() method.


FILTER_TYPE_EDITBOX=2 - field in class Dashboard.DashboardWidgetFilter

Constant for Editbox-based filter, optionally used when constructing a DashboardWidgetFilter.


FILTER_TYPE_LISTBUTTON=0 - field in class Dashboard.DashboardWidget

Constant for a BBjListButton-based filter used in the addFilter() method.


FILTER_TYPE_LISTBUTTON=0 - field in class Dashboard.DashboardWidgetFilter

Constant for a BBjListButton-based filter, optionally used when constructing a DashboardWidgetFilter.


FILTER_TYPE_LISTEDIT=1 - field in class Dashboard.DashboardWidget

Constant for BBjListEdit-based filter used in the addFilter() method.


FILTER_TYPE_LISTEDIT=1 - field in class Dashboard.DashboardWidgetFilter

Constant for BBjListEdit-based filter, optionally used when constructing a DashboardWidgetFilter.


Filterable - field in class Dashboard.GridExWidget

A number acting as a boolean that determines whether the grid enables filtering by columns


FilterableFloating - field in class Dashboard.GridExWidget

A number acting as a boolean that determines whether the grid enables filtering by columns via a floating filter


FilterOptions! - field in class GxFilters.GxColumnFilterAG

What Filter Options to present to the user. By default all supported options are presented


FilterOptions! - field in class GxFilters.GxFilterBasicDateTime

What Filter Options to present to the user. By default all supported options are presented


FilterSelectCallbackObject! - field in class Dashboard.DashboardWidgetFilter

CustomObject that constains the callback routine to handle a filter select event


FilterSelectCallbackRoutine! - field in class Dashboard.DashboardWidgetFilter

Callback routine to handle a filter select event


FilterSelectEventName! - field in class Dashboard.DashboardWidgetFilter

Name of the filter select event


FilterTo! - field in class GxClientModels.GxClientFilterNumberModel

In case you are using range filter , then this is the second input value


FilterTo! - field in class GxClientModels.GxClientFilterDateTimeModel

In case you are using range filter , then this is the second input value


FilterType - field in class Dashboard.DashboardWidgetFilter

Type of filter


FilterValueGetterExpression! - field in class GxColumns.GxDefaultColumnDefinition

An Ag Grid expression which can be executed to get the value for filtering purposes.


#Configuration
#ColumnsRenderer.


FIND$=#Translations!.getTranslation("find") - field in class BBJasper.BBJasperViewerControl

Translated text for find


FIND$=#Translations!.getTranslation("find") - field in class BBJasper.BBJasperView

Translated text for find


FIND_CASE_SENSITIVITY_INSENSITIVE - field in class BBJasper.BBJasperView

Find case sensitivity insensitive constant


FIND_CASE_SENSITIVITY_SENSITIVE - field in class BBJasper.BBJasperView

Find case sensitivity sensitive constant


FIND_CLEAR_TOOL_BUTTON_NAME$="BBJVFindClearToolButton" - field in class BBJasper.BBJasperView

Find clear text tool button name


FIND_EDIT_BOX_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the find edit, the default is 140


FIND_HIGHLIGHT_FIELD - field in class BBJasper.BBJasperView

Find highlight field constant


FIND_HIGHLIGHT_TEXT - field in class BBJasper.BBJasperView

Find highlight text constant


FIND_LIST_EDIT_NAME$="BBJVFindListEdit" - field in class BBJasper.BBJasperView

Find list edit name


FIND_MATCH_CONTAINS - field in class BBJasper.BBJasperView

Find match contains constant


FIND_MATCH_FULL_WORD - field in class BBJasper.BBJasperView

Find match full word constant


FIND_MATCH_STARTS_WITH - field in class BBJasper.BBJasperView

Find match starts with constant


FIND_MENU_ITEM_NAME$="BBJVFindMenuItem" - field in class BBJasper.BBJasperView

Find menu item name


FIND_MENU_ITEM_NAME$=BBJasperView.getFIND_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Find menu item name


FIND_MENU_NAME$="BBJVFindMenu" - field in class BBJasper.BBJasperView

Find menu name


FIND_NEXT$=#Translations!.getTranslation("find.next") - field in class BBJasper.BBJasperView

Translated text for searc next


FIND_NEXT_MENU_ITEM_NAME$="BBJVFindNextMenuItem" - field in class BBJasper.BBJasperView

Find next menu item name


FIND_NEXT_MENU_ITEM_NAME$=BBJasperView.getFIND_NEXT_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Find next menu item name


FIND_NEXT_TOOL_BUTTON_NAME$="BBJVFindNextToolButton" - field in class BBJasper.BBJasperView

Find next tool button name


FIND_PREVIOUS$=#Translations!.getTranslation("find.previous") - field in class BBJasper.BBJasperView

Translated text for find previous


FIND_PREVIOUS_MENU_ITEM_NAME$="BBJVFindPreviousMenuItem" - field in class BBJasper.BBJasperView

Find previous menu item name


FIND_PREVIOUS_MENU_ITEM_NAME$=BBJasperView.getFIND_PREVIOUS_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Find previous menu item name


FIND_PREVIOUS_TOOL_BUTTON_NAME$="BBJVFindPreviousToolButton" - field in class BBJasper.BBJasperView

Find previous tool button name


FIND_SCOPE_CURRENT_PAGE - field in class BBJasper.BBJasperView

Find scope current page constant


FIND_SCOPE_ENTIRE_REPORT - field in class BBJasper.BBJasperView

Find scope entire report constant


FIND_STATIC_TEXT_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the find static text, the default is 60


FIND_STATUS_BAR_NAME$="BBJVFindStatusBar" - field in class BBJasper.BBJasperView

Find status bar name


FIND_TOOL_BUTTON_NAME$="BBJVFindToolButton" - field in class BBJasper.BBJasperViewerControl

Find tool button name


FIND_TOOL_BUTTON_NAME$=BBJasperViewerControl.getFIND_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Find tool button name


FIND_WINDOW_NAME$="BBJVFindWindow" - field in class BBJasper.BBJasperView

Find window name


FindElement - class in BBJasper

FindElement(BBjNumber p_index, JRPrintText p_printText!, JRPrintFrame p_printFrame!) - constructor in class BBJasper.FindElement

FINDING$=#Translations!.getTranslation("finding") - field in class BBJasper.BBJasperView

Translated text for finding


findReport() - method in class BBJasper.BBJasperViewerControl

findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find.


findReport() - method in class BBJasper.BBJasperView

findReport Findes the entire report for the current find text and updates the passed vector with report elements found in the find.


findStaticTextElement(JRElementGroup parent!, java.lang.String exp!) - method in class BBJasper.BBJasperDesign

findStaticTextElement Finds a static text element in the passed element group


findTextFieldElement(JRElementGroup band!, java.lang.String exp!) - method in class BBJasper.BBJasperDesign

findTextFieldElement Finds a text field element in the passed element group


findTranslationLocale(BBjString p_key$) - method in class BBTranslator.BBTranslations

Returns the locale that contains the passed translation key


FINISHED=3 - field in class BBJasper.BBJasperProgress

Constant which represents the fill operation has finished


FIRST_PAGE$=#Translations!.getTranslation("first.page") - field in class BBJasper.BBJasperViewerControl

Translated text for first page


FIRST_PAGE$=#Translations!.getTranslation("first.page") - field in class BBJasper.BBJasperView

Translated text for first page


FIRST_PAGE_MENU_ITEM_NAME$="BBJVFirstPageMenuItem" - field in class BBJasper.BBJasperView

First page menu item name


FIRST_PAGE_MENU_ITEM_NAME$=BBJasperView.getFIRST_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

First page menu item name


FIRST_PAGE_TOOL_BUTTON_NAME$="BBJVFirstPageToolButton" - field in class BBJasper.BBJasperViewerControl

First page tool button name


FIRST_PAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getFIRST_PAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

First page tool button name


FirstCondition! - field in class GxClientModels.GxClientFilterCombinedModel

The first filter condition


FirstName$ - field in class Email.EmailContact

Contact first name


firstPage() - method in class BBJasper.BBJasperView

firstPage Changes the view to display the first page, if it's not already on the first page


FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$="BBJVFitActualSizeToolButton" - field in class BBJasper.BBJasperViewerControl

Fit actual size tool button name


FIT_ACTUAL_SIZE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getFIT_ACTUAL_SIZE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Fit actual size tool button name


FIT_PAGE$=#Translations!.getTranslation("fit.page") - field in class BBJasper.BBJasperViewerControl

Translated text for fit to page


FIT_PAGE$=#Translations!.getTranslation("fit.page") - field in class BBJasper.BBJasperView

Translated text for fit to page


FIT_PAGE_MENU_ITEM_NAME$="BBJVFitPageMenuItem" - field in class BBJasper.BBJasperView

Fit page menu item name


FIT_PAGE_MENU_ITEM_NAME$=BBJasperView.getFIT_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Fit page menu item name


FIT_PAGE_TOOL_BUTTON_NAME$="BBJVFitPageToolButton" - field in class BBJasper.BBJasperViewerControl

Fit page tool button name


FIT_PAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getFIT_PAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Fit page tool button name


FIT_TYPE_ACTUAL=0 - field in class BBJasper.BBJasperView

Constant for fit type actual


FIT_TYPE_ACTUAL=BBJasperView.getFIT_TYPE_ACTUAL() - field in class BBJasper.BBJasperViewerControl

Constant for fit type actual


FIT_TYPE_PAGE=2 - field in class BBJasper.BBJasperView

Constant for fit type page


FIT_TYPE_PAGE=BBJasperView.getFIT_TYPE_PAGE() - field in class BBJasper.BBJasperViewerControl

Constant for fit type page


FIT_TYPE_WIDTH=1 - field in class BBJasper.BBJasperView

Constant for fit type width


FIT_TYPE_WIDTH=BBJasperView.getFIT_TYPE_WIDTH() - field in class BBJasper.BBJasperViewerControl

Constant for fit type width


FIT_TYPE_ZOOM=3 - field in class BBJasper.BBJasperView

Constant for fit type zoom


FIT_TYPE_ZOOM=BBJasperView.getFIT_TYPE_ZOOM() - field in class BBJasper.BBJasperViewerControl

Constant for fit type zoom


FIT_WIDTH$=#Translations!.getTranslation("fit.width") - field in class BBJasper.BBJasperViewerControl

Translated text for fit to width


FIT_WIDTH$=#Translations!.getTranslation("fit.width") - field in class BBJasper.BBJasperView

Translated text for fit to width


FIT_WIDTH_MENU_ITEM_NAME$="BBJVFitWidthMenuItem" - field in class BBJasper.BBJasperView

Fit width menu item name


FIT_WIDTH_MENU_ITEM_NAME$=BBJasperView.getFIT_WIDTH_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Fit width menu item name


FIT_WIDTH_TOOL_BUTTON_NAME$="BBJVFitWidthToolButton" - field in class BBJasper.BBJasperViewerControl

Fit width tool button name


FIT_WIDTH_TOOL_BUTTON_NAME$=BBJasperViewerControl.getFIT_WIDTH_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Fit width tool button name


FitPage=-1 - field in class Dashboard.JasperViewerWidget

Fit page


FitToGrid - field in class Dashboard.GridExWidget

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.


FitType - field in class BBJasper.BBJasperHyperlink

FitWidth=1 - field in class Dashboard.JasperViewerWidget

Fit width


FixedWidgetWidth - field in class Dashboard.DashboardCategory

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 - field in class Dashboard.DashboardCategoryAttribute

FixedWidgetWidth attribute


FixedWidgetWidth:n(1*)" - field in class Dashboard.DashboardCategoryAttribute

DashboardCategoryAttribute string template


Flex! - field in class GxColumns.GxDefaultColumnDefinition

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


flipHorizontally() - method in class BBXImage.BBXImage

Method to flip the BBXImage horizontally


flipVertically() - method in class BBXImage.BBXImage

Method to flip the BBXImage vertically


Floating! - field in class GxClientModels.GxClientRowModel

The row pin position (top , bottom , null)


FloatingFilter! - field in class GxColumns.GxDefaultColumnDefinition

When true enable the floating filter on this column , false otherwise


#Configuration
#ColumnsRenderer


FloatingFiltersHeight! - field in class GxOptions.GxOptions

The height for the row containing the floating filters. If not specified the default is 20px.
#Configuration
#GridRenderer


flush() - method in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


flush() - method in class BBjGridExWidget.GxExecutor

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.


focus() - method in class QVGrid.QVGrid

Sets the focus on the grid control


focus(BBjString row!, BBjString column!, BBjString floating!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the given column


#API


focus(BBjString row!, BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the given column


#API


focus(BBjString row!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the first column


#API


focus(BBjNumber row!, BBjString column!, BBjString floating!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the given column


#API


focus(BBjNumber row!, BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the given column


#API


focus(BBjNumber row!) - method in class BBjGridExWidget.BBjGridExWidget

Set the focus on the given row id and the first column


#API


focus() - method in class BBjGridExWidget.BBjGridExWidget

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


FOLDER_TYPE$=#MIME$+"folder" - field in class GDoc

FolderInfo - class in this project

FolderInfo(BBjString p_name$, BBjString p_parentHref$) - constructor in class FolderInfo

Font! - field in class Dashboard.GridExWidget

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


Font! - field in class Dashboard.GridWidget

A BBjFont that is applied to the underlying BBjGrid control, allowing customization of the font family, size, and style


FONT_STYLE_BOLD - field in class DemoUtils.DemoUtils

FONT_STYLE_ITALIC - field in class DemoUtils.DemoUtils

FONT_STYLE_PLAIN - field in class DemoUtils.DemoUtils

FONT_STYLE_STRIKEOUT - field in class DemoUtils.DemoUtils

FONT_STYLE_UNDERLINE - field in class DemoUtils.DemoUtils

FontChooser - class in this project

FontChooser(BBjFont startFont!, BBjNumber startX, BBjNumber startY, BBjString nsVar$) - constructor in class FontChooser

FooterValueGetterExpression! - field in class GxRenderers.GxRendererGroupCellRenderer

Provide a footer value getter expression


ForceCommunityBuild! - field in class BBjGridExWidget.BBjGridExWidget

When true, the grid will force using the community version of the grid whether there is a license key or not.


ForceTrailingZeros - field in class GxCellEditors.GxCellEditorBasicNumber

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


FORM_TYPE$=#MIME$+"form" - field in class GDoc

FORM_TYPE_NAME$="FORM" - field in class GDocSaveDialog

FormatterExpression! - field in class GxOptions.GxOptionsDateTime

A valid expression which validates the datetime


FREQ_DAILY!="DAILY" - field in class gappsv3.SimpleRULE

Constant for days


FREQ_HOURLY!="HOURLY" - field in class gappsv3.SimpleRULE

Constant for hours


FREQ_MINUTELY!="MINUTELY" - field in class gappsv3.SimpleRULE

Constant for minutes


FREQ_MONTHLY!="MONTHLY" - field in class gappsv3.SimpleRULE

Constant for months


FREQ_SECONDLY!="SECONDLY" - field in class gappsv3.SimpleRULE

Constant for seconds


FREQ_WEEKLY!="WEEKLY" - field in class gappsv3.SimpleRULE

Constant for weeks


Frequency!=null() - field in class gappsv3.SimpleRULE

Frequency with which an event or exception should occur: required


FriendlyName$ - field in class DialogWizard.Event

FROM_CURRENT_PAGE$=#Translations!.getTranslation("from.current.page") - field in class BBJasper.BBJasperView

Translated text for from currrent page


FULL_WORD$=#Translations!.getTranslation("full.word") - field in class BBJasper.BBJasperView

Translated text for full word


FunctionsReadOnly! - field in class GxOptions.GxOptions

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


G

GACL - class in gappsv3

Access Control List class (Currently unimplemented. Subject to relocation or deletion.)


GApps - class in this project

GAppsAuthorization - class in gappsv3

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.


GAppsAuthorization(BBjString authorizationToken!) - constructor in class gappsv3.GAppsAuthorization

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.


GAppsLoginDialog - class in this project

GAppsLoginDialog(GAppsService p_service!) - constructor in class GAppsLoginDialog

GAppsService - class in this project

gapps.bbj


GCalendar - class in gappsv3

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.


GCalendar(GCalendarAPI api!, CalendarListEntry wrappedCalendar!) - constructor in class gappsv3.GCalendar

Constructor


GCalendarAPI - class in gappsv3

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.


GCalendarAPI(BBjString oauthToken!) - constructor in class gappsv3.GCalendarAPI

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.


GDoc - class in this project

GDoc(GDocsService p_service!, BBjString p_fileID$) - constructor in class GDoc

GDoc(GDocsService p_service!, com.google.api.services.drive.model.File p_fl!) - constructor in class GDoc

GDocFolderSelectionDialog - class in this project

GDocFolderSelectionDialog() - constructor in class GDocFolderSelectionDialog

GDocOpenDialog - class in this project

GDocOpenDialog() - constructor in class GDocOpenDialog

GDocSaveDialog - class in this project

GDocSaveDialog() - constructor in class GDocSaveDialog

GDocSelectionDialog - class in this project

GDocSelectionDialog() - constructor in class GDocSelectionDialog

GDocSelectionListener - interface in this project

GDocsResultSet - class in this project

Class for accessing large sets of GDocs without having to perform the conversion on every single document


GDocsResultSet(GDocsService p_service!, Map p_docs!) - constructor in class GDocsResultSet

GDocsService - class in this project

GDocsService() - constructor in class GDocsService

GeneralUtilities - class in this project

@description: General BBj-related utilities class


generateBeginClassCode() - method in class BuildItem

generateBeginClassCode() - method in class WidgetBuildItem

generateBeginClassCode() - method in class WidgetSetBuildItem

generateBeginClassCode() - method in class WidgetDashboardBuildItem

generateBuildItemProgramCode() - method in class WidgetWizard

Method generateBuildItemProgramCode: Generates and returns BBj program code


generateEndClassCode() - method in class BuildItem

generateEndClassCode() - method in class BaseBuildItem

generateFieldCode() - method in class BuildItem

generateFieldCode() - method in class WidgetBuildItem

generateFieldCode() - method in class WidgetSetBuildItem

generateFieldCode() - method in class WidgetDashboardBuildItem

generateHeaderCode() - method in class BuildItem

generateHeaderCode() - method in class BaseBuildItem

generateMethodCode() - method in class BuildItem

generateMethodCode() - method in class WidgetBuildItem

generateMethodCode() - method in class WidgetSetBuildItem

generateMethodCode() - method in class WidgetDashboardBuildItem

generateProgramCode() - method in class BuildItem

generateProgramCode() - method in class BaseBuildItem

Method generateProgramCode: Generates and returns BBj program code


generateSampleCode() - method in class BuildItem

generateSampleCode() - method in class BaseBuildItem

get(BBjString column!) - method in class GxClientModels.GxClientSortModel

Get sorting for the given column


get_active_func(BBjNamespaceEvent pEvent!) - method in class DialogWizard.BBDialog

Method get_active_func: Check for and act on last application event, invoke caller's toolbar button push callback method


getAccessRole() - method in class gappsv3.GCalendar

Get access role.


getACL(String aclId!) - method in class gappsv3.GCalendarAPI

Read Access Control List. (Not implemented. Subject to removal or relocating.)


getACLs() - method in class gappsv3.GCalendarAPI

Get all Access Control Lists. (Not implemented. Subject to removal or relocating.)


getActiveDashboardWidgetControlPosition(BBjString p_widgetName$) - method in class Dashboard.DashboardCategoryControl

Returns the current position of an active dashboard widget control that is part of the dashboard category control


getActiveDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the active dashboard widget controls in the dashboard category control


getActiveEnd() - method in class BBjCalendarWidget.CalendarView

Returns the calendar's last visible day as a date string.

Note: This value is exclusive, as are all ending dates.


getActiveStart() - method in class BBjCalendarWidget.CalendarView

Returns the calendar's first visible day as a date string.


getAdditionalRoles() - method in class GPermission

getAlignment() - method in class BBjCalendarWidget.CalendarToolbarSection

Returns the section's horizontal alignement as one of the three possible alignments constants.


getAlignment() - method in class GxStatusBar.GxStatusBarComponentInterface

Get the component alignment


getAllControls(BBjString pResFilePath$) - method in class DialogWizard.DialogUtils

Method getAllControls: Get all controls in a resource file


getAllControls(BBjString pResFilePath$, BBjNumber pWinId) - method in class DialogWizard.DialogUtils

Method getAllControls: Get all controls in a resource file for a particular window id


getAllControls(BBjWindow pWindow!) - method in class DialogWizard.DialogUtils

Method getAllControls: Get all controls using a window object


getAllControls() - method in class BBJasper.BBJasperViewerControl

getAllControls Returns a HashMap containg all of the controls


getAllControls() - method in class BBJasper.BBJasperTabbedView

getAllControls Returns a HashMap containg all of the controls


getAllControls() - method in class BBJasper.BBJasperView

getAllControls Returns a HashMap containg all of the controls


getAllControlsRecursive(BBjWindow pWindow!, BBjNumber pInclInstance) - method in class DialogWizard.DialogUtils

Method getAllControlsRecursive: Get all controls recursively


getAllDay() - method in class BBjCalendarWidget.CalendarSelectEvent

Returns a BBjNumber acting as a boolean that determines whether the user selected all-day cells (1) or not (0).


getAllDay() - method in class BBjCalendarWidget.CalendarDateClickEvent

Returns a BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).


getAllDay() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.


getAllDayEventDateTime(BBjNumber year!, BBjNumber month!, BBjNumber day!) - method in class gappsv3.GUtil

Create an all-day Google EventDateTime object by specifying 6 numbers for Year, Month, and Day.


getAllDayEventDateTime(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjString timeZone!) - method in class gappsv3.GUtil

Create an all-day Google EventDateTime object by specifying 6 numbers for Year, Month, and Day.


getAllDayEventDateTime(java.util.Date date!) - method in class gappsv3.GUtil

Create an All-Day Google EventDateTime object using a java.util.Date


getAllDayEventDateTime(java.util.Date date!, BBjString timeZone!) - method in class gappsv3.GUtil

Create an All-Day Google EventDateTime object using a java.util.Date


getAllFolders() - method in class GDocsService

getAllMatchingNodes(BBjString p_name!) - method in class BBXMLDoc

getAllMatchingNodes(Node p_node!, BBjString p_name!) - method in class BBXMLDoc

getAllMatchingNodes(Node p_node!, BBjString p_name!, BBjNumber p_nodeType, BBjVector p_nodeVector!) - method in class BBXMLDoc

getAllMatchingNodesWithAttr(BBjString p_attrName$) - method in class BBXMLDoc

getAllMatchingNodesWithAttr(Node p_node!, BBjString p_attrName$, BBjString p_attrValue!, BBjVector p_nodeVector!) - method in class BBXMLDoc

getAllowInput() - method in class GxOptions.GxOptionsDateTime

getAllViewTypes() - method in class BBjCalendarWidget.CalendarView

Returns a BBjVector filled with all possible calendar view types.


getAllViewTypes() - method in class BBjCalendarWidget.CalendarAPI

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.


getAltKey() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns whether the user's alt key was pressed when the event occurred.


getAnyoneCanAddSelf() - method in class gappsv3.GEvent

Indicates whether people can invite themselves to the event regardless of ownership.


getApplications(BBjString p_vendor$) - method in class BUS

getAsFormattedString() - method in class BBjCalendarWidget.CalendarOptions

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarOptions object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarEvent

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEvent object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarEntry

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntry object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarView

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarView object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarToolbar

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarToolbar object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarToolbarSection

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarToolbarSection object.


getAsFormattedString() - method in class BBjCalendarWidget.CalendarEntrySource

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntrySource object.


getAsJsonArray() - method in class GxClientModels.GxClientSortModel

Convert the model to JSON array


getAsJsonObject() - method in class BBjCalendarWidget.CalendarOptions

Returns the CalendarOptions as a JsonObject.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarEvent

Returns a JsonObject representation of the CalendarEvent.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarEntry

Returns a JsonObject representation of the CalendarEntry object.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarView

Returns a JsonObject representation of the calendar view object.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarToolbar

Returns the CalendarToolbar object as a JsonObject.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarToolbarSection

Returns the component's JSON representation.


getAsJsonObject() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the options object as a JsonObject.


getAsJsonObject() - method in class BBjGridExWidget.BBjGridExWidget

Build the grid json configuration object


getAsJsonObject() - method in class GxCellEditors.GxCellEditorInterface

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxCellEditors.GxCellEditorText

@override

{@inheritDoc}


getAsJsonObject() - method in class GxCellEditors.GxCellEditorLargeText

@override

{@inheritDoc}


getAsJsonObject() - method in class GxCellEditors.GxCellEditorSelect
{@inheritDoc}

getAsJsonObject() - method in class GxCellEditors.GxCellEditorRichSelect
{@inheritDoc}

getAsJsonObject() - method in class GxCellEditors.GxCellEditorBasicBoolean

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxCellEditors.GxCellEditorBasicNumber

@override

{@inheritDoc}


getAsJsonObject() - method in class GxCellEditors.GxCellEditorBasicText

@override

{@inheritDoc}


getAsJsonObject() - method in class GxCellEditors.GxCellEditorSuggestion

@override

{@inheritDoc}


getAsJsonObject() - method in class GxClientModels.GxClientRowModel

Get the row data as JsonObject


getAsJsonObject() - method in class GxClientModels.GxClientAddRangeSelectionModel

Convert the model to JSON object


getAsJsonObject() - method in class GxClientModels.GxClientAddRangeChartModel

Convert the model to JSON object


getAsJsonObject() - method in class GxClientModels.GxClientFilterModel

Convert the model to JSON object


getAsJsonObject() - method in class GxClientModels.GxClientFilterCombinedModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterSimpleModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterTextModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterNumberModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterDateTimeModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterBooleanModel
{@inheritDoc}

getAsJsonObject() - method in class GxClientModels.GxClientFilterSetFilterModel
{@inheritDoc}

getAsJsonObject() - method in class GxColumns.GxColumnDefinition

Convert the definition to Json Object


getAsJsonObject() - method in class GxColumns.GxDefaultColumnDefinition

Convert the definition to Json Object


getAsJsonObject() - method in class GxColumns.GxColumn

Convert the definition to Json Object


getAsJsonObject() - method in class GxColumns.GxDefaultColumnGroup

Convert the definition to Json Object


getAsJsonObject() - method in class GxColumns.GxColumnGroup

Convert the definition to Json Object


getAsJsonObject() - method in class GxFilters.GxFilterInterface

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxFilters.GxColumnFilterAG

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxFilters.GxFilterText

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxFilters.GxFilterNumber

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxFilters.GxFilterSetFilter

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxFilters.GxFilterBasicBoolean

@override


getAsJsonObject() - method in class GxFilters.GxFilterBasicDateTime

Convert the filter definition to Json Object


getAsJsonObject() - method in class GxOptions.GxOptionsBoolean

Transform the options object to json


getAsJsonObject() - method in class GxOptions.GxOptionsDateTime

Transform the options object to json


getAsJsonObject() - method in class GxOptions.GxOptions

Build the grid json configuration object


getAsJsonObject() - method in class GxRenderers.GxRendererInterface

Convert the renderer definition to Json Object


getAsJsonObject() - method in class GxRenderers.GxRendererBoolean

Convert the renderer definition to Json Object


getAsJsonObject() - method in class GxRenderers.GxRendererCustomHTML
{@inheritDoc}

getAsJsonObject() - method in class GxRenderers.GxRendererImageRenderer
{@inheritDoc}

getAsJsonObject() - method in class GxRenderers.GxRendererGroupCellRenderer
{@inheritDoc}

getAsJsonObject() - method in class GxSidebar.GxToolpanelInterface

Get a json representation for the toolpanel


getAsJsonObject() - method in class GxSidebar.GxToolpanel

Get a json representation for the toolpanel


getAsJsonObject() - method in class GxSidebar.GxColumnsToolpanel

Get a json representation for the toolpanel


getAsJsonObject() - method in class GxSidebar.GxFiltersToolpanel

Get a json representation for the toolpanel


getAsJsonObject() - method in class GxSidebar.GxSidebar

Convert the sidebar into json object


getAsJsonObject() - method in class GxStatusBar.GxStatusBarComponentInterface

Get the component's JSON representation


getAsJsonObject() - method in class GxStatusBar.GxStatusBarComponent

Get the component's JSON representation


getAsJsonObject() - method in class GxStatusBar.GxStatusBarAggregationComponent

Get the component's JSON representation


getAspectRatio() - method in class BBjCalendarWidget.CalendarOptions

Returns the width-to-height aspect ratio of the calendar.


getAsString() - method in class BBjCalendarWidget.CalendarOptions

Returns a stringified JsonObject representation of CalendarOptions object.


getAsString() - method in class BBjCalendarWidget.CalendarEvent

Returns a stringified JsonObject representation of the CalendarEvent.


getAsString() - method in class BBjCalendarWidget.CalendarEntry

Returns a stringified JsonObject representation of the CalendarEntry object.


getAsString() - method in class BBjCalendarWidget.CalendarView

Returns a stringified JsonObject representation of the calendar view object.


getAsString() - method in class BBjCalendarWidget.CalendarToolbar

Returns a stringified JsonObject representation of CalendarToolbar object.


getAsString() - method in class BBjCalendarWidget.CalendarToolbarSection

Returns a stringified JsonObject representation of CalendarToolbarSection object.


getAsString() - method in class BBjCalendarWidget.CalendarEntrySource

Returns a stringified JsonObject representation of the CalendarEntrySource object.


getAttendees() - method in class gappsv3.GEvent

Get a list of participants in the meeting


getAttendeesOmitted() - method in class gappsv3.GEvent

Indicates whether attendees have been omitted from the event.


getAttribute(String attribute!) - method in class QVGrid.QVGrid

Returns a control attribute previously set with setAttribute() for the grid control


getAutoRefreshEnabled() - method in class Dashboard.DashboardWidget

Returns the auto refresh enabled state (1 for enabled and 0 for disabled)


getAutoRefreshEnabled() - method in class Dashboard.WidgetControl

Returns the auto refresh status


getAutoRefreshRate() - method in class Dashboard.DashboardWidget

Returns the auto refresh interval


getAutoRefreshRate() - method in class Dashboard.WidgetControl

Returns the auto refresh rate


getAutoRefreshUnit() - method in class Dashboard.DashboardWidget

Returns the auto refresh unit


getAutoRefreshUnit() - method in class Dashboard.WidgetControl

Returns the auto refresh unit


getBackColor() - method in class Dashboard.DashboardItem

Returns the background color of dashboard item


getBackColor() - method in class Dashboard.DashboardWindow

Returns the background color of the dashboard window


getBackColor() - method in class Dashboard.DashboardControl

Returns the background color of the dashboard control


getBackColor() - method in class Dashboard.DashboardCategoryControl

Returns the background color of the dashboard category control


getBackColor() - method in class Dashboard.WidgetControl

Returns the background color of the widget control


getBackColor() - method in class QVGrid.QVGrid

Returns the background color of the grid control


getBackColor() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the background color of the calendar's containing window.


getBackgroundColor() - method in class gappsv3.GCalendar

Get background color.


getBackgroundColor() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's background color.


getBackgroundColor() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry background color.


getBands() - method in class BBJasper.BBJasperDesign

getBands Returns all the bands in the JasperDesign object


getBase64() - method in class BBXImage.BBXImage

Method to return the BBXImage out to an Image Output Stream 32-bit converted to a Base64 ASCII Stream


getBBjColor(Color p_color!) - method in class Dashboard.ChartWidget

Method to create a BBjColor from a Java Color, taking into account an alpha channel if it exists


getBBjColorFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to create a BBjColor from a hex color string


getBBjColorFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a BBjColor from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values


getBBjColorFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

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


getBBjColorFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a BBjColor from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values


getBBjColorFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

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


getBBjColorFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to create a BBjColor from a Java Color with an alpha channel


getBBjColorWithAlphaFromHexString(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Method to create a BBjColor with an alpha channel from a hex string


getBBjControl(BBjString p_controlName$) - method in class Dashboard.DashboardWindow

Returns a dashboard window BBj control


getBBjControl(BBjString p_controlName$) - method in class Dashboard.DashboardControl

Returns a dashboard window BBj control


getBBjControl(BBjString p_controlName$) - method in class Dashboard.DashboardCategoryControl

Returns a BBj control give a name


getBBjControl(BBjString p_controlName$) - method in class Dashboard.WidgetControl

Returns the BBjControl identified by the provided control name


getBBjEventName() - method in class DialogWizard.Event

Method getBBjEventName: Get BBj event class name (e.g. "BBjButtonPushEvent")


getBBjFont(Font p_font!) - method in class DemoUtils.DemoUtils

Method to get a BBjFont object from a Java Font object


getBBjFont(BBjString p_fontPath$, BBjNumber p_fontSize, BBjNumber p_fontStyle) - method in class DemoUtils.DemoUtils

Method to get a BBjFont object from a path to a TTF or OTF file


getBBjImage() - method in class BBXImage.BBXImage

Method to get a BBjImage for the BBXImage


getBBjImageFromURL(BBjString url$) - method in class GeneralUtilities

getBBjTypeName() - method in class DialogWizard.Control

Method getBBjTypeName: Get control BBj type class name


getBBjVectorAsJsonArray(BBjVector vector!) - method in class BBjCalendarWidget.BBjCalendarWidget

A utility method that returns a JSON array version of the supplied BBjVector.


getBBjVectorAsJsonArray(BBjVector vector!) - method in class BBjCalendarWidget.CalendarAPI

Returns a JSON array version of the supplied BBjVector.


getBearerTokenFromRefreshToken(BBjString refreshToken!) - method in class gappsv3.GOAuth2

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.


getBeepOnValidationFailure() - method in class QVGrid.QVGrid

Returns whether the grid will beep when the program calls 'accept(0)' in response to a validation event


getBody() - method in class BBWebClient.BBWebResponse

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.


getBorderColor() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's border color.


getBorderColor() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry border color.


getBottom() - method in class BBJasper.BBJasperPrintMediaTray

getBottom Creates and returns a print media tray object that contains bottom tray information


getBottomRow() - method in class QVGrid.QVGrid

Returns the current visible bottom row


getBufferedImage() - method in class BBXImage.BBXImage

Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage


getBufferedImage(BBjNumber p_bufferedImageType!) - method in class BBXImage.BBXImage

Method to get a BufferedImage from the BBXImage


getBuiIosMajorVersion() - method in class BBUtils.BBUtils

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.


getBuiIosVersion() - method in class BBUtils.BBUtils

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.


getBuildItem() - method in class WidgetWizard

Method getBuildItem Returns the BuildItem


getBuildItemCategoryNames() - method in class WidgetWizard

getBuildItemCategoryTitles() - method in class WidgetWizard

getBuildItemEmbeddedCode() - method in class WidgetWizard

Method getBuildItemEmbeddedCode: Returns the BBj program code necessary to embed the build item


getBuildItemType() - method in class WidgetWizard

Method getBuildItemType: Returns the build type


getBuildItemWidgetConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetDescription(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetExists(BBjString p_categoryName$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetNames(BBjString p_widgetCategory$) - method in class WidgetWizard

getBuildItemWidgetRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetReportConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetReportFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetSeriesConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

getBuildItemWidgetSeriesNames(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetSeriesRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

getBuildItemWidgetSeriesRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

getBuildItemWidgetSeriesRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

getBuildItemWidgetSeriesSQL(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

getBuildItemWidgetSQL(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBuildItemWidgetTitles(BBjString p_widgetCategory$) - method in class WidgetWizard

getBuildItemWidgetType(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

getBundle(BBjString p_name!) - method in class BBTranslator.BBTranslationBundle

getBundle(BBjString p_name!, BBjString p_directory!) - method in class BBTranslator.BBTranslationBundle

getBundle(BBjString p_name!, BBjString p_directory!, Locale p_localeOfOrigin!) - method in class BBTranslator.BBTranslationBundle

getBundle() - method in class BBjGridExWidget.BBjGridExWidget

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.


getBundleFromJar(BBjString p_name!, BBjString p_jarFileName!, Locale p_localeOfOrigin!) - method in class BBTranslator.BBTranslationBundle

getBundleFromZip(BBjString p_name!, BBjString p_zipFileName!, Locale p_localeOfOrigin!) - method in class BBTranslator.BBTranslationBundle

getBundleLockUser(BBjString p_name!, BBjString p_directory!) - method in class BBTranslator.BBTranslationBundle

getBusyTimes(java.util.Date startDate!, java.util.Date endDate!) - method in class gappsv3.GCalendar

getButtonText(BBjString buttonName!) - method in class BBjCalendarWidget.CalendarOptions

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.


getCalendar(BBjString calendarId!) - method in class gappsv3.GCalendarAPI

Retrieves the GCalendar corresponding to calendarId!


getCalendarEntry() - method in class BBjCalendarWidget.CalendarEntryEvent

Returns the entry (appointment, event, etc.) from the calendar.


getCalendarEntry() - method in class BBjCalendarWidget.CalendarEntryModificationEvent

Returns the entry (appointment, event, etc.) from the calendar.


getCalendarId() - method in class BBjCalendarWidget.CalendarEntrySourceGoogle

Returns the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".


getCalendars() - method in class gappsv3.GCalendarAPI

Retrieves list of all GCalendars associated with user's Google Account. This includes Calendars visible to the user.


getCalendarUuid() - method in class BBjCalendarWidget.CalendarEvent

Returns a unique ID that identifes the calendar instance to which the event belongs.


getCalendarUuid() - method in class BBjCalendarWidget.CalendarView

Returns a unique ID that identifes the calendar instance to which the view belongs.


getCalendarView() - method in class BBjCalendarWidget.CalendarEvent

Returns the calendar's CalendarView object.


getCalendarX() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

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())


getCalendarY() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

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())


getCategoryNames() - method in class BuildItem

getCategoryNames() - method in class WidgetBuildItem

getCategoryNames() - method in class WidgetSetBuildItem

getCategoryNames() - method in class WidgetDashboardBuildItem

getCategoryTitles() - method in class BuildItem

getCategoryTitles() - method in class WidgetBuildItem

getCategoryTitles() - method in class WidgetSetBuildItem

getCategoryTitles() - method in class WidgetDashboardBuildItem

getCausesControlValidation() - method in class QVGrid.QVGrid

Returns whether entering the grid control will trigger control validation on the control that previously had focus


getCell(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientCellModel


getCell(BBjString json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON string to GxClientCellModel


getCell(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientCellModel


getCell(BBjString json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON string to GxClientCellModel


getCellAlignment(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the alignment of a cell


getCellBackColor(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the background color of a cell


getCellEditorName() - method in class GxCellEditors.GxCellEditorInterface

A constant which holds the client cell editor real name


getCellEditorName() - method in class GxCellEditors.GxCellEditorText

@override

{@inheritDoc}


getCellEditorName() - method in class GxCellEditors.GxCellEditorPopupText

@override

{@inheritDoc}


getCellEditorName() - method in class GxCellEditors.GxCellEditorLargeText

@override

{@inheritDoc}


getCellEditorName() - method in class GxCellEditors.GxCellEditorSelect
{@inheritDoc}

getCellEditorName() - method in class GxCellEditors.GxCellEditorPopupSelect
{@inheritDoc}

getCellEditorName() - method in class GxCellEditors.GxCellEditorRichSelect
{@inheritDoc}

getCellEditorName() - method in class GxCellEditors.GxCellEditorBasicBoolean

A constant which holds the client cell editor real name


getCellEditorName() - method in class GxCellEditors.GxCellEditorBasicNumber

@override

{@inheritDoc}


getCellEditorName() - method in class GxCellEditors.GxCellEditorBasicText

@override

{@inheritDoc}


getCellEditorName() - method in class GxCellEditors.GxCellEditorBasicDateTime

A constant which holds the client cell editor real name


getCellEditorName() - method in class GxCellEditors.GxCellEditorSuggestion

@override

{@inheritDoc}


getCellFont(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the font of a cell


getCellForeColor(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the foreground color of a cell


getCellHasQuery(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns whether a BBjStandardGrid cell has an associated query button


getCellListControl(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the list control for a cell


getCellListSelection(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the list selection for a list control in a cell


getCellMask(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the mask for a cell


getCellRelated(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the "related" text associated with a cell


getCellRendererName() - method in class GxRenderers.GxRendererInterface

A constant which holds the client renderer real name


getCellRendererName() - method in class GxRenderers.GxRendererBoolean

A constant which holds the client renderer real name


getCellRendererName() - method in class GxRenderers.GxRendererCustomHTML
{@inheritDoc}

getCellRendererName() - method in class GxRenderers.GxRendererImageRenderer
{@inheritDoc}

getCellRendererName() - method in class GxRenderers.GxRendererGroupCellRenderer
{@inheritDoc}

getCellRestore(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the restore value for a cell


getCellState(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the checked state of a check box or button style cell


getCellStyle(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the style of a cell


getCellStyleNames(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns a list of all CSS style names that have been added to a grid cell


getCellText(BBjNumber p_row, BBjNumber p_col) - method in class Dashboard.GridWidget

Returns the text of a cell in the GridWidget given the cell's row and column number


getCellText(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the value of the text stored in the specified cell


getCellVerticalAlignment(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the vertical alignment of a cell


getChartDataItemFromPoint(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.ChartWidget

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.


getChartDataItemsFromPoint(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.ChartWidget

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.


getChartDomainAxisFormat() - method in class Dashboard.ChartWidget

Returns the custom decimal format for the XYChart's domain axis (x-axis) numbers - note that this applies only to an XYChart


getChartFontFile() - method in class Dashboard.ChartWidget

Gets the customized font file for the chart.


getChartHeight() - method in class Dashboard.ChartWidget

Returns the height of the chart


getChartImage(BBjNumber p_width, BBjNumber p_height) - method in class BBjBUIDialChart.BBjBUIDialChart

Method to get a screenshot of the chart in the form of a BBjImage sized to the provided width and height parameters


getChartRangeAxisFormat() - method in class Dashboard.ChartWidget

Returns the custom decimal format for the chart's range axis (y-axis) numbers


getChartRangeAxisToCurrency() - method in class Dashboard.ChartWidget

Return a BBjNumber indicating if the range axis was set to show its values formatted as currency for the current locale


getChartRangeAxisToPercent() - method in class Dashboard.ChartWidget

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.


getChartWidth() - method in class Dashboard.ChartWidget

Returns the width of the chart


getChildren() - method in class BBTranslator.BBTranslations

Returns the children of the translations in a HashMap


getChromaticity() - method in class BBJasper.BBJasperPrintChromaticity

getChromaticity Returns the chromaticity object


getClassName() - method in class BBjCalendarWidget.CalendarEntry

DEPRECATED Returns an entry's a class name string.


getClassName() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry class name string.


getClassNames() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's class names (or CSS styles) in a vector of strings.


getClickTarget(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.GridWidget

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.


getClientBBjConfigFile() - method in class BBConfig

getClientBBjHome() - method in class BBConfig

getClientBBjInterpreter() - method in class BBConfig

getClientContext() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid's client context


getClientEdge() - method in class QVGrid.QVGrid

Returns whether the client (lowered) border is set for the grid control


getClientJasperPrint() - method in class BBJasper.BBJasperReport

getClientJasperPrint Creates (if necessary) and returns the client JasperPrint object


getClientJavaHome() - method in class BBConfig

getClientJsonFactory() - method in class BBjGridExWidget.BBjGridExWidget

Get instance of GxClientJsonFactory


getClientLocale() - method in class BBJasper.BBJasper

getClientLocale Returns the locale used by the client


getClientLocale() - method in class BBTranslator.BBTranslator

Returns the locale used by the client


getClientLocale() - method in class BBTranslator.BBTranslationBundle

getClientLocale() - method in class BBTranslator.BBTranslations

Returns the locale used by the client


getClientLocaleString() - method in class BBTranslator.BBTranslator

Returns the locale string used by the client


getClientLocaleString() - method in class BBTranslator.BBTranslationBundle

getClientLocaleString() - method in class BBTranslator.BBTranslations

Returns the locale string used by the client


getClientOS() - method in class BBConfig

getClientPrintRequestAttributeSet() - method in class BBJasper.BBJasperPrintServiceExporter

getClientPrintRequestAttributeSet Returns the client print request attribute set


getClientProperty(Object p_key!) - method in class QVGrid.QVGrid

see BBjControl


getClientSlash() - method in class Dashboard.BaseWidget

getClientSlash Returns the client's path separator: "" for Windows and "/" for all other operating systems


getClientSlash() - method in class Dashboard.ExportData

getClientSlash Returns the last record delimiter used


getClientX() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

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.


getClientY() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns the Y-coordinate of the user's mouse relative to the calendar's window.


getClosed() - method in class FaxJob

getClosed() - method in class FaxJobBase

getCloseOnSend() - method in class Email.EmailDialog

getCloseOnSend Returns whether the dialog should be closed on a send


getColor() - method in class BBJasper.BBJasperPrintChromaticity

getColor Creates and returns a chromaticity object that contains color information


getColor() - method in class BBjCalendarWidget.CalendarEntry

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.


getColor() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry combined background and border color.


getColor(BBjColor color!) - method in class BBjBUIDialChart.BBjBUIDialChart

getColorFromHexString(BBjString p_colorHexString$) - method in class BBXImage.BBXImage

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.


getColorId() - method in class gappsv3.GCalendar

Get color id.


getColorId() - method in class gappsv3.GEvent

Gets the color id of the event.


getColorTheme(BBjNumber p_colorThemeIndex) - method in class Dashboard.ChartWidget

Gets a pre-defined color theme vector


getColorThemeCount() - method in class Dashboard.ChartWidget

Gets the total number of color themes


getColorThemeDescription(BBjNumber p_colorThemeIndex) - method in class Dashboard.ChartWidget

Gets the description of the specified color theme


getColorWithAlpha(BBjColor p_color!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Method to create a Java Color with an alpha channel from a BBjColor where opacity = (0-1)


getColorWithAlpha(Color p_color!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Method to create a Java Color with an alpha channel from a Java Color by specifying an opacity amount.


getColorWithAlpha(BBjColor color!, BBjNumber alpha) - method in class BBjBUIDialChart.BBjBUIDialChart

getColorWithAlphaFromHexString(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class BBXImage.BBXImage

Method to create a Java Color with an alpha channel from a hex string


getColorWithAlphaFromHexString(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Method to create a Java Color with an alpha channel from a hex string


getColumn(BBjString field!) - method in class BBjGridExWidget.BBjGridExWidget

Get the column definition instance


#Configuration
#ColumnsRenderer


getColumn() - method in class GxClientEvents.GxClientEventsContextMenu

Get the cell's column


getColumn(BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Map column name to GxClientColumnModel


getColumn(BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Map column name to GxClientColumnModel


getColumn() - method in class GxClientModels.GxClientFilterModel

Get the working column


getColumn(BBjString field!) - method in class GxColumns.GxColumnsManagerInterface

Get the column definition instance


#Configuration
#ColumnsRenderer


getColumn(BBjString field!) - method in class GxColumns.GxColumnsManager

Get the column definition instance


#Configuration
#ColumnsRenderer


getColumn(BBjString field!) - method in class GxColumns.GxColumnGroup

Get the column definition instance


#Configuration
#ColumnsRenderer


getColumnAlignment(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default horizontal alignment for a column


getColumnBackColor(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default background color of a column


getColumnFont(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default font of a column


getColumnForeColor(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default foreground color of a column


getColumnGroup(BBjString id!) - method in class BBjGridExWidget.BBjGridExWidget

Get the column group definition instance


#Configuration
#ColumnsRenderer


getColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManagerInterface

Get the column group definition instance


#Configuration
#ColumnsRenderer


getColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManager

Get the column group definition instance


#Configuration
#ColumnsRenderer


getColumnGroup(BBjString id!) - method in class GxColumns.GxColumnGroup

Get the column group definition instance


#Configuration
#ColumnsRenderer


getColumnGutter() - method in class QVGrid.QVGrid

Returns the number of pixels separating the column header and the main grid area


getColumnHasQuery(BBjNumber column) - method in class QVGrid.QVGrid

Returns whether all cells in the specified column have associated query buttons


getColumnHeader() - method in class QVGrid.QVGrid

Returns the column header object for the grid


getColumnHeaderAlignment() - method in class QVGrid.QVGrid

Returns the default column header horizontal alignment


getColumnHeaderBackColor() - method in class QVGrid.QVGrid

Returns the default background color of the column header


getColumnHeaderCellAlignment(BBjNumber column) - method in class QVGrid.QVGrid

Returns the horizontal alignment for a column header cell


getColumnHeaderCellBackColor(BBjNumber column) - method in class QVGrid.QVGrid

Returns the background color of a column header cell


getColumnHeaderCellForeColor(BBjNumber column) - method in class QVGrid.QVGrid

Returns the foreground color of a column header cell


getColumnHeaderCellStyle(BBjNumber column) - method in class QVGrid.QVGrid

Returns the style of a column header cell


getColumnHeaderCellText(BBjNumber column) - method in class QVGrid.QVGrid

Returns the text displayed in a column header cell


getColumnHeaderCellVerticalAlignment(BBjNumber column) - method in class QVGrid.QVGrid

Returns the vertical alignment for a column header cell


getColumnHeaderData() - method in class Dashboard.GridExWidget

Returns the header data of the GridWidget in a BBjVector


getColumnHeaderData() - method in class Dashboard.GridWidget

Returns the header data of the GridWidget in a BBjVector


getColumnHeaderFont() - method in class QVGrid.QVGrid

Returns the default font of the column header


getColumnHeaderForeColor() - method in class QVGrid.QVGrid

Returns the default foreground color of the column header


getColumnHeaderHeight() - method in class QVGrid.QVGrid

Returns the height of the column header


getColumnHeaderStyle() - method in class QVGrid.QVGrid

Returns the style used by default for the column headers


getColumnHeaderVerticalAlignment() - method in class QVGrid.QVGrid

Returns the default column header vertical alignment


getColumnListControl(BBjNumber column) - method in class QVGrid.QVGrid

Returns the list control for a column


getColumnListSelection(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default selected index for the list control in the column


getColumnMask(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default mask for a column


getColumns() - method in class Dashboard.DataFillableWidget

Returns the Columns


getColumns() - method in class BBJasper.BBJasperDesign

getColumns Returns the columns


getColumnState() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid's columns , sorting and filtering state


#API


getColumnStyle(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default style of a column in the grid


getColumnStyleNames(BBjNumber column) - method in class QVGrid.QVGrid

Returns a list of all CSS styles names that have been added to a grid column


getColumnVerticalAlignment(BBjNumber column) - method in class QVGrid.QVGrid

Returns the default vertical alignment for all of the cells in a particular column


getColumnWidth(BBjNumber column) - method in class QVGrid.QVGrid

Retrieves the width of a specified column


getColumnWidths() - method in class QVGrid.QVGrid

Returns a vector containing the column widths within a grid


getComment() - method in class gappsv3.GEventAttendee

Attendee's comment for the event. Example: "I am bringing cherry cobbler to the party."


getComponent(BBjString id!) - method in class GxStatusBar.GxStatusBar

Get statusbar component


getComputedStyle(String arg0!) - method in class QVGrid.QVGrid

see BBjControl


getConnectString() - method in class Dashboard.DataFillableWidget

Returns the JDBC connect String


getConnectString() - method in class BBJasper.BBJasperReport

getConnectString Returns the JDBC connect string


getConnectString() - method in class BBJasper.BBJasperDesign

getConnectString Returns the connect string


getContainer() - method in class WidgetWizard

Method getContainer Returns the container type


getContextID() - method in class QVGrid.QVGrid

Returns the context ID of the QVGrid component child window


getContextMenu() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid default context menu


getControl(BBjString p_controlName$) - method in class BBJasper.BBJasperViewerControl

getControl Returns a control given the control name


getControl(BBjString p_controlName$) - method in class BBJasper.BBJasperTabbedView

getControl Returns a control given the control name


getControl(BBjString p_controlName$) - method in class BBJasper.BBJasperView

getControl Returns a view control given the control name


getControlKey() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns whether the user's control key was pressed when the event occurred.


getControlType() - method in class QVGrid.QVGrid

Returns the control type of the grid control Note: For a listing of control type constants, see Constants in BBjControl.


getControlType() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the unique control type for the BBjCalendarWidget, which is 65050.


getControlType() - method in class BBjGridExWidget.BBjGridExWidget

Get the unique control type


getCookies(BBjString p_cookieKey$) - method in class DemoUtils.DemoUtils

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() - method in class Email.EmailDialog

getCreateContactsOnSend Returns whether contacts should be created for new email addresses on a send


getCreated() - method in class gappsv3.GEvent

Gets the creation time of the event.


getCreator() - method in class gappsv3.GEvent

Gets the creator of the event.


getCSVExporter() - method in class BBJasper.BBJasperViewerControl

getCSVExporter Returns the CSV exporter which contains export options


getCurrentEnd() - method in class BBjCalendarWidget.CalendarView

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.


getCurrentStart() - method in class BBjCalendarWidget.CalendarView

Returns the calendar's start date of the interval the view is trying to represent.


getCurrentUpdateLevel(BBjString p_vendor$, BBjString p_application$, BBjString p_version$) - method in class BUS

getCurrentUpdateVersion(BBjString p_vendor$, BBjString p_application$, BBjString p_baseVersion$) - method in class BUS

getDashboard() - method in class Dashboard.DashboardWindow

Returns the encapsualted dashboard


getDashboard() - method in class Dashboard.DashboardControl

Returns the encapsualted dashboard


getDashboardCategories() - method in class Dashboard.Dashboard

Returns the categories of the dashboard


getDashboardCategory(BBjString p_categoryName$) - method in class Dashboard.Dashboard

Returns a category of the dashboard, give a category name


getDashboardCategory() - method in class Dashboard.DashboardCategoryControl

Returns the encapuslated dashboard category used in the dashboard category control


getDashboardCategoryControl(BBjString p_categoryName$) - method in class Dashboard.DashboardControl

Returns a dashboard category control given its unique name


getDashboardCategoryControl() - method in class Dashboard.DashboardWidgetControl

Returns the dashboard category control that the dashboard widget control is housed in


getDashboardCategoryWindow() - method in class Dashboard.DashboardCategoryControl

Returns the window of the dashboard category control


getDashboardControl() - method in class Dashboard.DashboardWindow

Returns the encapsualted dashboard control


getDashboardControl() - method in class Dashboard.DashboardCategoryControl

Returns the dashboard control that this dashboard category control is a part of


getDashboardControlWindow() - method in class Dashboard.DashboardControl

Returns the window of the dashboard control


getDashboardWidget(BBjString p_widgetName$) - method in class Dashboard.DashboardCategory

Returns a dashboard widget given its name


getDashboardWidget() - method in class Dashboard.WidgetControl

Returns the encapuslated dashboard widget used in the widget control


getDashboardWidget() - method in class Dashboard.DashboardWidgetEvent

Returns the DashboardWidget that is associated with the event


getDashboardWidgetControl(BBjString p_widgetName$) - method in class Dashboard.DashboardCategoryControl

Returns a dashboard widget control


getDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the dashboard widget controls in the dashboard category control


getDashboardWidgetFilterLeft() - method in class Dashboard.DashboardWidget

Returns the left dashboard widget filter


getDashboardWidgetFilterRight() - method in class Dashboard.DashboardWidget

Returns the right dashboard widget filter


getDashboardWidgetLinkLeft() - method in class Dashboard.DashboardWidget

Returns the left dashboard widget link


getDashboardWidgetLinkRight() - method in class Dashboard.DashboardWidget

Returns the right dashboard widget link


getDashboardWidgetMenu(BBjNumber p_triggerType) - method in class Dashboard.DashboardWidget

Returns the custom popup menu associated with the dashboard widget given the menu trigger type


getDashboardWidgetPosition(DashboardWidget p_dashboardWidget!) - method in class Dashboard.DashboardCategory

Returns the position of a dashboard widget


getDashboardWidgets() - method in class Dashboard.DashboardCategory

Returns the dashboard widgets in a BBjVector


getDashboardWindow() - method in class Dashboard.DashboardControl

Returns the dashboard window that houses the dashboard control


getData() - method in class GxClientModels.GxClientRowModel

Alias for getAsJsonObject()


getDatabaseName() - method in class BBJasper.DatabaseType

getDatabaseName Returns the database name


getDataset() - method in class Dashboard.ChartWidget

getDataset() - method in class Dashboard.PieChartWidget

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


getDataset() - method in class Dashboard.BarChartWidget

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


getDataset() - method in class Dashboard.LineChartWidget

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


getDataset() - method in class Dashboard.XYChartWidget

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


getDataset(BBjNumber datsetNumber) - method in class BBjBUIDialChart.BBjBUIDialChart

getDate() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the calendar's currently selected date.


getDate() - method in class BBjCalendarWidget.CalendarDateClickEvent

Returns the calendar's date (day/time) that was clicked.


getDateAsISOString() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the calendar's currently selected date in ISO format.


getDateString() - method in class BBjCalendarWidget.CalendarDateClickEvent

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.


getDBAdminPassword(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBEncryptKey(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBHost(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBPassword(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBPath(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBPort(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDBUser(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getDecimalFromHex(BBjString p_hexValue$) - method in class BBXImage.BBXImage

Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255


getDecimalFromHex(BBjString p_hexValue$) - method in class Colors.Colors

Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255


getDefaultChartColors() - method in class Dashboard.ChartWidget

Gets the default colors for a chart


getDefaultColSpacing() - method in class Dashboard.DashboardCategory

Returns the default col spacing between widgets


getDefaultColumnWidth() - method in class QVGrid.QVGrid

Returns the default column width


getDefaultDatesMask() - method in class GxColumns.GxDefaultColumnDefinition

getDefaultFilePrefix() - method in class BBJasper.BBJasperReport

getDefaultFilePrefix returns the default file prefix for temporary files like email attachements


getDefaultGridStyle() - method in class QVGrid.QVGrid

Returns the default style of cells in the grid


getDefaultMaxWidgetWidth() - method in class Dashboard.DashboardCategory

Returns the default maximum widget width


getDefaultMinWidgetWidth() - method in class Dashboard.DashboardCategory

Returns the default minimum widget width


getDefaultNumbersMask() - method in class GxColumns.GxDefaultColumnDefinition

getDefaultRowSpacing() - method in class Dashboard.DashboardCategory

Returns the default row spacing between widgets


getDefaultSave() - method in class BBJasper.BBJasperViewerControl

getDefaultSave Returns the default save location


getDefaultStringsMask() - method in class GxColumns.GxDefaultColumnDefinition

getDefaultTimedEntryDuration() - method in class BBjCalendarWidget.CalendarOptions

Returns the fallback duration for timed entries that do not have a specified end time.


getDefaultTimesMask() - method in class GxColumns.GxDefaultColumnDefinition

getDefaultTimestampsMask() - method in class GxColumns.GxDefaultColumnDefinition

getDefaultTranslations() - method in class BBTranslator.BBTranslationBundle

getDeletedEvents() - method in class gappsv3.GCalendar

Gets deleted events


getDeletedEvents() - method in class gappsv3.GEvents

getDelta() - method in class BBjCalendarWidget.CalendarEntryDropEvent

Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's date/time was moved by.


getDeltaColumnMode() - method in class GxOptions.GxOptions

Get DeltaColumn Mode value


getDescription() - method in class BBXImage.BBXImage

Method to get the description of the BBXImage


getDescription() - method in class gappsv3.GCalendar

Description of the calendar.


getDescription() - method in class gappsv3.GEvent

Gets the event's description.


getDescription() - method in class BBJasper.BBJasperExporterParameter

getDescription() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's extended information that can be used to further describe the entry beyond the title text.


getDescription() - method in class BBjCalendarWidget.CalendarEntrySource

Returns a source's extended information that can be used to further describe the source.


getDevicePixelRatio() - method in class Dashboard.BBjWidget

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.


getDevicePixelRatio() - method in class Dashboard.ChartWidget

Gets the screen's device pixel ratio used for modifying ChartWidgets


getDirectory() - method in class BBTranslator.BBTranslationBundle

getDisplay() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's display style.


getDisplay() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's display style.


getDisplayName() - method in class GPermission

getDisplayName() - method in class gappsv3.GEventAttendee

The attendee's name, if available.


getDoc(BBjString id$) - method in class GDocsResultSet

getDocList(BBjString criteria$, BBjNumber maxResults) - method in class GDocsService

https://developers.google.com/drive/web/search-parameters


getDocument(BBjString p_resourceID$) - method in class GDocsService

getDocument(BBjString p_title$, BBjString p_mimeType$, BBjString p_folder$, BBjNumber p_createIfNeeded) - method in class GDocsService

getDocument(BBjString p_title$, BBjString p_type$, BBjString p_mimeType$, BBjString p_folder$, BBjNumber p_createIfNeeded) - method in class GDocsService

getDocument() - method in class BBXMLDoc

getDocumentTypeName() - method in class GDocSaveDialog

getDOCXExporter() - method in class BBJasper.BBJasperViewerControl

getDOCXExporter Returns the DOCX exporter which contains export options


getDomain() - method in class GPermission

getDraft() - method in class BBJasper.BBJasperPrintQuality

getDraft Creates and returns a print quality object that contains draft quality information


getDragAccept() - method in class QVGrid.QVGrid

Returns whether the grid accepts drag and drop operations


getDragActions() - method in class QVGrid.QVGrid

Returns the actions that are currently available when dragging from the grid control


getDragEnabled() - method in class QVGrid.QVGrid

Returns whether the grid control should allow drag operations


getDragType(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the drag type that was set for a particular cell in a previous call to setDragType()


getDragType(BBjNumber column) - method in class QVGrid.QVGrid

Returns the drag type that was set for a particular column in a previous call to setDragType()


getDragType() - method in class QVGrid.QVGrid

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


getDropActions() - method in class QVGrid.QVGrid

Returns the actions that are currently available when dropping to the grid control. Returns ACTION_NONE if the control is disabled or non-editable.


getDropTypes(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns the drop types that were set for a particular cell in a previous call to setDropTypes()


getDropTypes(BBjNumber column) - method in class QVGrid.QVGrid

Returns the drop types that were set for a particular column in a previous call to setDropTypes()


getDropTypes() - method in class QVGrid.QVGrid

Returns the drop types that were set in a previous call to setDropTypes()


getDuplex() - method in class BBJasper.BBJasperPrintSides

getDuplex Creates and returns a print sides object that contains duplex sides information


getEditClickCount() - method in class QVGrid.QVGrid

Returns the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.


getEditText() - method in class QVGrid.QVGrid

Returns the current edit text associated with the grid Note: The QVGrid is not editable, so this method has no meaning


getElements(JRElementGroup group!) - method in class BBJasper.BBJasperDesign

getElements Returns all the design elements in the passed element group


getEmail() - method in class gappsv3.GEventAttendee

The attendee's email address, if available. This field must be present when adding an attendee.


getEmailAddress() - method in class GPermission

getEmailAddresses(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailAttachments() - method in class Email.EmailDialog

getEmailAttachments Returns the file names of the email attachments


getEmailCC(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailContacts() - method in class Email.EmailDialog

getEmailContacts Returns the email contacts


getEmailDialog() - method in class BBJasper.BBJasperViewerControl

getEmailDialog Returns the EmailDialog object so that it can be customized


getEmailDialog() - method in class BBJasper.BBJasperView

getEmailDialog Returns the EmailDialog object so that it can be customized


getEmailFirstName(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_emailAddress$) - method in class BUS

getEmailFrom(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailFrom() - method in class Email.EmailDialog

getEmailFrom Returns the email from address


getEmailHeaderType(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailHeaderValue(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailHost(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailLastName(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_emailAddress$) - method in class BUS

getEmailMessage() - method in class Email.EmailDialog

getEmailMessage Returns the email message


getEmailPassword(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailPort(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailProtocol(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailReplyTo(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailServerHost() - method in class Email.EmailDialog

getEmailServerHost Returns the email server host name


getEmailServerPassword() - method in class Email.EmailDialog

getEmailServerPassword Returns the email server password


getEmailServerPort() - method in class Email.EmailDialog

getEmailServerPort Returns the email server port


getEmailServerSSL() - method in class Email.EmailDialog

getEmailServerSSL Returns the email server SSL


getEmailServerUserName() - method in class Email.EmailDialog

getEmailServerUserName Returns the email server user name


getEmailSubject(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailSubject() - method in class Email.EmailDialog

getEmailSubject Returns the email subject


getEmailText(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmailUser(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getEmbeddedCode() - method in class BuildItem

getEmbeddedWidgetControl() - method in class Dashboard.EmbeddedWidgetWindow

Returns the encapsulated EmbeddedWidgetControl


getEmbeddedWidgetSetControl() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the encapsulated EmbeddedWidgetSetControl


getEnableDayHeaders() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the day headers should appear for the Month, TimeGrid, and DayGrid views (1) or not (0).


getEnableDebug() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns whether the BBjCalendarWidget should run in debug mode (1) or not (0).


getEnableDurationEditable() - method in class BBjCalendarWidget.CalendarEntry

Returns the entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).


getEnableDurationEditable() - method in class BBjCalendarWidget.CalendarEntrySource

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).


getEnableEditable() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the user can modify entries on the calendar (1) or not (0).


getEnableEditable() - method in class BBjCalendarWidget.CalendarEntry

Returns the entry's editable status that determines if the entry can be modified by the user.


getEnableEditable() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry editable status that determines if the entry can be modified by the user.


getEnableEntryDurationEditable() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the user can modify entry durations on the calendar (1) or not (0).


getEnableEntryOverlap() - method in class BBjCalendarWidget.CalendarOptions

Returns whether entries being dragged and resized are allowed to overlap one other (1) or not (0).


getEnableEntryOverlap() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's overlap status that determines if the entries may be dragged/resized over one another.


getEnableEntryResizableFromStart() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the user can resize an entry from its starting edge (1) or not (0).


getEnableEntryStartEditable() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the user can modify event start times through dragging (1) or not (0).


getEnableExpandRows() - method in class BBjCalendarWidget.CalendarOptions

Returns whether a calendar view's rows will expand to fit the available height (1) or not (0).


getEnableFixedWeekCount() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the calendar will always show 6 weeks in month view (1) or not (0).


getEnableNavLinks() - method in class BBjCalendarWidget.CalendarOptions

Returns whether day and week names are clickable (1) or not (0), causing the associated view to be loaded on click.


getEnableNowIndicator() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the calendar will display a marker indicating the current time (1) or not (0).


getEnableOverlap() - method in class BBjCalendarWidget.CalendarEntrySource

Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).


getEnableSelectable() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the user can highlight multiple days or timeslots by clicking and dragging (1) or not (0).


getEnableShowNonCurrentDates() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the previous or next month's dates should display in the calendar's month view (1) or not (0).


getEnableSlotEntryOverlap() - method in class BBjCalendarWidget.CalendarOptions

Returns whether entries should visually overlap one another (1) or not (0).


getEnableStartEditable() - method in class BBjCalendarWidget.CalendarEntry

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).


getEnableStartEditable() - method in class BBjCalendarWidget.CalendarEntrySource

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).


getEnableUnselectAuto() - method in class BBjCalendarWidget.CalendarOptions

Returns whether clicking elsewhere on calendar/window causes the current selection to be cleared (1) or not (0).


getEnableWeekends() - method in class BBjCalendarWidget.CalendarOptions

Returns whether the calendar views include Saturday/Sunday columns (1) or not (0).


getEnableWeekNumbers() - method in class BBjCalendarWidget.CalendarOptions

Returns whether week numbers should be displayed on the calendar (1) or not (0).


getEnd() - method in class gappsv3.GEvent

Gets the ending time or date for an event


getEnd() - method in class BBjCalendarWidget.CalendarSelectEvent

Returns the calendar's ending date of the selection, which may include timezone information and is exclusive.


getEnd() - method in class BBjCalendarWidget.CalendarDatesSetEvent

Returns the calendar's ending date for the current range.


getEnd() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's exclusive ending date/time.


getEndDelta() - method in class BBjCalendarWidget.CalendarEntryResizeEvent

Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's end date was moved by.


getEndStr() - method in class BBjCalendarWidget.CalendarDatesSetEvent

Returns the calendar's ending date in ISO 8601 format for the current range.


getEndString() - method in class BBjCalendarWidget.CalendarSelectEvent

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.


getEndTimeUnspecified() - method in class gappsv3.GEvent

Gets whether the end time for the event is unspecified.


getEntries() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.


getEntries() - method in class BBjCalendarWidget.CalendarEntriesSetEvent

Returns the calendar's entries as a BBjVector filled with CalendarEntry objects.


getEntriesAsJsonArray() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns all of the calendar's entries as a JsonArray of JsonObject events.


getEntriesFetched() - method in class BBjCalendarWidget.CalendarEntrySourceSuccessEvent

Returns a BBjVector filled with CalendarEntry objects for all the fetched entries.


getEntriesWithTag(BBjString tag!) - method in class BBjCalendarWidget.BBjCalendarWidget

Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.


getEntriesWithTags(BBjVector tags!) - method in class BBjCalendarWidget.BBjCalendarWidget

Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.


getEntryBackgroundColor() - method in class BBjCalendarWidget.CalendarOptions

Returns the background color for all calendar entries.


getEntryBorderColor() - method in class BBjCalendarWidget.CalendarOptions

Returns the border color for all calendar entries.


getEntryColor() - method in class BBjCalendarWidget.CalendarOptions

Returns the background and border color for all calendar entries.


getEntryDisplay() - method in class BBjCalendarWidget.CalendarOptions

Returns the display setting parameter for the calendar entries.


getEntrySourceIds() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns a BBjVector filled with IDs for all the CalendarEntrySource objects that have previously been added to the calendar via the addEntrySource() method.


getEntryTextColor() - method in class BBjCalendarWidget.CalendarOptions

Returns the text color for all calendar entries.


getEnvelope() - method in class BBJasper.BBJasperPrintMediaTray

getEnvelope Creates and returns a print media tray object that contains envelope tray information


getErrorMessage() - method in class BBjCalendarWidget.CalendarEntrySourceFailureEvent

Returns a the error message associate with the fetching failure.


getEtag() - method in class gappsv3.GCalendar

ETag for the calendar. ETags are used in caching to determine whether a resource has changed.


getEtag() - method in class gappsv3.GEvent

ETag for the event. ETags are used in caching to determine whether a resource has changed.


getEvent() - method in class DialogWizard.Event

Method getEvent: Get event id


getEventDateTime(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!) - method in class gappsv3.GUtil

Create a Google EventDateTime object by specifying 6 numbers for Year, Month, Day, Hour, Minute, and Second.


getEventDateTime(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!, BBjString timezone!) - method in class gappsv3.GUtil

Create a Google EventDateTime object by specifying 6 numbers for Year, Month, Day, Hour, Minute, and Second.


getEventDateTime(java.util.Date date!) - method in class gappsv3.GUtil

Create a Timed Google EventDateTime object using a java.util.Date


getEventDateTime(java.util.Date date!, BBjString timezone!) - method in class gappsv3.GUtil

Create a Timed Google EventDateTime object using a java.util.Date


getEventDescription(BBjNumber eventNumber!) - method in class BBjCalendarWidget.BBjCalendarWidget

A utility method that returns a descriptive string given an event number based on the CalendarAPI.ON_CALENDAR_* callback constants.


getEventItems() - method in class gappsv3.GEvents

getEventName() - method in class DialogWizard.Event

Method getEventName: Get event name (e.g. "ON_BUTTON_PUSH")


getEventNumber() - method in class BBjCalendarWidget.CalendarEvent

Returns the event number that corresponds to one of the CalendarAPI.ON_CALENDAR_* callback constants.


getEvents() - method in class DialogWizard.Control

Method getEvents: Get allowed events for control


getEvents() - method in class gappsv3.GCalendar

Get all events (like scheduled appointments) associated with this calendar.


getEvents(DateTime timeMin!, DateTime timeMax!) - method in class gappsv3.GCalendar

Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.


getEvents(java.util.Date timeMin!, java.util.Date timeMax!) - method in class gappsv3.GCalendar

Get all events (like scheduled appointments) associated with this calendar that fall in between the specified date range.


getEvents(BBjString retrieveToken!) - method in class gappsv3.GCalendar

Get all events (like scheduled appointments) associated with this calendar using a token that represents a datetime when events were last retrieved.


getExtendedProperties() - method in class gappsv3.GEvent

ExtendedProperties for the event.


getExtendedProperties() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's custom key/value string pairs that define the entry's custom properties


getExtendedPropertyValue(BBjString key!) - method in class BBjCalendarWidget.CalendarEntry

Returns the value of the provided extended property if the key exists in the entry's HashMap of extended properties.


getFileBaseName(BBjString p_source$) - method in class DemoUtils.DemoUtils

Method to return a file's base name by stripping its extension. If the file


getFileBytes(BBjString p_source$) - method in class DemoUtils.DemoUtils

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.


getFileContents(BBjString p_source$) - method in class DemoUtils.DemoUtils

Method to get a file's contents in a BBjString variable - Note that this method reads in a maximum of 10 megabytes.


getFileExtension() - method in class GDoc

getFileExtension(BBjString p_source$) - method in class DemoUtils.DemoUtils

Method to get a file's extension


getFileNameFromFullPath(BBjString p_source$) - method in class DemoUtils.DemoUtils

Method to get a file's name from a fully-qualified path by stripping all the directories


getFileNameWithoutExtensionFromFullPath(BBjString p_source$) - method in class DemoUtils.DemoUtils

Method to get a file's name without extension from a fully-qualified path by stripping all the directories, dot, and extension


getFilePathWithEndSeparator(BBjString p_source$) - method in class DemoUtils.DemoUtils

getFilePathWithoutEndSeparator(BBjString p_source$) - method in class DemoUtils.DemoUtils

getFillError() - method in class Dashboard.BaseWidget

Gets the number of the last error that occurred when filling the widget. A return value of 0 indicates that no fill error occurred.


getFillErrorDesc() - method in class Dashboard.BaseWidget

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.


getFilter(JsonObject json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter conditions (single or combined) and return a filter model


getFilter(BBjString json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter conditions (single or combined) and return a filter model


getFilter(JsonObject json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter conditions (single or combined) and return a filter model


getFilter(BBjString json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter conditions (single or combined) and return a filter model


getFilterAsCombinedModel(BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

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


getFilterCondition(JsonObject json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter condition and return a filter model


getFilterCondition(JsonObject json!, BBjString column!) - method in class BBjGridExWidget.GxClientJsonFactory

Parse a filter condition and return a filter model


getFilterControl() - method in class Dashboard.DashboardWidgetFilterSelectEvent

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.


getFilterKey(BBjString p_filterValue$) - method in class Dashboard.DashboardWidgetFilter

Returns the filter key for a specified filter value


getFilterKey() - method in class Dashboard.DashboardWidgetFilterSelectEvent

Returns the key of a dashboard widget filter select event


getFilterModel(BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

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


getFilterName() - method in class Dashboard.DashboardWidgetFilterSelectEvent

Returns the name of a dashboard widget filter select event


getFilterName() - method in class GxFilters.GxFilterInterface

A constant which holds the client filter real name


getFilterName() - method in class GxFilters.GxFilterText
{@inheritDoc}

getFilterName() - method in class GxFilters.GxFilterNumber
{@inheritDoc}

getFilterName() - method in class GxFilters.GxFilterDate
{@inheritDoc}

getFilterName() - method in class GxFilters.GxFilterSetFilter
{@inheritDoc}

getFilterName() - method in class GxFilters.GxFilterBasicBoolean

@override


getFilterName() - method in class GxFilters.GxFilterBasicDateTime

A constant which holds the client filter real name


getFilterType() - method in class Dashboard.DashboardWidgetFilterSelectEvent

Returns the filter type of a dashboard widget filter select event


getFilterValue(BBjString p_filterKey$) - method in class Dashboard.DashboardWidgetFilter

Returns the filter value for a specified filter key


getFilterValue() - method in class Dashboard.DashboardWidgetFilterSelectEvent

Returns the value of a dashboard widget filter select event


getFindMatches() - method in class BBJasper.BBJasperView

getFindResults() - method in class BBJasper.BBJasperView

getFindText() - method in class BBJasper.BBJasperView

getFirstDay() - method in class BBjCalendarWidget.CalendarOptions

Returns the day on which each week begins where the value is a 0-based number starting with Sunday.


getFitType() - method in class Dashboard.JasperViewerWidget

getFitType Returns the FitType for the report (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)


getFitType() - method in class BBJasper.BBJasperViewerControl

getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)


getFitType() - method in class BBJasper.BBJasperTabbedView

getFitType Returns the fit type of the tabbed view (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)


getFitType() - method in class BBJasper.BBJasperView

getFitType Returns the FitType (FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE)


getFolder(BBjString id$) - method in class GDocsService

getFolderPath(BBjNumber nodeID) - method in class GDocSelectionDialog

getFolderPathForDisplay(BBjNumber nodeID) - method in class GDocSelectionDialog

getFont(BBjFont p_font!) - method in class Dashboard.ChartWidget

Create a java font from a BBjFont


getFont() - method in class QVGrid.QVGrid

Returns the font of the grid control


getFont(BBjFont p_font!) - method in class BBjBUIDialChart.BBjBUIDialChart

getFontScalingFactor() - method in class Dashboard.ChartWidget

Gets the custom font scaling factor for the chart as set by the original dashboard program.


getFooterToolbar() - method in class BBjCalendarWidget.CalendarOptions

Returns the header or footer toolbar that's displayed on the calendar.


getForeColor() - method in class QVGrid.QVGrid

Returns the foreground (text) color of the grid control


getForegroundColor() - method in class gappsv3.GCalendar

Get foreground color.


getFormattedName(BBjString p_name!) - method in class WidgetWizard

getFormattedValue(BBjNumber p_value!) - method in class Dashboard.PieChartWidget

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.


getFriendlyName() - method in class DialogWizard.Control

Method getFriendlyName: Get control translateable "friendly" name


getFriendlyName() - method in class DialogWizard.Event

Method getFriendlyName: Get (translateable) "friendly" event name (e.g. "Button Push")


getGadget() - method in class gappsv3.GEvent

Gets the Gadget for the event.


getGDocSaveDialog() - method in class BBJasper.BBJasperViewerControl

getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized


getGDocSaveDialog() - method in class BBJasper.BBJasperView

getGDocSaveDialog Returns the GDocSaveDialog object so that it can be customized


getGDocsService() - method in class GDocSelectionDialog

getGoogleCalendarApiKey() - method in class BBjCalendarWidget.CalendarOptions

Returns the API key that is used to access public Goolge Calendars programmatically.


getGoogleSaveDocument() - method in class BBJasper.BBJasperView

getGoogleSaveDocument Returns the Google save document


getGrid() - method in class Dashboard.GridExWidget

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)


getGrid() - method in class Dashboard.GridWidgetEvent

Gets the GridWidget's BBjGrid


getGrid() - method in class QVGrid.QVGrid

Returns the underlying BBjStandardGrid object


getGridWidget() - method in class Dashboard.GridWidgetEvent

Gets the GridWidget that the event is for


getGroupId() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.


getGroups() - method in class BBJasper.BBJasperDesign

getGroups Returns the groups


getGuestsCanInviteOthers() - method in class gappsv3.GEvent

Gets whether participants can invite other participants to the event.


getGuestsCanModify() - method in class gappsv3.GEvent

Gets whether participants can modify the event.


getGuestsCanSeeOtherGuests() - method in class gappsv3.GEvent

Gets whether participants can see what other participants are invited to the meeting.


getHangoutLink() - method in class gappsv3.GEvent

Gets the hangout link associated with the meeting.


getHasColumnHeader() - method in class QVGrid.QVGrid

Returns whether the grid has a column header


getHasRowHeader() - method in class QVGrid.QVGrid

Returns whether the grid has a row header


getHasToolBar() - method in class Dashboard.JasperViewerWidget

Returns whether the widget is using a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar


getHeaderGroupTooltip() - method in class GxColumns.GxDefaultColumnGroup

Get the tooltip for the column group header


getHeaders() - method in class BBWebClient.BBWebResponse

Retrieves an array of headers from the response. These headers could be information like content type, cookies, authorization tokens, etc.


getHeaderSelection() - method in class QVGrid.QVGrid

Returns whether header selection is active


getHeaderToolbar() - method in class BBjCalendarWidget.CalendarOptions

Returns the header or footer toolbar that's displayed on the calendar.


getHeight() - method in class BBXImage.BBXImage

Method to get the height of the BBXImage


getHeight() - method in class Dashboard.WidgetControl

Returns the height of the widget control


getHeight() - method in class Dashboard.EmbeddedWidgetWindow

Returns the height of the EmbeddedWidgetWindow


getHeight() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the height of the EmbeddedWidgetSetWindow


getHeight() - method in class Dashboard.ExportDataDialog

getHeight Returns the height of the dialog


getHeight() - method in class Email.EmailDialog

getHeight Returns the height of the dialog


getHeight() - method in class QVGrid.QVGrid

Returns the height of the QVGrid component child window


getHeight() - method in class BBJasper.BBJasperViewerControl

getHeight Returns the height of the viewer control


getHeight() - method in class BBJasper.BBJasperTabbedView

getHeight Returns the height of the tabbed view


getHeight() - method in class BBJasper.BBJasperView

getHeight Returns the height of the viewer control


getHeight() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's height.


getHeight() - method in class BBjCalendarWidget.CalendarOptions

Returns the height setting parameter for the calendar.


getHexFromDecimal(BBjNumber p_decimalValue) - method in class Colors.Colors

Method to convert a decimal number to a hexadecimal number


getHexStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to get a hexadecimal color from a BBjColor


getHexStringFromColor(Color p_color!) - method in class BBXImage.BBXImage

Method to get a hex representation of a Java Color with an alpha channel


getHexStringFromColor(Color p_color!) - method in class Dashboard.ChartWidget

Method to get a hex representation of a Java Color with an alpha channel


getHexStringFromFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a hexadecimal color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values


getHexStringFromFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

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


getHexStringFromFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a hexadecimal color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values


getHexStringFromFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

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


getHexStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to get a hex representation of a Java Color


getHidden() - method in class gappsv3.GCalendar

Returns whether calendar is suppressed from displaying. User can have several calendars, but only show the desired calendars at any time.


getHiddenDays() - method in class BBjCalendarWidget.CalendarOptions

Returns which days of the week should be hidden in the calendar in a BBjVector containing the day numbers that should be hidden.


getHiddenTags() - method in class BBjCalendarWidget.BBjCalendarWidget

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:

  1. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.
  2. The 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.
  3. The 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() - method in class BBJasper.BBJasperPrintQuality

getHigh Creates and returns a print quality object that contains high quality information


getHighlightMethod() - method in class QVGrid.QVGrid

Returns which selection highlight method is currently being used


getHorizontalCellSpacing() - method in class QVGrid.QVGrid

Returns the amount of horizontal space between the columns


getHorizontalLinesVisible() - method in class QVGrid.QVGrid

Returns whether horizontal lines between the rows are visible


getHorizontalScrollable() - method in class QVGrid.QVGrid

Returns whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid


getHorizontalScrollBarAlways() - method in class QVGrid.QVGrid

Returns whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed


getHref() - method in class GDoc

getHSBAStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to format a BBjColor into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to format a hex color string into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to format individual HSBA values into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSBA values into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to format individual HSLA values into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSLA values into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to format a Java Color into an HSBA string in the format hsba(h, s%, b%, a)


getHSBAValuesFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

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


getHSBAValuesFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

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


getHSBAValuesFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to get a vector of HSBA values from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values


getHSBAValuesFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

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


getHSBAValuesFromJavaColor(Color p_color!) - method in class Colors.Colors

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


getHSBStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to format a BBjColor into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to format a hex color string into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromHSBValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness) - method in class Colors.Colors

Method to format individual HSB values into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromHSBValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSB values into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromHSLValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness) - method in class Colors.Colors

Method to format individual HSL values into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromHSLValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSL values into an HSB string in the format hsb(h, s%, b%)


getHSBStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to format a Java Color into an HSB string in the format hsb(h, s%, b%)


getHSBValuesFromRGBColor(Color p_color!) - method in class Dashboard.ChartWidget

Method to convert a RGB Color to its corresponding HSB (Java) values and return an array containing the 3 HSB values


getHSLAStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to format a BBjColor into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to format a hex color string into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to format individual HSBA values into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSBA values into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to format individual HSLA values into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSLA values into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to format a Java Color into an HSLA string in the format hsla(h, s%, l%, a)


getHSLAValuesFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

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


getHSLAValuesFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

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


getHSLAValuesFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to get a vector of HSLA values from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values


getHSLAValuesFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

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


getHSLAValuesFromJavaColor(Color p_color!) - method in class Colors.Colors

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


getHSLStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to format a BBjColor into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to format a hex color string into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromHSBValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness) - method in class Colors.Colors

Method to format individual HSB values into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromHSBValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSB values into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromHSLValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness) - method in class Colors.Colors

Method to format individual HSL values into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromHSLValues(BBjVector p_values!) - method in class Colors.Colors

Method to format a BBjVector of individual HSL values into an HSL string in the format hsl(h, s%, l%)


getHSLStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to format a Java Color into an HSL string in the format hsl(h, s%, l%)


getHSLValuesFromRGBColor(Color p_color!) - method in class Dashboard.ChartWidget

Method to convert a RGB Color to its corresponding HSL (CSS) values and return an array containing the 3 HSL values


getHtmlElement() - method in class BBjCalendarWidget.CalendarViewChangeEvent

Returns the native HTML element with low-level information such as content, size, and position.


getHtmlElement() - method in class BBjCalendarWidget.CalendarDateClickEvent

Returns the native HTML element with low-level information such as content, size, and position.


getHtmlElement() - method in class BBjCalendarWidget.CalendarEntryEvent

Returns the native HTML element with low-level information such as content, size, and position.


getHTMLExporter() - method in class BBJasper.BBJasperViewerControl

getHTMLExporter Returns the HTML exporter which contains export options


getHtmlLink() - method in class gappsv3.GEvent

Gets the HTML Link for the meeting


getHtmlView() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the underlying BBjHtmlView control that contains the JavaScript FullCalendar.


getHyperlinkPopupMenu() - method in class BBJasper.BBJasperView

getHyperlinkPopupMenu Returns the hyperlink popup menu


getICalUID() - method in class gappsv3.GEvent

Gets the iCalendar User ID for the meeting.


getIconLink() - method in class GDoc

getID() - method in class QVGrid.QVGrid

Returns the control ID of the QVGrid component child window


getID() - method in class BBJasper.BBJasperTabbedView

getID Returns the ID of the tabbed view


getId() - method in class GPermission

getId() - method in class GDoc

getId() - method in class gappsv3.GCalendar

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.


getId() - method in class gappsv3.GEvent

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.


getId() - method in class gappsv3.GEventAttendee

The attendee's Profile ID, if available.


getId() - method in class BBjCalendarWidget.CalendarEntry

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.


getId() - method in class BBjCalendarWidget.CalendarEntrySource

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.


getId() - method in class GxCellEditors.GxCellEditorSuggestion

Get the editor unique id


getId() - method in class GxContextMenu.GxContextMenuItemInterface

Get the menu item ID


getId() - method in class GxContextMenu.GxContextMenuItem

Get the menu item ID


getId() - method in class GxSidebar.GxToolpanelInterface

Get the toolbar unique name


getId() - method in class GxSidebar.GxColumnsToolpanel
{@inheritDoc}

getId() - method in class GxSidebar.GxFiltersToolpanel
{@inheritDoc}

getId() - method in class GxStatusBar.GxStatusBarComponentInterface

Get the component id


getId() - method in class GxStatusBar.GxStatusBarSelectedRowCountComponent
{@inheritDoc}

getId() - method in class GxStatusBar.GxStatusBarFilteredRowCountComponent
{@inheritDoc}

getId() - method in class GxStatusBar.GxStatusBarTotalAndFilteredRowCountComponent
{@inheritDoc}

getId() - method in class GxStatusBar.GxStatusBarTotalRowCountComponent
{@inheritDoc}

getId() - method in class GxStatusBar.GxStatusBarAggregationComponent
{@inheritDoc}

getImage() - method in class BBXImage.BBXImage

Method to get an ImageIcon from the BBXImage


getImage(BBjString p_imageName!) - method in class Dashboard.BaseWidget

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.


getImage(Object p_object!, BBjString p_defaultImagePath!, Object p_widget!) - method in class Dashboard.BaseWidget

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.


getImage() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns a BBjImage screenshot of the BBjCalendarWidget.


getImageData(BBjString filename!) - method in class BBjGridExWidget.BBjGridExWidget

Alias for imageToBase64()


getImageIcon() - method in class BBXImage.BBXImage

Method to get an ImageIcon from the BBXImage


getImageName() - method in class Dashboard.ImageWidget

Returns the image name for the widget.


getImageURL() - method in class Dashboard.ImageWidget

Returns the image URL for the widget.


getImgPathQueryResult(BBjNamespaceEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method getImgPathQueryResult: Namespace event handler for the image path query file chooser


getInactiveDashboardWidgetControlPosition(BBjString p_widgetName$) - method in class Dashboard.DashboardCategoryControl

Returns the current position of an inactive dashboard widget control that is part of the dashboard category control


getInactiveDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the inactive dashboard widget controls in the dashboard category control


getIndentSpaces(BBjNumber p_indent) - method in class BBXMLDoc

getIndex() - method in class GxClientModels.GxClientColumnModel

Get the column index

Returns the index of the column with the specified name.


getIndexOfFileExtension(BBjString p_source$) - method in class DemoUtils.DemoUtils

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.


getInitalLowerCaseName(BBjString p_name!) - method in class WidgetWizard

getInitialDate() - method in class BBjCalendarWidget.CalendarOptions

Returns the initial date that the calendar displays.


getInitialView() - method in class BBjCalendarWidget.CalendarOptions

Returns the calendar's initial view type.


getInputNBeep() - method in class QVGrid.QVGrid

Returns an indication of whether InputN style cells will beep when user enters an invalid character


getInputNCommaCharacter() - method in class QVGrid.QVGrid

Returns the character that InputN style cells will display as their 'thousands' separator


getInputNDotCharacter() - method in class QVGrid.QVGrid

Returns the character that InputN style cells will display as their decimal separator


getInputNUseEditCommas() - method in class QVGrid.QVGrid

Returns an indication of whether InputN style cells will display a character at each 'thousands' position


getInputValueType() - method in class DialogWizard.Control

Method getInputValueType: Get control standard input type


getInsertMode() - method in class QVGrid.QVGrid

Returns whether the editor is in insert mode


getInstance(BBjString p_translationBundleName!) - method in class BBTranslator.BBTranslator

Returns an instance of the BBTranslator given a translation bundle name


getInstance(BBjString p_translationBundleName!, BBjString p_locale!, BBjString p_localeOfOrigin!, BBjString p_translationBundleDir!) - method in class BBTranslator.BBTranslator

Returns an instance of the BBTranslator given a translation bundle name, language, language of origin, and translation bundle directory


getInstance(BBTranslationBundle p_translationBundle!) - method in class BBTranslator.BBTranslator

Returns an instance of the BBTranslator given a translation bundle


getInstance(BBTranslationBundle p_translationBundle!, Locale p_locale!) - method in class BBTranslator.BBTranslator

Returns an instance of the BBTranslator so that there is only one instance per translation bundle and locale


getInstanceCount() - method in class BBjGridExWidget.BBjGridExWidget

Return the number of initiated instances of the grid


getInterspace() - method in class QVGrid.QVGrid

Method getInterspace: Note: This method has been deprecated since BBj 5.0. Use getHorizontalCellSpacing().


getISO_A3() - method in class BBJasper.BBJasperPrintMediaSizeName

getISO_A3 Creates and returns a media sized name object that contains ISO A3 media name information


getISO_A4() - method in class BBJasper.BBJasperPrintMediaSizeName

getISO_A4 Creates and returns a media sized name object that contains ISO A4 media name information


getIsReady() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns a BBjNumber acting as a boolean that indicates whether the widget is ready to be interacted with (1) or not (0).


getJasperDesign() - method in class BBJasper.BBJasperDesign

getJasperDesign Returns the JasperDesign object


getJasperPrint() - method in class BBJasper.BBJasperReport

getJasperPrint Returns the JasperPrint object


getJasperPrint() - method in class BBJasper.BBJasperViewerControl

getJasperPrint Returns the JasperPrint object


getJasperPrint() - method in class BBJasper.BBJasperTabbedView

getJasperPrint Returns the JasperPrint of the tabbed view


getJasperPrint() - method in class BBJasper.BBJasperView

getJasperPrint Returns the JasperPrint object


getJasperReport() - method in class BBJasper.BBJasperReport

getJasperReport Returns the JasperReport object


getJavaColor(BBjColor p_color!) - method in class Dashboard.ChartWidget

Method to create a Java Color from a BBjColor


getJavaColor(BBjString p_colorHexString$) - method in class Dashboard.ChartWidget

Method to create a Java Color from a hex color string


getJavaColorFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to create a Java Color from a BBjColor


getJavaColorFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to create a Java Color from a hex color string


getJavaColorFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

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


getJavaColorFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a Java Color from its corresponding HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values


getJavaColorFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

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


getJavaColorFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to create a Java Color from its corresponding HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values


getJavaDate(EventDateTime dateTime!) - method in class gappsv3.GUtil

Convert a Google EventDateTime object to a java.util.Date


getJavaDateFromDateTime(DateTime dateTime!) - method in class gappsv3.GUtil

getJavaDateFromGoogleDateTime(DateTime datetime!) - method in class gappsv3.GUtil

getJavaFont(BBjFont p_font!) - method in class DemoUtils.DemoUtils

Method to get a Java Font object from a BBjFont object


getJDBCCategoryDataset(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.ChartWidget

Given an SQL query, return a DefaultCategoryDataset filled with the desired data


getJDBCCategoryDataset(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.ChartWidget

Given an SQL query, return a DefaultCategoryDataset filled with the desired data


getJDBCCategoryDataset(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.ChartWidget

Given a BBjRecordSet and a BBjVector containing the columns of interest, return a DefaultCategoryDataset filled with the desired data


getJDBCPieDataset(BBjString p_connectString$, BBjString p_sql$) - method in class Dashboard.ChartWidget

Given an SQL query, return a DefaultPieDataset filled with the desired data


getJDBCPieDataset(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.ChartWidget

Given an SQL query, return a DefaultPieDataset filled with the desired data


getJDBCPieDataset(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.ChartWidget

Given a BBjRecordSet and a BBjVector containing the columns of interest return a DefaultCategoryDataset filled with the desired data


getJFreeChart() - method in class BBjBUIDialChart.BBjBUIDialChart

Method to get the underlying JFreeChart so that it can be further manipulated if desired


getJsEvent() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns the native JavaScript event for the calendar event with low-level information such as click coordinates.


getJsEventAsFormattedString() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the native JavaScript event object.


getJsEventAsString() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns a stringified JsonObject representation of the native JavaScript event.


getJsonArrayAsBBjVector(JsonArray array!) - method in class BBjCalendarWidget.BBjCalendarWidget

A utility method that returns a BBjVector version of the supplied JSON array.


getJsonArrayAsBBjVector(JsonArray array!) - method in class BBjCalendarWidget.CalendarAPI

Returns a BBjVector version of the supplied JSON array.


getJsonCSS(JsonObject p_jsonCSS!, BBjNumber p_fontSize, BBjNumber p_fontWeight) - method in class DemoUtils.DemoUtils

Method to get the CSS properties for a given BBjFont and return a Google JsonObject, typically used when themeing the BBjGridExWidget


getJsonCSSForBBjFont(BBjFont p_font!, BBjString p_altFamilies$) - method in class DemoUtils.DemoUtils

Method to get the CSS properties for a given BBjFont and return a Google JsonObject, typically used when themeing the BBjGridExWidget


getJsonObjectAsFormattedString(JsonObject json!) - method in class BBjCalendarWidget.BBjCalendarWidget

A utility method that returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.


getJsonObjectAsFormattedString(JsonObject json!) - method in class BBjCalendarWidget.CalendarAPI

Returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.


getKeypress(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientKeypressModel


getKeypress(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientKeypressModel


getKeys() - method in class BBTranslator.BBTranslations

Returns a collection translation keys


getKind() - method in class GPermission

getKind() - method in class gappsv3.GCalendar

Specifies the type of Google resource.


getKind() - method in class gappsv3.GEvent

Gets the Google resource kind.


getLandscape() - method in class BBJasper.BBJasperPrintOrientation

getLandscape Creates and returns a print orientation object that contains landscape information


getLanguage() - method in class BBjGridExWidget.GxLanguageManager

Get the selected language


getLanguageKeys() - method in class BBjGridExWidget.GxLanguageManager

Get the language keys

Get the translation keys as JSON string


getLanguageKeys(BBjString language$) - method in class BBjGridExWidget.GxLanguageManager

Get the language keys

Get the translation keys as JSON string


getLanguageManager() - method in class BBjGridExWidget.BBjGridExWidget

Get the language manager instance


getLargeCapacity() - method in class BBJasper.BBJasperPrintMediaTray

getLargeCapacity Creates and returns a print media tray object that contains large capacity tray information


getLastErrorMsg() - method in class Admin

getLastExportDir() - method in class Dashboard.ExportData

getLastExportDir Returns the last export directory used


getLastFieldDelimiter() - method in class Dashboard.ExportData

getLastFieldDelimiter Returns the last field delimiter used


getLastRecordDelimiter() - method in class Dashboard.ExportData

getLastRecordDelimiter Returns the last record delimiter used


getLastSaveAsDefault() - method in class Dashboard.ExportData

getLastSaveAsDefault Returns the last save as default value


getLastTextQualifier() - method in class Dashboard.ExportData

getLastTextQualifier Returns the last text qualifier used


getLaunchDock() - method in class BBLaunchDock

getLeftColumn() - method in class QVGrid.QVGrid

Returns the current visible left-most column


getLegendFontSize() - method in class Dashboard.ChartWidget

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.


getLineColor() - method in class QVGrid.QVGrid

Returns the color of the separator lines


getLocalAdminPassword() - method in class Admin

getLocale() - method in class BBTranslator.BBTranslations

Returns the locale of the translations


getLocale() - method in class BBjCalendarWidget.CalendarOptions

Returns the calendar's locale setting which defaults to null() and can be modified via the setLocale() method.


getLocaleOfOrigin() - method in class BBTranslator.BBTranslationBundle

getLocales() - method in class BBTranslator.BBTranslationBundle

getLocalTimeZoneOffsetFromUtc() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


getLocalTimeZoneOffsetFromUtc() - method in class BBjCalendarWidget.CalendarAPI

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.


getLocation() - method in class gappsv3.GCalendar

Get Calendar's location.


getLocation() - method in class gappsv3.GEvent

Gets a string representing the event location


getLocation() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's extended information that can be used to further describe the entry beyond the title text.


getLocked() - method in class gappsv3.GEvent

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.


getLongCue() - method in class QVGrid.QVGrid

Returns the text that appears in the status bar when the mouse pointer hovers over the grid control


getMain() - method in class BBJasper.BBJasperPrintMediaTray

getLargeCapacity Creates and returns a print media tray object that contains main tray information


getMainGridAlignment() - method in class QVGrid.QVGrid

Returns the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.


getMainGridBackColor() - method in class QVGrid.QVGrid

Returns the default background color of the grid


getMainGridFont() - method in class QVGrid.QVGrid

Returns the default font of the grid


getMainGridForeColor() - method in class QVGrid.QVGrid

Returns the default foreground color of the grid


getMainGridStripeColor() - method in class QVGrid.QVGrid

Returns the background stripe color of the grid


getMainGridVerticalAlignment() - method in class QVGrid.QVGrid

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() - method in class BBJasper.BBJasperPrintMediaTray

getManual Creates and returns a print media tray object that contains manual tray information


getMask() - method in class GxColumns.GxDefaultColumnDefinition

Get the column mask


getMaxColumns() - method in class QVGrid.QVGrid

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.


getMaxRows() - method in class QVGrid.QVGrid

Returns the maximum number of rows allowed in the data set


getMediaSizeName() - method in class BBJasper.BBJasperPrintMediaSizeName

getMediaSizeName Returns the media size name object


getMediaTray() - method in class BBJasper.BBJasperPrintMediaTray

getReverseLandscape Returns the media try object


getMetaData() - method in class GxClientModels.GxClientColumnModel

Get the column type

Returns the metadata of the column.


getMetaKey() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns whether the user's meta key was pressed when the event occurred.


getMiddle() - method in class BBJasper.BBJasperPrintMediaTray

getMiddle Creates and returns a print media tray object that contains middle tray information


getMimeType() - method in class GDoc

getMiniFilter() - method in class GxClientModels.GxClientFilterSetFilterModel

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


getModifiedDate() - method in class GDoc

getMonochrome() - method in class BBJasper.BBJasperPrintChromaticity

getMonochrome Creates and returns a chromaticity object that contains monochrome information


getNA_Ledger() - method in class BBJasper.BBJasperPrintMediaSizeName

getNA_Ledger Creates and returns a media sized name object that contains NA Ledger media name information


getNA_Legal() - method in class BBJasper.BBJasperPrintMediaSizeName

getNA_Legal Creates and returns a media sized name object that contains NA Legal media name information


getNA_Letter() - method in class BBJasper.BBJasperPrintMediaSizeName

getNA_Letter Creates and returns a media sized name object that contains NA Letter media name information


getName() - method in class Dashboard.DashboardItem

Returns the name of dashboard item


getName() - method in class Dashboard.DashboardControl

Returns the name of the widget control


getName() - method in class Dashboard.DashboardCategoryControl

Returns the name of the dashboard category control


getName() - method in class Dashboard.WidgetControl

Returns the name of the widget control


getName() - method in class BuildItem

getName() - method in class WidgetBuildItem

getName() - method in class WidgetSetBuildItem

getName() - method in class WidgetDashboardBuildItem

getName() - method in class GDoc

getName() - method in class QVGrid.QVGrid

Returns the control name of the grid control


getName() - method in class BBJasper.BBJasperExporterParameter

getName() - method in class BBTranslator.BBTranslationBundle

getName() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's name as previously-set via the setName() method.


getName() - method in class GxClientModels.GxClientColumnModel

Get the column name


getNextRetrieveToken() - method in class gappsv3.GEvents

getNode(BBjString p_name$) - method in class BBXMLDoc

getNode(Node p_node!, BBjString p_name$) - method in class BBXMLDoc

getNodeAttribute(Node p_node!, BBjString p_attrKey$) - method in class BBXMLDoc

getNodeCDATA(Node p_node!) - method in class BBXMLDoc

getNodeComment(Node p_node!) - method in class BBXMLDoc

getNodeText(Node p_node!) - method in class BBXMLDoc

getNodeValue(Node p_node!, BBjNumber p_nodeType) - method in class BBXMLDoc

getNoEdge() - method in class QVGrid.QVGrid

Returns whether the grid control has no border


getNormal() - method in class BBJasper.BBJasperPrintQuality

getNormal Creates and returns a print quality object that contains normal quality information


getNumActiveDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the number of active dashboard widget controls in the dashboard category control


getNumberOfEntriesFetched() - method in class BBjCalendarWidget.CalendarEntrySourceSuccessEvent

Returns the number of fetched entries.


getNumCols() - method in class Dashboard.BarChartWidget

Returns the number of columns in the bar chart's dataset


getNumCols() - method in class Dashboard.LineChartWidget

Returns the number of rows in the line chart's dataset


getNumColumns() - method in class Dashboard.GridExWidget

Returns the number of columns in the GridExWidget


getNumColumns() - method in class Dashboard.GridWidget

Returns the number of columns in the GridWidget


getNumColumns() - method in class QVGrid.QVGrid

Returns the number of columns in the grid


getNumDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the number of dashboard widget controls in the dashboard category control


getNumDashboardWidgets() - method in class Dashboard.DashboardCategory

Returns the number of dashboard widgets


getNumInactiveDashboardWidgetControls() - method in class Dashboard.DashboardCategoryControl

Returns the number of inactive dashboard widget controls in the dashboard category control


getNumItems() - method in class Dashboard.XYChartWidget

Gets the number of items in the first series in the chart


getNumItems(BBjNumber p_series) - method in class Dashboard.XYChartWidget

Gets the number of items in the chart for a particular series


getNumPages() - method in class BBJasper.BBJasperReport

Returns the number of pages in the report


getNumPages() - method in class BBJasper.BBJasperView

getNumPages Returns the number of pages in the report


getNumRows() - method in class Dashboard.GridExWidget

Returns the number of rows in the GridExWidget


getNumRows() - method in class Dashboard.GridWidget

Returns the number of rows in the GridWidget


getNumRows() - method in class Dashboard.PieChartWidget

Returns the number of rows in the pie chart's dataset (or slices in the pie)


getNumRows() - method in class Dashboard.BarChartWidget

Returns the number of rows in the bar chart's dataset


getNumRows() - method in class Dashboard.LineChartWidget

Returns the number of rows in the line chart's dataset


getNumRows() - method in class Dashboard.XYChartWidget

Gets the number of series (number of lines) in the chart


getNumRows() - method in class QVGrid.QVGrid

Returns the number of rows in the grid


getNumViews() - method in class BBJasper.BBJasperTabbedView

geNumViews Returns the number of views


getODSExporter() - method in class BBJasper.BBJasperViewerControl

getODSExporter Returns the ODS exporter which contains export options


getODTExporter() - method in class BBJasper.BBJasperViewerControl

getODTExporter Returns the ODT exporter which contains export options


getOldCalendarEntry() - method in class BBjCalendarWidget.CalendarEntryResizeEvent

Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.


getOldCalendarEntry() - method in class BBjCalendarWidget.CalendarEntryDropEvent

Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.


getOldCalendarEntry() - method in class BBjCalendarWidget.CalendarEntryChangeEvent

Returns the old version of the calendar entry, e.g. the entry as it existed before the changes were applied.


getOneSided() - method in class BBJasper.BBJasperPrintSides

getOneSided Creates and returns a print sides object that contains one sided information


getOptional() - method in class gappsv3.GEventAttendee

Whether this is an optional attendee. Optional. The default is False (0).


getOptions() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the calendar's current options in an instance of the CalendarOptions class.


getOptionsAsJsonObject() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the calendar's options as a JsonObject.


getOrganizer() - method in class gappsv3.GEvent

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.


getOrganizer() - method in class gappsv3.GEventAttendee

Whether this attendee is also the organizer. Default is 0.


getOrientation() - method in class BBJasper.BBJasperPrintOrientation

getOrientation Returns the orientation requested object


getOriginalStartTime() - method in class gappsv3.GEvent

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() - method in class BBJasper.BBJasperViewerControl

getPage Return the current page


getPage() - method in class BBJasper.BBJasperView

getPage Returns the current viewed page of the report


GetPageContents() - method in class BBWebClient.BBWebClient

Test method that retrieves the local webserver page at http://localhost:8888/


getPagingAmount() - method in class QVGrid.QVGrid

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(BBjString p_key$) - method in class BBJasper.BBJasperReport

getParam Returns an individual parameter


getParameter(BBjString p_exportParameter$) - method in class BBJasper.BBJasperExporter

getParameter Returns a export parameter value


getParameters() - method in class BBJasper.BBJasperExporter

getParameters Returns export parameter values


getParams() - method in class BBJasper.BBJasperReport

getParams Returns all report parameters


getParent() - method in class BBTranslator.BBTranslations

Returns the parent of the translations


getParents() - method in class GDoc

getParentWindow() - method in class Dashboard.WidgetControl

Returns the widget control's parent window which was specified during the construction of the WidgetControl


getParentWindow() - method in class QVGrid.QVGrid

see BBjControl


getParentWindow() - method in class BBJasper.BBJasperTabbedView

getParentWindow Returns the parent window that houses the tabbed view


getPassword() - method in class GAppsService

getPassword() - method in class GAppsLoginDialog

getPDFExporter() - method in class BBJasper.BBJasperViewerControl

getPDFExporter Returns the PDF exporter which contains export options


getPermission(BBjString p_id$) - method in class GDoc

getPermissions() - method in class GDoc

getPermissionsForFile(BBjString p_fileID$) - method in class GDocsService

getPgmFileFindResult(BBjNamespaceEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method getPgmFileFindResult: Get result of program file find from namespace


getPgmFilePath() - method in class DialogWizard.DialogWizardFrame1

Method getPgmFilePath: Get program file path from input control


getPhotoLink() - method in class GPermission

getPinnedBottomRows() - method in class BBjGridExWidget.BBjGridExWidget

Get the pinned bottom rows as defined in the grid options


getPinnedBottomRowsAsJson() - method in class GxOptions.GxOptions

Get the bottom pinned rows as json String


getPinnedBottomRowsAsJsonArray() - method in class GxOptions.GxOptions

Get the bottom pinned rows as Json Array


getPinnedBottomRowsCount() - method in class BBjGridExWidget.BBjGridExWidget

Get the count of pinned rows on bottom


getPinnedTopRows() - method in class BBjGridExWidget.BBjGridExWidget

Get the pinned top rows as defined in the grid options


getPinnedTopRowsAsJson() - method in class GxOptions.GxOptions

Get the top pinned rows as json String


getPinnedTopRowsAsJsonArray() - method in class GxOptions.GxOptions

Get the top pinned rows as Json Array


getPinnedTopRowsCount() - method in class BBjGridExWidget.BBjGridExWidget

Get the count of pinned rows on top


getPivotMode() - method in class BBjGridExWidget.BBjGridExWidget

Check if pivot mode is enabled or disabled


#Configuration
#API


getPopupMenu() - method in class QVGrid.QVGrid

Retrieves a popup menu from the grid control


getPortait() - method in class BBJasper.BBJasperPrintOrientation

getPortait


getPortrait() - method in class BBJasper.BBJasperPrintOrientation

getPortrait Creates and returns a print orientation object that contains portrait information


getPosition() - method in class BBjCalendarWidget.CalendarToolbar

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() - method in class BBJasper.BBJasperViewerControl

getPPTXExporter Returns the PPTX exporter which contains export options


getPreviewImage() - method in class Dashboard.WidgetControl

Returns the preview image for the widget control that is used for display in the customize dialog


getPrimaryCalendar() - method in class gappsv3.GCalendarAPI

Get the primary calendar. This is the user's default calendar when they navigate to https://www.google.com/calendar


getPrinterName() - method in class BBJasper.BBJasperPrintServiceExporter

getPrinterName Returns the printer name


getPrintQuality() - method in class BBJasper.BBJasperPrintQuality

getChromaticity Returns the print quality object


getPrintRequestAttributeSet() - method in class BBJasper.BBJasperPrintServiceExporter

getPrintRequestAttributeSet Returns the print request attribute set


getPrintServiceExporter() - method in class BBJasper.BBJasperViewerControl

getPrintServiceExporter Returns the PrintService exporter which contains export options


getPrivateCopy() - method in class gappsv3.GEvent

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).


getProperties() - method in class BBTranslator.BBTranslations

Returns the translations properties


getPropertiesFileName(Locale p_locale!) - method in class BBTranslator.BBTranslations

Returns a properties file name


getQuery() - method in class BBJasper.BBJasperDesign

getQuery Returns the SQL query string


getQueryLanguage() - method in class BBJasper.BBJasperDesign

getQueryLanguage Returns the query language string, e.g. "SQL"


getRaisedEdge() - method in class QVGrid.QVGrid

Returns whether the grid control has a raised border


getRangeSelection(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientRangeSelectionModel


getRangeSelection(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientRangeSelectionModel


getRangeSelections() - method in class BBjGridExWidget.BBjGridExWidget

The method will return a vector of the selected ranges including columns and rows


#API


getReasonPhrase() - method in class BBWebClient.BBWebResponse

Text about the status code. Some webservers may give more elaborate error information than the standard status code text.


getRecord() - method in class QVGrid.QVGrid

Retrieves the current record data


getRecordSet() - method in class Dashboard.DataFillableWidget

Returns the RecordSet


getRecordTemplate() - method in class QVGrid.QVGrid

Retrieves the current record template definition


getRecurrence() - method in class gappsv3.GEvent

Returns a vector of strings containing the iCalendar-format
rules for the event recurrence.


getRecurringEventId() - method in class gappsv3.GEvent

For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.


getRefreshToken() - method in class gappsv3.GOAuth2

The authorization refresh token. This is a long term token used to retrieve session tokens.


getRefreshType() - method in class Dashboard.DashboardWidgetRefreshEvent

Returns the type of refresh (a constant defined in the ChartWidget class) based on what initiated the event.


getRegNotificationEmailAddresses(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$) - method in class BUS

getRelatedEntries() - method in class BBjCalendarWidget.CalendarEntryResizeEvent

Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.


getRelatedEntries() - method in class BBjCalendarWidget.CalendarEntryDropEvent

Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.


getRelatedEntries() - method in class BBjCalendarWidget.CalendarEntryModificationEvent

Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.


getRelativeDate(BBjNumber field, BBjNumber amount) - method in class gappsv3.GCalendar

getRemember() - method in class GAppsLoginDialog

getReminders() - method in class gappsv3.GEvent

Gets information about reminders such as email and popup notifications.


getReport() - method in class Dashboard.JasperViewerWidget

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() - method in class BBJasper.BBJasperViewerControl

getReport Returns the BBJasperReport object


getReport() - method in class BBJasper.BBJasperTabbedView

getReport Returns the report of the tabbed view


getReport() - method in class BBJasper.BBJasperView

getReport Returns the BBJasperReport object


getReportChildWindow() - method in class BBJasper.BBJasperView

getReportChildWindow Returns the ReportChildWindow object


getReportDir() - method in class BBJasper.BBJasperReport

getReportDir Returns the report directory


getReportFile() - method in class BBJasper.BBJasperReport

getReportFile Returns the report file


getReportFile() - method in class BBJasper.BBJasperDesign

getReportFile Returns the report file path


getReportName() - method in class BBJasper.BBJasperView

getReportName Returns the report name


getReportName() - method in class BBJasper.BBJasperDesign

getReportName Returns the report name


getReports() - method in class BBJasper.BBJasperViewerControl

getReports Returns a BBjVector containing the BBJasperReport objects


getRequiredPermissions() - method in class Admin

getResFileFindResult(BBjNamespaceEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method getResFileFindResult: Get result of resource file find from namespace


getResolver() - method in class GxCellEditors.GxCellEditorSuggestion

Get the editor resolver instance


getResource() - method in class gappsv3.GEventAttendee

Whether the attendee is a resource. Read-only. The default is False (0)


getResourcePath(String p_id!) - method in class BBJasper.BBJasperHtmlResourceHandler

getResponseStatus() - method in class gappsv3.GEventAttendee

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.


getResultSet() - method in class Dashboard.GridExWidget

Returns the GridExWidget's underlying BASIS Components ResultSet


getResultSet() - method in class Dashboard.PieChartWidget

Returns the pie chart's underlying dataset as a BBjRecordSet


getResultSetFromBBjRS(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.GridExWidget

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


getResultSetFromSQLQuery(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.GridExWidget

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


getResultSetFromVectors(BBjVector p_colHeaderData!, BBjVector p_rowData!) - method in class Dashboard.GridExWidget

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() - method in class BBJasper.BBJasperPrintOrientation

getReverseLandscape Creates and returns a print orientation object that contains reverse landscape information


getReversePortait() - method in class BBJasper.BBJasperPrintOrientation

getReversePortait


getReversePortrait() - method in class BBJasper.BBJasperPrintOrientation

getReversePortrait Creates and returns a print orientation object that contains reverse portrait information


getRGBAStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to get an RGBA representation of a BBjColor


getRGBAStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to get an RGBA representation of a hex color string


getRGBAStringFromHSBAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_brightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to get an RGBA representation from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) discrete values


getRGBAStringFromHSBAValues(BBjVector p_values!) - method in class Colors.Colors

Method to get an RGBA representation from HSBA (Hue 0-360, Saturation 0-1, Brightness 0-1, Alpha 0-1) values in a vector


getRGBAStringFromHSLAValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness, BBjNumber p_alpha) - method in class Colors.Colors

Method to get an RGBA representation from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) discrete values


getRGBAStringFromHSLAValues(BBjVector p_values!) - method in class Colors.Colors

Method to get an RGBA representation from HSLA (Hue 0-360, Saturation 0-1, Lightness 0-1, Alpha 0-1) values in a vector


getRGBAStringFromHSLAValues(BBjString p_colorHexString$) - method in class Colors.Colors

Method to get an RGBA representation of a hex color string


getRGBAStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to get an RGBA representation of a Java Color


getRGBColorFromHSLValues(BBjNumber p_hue, BBjNumber p_saturation, BBjNumber p_lightness) - method in class Dashboard.ChartWidget

Method to create a java RGB Color from its corresponding HSL (CSS) values


getRGBStringFromBBjColor(BBjColor p_color!) - method in class Colors.Colors

Method to get an RGB representation of a BBjColor


getRGBStringFromHexString(BBjString p_colorHexString$) - method in class Colors.Colors

Method to get an RGB representation of a hex color string


getRGBStringFromJavaColor(Color p_color!) - method in class Colors.Colors

Method to get an RGB representation of a Java Color


getRole() - method in class GPermission

getRole(BBjString p_id$) - method in class GDoc

getRootElement() - method in class BBXMLDoc

getRootId() - method in class BBjGridExWidget.BBjGridExWidget

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


getRow(BBjString key!) - method in class BBjGridExWidget.BBjGridExWidget

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!) )


getRow() - method in class GxClientEvents.GxClientEventsContextMenu

Get the cell's row


getRow(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientRowModel


getRow(BBjString json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON string to GxClientRowModel


getRow(JsonObject json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON object to GxClientRowModel


getRow(BBjString json!) - method in class BBjGridExWidget.GxClientJsonFactory

Map a JSON string to GxClientRowModel


getRowAlignment(BBjNumber row) - method in class QVGrid.QVGrid

Returns the horizontal alignment of a row


getRowData() - method in class Dashboard.GridExWidget

Returns the data of the GridWidget in a BBjVector


getRowData() - method in class Dashboard.GridWidget

Returns the data of the GridWidget in a BBjVector


getRowDeselection() _break_ - method in class GxOptions.GxOptions

getRowFont(BBjNumber row) - method in class QVGrid.QVGrid

Returns the default font of a row


getRowGutter() - method in class QVGrid.QVGrid

Returns the number of pixels separating the row header and the main grid area


getRowHeader() - method in class QVGrid.QVGrid

Returns the BBjGridHeader object for this grid


getRowHeaderAlignment() - method in class QVGrid.QVGrid

Returns the default alignment of the row header


getRowHeaderBackColor() - method in class QVGrid.QVGrid

Returns the default background color of the row header


getRowHeaderCellAlignment(BBjNumber row) - method in class QVGrid.QVGrid

Returns the alignment of a row header cell


getRowHeaderCellBackColor(BBjNumber row) - method in class QVGrid.QVGrid

Returns the background color for a row header cell


getRowHeaderCellForeColor(BBjNumber row) - method in class QVGrid.QVGrid

Returns the foreground color of a row header cell


getRowHeaderCellStyle(BBjNumber row) - method in class QVGrid.QVGrid

Returns the style of a row header cell


getRowHeaderCellText(BBjNumber row) - method in class QVGrid.QVGrid

Returns the text displayed in a row header cell


getRowHeaderCellVerticalAlignment(BBjNumber row) - method in class QVGrid.QVGrid

Returns the vertical alignment of the row header cell


getRowHeaderFont() - method in class QVGrid.QVGrid

Returns the default font of the row header


getRowHeaderForeColor() - method in class QVGrid.QVGrid

Returns the default foreground color of the row header


getRowHeaderStyle() - method in class QVGrid.QVGrid

Returns the default style of the row header


getRowHeaderVerticalAlignment() - method in class QVGrid.QVGrid

Returns the vertical alignment of the row header


getRowHeaderWidth() - method in class QVGrid.QVGrid

Returns the width of the row header


getRowHeight(BBjNumber row) - method in class QVGrid.QVGrid

Returns the height of a row in pixels


getRowHeight() - method in class QVGrid.QVGrid

Returns the default height in pixels of the rows


getRowKey(BBjNumber row) - method in class QVGrid.QVGrid

Retrieves the row key for the specified resultset row


getRowModelIndexFromViewIndex(BBjNumber index) - method in class QVGrid.QVGrid

Maps the view index of a row to the model index


getRows(BBjString phase!, BBjString filterExpression!) - method in class BBjGridExWidget.BBjGridExWidget

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


getRows(BBjString phase!, GxExpressionInterface filterExpression!) - method in class BBjGridExWidget.BBjGridExWidget

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


getRows(BBjString phase!) - method in class BBjGridExWidget.BBjGridExWidget

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


getRows() - method in class BBjGridExWidget.BBjGridExWidget

Get the rows from grid after sorting and filtering


getRowStyleNames(BBjNumber row) - method in class QVGrid.QVGrid

Returns a vector of style names that have been added to a row


getRowVerticalAlignment(BBjNumber row) - method in class QVGrid.QVGrid

Returns the default vertical alignment for a row


getRowViewIndexFromModelIndex(BBjNumber index) - method in class QVGrid.QVGrid

Maps the model index of a row to the view index


getRTFExporter() - method in class BBJasper.BBJasperViewerControl

getRTFExporter Returns the RTF exporter which contains export options


getSaveFile() - method in class BBJasper.BBJasperView

getSaveFile Returns the save file


getSavePopupMenu() - method in class BBJasper.BBJasperViewerControl

geSavePopupMenu Returns the save popup menu


getScope(BBjString p_id$) - method in class GDoc

getScreenImage() - method in class ScreenCapture.ScreenCapture

Method getScreenImage: Capture an image of the entire screen


getScreenPixelRatio() - method in class DemoUtils.DemoUtils

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


getScreenPixelRatio(BBjWindow p_window!) - method in class DemoUtils.DemoUtils

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


getScreenX() - method in class Dashboard.WidgetControl

Returns the X location of the widget control on the screen


getScreenX() - method in class QVGrid.QVGrid

Returns the X coordinate of the the QVGrid component child window on the screen


getScreenX() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

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.


getScreenY() - method in class Dashboard.WidgetControl

Returns the Y location of the widget control on the screen


getScreenY() - method in class QVGrid.QVGrid

Returns the Y coordinate of the the QVGrid component child window on the screen


getScreenY() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns the Y-coordinate of the user's mouse relative to the screen.


getScrollOutside() - method in class QVGrid.QVGrid

Returns whether the grid will scroll when the mouse cursor is moved outside the bounds of the grid during a drag and drop operation


getScrollUpdate() - method in class QVGrid.QVGrid

Returns whether the grid updates the display of data in the cells while being scrolled


getScrollWheelBehavior() - method in class QVGrid.QVGrid

Returns a constant indicating under what situations the grid control will respond to the mouse scroll wheel


getSelectedColumn() - method in class Dashboard.GridWidget

Returns the currently selected column in the GridWidget


getSelectedColumn() - method in class QVGrid.QVGrid

Returns the currently selected column


getSelectedColumns() - method in class QVGrid.QVGrid

Returns a BBjVector containing selected columns


getSelectedDoc() - method in class GDocSelectionDialog

getSelectedDocs() - method in class GDocSelectionDialog

getSelectedFile() - method in class FileChooser

getSelectedFiles() - method in class FileChooser

getSelectedFilter() - method in class GDocSelectionDialog

getSelectedFolder() - method in class GDocSelectionDialog

getSelectedFont() - method in class FontChooser

getSelectedRow() - method in class Dashboard.GridWidget

Returns the currently selected row in the GridWidget


getSelectedRow() - method in class QVGrid.QVGrid

Returns the currently selected row


getSelectedRow() - method in class BBjGridExWidget.BBjGridExWidget

Get the current selected row


#API


getSelectedRowCount() - method in class GxClientEvents.GxClientEventsRowSelection

Get the number of affected rows by the last event


getSelectedRows() - method in class QVGrid.QVGrid

Returns a vector containing the selected rows in a grid


getSelectedRows() - method in class BBjGridExWidget.BBjGridExWidget

Get Array of selected rows


#API


getSelectedText() - method in class Dashboard.GridWidget

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.


getSelectionMode() - method in class QVGrid.QVGrid

Returns the current selection mode


getSelf() - method in class gappsv3.GEventAttendee

Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.


getSequence() - method in class gappsv3.GEvent

iCalendar sequence number.


getSeries(BBjString p_seriesName$) - method in class Dashboard.XYChartWidget

Returns the requested series


getSeriesName(BBjNumber p_seriesNumber) - method in class Dashboard.XYChartWidget

Returns the name of the specified series number associated with the XY Chart


getSeriesNameVector() - method in class Dashboard.XYChartWidget

Returns the names of the series associated with the XY Chart


getSeriesNumber(BBjString p_seriesName$) - method in class Dashboard.XYChartWidget

Returns the number of the specified series name associated with the XY Chart


getServerBBjConfigFile() - method in class BBConfig

getServerBBjHome() - method in class BBConfig

getServerBBjInterpreter() - method in class BBConfig

getServerJavaHome() - method in class BBConfig

getServerOS() - method in class BBConfig

getService() - method in class GDocsService

@description: Changed with transition to Google Drive. Used to return DocsService and now returns Drive (a service object)


getShiftKey() - method in class BBjCalendarWidget.CalendarEventWithJavaScriptEvent

Returns whether the user's shift key was pressed when the event occurred.


getShortCue() - method in class QVGrid.QVGrid

Returns the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as getToolTipText().


getShortName() - method in class DialogWizard.Control

Method getShortName: Get control short name


getShouldHighlightSelectedColumn() - method in class QVGrid.QVGrid

Returns whether the grid should highlight the entire column of the currently selected cell


getShouldHighlightSelectedRow() - method in class QVGrid.QVGrid

Returns whether the grid should highlight the entire row of the currently selected cell


getShowFileDialogOnInitDefaultSave() - method in class BBJasper.BBJasperViewerControl

getShowFileDialogOnInitDefaultSave Returns if the file save dialog should be shown on the intitial save


getShowGoogleDialogOnInitDefaultSave() - method in class BBJasper.BBJasperViewerControl

getShowGoogleDialogOnInitDefaultSave Returns if the Google save dialog should be shown on the intitial save


getShowMaskWhenRendering() - method in class QVGrid.QVGrid

Returns whether input style cells display the decoration characters of their mask in non-edit mode Note: This method has been deprecated.


getSide() - method in class BBJasper.BBJasperPrintMediaTray

getSide Creates and returns a print media tray object that contains side tray information


getSidebar() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid sidebar instance


getSides() - method in class BBJasper.BBJasperPrintSides

getSides Returns the sides object


getSize() - method in class BBTranslator.BBTranslations

Returns the number of translations


getSlotDuration() - method in class BBjCalendarWidget.CalendarOptions

Returns the time slot duration.


getSlotMaxTime() - method in class BBjCalendarWidget.CalendarOptions

Returns the maximum time slot (latest time) that will be displayed for each day in a time grid view.


getSlotMinTime() - method in class BBjCalendarWidget.CalendarOptions

Returns the minimum time slot (earliest time) that will be displayed for each day in a time grid view.


getSlotScrollTime() - method in class BBjCalendarWidget.CalendarOptions

Returns the time slot that the calendar initially scrolls to.


getSnapToRowHeight() - method in class QVGrid.QVGrid

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.


getSortByMultipleColumns() - method in class QVGrid.QVGrid

Returns an indication of whether this grid sorts by multiple columns


getSource() - method in class gappsv3.GEvent

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.


getSourceFile() - method in class WidgetWizard

Method getSourceFile: Returns the source file


getSQL() - method in class Dashboard.DataFillableWidget

Returns the SQL query


getStart() - method in class gappsv3.GEvent

The event's start time.


getStart() - method in class BBjCalendarWidget.CalendarSelectEvent

Returns the calendar's selected starting date, which may include timezone information.


getStart() - method in class BBjCalendarWidget.CalendarDatesSetEvent

Returns the calendar's starting date for the current range.


getStart() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's starting date/time.


getStartDelta() - method in class BBjCalendarWidget.CalendarEntryResizeEvent

Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's start date was moved by.


getStartEditSelectionMode() - method in class QVGrid.QVGrid

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


getStartStr() - method in class BBjCalendarWidget.CalendarDatesSetEvent

Returns the calendar's starting date in ISO 8601 format for the current range.


getStartString() - method in class BBjCalendarWidget.CalendarSelectEvent

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.


getState() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid's columns , sorting and filtering state


#API


getStatus() - method in class gappsv3.GEvent

Whether the event is occurring. Values are "confirmed", "tenative", and "cancelled". The default is "confirmed".


getStatusbar() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid statusbar instance


getStatusCode() - method in class BBWebClient.BBWebResponse

The status code resulting from sending the corresponding request. I.E., 404 for "File Not Found" or "200" for "success".


getString() - method in class BBjGridExWidget.GxState

getStringWidth(BBjString text$) - method in class QVGrid.QVGrid

Returns the width of a string in pixels


getStripeCount() - method in class QVGrid.QVGrid

Returns the number of grid rows to alternate between the stripe color and the default background color


getStyle(String arg!) - method in class QVGrid.QVGrid

see BBjControl


getStyle(BBjString property!) - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the value of the specified CSS property.


getStyles() - method in class QVGrid.QVGrid

Gets a vector of all CSS style names that have been added to the grid control


getStyles() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's name as previously-set via the setName() method.


getSubimage(BBjNumber p_x, BBjNumber p_y, BBjNumber p_w, BBjNumber p_h) - method in class BBXImage.BBXImage

Method to return a BBXImage that is a subimage defined by a specified rectangular region


getSummary() - method in class gappsv3.GCalendar

Retrieves the calendar's summary.


getSummary() - method in class gappsv3.GEvent

Get the title of the event.


getSummaryOverride() - method in class gappsv3.GCalendar

Retrieves the calendar's summary override.


getSuppressBuiDebouncing() - method in class BBjGridExWidget.GxExecutor

getSysGuiEvent() - method in class Dashboard.GridWidgetEvent

Gets the SysGui event


getTabAction() - method in class QVGrid.QVGrid

Returns the current tab action of the grid


getTabActionSkipsNonEditableCells() - method in class QVGrid.QVGrid

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() - method in class BBJasper.BBJasperViewerControl

getTabbedView Returns the tabbed view


getTable() - method in class BBJasper.BBJasperDesign

getTable Returns the table name


getTabOnParentHyperlinkTarget() - method in class BBJasper.BBJasperTabbedView

getTabOnParentHyperlinkTarget Returns whether a tab will be created when hyperlink targets are set to parent, otherwise a window will be created


getTags() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's tags in a vector of strings.


getTempDir() - method in class ScreenCapture.ScreenCapture

Method getTempDir: Get temporary directory path


getTempDir(BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method getTempDir: Get temporary directory path on server or client


getTemplate() - method in class BBJasper.BBJasperDesign

getTemplate Returns the BBJasperTemplate object


getTemplatedStringRepresentation() - method in class Dashboard.DashboardCategoryAttribute

Gets a BBjTemplatedString representation of the DashboardCategoryAttribute


getText() - method in class QVGrid.QVGrid

Returns the control text assigned to the grid control Note: The relevance of this method for a grid is questionable, but provided for compatability.


getTextColor() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's text color.


getTextColor() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's entry text color.


getTheme() - method in class BBjCalendarWidget.CalendarOptions

Returns the theme that the calendar is using.


getThemes() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


getThemes() - method in class BBjGridExWidget.BBjGridExWidget

Get the grid supported themes


#API


getTimeZone() - method in class gappsv3.GCalendar

Retrieves the calendar's timezone.


getTimeZone() - method in class BBjCalendarWidget.CalendarOptions

Returns the calendar's timezone setting which defaults to "local".


getTimeZone() - method in class BBjCalendarWidget.CalendarDatesSetEvent

Returns the calendar's time zone setting.


getTitle() - method in class Dashboard.DashboardItem

Returns the title of dashboard item


getTitle() - method in class Dashboard.DashboardWindow

Gets the dashboard window's title


getTitle() - method in class Dashboard.WidgetControl

Returns the title of the widget control


getTitle() - method in class BuildItem

getTitle() - method in class WidgetBuildItem

getTitle() - method in class WidgetSetBuildItem

getTitle() - method in class WidgetDashboardBuildItem

getTitle() - method in class Email.EmailDialog

getTitle Returns the dialog title


getTitle() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's optional unique ID if it has previously been set.


getTitle() - method in class BBjCalendarWidget.CalendarView

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".


getToken() - method in class gappsv3.GOAuth2

The authorization token.


getTokenFromCookie() - method in class gappsv3.GOAuth2

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.


getToolBar() - method in class Dashboard.DashboardControl

Returns the toolbar of the dashboard control


getToolbar() - method in class BBJasper.BBJasperViewerControl

getToolbar Returns the tool bar


getToolbarControlAt(BBjNumber p_index) - method in class BBJasper.BBJasperViewerControl

getToolbarControlAt Returns a tool bar control at the specified index


getToolsPopupMenu() - method in class BBJasper.BBJasperView

getToolsPopupMenu Returns the tools popup menu


getToolTipText(BBjNumber row!, BBjNumber column!) - method in class QVGrid.QVGrid

Returns the tooltip text (also known as short cue) for a cell


getToolTipText(BBjNumber column!) - method in class QVGrid.QVGrid

Returns the tooltip text (also known as short cue) for a column


getToolTipText() - method in class QVGrid.QVGrid

Returns the tooltip text (also known as short cue) for the grid control


getTop() - method in class BBJasper.BBJasperPrintMediaTray

getTop Creates and returns a print media tray object that contains top tray information


getTopRow() - method in class QVGrid.QVGrid

Returns the current top visible row


getTopWindowId(BBjString pResFilePath$) - method in class DialogWizard.DialogUtils

Method getTopWindowId: Get the first top level window id in a resource file


getTopWindowIdList(BBjString pResFilePath$) - method in class DialogWizard.DialogUtils

Method getTopWindowIdList: Get a list of all the top level window ids in a resource file


getTranslation(BBjString p_key$) - method in class Admin

getTranslation(BBjString p_translationKey$) - method in class Dashboard.Dashboard

Returns the translation value given a key


getTranslation(BBjString p_translationKey$) - method in class Dashboard.ExportData

getTranslation Returns a translation value, given a translation key


getTranslation(BBjString p_key$) - method in class GApps

getTranslation(BBjString p_key$) - method in class BBTranslator.BBTranslator

Returns the translated string given a key

If the translation is not found, then the passed in key is returned


getTranslation(BBjString p_key$, BBjString p_defaultValue!) - method in class BBTranslator.BBTranslator

Returns the translated string given a key

If the translation is not found, then the passed in default value is returned


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound) - method in class BBTranslator.BBTranslator

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.


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd) - method in class BBTranslator.BBTranslator

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.


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale) - method in class BBTranslator.BBTranslator

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.


getTranslation(Locale p_locale!, BBjString p_key$) - method in class BBTranslator.BBTranslationBundle

getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!) - method in class BBTranslator.BBTranslationBundle

getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound) - method in class BBTranslator.BBTranslationBundle

getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd) - method in class BBTranslator.BBTranslationBundle

getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale) - method in class BBTranslator.BBTranslationBundle

getTranslation(BBjString p_key$) - method in class BBTranslator.BBTranslations

Returns the translated string given a key, if the translation is not found, then the passed in key is returned


getTranslation(BBjString p_key$, BBjString p_defaultValue!) - method in class BBTranslator.BBTranslations

Returns the translated string given a key, if the translation is not found, then the passed in default value is returned


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound) - method in class BBTranslator.BBTranslations

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.


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd) - method in class BBTranslator.BBTranslations

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.


getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale) - method in class BBTranslator.BBTranslations

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.


getTranslationBundle() - method in class BBTranslator.BBTranslator

Returns the translation Bundle


getTranslations() - method in class BBTranslator.BBTranslator

Returns all translations for the current locale


getTranslations(Locale p_locale!) - method in class BBTranslator.BBTranslationBundle

getTransparency() - method in class gappsv3.GEvent

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".


getTrimBlankSpace() - method in class QVGrid.QVGrid

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() - method in class BBJasper.BBJasperPrintSides

getTumble Creates and returns a print sides object that contains tumble information


getTwoSidedLongEdge() - method in class BBJasper.BBJasperPrintSides

getTwoSidedLongEdge Creates and returns a print sides object that contains two sided long edge information


getTwoSidedShortEdge() - method in class BBJasper.BBJasperPrintSides

getTwoSidedShortEdge Creates and returns a print sides object that contains two sided short edge information


getTXTExporter() - method in class BBJasper.BBJasperViewerControl

getTXTExporter Returns the TXT exporter which contains export options


getType() - method in class BuildItem

getType() - method in class BaseBuildItem

getType() - method in class DialogWizard.Control

Method getType: Get control type id


getType() - method in class GPermission

getType() - method in class BBJasper.DesignType

getType Returns the design type


getType() - method in class BBjCalendarWidget.CalendarView

Returns the calendar's view type.


getType() - method in class GxClientModels.GxClientColumnModel

Get the column type

Returns the value of the ColumnType property from the ResultSet's metadata.


getTypeName() - method in class DialogWizard.Control

Method getTypeName: Get control type name


getUnregNotificationEmailAddresses(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$) - method in class BUS

getUpdateActive(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

getUpdateCached() - method in class QVGrid.QVGrid

Returns whether the grid sends table update events


getUpdateComment(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

getUpdated() - method in class gappsv3.GEvent

The time the event was last updated.


getUpdateDate(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

getUpdateLevel(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_includeInactive%) - method in class BUS

getUpdateLevels(BBjString p_vendor$, BBjString p_application$, BBjString p_version$) - method in class BUS

getUpdateLocation(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

getUpdateSize(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

getUpdateVersion(BBjString p_vendor$, BBjString p_application$, BBjString p_baseVersion$, BBjInt p_includeInactive%) - method in class BUS

getURL() - method in class Dashboard.DashboardWidgetLinkSelectEvent

Returns the URL of a dashboard widget link select event


getUrl() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's associated URL that may be visited when this entry is clicked by the user.


getUrl() - method in class BBjCalendarWidget.CalendarEntrySource

Returns the source's URL parameter.


getUser() - method in class GAppsService

getUser() - method in class GAppsLoginDialog

getUser() - method in class GDocsService

getUserAdminDatabase(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUserAdminEmail(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUserAdminNotifications(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUserAdminUpdates(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUserAdminUsers(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUserAgent() - method in class Dashboard.HtmlViewWidget

Returns the user agent string for the HtmlViewWidget

This requires a BBj 15 or greater interpreter


getUserCredentials() - method in class Admin

getUserData() - method in class Dashboard.DashboardItem

Returns the user data object of dashboard item


getUserData() - method in class QVGrid.QVGrid

Retrieves user data associated with the grid control after having called setUserData()


getUserData() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the custom object that was previously associated with the widget by calling the setUserData() method.


getUserFontScalingFactor() - method in class Dashboard.ChartWidget

Gets the custom font scaling factor or the chart as set by the user in the Customize screen.


getUserPassword(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

getUsers(BBjString p_adminUser$, BBjString p_adminPassword$) - method in class BUS

getUserToken() - method in class GAppsService

getUuid() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns a unique auto-generated ID for the calendar instance that may be used to distinguish between instances of the class.


getUuid() - method in class BBjCalendarWidget.CalendarEntry

Returns an entry's unique UUID that is automatically generated for all entries.


getValidationText() - method in class QVGrid.QVGrid

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


getValidDateString(BBjString dateString!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


getValidDateString(BBjString dateString!) - method in class BBjCalendarWidget.CalendarAPI

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.


getValidDateTimeString(BBjString dateTimeString!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


getValidDateTimeString(BBjString dateTimeString!) - method in class BBjCalendarWidget.CalendarAPI

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.


getValidEvents() - method in class DialogWizard.Event

Method getValidEvents: Get valid events map


getValidRangeEnd() - method in class BBjCalendarWidget.CalendarOptions

Returns the calendar's ending date that the user sees and interact with.


getValidRangeStart() - method in class BBjCalendarWidget.CalendarOptions

Returns the calendar's starting date that the user sees and interact with.


getValidTimeString(BBjString timeString!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


getValidTimeString(BBjString timeString!) - method in class BBjCalendarWidget.CalendarAPI

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.


getValidTypes() - method in class DialogWizard.Control

Method getValidTypes: Get all valid control type information


getValue(BBjString p_path$, BBjString p_jsonContent$) - method in class BBJSONResolver.BBJSONResolver

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".


getValue() - method in class GxClientEvents.GxClientEventsContextMenu

Get the cell value


getValue() - method in class BBjDialChartProgress.BBjDialChartProgress

Method to get the dial chart's current value which is in the range from 0 to 100, indicating percentage complete


getValue(BBjNumber p_datasetNumber) - method in class BBjBUIDialChart.BBjBUIDialChart

Method to get the value of the dial chart


getVectorOfJavaColorsFromDivergentHexColorStrings(BBjNumber p_numColors, BBjString p_colorDescStart$, BBjString p_colorDescMiddle$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaMiddle!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

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.


getVectorOfJavaColorsFromHexColorStrings(BBjNumber p_numColors, BBjString p_colorDescStart$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

Method to create a vector of Java Colors with a specified starting and ending range


getVectorsFromBBjRS(BBjRecordSet p_rs!, BBjVector p_columns!) - method in class Dashboard.GridWidget

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


getVectorsFromSQLQuery(BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - method in class Dashboard.GridWidget

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


getVendors() - method in class BUS

getVersions(BBjString p_vendor$, BBjString p_application$) - method in class BUS

getVerticalCellSpacing() - method in class QVGrid.QVGrid

Returns the amount of vertical space between the rows


getVerticalLinesVisible() - method in class QVGrid.QVGrid

Returns whether the vertical lines between columns are visible


getVerticalScrollable() - method in class QVGrid.QVGrid

Returns whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid


getVerticalScrollBarAlways() - method in class QVGrid.QVGrid

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() - method in class Dashboard.JasperViewerWidget

getView Returns the BBJasperView for the widget


getView() - method in class BBJasper.BBJasperViewerControl

getView Returns the current view


getView() - method in class BBJasper.BBJasperTabbedView

getView Returns the current view of the tabbed view


getViewAt(BBjNumber p_index) - method in class BBJasper.BBJasperTabbedView

getViewAt Returns a view at a specified index


getViewerControl() - method in class Dashboard.JasperViewerWidget

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() - method in class BBJasper.BBJasperViewerWindow

getViewerControl Returns the viewer control


getViewerControl() - method in class BBJasper.BBJasperTabbedView

getViewerControl Returns the viewer control that houses the tabbed view


getViewerWindow() - method in class BBJasper.BBJasperViewerWindow

getViewerWindow Returns the viewer window


getViewIndex(BBJasperView p_view!) - method in class BBJasper.BBJasperTabbedView

Returns the view index in the view vector


getViews() - method in class BBJasper.BBJasperTabbedView

getViews Returns all views in a vector


getViewType() - method in class BBjCalendarWidget.BBjCalendarWidget

getVisibility() - method in class gappsv3.GEvent

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.


getVisibleColumns() - method in class BBjGridExWidget.GxState

getVisibleRowCount() - method in class QVGrid.QVGrid

Returns the number of rows that are currently visible in the grid


getVisibleTags() - method in class BBjCalendarWidget.BBjCalendarWidget

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:

  1. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.
  2. The 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.
  3. The 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.


getVPRO5Config() - method in class BBConfig

getVPRO5Home() - method in class BBConfig

getVPRO5Interpreter() - method in class BBConfig

getWebContentLink() - method in class GDoc

getWebPreviewLink() - method in class GDoc

getWebServerAppsURL() - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's apps directory.


getWebServerAppsURL(BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's apps directory, specifying whether an SSL connection is required or not.


getWebServerAppsURL() - method in class BBLaunchDock

getWebServerAppsURL(BBjNumber p_requireSSL) - method in class BBLaunchDock

getWebServerFilesURL() - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's files directory.


getWebServerFilesURL(BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's files directory, specifying whether an SSL connection is required or not.


getWebServerFilesURL() - method in class BBLaunchDock

getWebServerFilesURL(BBjNumber p_requireSSL) - method in class BBLaunchDock

getWebServerFileURL(BBjString p_file$, BBjString p_subDir$, BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

getWebServerHost() - method in class BBUtils.BBUtils

Get the host of the Jetty Web Server.


getWebServerHost() - method in class BBLaunchDock

getWebServerHttpPort() - method in class BBUtils.BBUtils

Get the port of the Jetty Web Server.


getWebServerHttpPort() - method in class BBLaunchDock

getWebServerPort() - method in class BBUtils.BBUtils

Get the port of the Jetty Web Server.


getWebServerPort(BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

Get the port of the Jetty Web Server, specifying whether an SSL connection is required or not.


getWebServerPort() - method in class BBLaunchDock

getWebServerPort(BBjNumber p_requireSSL) - method in class BBLaunchDock

getWebServerProtocol() - method in class BBUtils.BBUtils

getWebServerProtocol(BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

getWebServerProtocol() - method in class BBLaunchDock

getWebServerProtocol(BBjNumber p_requireSSL) - method in class BBLaunchDock

getWebServerSSLPort() - method in class BBUtils.BBUtils

Get the SSL port of the Jetty Web Server.


getWebServerSSLPort() - method in class BBLaunchDock

getWebServerURL() - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's root directory.


getWebServerURL(BBjNumber p_requireSSL) - method in class BBUtils.BBUtils

Get the URL of the Jetty Web Server's root directory, specifying whether an SSL connection is required or not.


getWebServerURL() - method in class BBLaunchDock

getWebServerURL(BBjNumber p_requireSSL) - method in class BBLaunchDock

getWebViewLink() - method in class GDoc

getWidget() - method in class Dashboard.DashboardWidget

Returns the encapsulated widget


getWidget() - method in class Dashboard.WidgetControl

Returns the encapuslated widget used in the widget control


getWidget() - method in class BBjGridExWidget.GxClientJsonFactory

Get the widget instance


getWidget() - method in class BBjGridExWidget.GxClientJsonFactory

Get the widget instance


getWidget() - method in class GxClientModels.GxClientRowModel

Get the widget instance


getWidget() - method in class GxClientModels.GxClientColumnModel

Get the widget instance


getWidget() - method in class GxClientModels.GxClientFilterModel

Get the widget instance


getWidgetAttributesHashMap() - method in class Dashboard.DashboardControl

Returns the widget attributes


getWidgetConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetConnectString(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetDescription(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetDescription(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetDescription(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetDescription(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetDescription(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetExists(BBjString p_categoryName$, BBjString p_widgetName$) - method in class BuildItem

getWidgetExists(BBjString p_categoryName$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetExists(BBjString p_categoryName$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetExists(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetHtmlText(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetHtmlUrl(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetImageFile(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetImageUrl(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetNames(BBjString p_widgetCategory$) - method in class BuildItem

getWidgetNames(BBjString p_widgetCategory$) - method in class WidgetBuildItem

getWidgetNames(BBjString p_widgetCategory$) - method in class WidgetSetBuildItem

getWidgetNames(BBjString p_widgetCategory$) - method in class WidgetDashboardBuildItem

getWidgetRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetRecordsetColumns(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetRecordsetFile(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetRecordsetTemplate(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetReportConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetReportConnectString(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetReportConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetReportConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetReportConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetReportFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetReportFile(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetReportFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetReportFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetReportFile(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

getWidgetSeriesConnectString(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

getWidgetSeriesConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

getWidgetSeriesConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

getWidgetSeriesConnectString(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesNames(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetSeriesNames(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetSeriesNames(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetSeriesNames(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetSeriesNames(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

getWidgetSeriesRecordsetColumns(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

getWidgetSeriesRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

getWidgetSeriesRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

getWidgetSeriesRecordsetColumns(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

getWidgetSeriesRecordsetFile(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

getWidgetSeriesRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

getWidgetSeriesRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

getWidgetSeriesRecordsetFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

getWidgetSeriesRecordsetTemplate(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

getWidgetSeriesRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

getWidgetSeriesRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

getWidgetSeriesRecordsetTemplate(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

getWidgetSeriesSQL(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

getWidgetSeriesSQL(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

getWidgetSeriesSQL(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

getWidgetSeriesSQL(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

getWidgetSeriesSQL(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

getWidgetSQL(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetSQL(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetSQL(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetSQL(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetSQL(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetTitles(BBjString p_widgetCategory$) - method in class BuildItem

getWidgetTitles(BBjString p_widgetCategory$) - method in class WidgetBuildItem

getWidgetTitles(BBjString p_widgetCategory$) - method in class WidgetSetBuildItem

getWidgetTitles(BBjString p_widgetCategory$) - method in class WidgetDashboardBuildItem

getWidgetType() - method in class Dashboard.DashboardWidget

Returns the widget type


getWidgetType(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

getWidgetType(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

getWidgetType(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

getWidgetType(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

getWidgetType(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

getWidgetTypeDisplayString(BBjNumber p_widgetType) - method in class WidgetWizard

getWidgetTypeString(BBjNumber p_widgetType) - method in class WidgetWizard

getWidth() - method in class BBXImage.BBXImage

Method to get the width of the BBXImage


getWidth() - method in class Dashboard.WidgetControl

Returns the width of the widget control


getWidth() - method in class Dashboard.EmbeddedWidgetWindow

Returns the width of the EmbeddedWidgetWindow


getWidth() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the width of the EmbeddedWidgetWindow


getWidth() - method in class Dashboard.ExportDataDialog

getWidth Returns the width of the dialog


getWidth() - method in class Email.EmailDialog

getWidth Returns the width of the dialog


getWidth() - method in class QVGrid.QVGrid

Returns the width of the QVGrid component child window


getWidth() - method in class BBJasper.BBJasperViewerControl

getWidth Returns the width of the viewer control


getWidth() - method in class BBJasper.BBJasperTabbedView

getWidth Returns the width of the tabbed view


getWidth() - method in class BBJasper.BBJasperView

getWidth Returns the width of the viewer control


getWidth() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's width.


getWindow() - method in class Dashboard.ExportDataDialog

getWindow Returns the export window


getWindow() - method in class BBJasper.BBJasperDesigner

getWindow Returns the wizard window


getWindowOnBlankHyperlinkTarget() - method in class BBJasper.BBJasperTabbedView

getWindowOnBlankHyperlinkTarget Returns whether a window will be create when hyperlink targets are set to blank, otherwise a tabe will be created


getWindowTitle() - method in class BBJasper.BBJasperViewerWindow

getWindowTitle Returns the title of the viewer window


getX() - method in class Dashboard.WidgetControl

Returns the X location of the widget control


getX() - method in class Dashboard.EmbeddedWidgetWindow

Returns the X location of the EmbeddedWidgetWindow


getX() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the X location of the EmbeddedWidgetSetWindow


getX() - method in class Dashboard.ExportDataDialog

getX Returns the X screen location of the dialog


getX() - method in class Email.EmailDialog

getX Returns the X location of the email dialog


getX() - method in class QVGrid.QVGrid

Returns the X coordinate of the QVGrid component child window


getX() - method in class BBJasper.BBJasperViewerControl

getX Returns the X location of the viewer control


getX() - method in class BBJasper.BBJasperTabbedView

getX Returns the X location of the tabbed view


getX() - method in class BBJasper.BBJasperView

getX Returns the X location of the viewer control


getX() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's X coordinate, or horizontal position.


getXHTMLExporter() - method in class BBJasper.BBJasperViewerControl

getXHTMLExporter Returns the XHTML exporter which contains export options


getXLSExporter() - method in class BBJasper.BBJasperViewerControl

getXLSExporter Returns the XLS exporter which contains export options


getXLSXExporter() - method in class BBJasper.BBJasperViewerControl

getXLSXExporter Returns the XLSX exporter which contains export options


getXMLExporter() - method in class BBJasper.BBJasperViewerControl

getXMLExporter Returns the XML exporter which contains export options


getXYDataset() - method in class Dashboard.XYChartWidget

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


getY() - method in class Dashboard.WidgetControl

Returns the Y location of the widget control


getY() - method in class Dashboard.EmbeddedWidgetWindow

Returns the Y location of the EmbeddedWidgetWindow


getY() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the Y location of the EmbeddedWidgetSetWindow


getY() - method in class Dashboard.ExportDataDialog

getY Returns the Y screen location of the dialog


getY() - method in class Email.EmailDialog

getY Returns the Y location of the email dialog


getY() - method in class QVGrid.QVGrid

Returns the Y coordinate of the QVGrid component child window


getY() - method in class BBJasper.BBJasperViewerControl

getY Returns the Y location of the viewer control


getY() - method in class BBJasper.BBJasperTabbedView

getY Returns the Y location of the tabbed view


getY() - method in class BBJasper.BBJasperView

getY Returns the Y location of the viewer control


getY() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns the widget's Y coordinate, or vertical position.


getZoomLevel() - method in class BBJasper.BBJasperViewerControl

getZoomLevel Returns the current zoom level


getZoomLevel() - method in class BBJasper.BBJasperView

getZoomLevel Returns the current zoom level


getZoomNumber(BBjString p_pctString!) - method in class BBJasper.BBJasperView

getZoomNumber Returns the zoom number, given a precentage string


GEvent - class in gappsv3

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.


GEvent() - constructor in class gappsv3.GEvent

Constructor for creating a brand new event.


GEvent(Event wrappedEvent!) - constructor in class gappsv3.GEvent

Constructor for wrapping an existing Google Event.


GEventAttendee - class in gappsv3

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


GEventAttendee() - constructor in class gappsv3.GEventAttendee

Default constructor that creates a new attendee.


GEventAttendee(EventAttendee wrappedAttendee!) - constructor in class gappsv3.GEventAttendee

Constructor that wraps an existing Google attendee.


GEvents - class in gappsv3

A collection of one or more events in the Google calendar. This is often the result of an events request on the calendar. /


GEvents() - constructor in class gappsv3.GEvents

Constructor for GEvents.


GO_TO$=#Translations!.getTranslation("go.to") - field in class BBJasper.BBJasperView

Translated text for go to


GO_TO_MENU_NAME$="BBJVGoToMenu" - field in class BBJasper.BBJasperView

Go to menu name


GO_TO_PAGE$=#Translations!.getTranslation("go.to.page") - field in class BBJasper.BBJasperViewerControl

Translated text for go to page


GO_TO_PAGE$=#Translations!.getTranslation("go.to.page") - field in class BBJasper.BBJasperView

Translated text for go to page


GOAuth2 - class in gappsv3

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.


GOAuth2() - constructor in class gappsv3.GOAuth2

GOAuth2! - field in class GAppsService

GoldMineIntegrationWebService - class in GoldMineIntegration

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.


GoldMineIntegrationWebService() - constructor in class GoldMineIntegration.GoldMineIntegrationWebService

Constructor. Basic construction is provided by the GoldMineIntegrationWebServiceFactory factory class


GoldMineIntegrationWebServiceFactory - class in GoldMineIntegration

Creates a GoldMineIntegrationWebService instance


GOOGLE_DOC_SAVE_NAME$ - field in class Dashboard.JasperViewerWidget

Google Doc save notify name


GoogleDefaultDocument! - field in class Dashboard.JasperViewerWidget

Document that will be used by default on a google doc save


GoogleDefaultFolder! - field in class Dashboard.JasperViewerWidget

Folder that will be used by default on a google doc save


GoogleDefaultType! - field in class Dashboard.JasperViewerWidget

Type that will be used by default on a google doc save


GoogleEvent! - field in class gappsv3.GEvent

The wrapped Google Event object. Allows direct calls to the Java-based Google-based API.


GoogleEventAttendee!=null() - field in class gappsv3.GEventAttendee

The wrapped Google EventAttendee object. This can be accessed to make direct calls to the Java-based Google API.


GPermission - class in this project

GPermission(Permission p_permission!) - constructor in class GPermission

grdScrolled(BBjScrollWheelEvent ev!) - method in class QVGrid.QVGrid

Mouse scroll wheel event handler


GREATER_THAN() - method in class GxFilters.GxColumnFilterDateTimeFilterOptions

GREATER_THAN_OR_EQUALS() - method in class GxFilters.GxColumnFilterNumberFilterOptions

GRID$ - field in class WidgetWizard

GRID_ALIGN_CENTER() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define centered column


GRID_ALIGN_LEFT() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define left aligned column


GRID_ALIGN_RIGHT() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define right aligned column


GRID_EDITTYPE_CELL() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define editing mode "cell"


GRID_EDITTYPE_ROW() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define editing mode "row"


GRID_ENTER_NEXT_CELL() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define enter key behavior (Move to next cell)


GRID_ENTER_STOP_EDITING() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define enter key behavior (Stop editing)


GRID_FLOATING_BOTTOM() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the rows floating on bottom


GRID_FLOATING_NONE() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the rows with no floating


GRID_FLOATING_TOP() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the rows floating on top


GRID_GROUPPANEL_SHOW_HIDDEN() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that group panel must always be hidden


GRID_GROUPPANEL_SHOW_ONGROUPING() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that group panel must be shown only when grouping


GRID_GROUPPANEL_SHOW_VISIBLE() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that group panel must always be shown


GRID_NAVIGATION_BEHAVIOUR_NEXT_CELL() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define navigation behavior (Move to next cell)


GRID_NAVIGATION_BEHAVIOUR_NEXT_ROW() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define navigation behavior (Move to next row)


GRID_ROWPOS_BOTTOM() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row position


GRID_ROWPOS_MIDDLE() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row position


GRID_ROWPOS_TOP() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row position


GRID_ROWS_PHASE_AFTER_FILTER() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which describes the rows in after filtering phase.


GRID_ROWS_PHASE_AFTER_FILTER_SORT() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which describes the rows in after filtering and sorting phase.


GRID_ROWS_PHASE_ALL() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which describes the rows in before sorting and filtering phase.


GRID_THEME_ALPINE() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the alpine theme


GRID_THEME_ALPINE_DARK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the alpine dark theme


GRID_THEME_BALHAM() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that balham theme


GRID_THEME_BALHAM_DARK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines that balham dark theme


GRID_THEME_MATERIAL() - method in class BBjGridExWidget.BBjGridExWidget

Constant value which defines the material theme


GRID_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Grid widget type constant


GRIDEX_WIDGET_TYPE - field in class Dashboard.DashboardWidget

JGridEx widget type constant


GridExWidget - class in Dashboard

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.


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - constructor in class Dashboard.GridExWidget

Creates an empty GridExWidget to be filled later with one of the fill() methods


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, ResultSet p_resultSet!) - constructor in class Dashboard.GridExWidget

Creates a GridExWidget that is filled with a BASIS Components ResultSet


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.GridExWidget

Creates a GridExWidget with a connection string and SQL query which are used to automatically populate the grid with data


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.GridExWidget

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


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - constructor in class Dashboard.GridExWidget

Creates a GridExWidget providing the column header data and row data for the grid via BBjVectors


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_file$, BBjString p_template$, DataRow p_filter!) - constructor in class Dashboard.GridExWidget

Creates a GridExWidget that is filled using the BASIS Components to build a ResultSet based off of a data file, string template, and filter


GridExWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.GridExWidget

Creates a GridExWidget with a connection string, SQL query, and mode which are used to automatically populate the grid with data


GridWidget - class in Dashboard

GridWidget A Dashboard Utility Widget that displays data in a grid


GridWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - constructor in class Dashboard.GridWidget

Creates a GridWidget


GridWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.GridWidget

Creates a GridWidget with a connection string and SQL query which are used to automatically populate the grid with data


GridWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.GridWidget

Creates a GridWidget with a BBjRecordSet which is used to automatically populate the grid with data


GridWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) - constructor in class Dashboard.GridWidget

Creates a GridWidget providing the column header data and row data for the grid via BBjVectors


GridWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.GridWidget

Creates a GridWidget with a connection string and SQL query which are used to automatically populate the grid with data


GridWidgetEvent - class in Dashboard

GridWidgetEvent Class that contains event information for a GridWidget


GridWidgetEvent(GridWidget p_gridWidget!, BBjStandardGrid p_grid!, BBjSysGuiEvent p_sysguiEvent!) - constructor in class Dashboard.GridWidgetEvent

Contructs a GridWidgetEvent


GridWidgetRefreshEvent - class in Dashboard

GridWidgetRefreshEvent Class that contains event information for a GridWidget that has just refreshed


GridWidgetRefreshEvent(GridWidget p_gridWidget!, BBjStandardGrid p_grid!) - constructor in class Dashboard.GridWidgetRefreshEvent

Contructs a GridWidgetRefreshEvent


GROUP_DISPLAY_CUSTOM() - method in class GxOptions.GxOptions

Specifies the results of row grouping should be displayed as custom: informs the grid that group columns will be provided.


GROUP_DISPLAY_GROUP_ROWS() - method in class GxOptions.GxOptions

Specifies the results of row grouping should be displayed as group rows: group rows are automatically added instead of group columns.


GROUP_DISPLAY_MULTIPLE_COLUMNS() - method in class GxOptions.GxOptions

Specifies the results of row grouping should be displayed as multiple columns: a group column per row group is added automatically.


GROUP_DISPLAY_SINGLE_COLUMN() - method in class GxOptions.GxOptions

Specifies the results of row grouping should be displayed as single column: single group column automatically added by the grid.


GROUP_SCOPE=2 - field in class GDoc

GroupDefaultExpanded! - field in class GxOptions.GxOptions

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


GroupDisplayType! - field in class GxOptions.GxOptions

Specifies how the results of row grouping should be displayed.

The options are:

  1. 'GxOptions.GROUP_DISPLAY_SINGLE_COLUMN()': single group column automatically added by the grid.
  2. 'GxOptions.GROUP_DISPLAY_MULTIPLE_COLUMNS()': a group column per row group is added automatically.
  3. 'GxOptions.GROUP_DISPLAY_GROUP_ROWS()': group rows are automatically added instead of group columns.
  4. 'GxOptions.GROUP_DISPLAY_CUSTOM()': informs the grid that group columns will be provided.


#Configuration
#GridRenderer


GroupHeaderHeight! - field in class GxOptions.GxOptions

The height for the rows containing header column groups. If not specified, it uses headerHeight
#Configuration
#GridRenderer


GroupHideOpenParents! - field in class GxOptions.GxOptions

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


GroupId! - field in class GxColumns.GxColumnGroup

The unique ID to give the column.


GroupIncludeFooter! - field in class GxOptions.GxOptions

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


GroupIncludeTotalFooter! - field in class GxOptions.GxOptions

Set to true to show a 'grand' total group footer across all groups.
#Configuration
#GridRenderer


GroupMultiAutoColumn! - field in class GxOptions.GxOptions

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


GroupRemoveLowestSingleChildren! - field in class GxOptions.GxOptions

Set to true to collapse lowest level groups that only have one child.
#Configuration
#GridRenderer


GroupRemoveSingleChildren! - field in class GxOptions.GxOptions

Set to true to collapse groups that only have one child.
#Configuration
#GridRenderer


GroupSelectsChildren! - field in class GxOptions.GxOptions

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


GroupSelectsFiltered! - field in class GxOptions.GxOptions

If using groupSelectsChildren, then only the children that pass the current filter will get selected
#Configuration
#GridRenderer


GroupSeparator! - field in class GxCellEditors.GxCellEditorBasicNumber

The number's group separator to use. by default the bbj group separator will be used


GroupSeparator! - field in class GxExpressions.GxExpressionNumbersFormatter

The number's group separator to use. by default the bbj group separator will be used


GroupSuppressAutoColumn! - field in class GxOptions.GxOptions

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


GroupSuppressBlankHeader! - field in class GxOptions.GxOptions

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


GroupSuppressRow! - field in class GxOptions.GxOptions

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


GroupUseEntireRow! - field in class GxOptions.GxOptions

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


GTimePeriod - class in gappsv3

A structure representing the time interval for a busy space on a calendar.


GTimePeriod(TimePeriod timePeriod!) - constructor in class gappsv3.GTimePeriod

GUtil - class in gappsv3

@description: General Google-related utility class


GUtil - class in gappsv3

A Class for performing conversions needed to go from Google constructs to those more recognized by BBj and standard Java.


GxAutoGroupColumn - class in GxColumns

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.


GxAutoGroupColumn() - constructor in class GxColumns.GxAutoGroupColumn

Construct new instance


GxCellEditorAbstract - class in GxCellEditors

Abstract implementation for GxCellEditorInterface


GxCellEditorBasicBoolean - class in GxCellEditors

Simple switch button to switch boolean values


GxCellEditorBasicBooleanRichSelect - class in GxCellEditors

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


GxCellEditorBasicBooleanRichSelect() - constructor in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanRichSelect(BBjString trueValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanRichSelect(BBjString trueValue!, BBjString falseValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanRichSelect(BBjString trueValue!, BBjString falseValue!, BBjString noneValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanSelect - class in GxCellEditors

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)


GxCellEditorBasicBooleanSelect() - constructor in class GxCellEditors.GxCellEditorBasicBooleanSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanSelect(BBjString trueValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanSelect(BBjString trueValue!, BBjString falseValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicBooleanSelect(BBjString trueValue!, BBjString falseValue!, BBjString noneValue!) - constructor in class GxCellEditors.GxCellEditorBasicBooleanSelect

Construct new GxCellEditorBasicBooleanSelect


GxCellEditorBasicDate - class in GxCellEditors

A date cell editor


GxCellEditorBasicDate() - constructor in class GxCellEditors.GxCellEditorBasicDate

Construct a new GxCellEditorBasicDate


GxCellEditorBasicDate(BBjString mask!) - constructor in class GxCellEditors.GxCellEditorBasicDate

Construct new GxCellEditorBasicDate


GxCellEditorBasicDateTime - class in GxCellEditors

A cell editor for timestamps


GxCellEditorBasicDateTime(BBjString mask!) - constructor in class GxCellEditors.GxCellEditorBasicDateTime

Construct new GxFilterBasicDateTime


GxCellEditorBasicNumber - class in GxCellEditors

Simple number input


GxCellEditorBasicText - class in GxCellEditors

Simple text input


GxCellEditorBasicText(BBjString mask!) - constructor in class GxCellEditors.GxCellEditorBasicText

Construct new GxCellEditorBasicText


GxCellEditorBasicTime - class in GxCellEditors

A date cell editor


GxCellEditorBasicTime() - constructor in class GxCellEditors.GxCellEditorBasicTime

Construct a new GxCellEditorBasicTime


GxCellEditorBasicTime(BBjString mask!) - constructor in class GxCellEditors.GxCellEditorBasicTime

Construct new GxCellEditorBasicTime


GxCellEditorBasicTimestamp - class in GxCellEditors

Alias for GxCellEditorBasicDateTime


GxCellEditorBasicTimestamp(BBjString mask!) - constructor in class GxCellEditors.GxCellEditorBasicTimestamp

Construct new GxFilterBasicDateTime


GxCellEditorComparator - class in GxCellEditors

Compare two cell editor components


GxCellEditorInterface - interface in GxCellEditors

Column Filter Public Interface


GxCellEditorLargeText - class in GxCellEditors

Simple editor that uses the standard HTML 'textarea' tag.


GxCellEditorPopupSelect - class in GxCellEditors

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


GxCellEditorPopupText - class in GxCellEditors

Same as GxCellEditorText but as popup.


GxCellEditorRichSelect - class in GxCellEditors

Available in Enhanced Grid only. An alternative to using the browser's select popup for dropdown inside the grid.


#Enterprise


GxCellEditorSelect - class in GxCellEditors

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.


GxCellEditorSuggestion - class in GxCellEditors

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!)
 

GxCellEditorSuggestion(BBjString id!, GxCellEditorSuggestionResolverInterface resolver!) - constructor in class GxCellEditors.GxCellEditorSuggestion

Construct new GxCellEditorSuggestion


GxCellEditorSuggestionResolver - class in GxCellEditors

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
 

GxCellEditorSuggestionResolverInterface - interface in GxCellEditors

A interface which defines how a suggestion's resolver/builder should build the suggesting lst


GxCellEditorText - class in GxCellEditors

Simple text editors that use the standard HTML 'input' tag


GxCellRendererComparator - class in GxRenderers

Compare two cell renderers components


GxClientAddRangeChartModel - class in GxClientModels

The model is used to compose a range chart model in order to be applied on the client.


GxClientAddRangeSelectionModel - class in GxClientModels

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.


GxClientCellModel - class in GxClientModels

A model for the client cell


GxClientColumnModel - class in GxClientModels

A model for the client column


GxClientColumnModel(BBjGridExWidget widget! , BBjString name!) - constructor in class GxClientModels.GxClientColumnModel

Construct new GxClientColumnModel


GxClientEventsCell - class in GxClientEvents

Cell Editing / Clicking Event


GxClientEventsContextMenu - class in GxClientEvents

Context Menu Event


GxClientEventsKeypress - class in GxClientEvents

Keypress event


GxClientEventsRangeSelection - class in GxClientEvents

Cells range selection event


GxClientEventsRowEditing - class in GxClientEvents

Cell Editing / Clicking Event


GxClientEventsRowSelection - class in GxClientEvents

Row Selection Event (single & double)


GxClientFilterAbstractModel - class in GxClientModels

A generic abstract implementation for the GxClientFilterModel interface


GxClientFilterBooleanModel - class in GxClientModels

The filter model represents the state of the boolean filter


GxClientFilterBooleanModel(BBjNumber filter!) - constructor in class GxClientModels.GxClientFilterBooleanModel

Construct new GxClientFilterBooleanModel


GxClientFilterCombinedModel - class in GxClientModels

A filter a which wraps two filter models and combine them with an OR or AND operator


GxClientFilterCombinedModel(GxClientFilterModel condition1!) - constructor in class GxClientModels.GxClientFilterCombinedModel

Construct new GxClientFilterCombinedModel


GxClientFilterCombinedModel(GxClientFilterModel condition1! , GxClientFilterModel condition2!) - constructor in class GxClientModels.GxClientFilterCombinedModel

Construct new GxClientFilterCombinedModel


GxClientFilterCombinedModel(GxClientFilterModel condition1! , GxClientFilterModel condition2! , BBjString operator!) - constructor in class GxClientModels.GxClientFilterCombinedModel

Construct new GxClientFilterCombinedModel


GxClientFilterDateTimeModel - class in GxClientModels

The filter model represents the state of the datetime filter. Please not this model will work for date , times and timestamps


GxClientFilterDateTimeModel() - constructor in class GxClientModels.GxClientFilterDateTimeModel

Construct new GxClientFilterDateTimeModel


GxClientFilterDateTimeModel(BBjString filter!) - constructor in class GxClientModels.GxClientFilterDateTimeModel

Construct new GxClientFilterDateTimeModel


GxClientFilterDateTimeModel(BBjString filter! , BBjString filterTo!) - constructor in class GxClientModels.GxClientFilterDateTimeModel

Construct new GxClientFilterDateTimeModel


GxClientFilterDateTimeModel(BBjString filter! , BBjString filterTo! , BBjString type!) - constructor in class GxClientModels.GxClientFilterDateTimeModel

Construct new GxClientFilterDateTimeModel


GxClientFilterModel - interface in GxClientModels

When saving or restoring state on a filter the filter model is used. The filter model represents the state of the filter


GxClientFilterNumberModel - class in GxClientModels

The filter model represents the state of the number filter


GxClientFilterNumberModel() - constructor in class GxClientModels.GxClientFilterNumberModel

Construct new GxClientFilterNumberModel


GxClientFilterNumberModel(BBjNumber filter!) - constructor in class GxClientModels.GxClientFilterNumberModel

Construct new GxClientFilterNumberModel


GxClientFilterNumberModel(BBjNumber filter! , BBjNumber filterTo!) - constructor in class GxClientModels.GxClientFilterNumberModel

Construct new GxClientFilterNumberModel


GxClientFilterNumberModel(BBjNumber filter! , BBjString type!) - constructor in class GxClientModels.GxClientFilterNumberModel

Construct new GxClientFilterNumberModel


GxClientFilterNumberModel(BBjNumber filter! , BBjNumber filterTo! , BBjString type!) - constructor in class GxClientModels.GxClientFilterNumberModel

Construct new GxClientFilterNumberModel


GxClientFilterSetFilterModel - class in GxClientModels

The filter model represents the enhanced filter type "setFilter"


GxClientFilterSetFilterModel(JsonArray values!) - constructor in class GxClientModels.GxClientFilterSetFilterModel

Construct new GxClientFilterSetFilterModel


GxClientFilterSimpleModel - class in GxClientModels

An abstract filter model which defined the common properties of the provided simple filters


GxClientFilterTextModel - class in GxClientModels

The filter model represents the state of the text filter


GxClientFilterTextModel() - constructor in class GxClientModels.GxClientFilterTextModel

Construct new GxClientFilterTextModel


GxClientFilterTextModel(BBjString filter!) - constructor in class GxClientModels.GxClientFilterTextModel

Construct new GxClientFilterTextModel


GxClientFilterTextModel(BBjString filter! , BBjString type!) - constructor in class GxClientModels.GxClientFilterTextModel

Construct new GxClientFilterTextModel


GxClientJsonFactory - class in BBjGridExWidget

The class will create client models from JSON


GxClientJsonFactory(BBjGridExWidget widget!) - constructor in class BBjGridExWidget.GxClientJsonFactory

Construct new GxClientJsonFactory


GxClientJsonFactory - class in BBjGridExWidget

The class will create client models from JSON


GxClientJsonFactory(BBjGridExWidget widget!) - constructor in class BBjGridExWidget.GxClientJsonFactory

Construct new GxClientJsonFactory


GxClientKeypressModel - class in GxClientModels

The model is used to represent a keypress on the client


GxClientRangeSelectionModel - class in GxClientModels

This model is used when range selections are read from the client


GxClientRowModel - class in GxClientModels

A client model for rows


GxClientRowModel(BBjGridExWidget widget!) - constructor in class GxClientModels.GxClientRowModel

Construct new client row


GxClientSortModel - class in GxClientModels

The sorting model describes how the columns will be sorted on the client


GxClientTransactionModel - class in GxClientModels

The model describes an transaction operation that can be passed to the grid to add / remove & update that data at once.


GxClientTransactionModel(BBjGridExWidget widget!) - constructor in class GxClientModels.GxClientTransactionModel

Construct new transaction model


GxColumn - class in GxColumns

The class holds the grid column props, it also introduces several helper methods to update the styles like, fore/back colors.


GxColumn(BBjString field!) - constructor in class GxColumns.GxColumn

Create a new column definition


GxColumn(BBjString field!, BBjString label!) - constructor in class GxColumns.GxColumn

Create a new column definition


GxColumn(BBjString field!, BBjNumber type!) - constructor in class GxColumns.GxColumn

Create a new column definition


GxColumn(BBjString field!, BBjString label! , BBjNumber type!) - constructor in class GxColumns.GxColumn

Create a new column definition


GxColumnDefinition - class in GxColumns

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

GxColumnFilterAG - class in GxFilters

The class holds the shared ag filter options between all filter types. This is the base class for all ag filter types


GxColumnFilterDateTimeFilterOptions - class in GxFilters

Filter options constants for date/time filter


GxColumnFilterNumberFilterOptions - class in GxFilters

Filter options constants for numbers filter


GxColumnFilterTextFilterOptions - class in GxFilters

Filter options constants for texts filter


GxColumnGroup - class in GxColumns

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.


GxColumnGroup(BBjString id!) - constructor in class GxColumns.GxColumnGroup

Construct new GxColumnGroup


GxColumnGroup(BBjString id! , BBjString label!) - constructor in class GxColumns.GxColumnGroup

Construct new GxColumnGroup


GxColumnsManager - class in GxColumns

The class is a direct implementation for GxColumnsManagerInterface and it defines the common logic for all methods


GxColumnsManagerInterface - interface in GxColumns

The interface defines the common methods for columns and column groups management


GxColumnsToolpanel - class in GxSidebar

Columns Toolpanel


GxColumnsToolpanel() - constructor in class GxSidebar.GxColumnsToolpanel

Construct new columns toolpanel


GxColumnsToolpanel(BBjString label!) - constructor in class GxSidebar.GxColumnsToolpanel

Construct new toolpanel


GxColumnsToolpanel(BBjString label! , BBjString icon!) - constructor in class GxSidebar.GxColumnsToolpanel

Construct new toolpanel


GxContextMenu - class in GxContextMenu

A class which represents grid context menu


GxContextMenuItem - class in GxContextMenu

A class which represents a grid context menu item


GxContextMenuItem(BBjString id!) - constructor in class GxContextMenu.GxContextMenuItem

Construct new Menu item


GxContextMenuItem(BBjString id! , BBjString label!) - constructor in class GxContextMenu.GxContextMenuItem

Construct new Menu item


GxContextMenuItem(BBjNumber id! , BBjString label!) - constructor in class GxContextMenu.GxContextMenuItem

Construct new Menu item


GxContextMenuItemInterface - interface in GxContextMenu

An interface which defines a menu item


GxDefaultColumnDefinition - class in GxColumns

The class represents the default column definition which the grid will use.


GxDefaultColumnGroup - class in GxColumns

The class holds the default grid column group.


GxDefaultContextMenu - class in GxContextMenu

A class which represents the default grid context menu


GxDefaultContextMenu() - constructor in class GxContextMenu.GxDefaultContextMenu

Construct the default grid context menu


GxDefaultSidebar - class in GxSidebar

A class to define the default implementation of the grid sidebar


GxDefaultSidebar(BBjGridExWidget widget!) - constructor in class GxSidebar.GxDefaultSidebar

Construct the default grid sidebar


GxExecutor - class in BBjGridExWidget

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.


GxExecutor(BBjGridExWidget widget!, BBjNumber rate!) - constructor in class BBjGridExWidget.GxExecutor

Construct new GxExecutor object


GxExpression - class in GxExpressions

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:

  1. If your expression has the word return in it, then the grid will assume it is a multi-line expression and will not wrap it
  2. If a ValueGetterExpression does not have the word 'return' in it, then the grid will insert the 'return' statement and the ';' for you
  3. f your expression has many lines, then you will need to provide the ';' at the end of each line and also provide the 'return' statement.

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

GxExpression(BBjString expression!) - constructor in class GxExpressions.GxExpression

GxExpressionAbstract - class in GxExpressions

Abstract implementation for GxExpressionInterface


GxExpressionBytesFormatter - class in GxExpressions

The class defines a grid expression to format bytes to one of the following measuring terms : ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']


GxExpressionBytesFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionBytesFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionBytesFormatter(BBjString mask!, BBjString groupSeparator!) - constructor in class GxExpressions.GxExpressionBytesFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionBytesFormatter(BBjString mask!, BBjString groupSeparator!, BBjString decimalSeparator!) - constructor in class GxExpressions.GxExpressionBytesFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionDatesFormatter - class in GxExpressions

The class defines a grid expression to format date/timestamps according to BBj supported masks


GxExpressionDatesFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionDatesFormatter

Construct a new GxExpressionDatesFormatter


GxExpressionDatesFormatter(BBjString mask!, BBjString locale!) - constructor in class GxExpressions.GxExpressionDatesFormatter

Construct a new GxExpressionDatesFormatter


GxExpressionDatesFormatter(BBjString mask!, BBjString locale!, BBjString timezone!) - constructor in class GxExpressions.GxExpressionDatesFormatter

Construct a new GxExpressionDatesFormatter


GxExpressionDateTimesFormatter - class in GxExpressions

The class defines a grid expression to format date/timestamps according to BBj supported masks


GxExpressionDateTimesFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionDateTimesFormatter

Construct a new GxExpressionDateTimesFormatter


GxExpressionDateTimesFormatter(BBjString mask!, BBjString locale!) - constructor in class GxExpressions.GxExpressionDateTimesFormatter

Construct a new GxExpressionDateTimesFormatter


GxExpressionDateTimesFormatter(BBjString mask!, BBjString locale!, BBjString timezone!) - constructor in class GxExpressions.GxExpressionDateTimesFormatter

Construct a new GxExpressionDateTimesFormatter


GxExpressionInterface - interface in GxExpressions

GxExpressionInterface


GxExpressionNumbersFormatter - class in GxExpressions

The class defines a grid expression to format numbers according to BBj supported masks


GxExpressionNumbersFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionNumbersFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionNumbersFormatter(BBjString mask!, BBjString groupSeparator!) - constructor in class GxExpressions.GxExpressionNumbersFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionNumbersFormatter(BBjString mask!, BBjString groupSeparator!, BBjString decimalSeparator!) - constructor in class GxExpressions.GxExpressionNumbersFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionStringsFormatter - class in GxExpressions

The class defines a grid expression to format strings according to BBj supported masks


GxExpressionStringsFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionStringsFormatter

Construct a new GxExpressionNumbersFormatter


GxExpressionTimestampsFormatter - class in GxExpressions

Alias for GxExpressionDateTimesFormatter


GxExpressionTimestampsFormatter(BBjString mask!) - constructor in class GxExpressions.GxExpressionTimestampsFormatter

Construct a new GxExpressionTimestampsFormatter


GxExpressionTimestampsFormatter(BBjString mask!, BBjString locale!) - constructor in class GxExpressions.GxExpressionTimestampsFormatter

Construct a new GxExpressionTimestampsFormatter


GxExpressionTimestampsFormatter(BBjString mask!, BBjString locale!, BBjString timezone!) - constructor in class GxExpressions.GxExpressionTimestampsFormatter

Construct a new GxExpressionTimestampsFormatter


GxFilterBasicBoolean - class in GxFilters

The class represents the boolean filter


GxFilterBasicDate - class in GxFilters

The class represents the date filter


GxFilterBasicDate() - constructor in class GxFilters.GxFilterBasicDate

Construct a new GxFilterBasicDateTime


GxFilterBasicDate(BBjString mask!) - constructor in class GxFilters.GxFilterBasicDate

Construct new GxFilterBasicDate


GxFilterBasicDateTime - class in GxFilters

The class represents the date time filter


GxFilterBasicDateTime(BBjString mask!) - constructor in class GxFilters.GxFilterBasicDateTime

Construct new GxFilterBasicDateTime


GxFilterBasicTime - class in GxFilters

The class represents the time filter


GxFilterBasicTime() - constructor in class GxFilters.GxFilterBasicTime

Construct a new GxFilterBasicTime


GxFilterBasicTime(BBjString mask!) - constructor in class GxFilters.GxFilterBasicTime

Construct new GxFilterBasicTime


GxFilterBasicTimestamp - class in GxFilters

Alias for GxFilterBasicDateTime


GxFilterBasicTimestamp(BBjString mask!) - constructor in class GxFilters.GxFilterBasicTimestamp

Construct new GxFilterBasicTimestamp


GxFilterComparator - class in GxFilters

Compare two filter components


GxFilterDate - class in GxFilters

The class represents the default ag-grid date filter


GxFilterDate() - constructor in class GxFilters.GxFilterDate

GxFilterInterface - interface in GxFilters

Column Filter Public Interface


GxFilterNumber - class in GxFilters

The class represents the default ag-grid number filter


GxFilterSetFilter - class in GxFilters

GxFilterSetFilter allow you to filter on set data, influenced by how filters work in Microsoft Excel


#Enterprise


GxFiltersToolpanel - class in GxSidebar

A class which represents the filters toolpanel


GxFiltersToolpanel() - constructor in class GxSidebar.GxFiltersToolpanel

Construct new filters toolpanel


GxFiltersToolpanel(BBjString label!) - constructor in class GxSidebar.GxFiltersToolpanel

Construct new filters toolpanel


GxFiltersToolpanel(BBjString label! , BBjString icon!) - constructor in class GxSidebar.GxFiltersToolpanel

Construct new filters toolpanel


GxFilterText - class in GxFilters

The class represents the default ag-grid text filter


GxLanguageManager - class in BBjGridExWidget

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() - constructor in class BBjGridExWidget.GxLanguageManager

GxLanguageManager

Construct a new GxLanguageManager instance


GxLogger - class in BBjGridExWidget

A logger class which is used internally to output log , warn , error messages to the console and to the debug.log file


GxOptions - class in GxOptions

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

GxOptions(BBjGridExWidget widget!) - constructor in class GxOptions.GxOptions

Construct new GxOptions instance


GxOptionsBoolean - class in GxOptions

The class defines the common boolean options shared between components which manipulate booleans


GxOptionsBoolean() - constructor in class GxOptions.GxOptionsBoolean

Construct new GxOptionsBoolean


GxOptionsDateTime - class in GxOptions

The class defines the common date time options shared between components which manipulate dates , times & timestamps


GxRendererAbstract - class in GxRenderers

Abstract implementation for GxRendererInterface


GxRendererBoolean - class in GxRenderers

The class represents a boolean cell renderer


GxRendererCustomHTML - class in GxRenderers

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.


GxRendererCustomHTML(BBjString template!) - constructor in class GxRenderers.GxRendererCustomHTML

Construct new GxRendererCustomHTML


GxRendererGroupCellRenderer - class in GxRenderers

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.


GxRendererGroupCellRenderer(GxExpressionInterface footerValueGetterExpression!) - constructor in class GxRenderers.GxRendererGroupCellRenderer

Construct new GxRendererGroupCellRenderer


GxRendererGroupCellRenderer(BBjString footerValueGetterExpression!) - constructor in class GxRenderers.GxRendererGroupCellRenderer

Construct new GxRendererGroupCellRenderer


GxRendererImageRenderer - class in GxRenderers

The renderer can be used to display a list of images based on the cells values using a json object


GxRendererImageRenderer(JsonObject list!) - constructor in class GxRenderers.GxRendererImageRenderer

Construct new GxRendererImageRenderer


GxRendererInterface - interface in GxRenderers

GxRendererInterface


GxSidebar - class in GxSidebar

The class manages the grid sidebar and its toolpanels


GxSidebar(BBjGridExWidget widget!) - constructor in class GxSidebar.GxSidebar

Construct new sidebar


GxState - class in BBjGridExWidget

The Grid state object


GxState(BBjString String$) - constructor in class BBjGridExWidget.GxState

GxStatusBar - class in GxStatusBar

GxStatusBar

Gx status bar manager. The class can add, remove & hide status bar components


GxStatusBar(BBjGridExWidget widget!) - constructor in class GxStatusBar.GxStatusBar

Construct new sidebar


GxStatusBarAggregationComponent - class in GxStatusBar

A statusbar component which provides aggregations on the selected range.


GxStatusBarAggregationComponent() - constructor in class GxStatusBar.GxStatusBarAggregationComponent

Construct new Aggregation Component


GxStatusBarAggregationComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarAggregationComponent

Construct new Aggregation Component


GxStatusBarComponent - class in GxStatusBar

An Abstract implementation for GxStatusBarComponentInterface


GxStatusBarComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarComponent

Constructor


GxStatusBarComponentInterface - interface in GxStatusBar

An interface which defines a status bar component


GxStatusBarFilteredRowCountComponent - class in GxStatusBar

A statusbar component which provides the filtered row count.


GxStatusBarFilteredRowCountComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarFilteredRowCountComponent

Constructor


GxStatusBarSelectedRowCountComponent - class in GxStatusBar

A statusbar component which provides the selected row count


GxStatusBarSelectedRowCountComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarSelectedRowCountComponent

Constructor


GxStatusBarTotalAndFilteredRowCountComponent - class in GxStatusBar

A statusbar component which provides the total and filtered row count.


GxStatusBarTotalAndFilteredRowCountComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarTotalAndFilteredRowCountComponent

Constructor


GxStatusBarTotalRowCountComponent - class in GxStatusBar

A statusbar component which provides the total row count.


GxStatusBarTotalRowCountComponent(BBjString alignment!) - constructor in class GxStatusBar.GxStatusBarTotalRowCountComponent

Constructor


GxToolpanel - class in GxSidebar

An abstract class which represents a toolpanel which can be attached to a sidebar


GxToolpanel(BBjString label!) - constructor in class GxSidebar.GxToolpanel

Construct new toolpanel


GxToolpanel(BBjString label! , BBjString icon!) - constructor in class GxSidebar.GxToolpanel

Construct new toolpanel


GxToolpanelInterface - interface in GxSidebar

A interface which defines a grid toolpanel


H

HAlignCenter! - field in class Dashboard.ChartWidget

A constant to define horizontal alignment of the chart legend's container


HAlignLeft! - field in class Dashboard.ChartWidget

A constant to define horizontal alignment of the chart legend's container


HAlignRight! - field in class Dashboard.ChartWidget

A constant to define horizontal alignment of the chart legend's container


handleResource(String p_id!, byte[] p_byteArray!) - method in class BBJasper.BBJasperHtmlResourceHandler

hasChildren() - method in class TreeNode

hasColumn(BBjString field!) - method in class BBjGridExWidget.BBjGridExWidget

Check if the column definition exists


#Configuration
#ColumnsRenderer


hasColumn(BBjString field!) - method in class GxColumns.GxColumnsManagerInterface

Check if the column definition exists


#Configuration
#ColumnsRenderer


hasColumn(BBjString field!) - method in class GxColumns.GxColumnsManager

Check if the column definition exists


#Configuration
#ColumnsRenderer


hasColumn(BBjString field!) - method in class GxColumns.GxColumnGroup

Check if the column definition exists


#Configuration
#ColumnsRenderer


hasColumnGroup(BBjString id!) - method in class BBjGridExWidget.BBjGridExWidget

Check if the column group definition exists


#Configuration
#ColumnsRenderer


hasColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManagerInterface

Check if the column group definition exists


#Configuration
#ColumnsRenderer


hasColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManager

Check if the column group definition exists


#Configuration
#ColumnsRenderer


hasColumnGroup(BBjString id!) - method in class GxColumns.GxColumnGroup

Check if the column group definition exists


#Configuration
#ColumnsRenderer


hasLegend() - method in class Dashboard.ChartWidget

Indicates whether the chart has a legend


HeaderCheckboxSelection! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to render a selection checkbox in the column's header.


#Configuration
#ColumnsRenderer


HeaderCheckboxSelectionFilteredOnly! - field in class GxColumns.GxDefaultColumnDefinition

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


HeaderClass! - field in class GxColumns.GxColumnDefinition

CSS class(es) to use for the header cell.


#Configuration
#ColumnsRenderer


HeaderFont! - field in class Dashboard.GridExWidget

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


HeaderFont! - field in class Dashboard.GridWidget

A BBjFont that is applied to the header in the underlying BBjGrid control, allowing customization of the font family, size, and style


HeaderGroupTooltip! - field in class GxColumns.GxDefaultColumnGroup

Tooltip for the column group header


HeaderHeight! - field in class GxOptions.GxOptions

The height for the row containing the column label header. If not specified the default is 25px.
#Configuration
#GridRenderer


Headers!=BBjAPI().makeVector() - field in class BBWebClient.BBWebRequest

A vector of BBHeader. These are name/value pairs that provide the web server with additional information about the request.


HeaderTooltip! - field in class GxColumns.GxColumnDefinition

Tooltip for the column header


#Configuration
#ColumnsRenderer


Height - field in class BBXImage.BBXImage

Height - field in class Dashboard.JasperViewerWidget

Height


Height! - field in class GxCellEditors.GxCellEditorSuggestion

Setup the suggestion list height in pixels


Height! - field in class GxRenderers.GxRendererImageRenderer

The image's height


Hidden! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to make a column hidden by default.


#Configuration
#ColumnsRenderer


HiddenByDefault! - field in class GxSidebar.GxSidebar

When true, the sidebar will be hidden on the first draw, visible otherwise. default is false


hide() - method in class WidgetWizardFrameIntf

Method hide: Hide frame


hide() - method in class WidgetWizardFrame

Method hide: Hide frame


hide() - method in class DialogWizard.DialogWizardFrame

Method hide: Hide frame


hide() - method in class DialogWizard.DialogWizardFrameIntf

Method hide: Hide frame


hideOverlay() - method in class BBjGridExWidget.BBjGridExWidget

Clear all overlays


#API


HIGHLIGHT$=#Translations!.getTranslation("highlight") - field in class BBJasper.BBJasperView

Translated text for highlight


hitBottom(BBjGridHitBottomEvent ev!) - method in class QVGrid.QVGrid

Hit bottom event handler


hitTop(BBjGridHitTopEvent ev!) - method in class QVGrid.QVGrid

Hit top event handler


HOME$=#Translations!.getTranslation("home") - field in class BBJasper.BBJasperView

Translated text for home


HORIZONTAL_ALIGNMENT_CENTER - field in class Dashboard.GridExWidget

A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods


HORIZONTAL_ALIGNMENT_CENTER - field in class Dashboard.GridWidget

A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable


HORIZONTAL_ALIGNMENT_LEFT - field in class Dashboard.GridExWidget

A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods


HORIZONTAL_ALIGNMENT_LEFT - field in class Dashboard.GridWidget

A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable


HORIZONTAL_ALIGNMENT_RIGHT - field in class Dashboard.GridExWidget

A constant to define grid cell horizontal alignment, used in conjunction with the setColumnAlignment(), setColumnHeaderAlignment(), and pinColumn() methods


HORIZONTAL_ALIGNMENT_RIGHT - field in class Dashboard.GridWidget

A constant to define grid cell horizontal alignment, used in conjunction with the HorizontalAlignment field variable


HorizontalAlignment - field in class Dashboard.GridWidget

A number that determines the default horizontal alignment for cells in the grid. The default value is BBjGrid.GRID_ALIGN_CENTER


HorizontalHeaderAlignment - field in class Dashboard.GridWidget

A number that determines the default horizontal alignment for column header cells in the grid. The default value is BBjGrid.GRID_ALIGN_CENTER.


HorizontalScrollable - field in class Dashboard.GridWidget

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.


Host$ - field in class UserCredentials

Host$ - field in class BBJasper.BBJasperDesigner

Host$="localhost" - field in class AdminLoginDialog

Host$=#DEFAULT_HOST$ - field in class Admin

HostRequiredValue - field in class Admin

HOURS=2 - field in class Dashboard.AutoRefreshUnit

Constant for hours


HTML_SAVE_CONTRIBUTOR=2 - field in class BBJasper.BBJasperView

Constant that represents the HTML save contributor


HTML_SAVE_CONTRIBUTOR=BBJasperView.getHTML_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the HTML save contributor


HTML_VIEW$ - field in class WidgetWizard

HTML_VIEW_WIDGET_TYPE - field in class Dashboard.DashboardWidget

HTML View chart widget type constant


HTMLExporter! - field in class BBJasper.BBJasperView

HTML exporter which contains export options


HTMLView! - field in class BBjCalendarWidget.BBjJavaScriptExecutor

The BBjHtmlView control that will execute the JavaScript.


HTMLView! - field in class BBjGridExWidget.BBjGridExWidget

Instance of the created HTMLView


HtmlViewWidget - class in Dashboard

HtmlViewWidget A Dashboard Utility Widget that displays html text or the contents of a URL


HtmlViewWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - constructor in class Dashboard.HtmlViewWidget

Creates an HtmlViewWidget


HtmlViewWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_text$) - constructor in class Dashboard.HtmlViewWidget

Creates an HtmlViewWidget


HtmlViewWidgetEvent - class in Dashboard

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


HtmlViewWidgetEvent(Widget p_widget!, BBjSysGuiEvent p_sysguiEvent!) - constructor in class Dashboard.HtmlViewWidgetEvent

Constructs a HtmlViewWidgetEvent


Hyperlink! - field in class BBJasper.BBJasperHyperlink

HYPERLINK_PRODUCER_FACTORY$ - field in class BBJasper.BBJasperExporterParameter

HyperlinkTarget - field in class BBJasper.BBJasperHyperlink

HyperlinkType - field in class BBJasper.BBJasperHyperlink

I

ICalUID!=null() - field in class gappsv3.GCalendar

Filter for getEvents() method: Specifies event ID in the iCalendar format to be included in the response. Optional. (string)


Icon! - field in class GxContextMenu.GxContextMenuItem

The icon to display beside the icon, either a DOM element or HTML string


Icons! - field in class GxColumns.GxDefaultColumnDefinition

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! - field in class GxOptions.GxOptions

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
 
 

ID() - method in class GxSidebar.GxToolpanelInterface

Get the toolbar unique name


ID() - method in class GxSidebar.GxColumnsToolpanel
{@inheritDoc}

ID() - method in class GxSidebar.GxFiltersToolpanel
{@inheritDoc}

Id! - field in class GxClientModels.GxClientRowModel

The row id


IGNORE_PAGE_MARGINS$ - field in class BBJasper.BBJasperExporterParameter

IgnoreWhitespace - field in class BBXMLDoc

IMAGE$ - field in class WidgetWizard

IMAGE_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Image widget type constant


imageFileSaveDialog() - method in class Dashboard.BaseWidget

imageFileSaveDialog Displays a file save dialog to save a client image file.


ImageList$ - field in class Dashboard.Dashboard

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:

  • Widget Toolbar Popout
  • Widget Toolbar Configure
  • Widget Toolbar Close
  • DashboardWidget Customize
  • DashboardWidget Refresh
  • DashboardWidget Close
  • Customize Window Left Arrow
  • Customize Window Right Arrow
  • Customize Window Widget Already Active / AutoRefresh OK
  • Customize Window Add Widget

ImageList$ - field in class Dashboard.DashboardWidget

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.


ImageListHiRes$ - field in class Dashboard.Dashboard

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.


ImageListHiRes$ - field in class Dashboard.DashboardWidget

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.


imageToBase64(BBjString filename!) - method in class BBjGridExWidget.BBjGridExWidget

Convert the image at the given path to base64 string


ImageWidget - class in Dashboard

ImageWidget A Dashboard Utility Widget that displays an image retrieved from a file path or a URL


ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - constructor in class Dashboard.ImageWidget

Creates an ImageWidget without an image, which defaults to a transparent image


ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$) - constructor in class Dashboard.ImageWidget

Creates an ImageWidget specifying an image file for the image source


ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!) - constructor in class Dashboard.ImageWidget

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.


ImmutableColumns! - field in class GxOptions.GxOptions

Puts the grid into Immutable Column mode, so that setting new columns keeps column state. Default: false


#Configuration
#GridRenderer


IN_RANGE() - method in class GxFilters.GxColumnFilterDateTimeFilterOptions

INCH_UNITS=0 - field in class BBJasper.BBJasperPrintMediaSizeName

Constant that represents that inches should be used for units


IncludeBlanksInEquals! - field in class GxFilters.GxFilterNumber

If true then blank (null or undefined) values will pass the 'equals' filter option.


IncludeBlanksInGreaterThan! - field in class GxFilters.GxFilterNumber

If true then blank (null or undefined) values will pass the 'greaterThan' and 'greaterThanOrEqual' filter options.


IncludeBlanksInLessThan! - field in class GxFilters.GxFilterNumber

If true then blank (null or undefined) values will pass the 'lessThan' and 'lessThanOrEqual' filter options.


includeClientRowDataInRowModels(BBjNumber include!) - method in class BBjGridExWidget.BBjGridExWidget

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


INCREMENTAL_FIND$=#Translations!.getTranslation("incremental.find") - field in class BBJasper.BBJasperView

Translated text for incremental find


Index - field in class BBJasper.FindElement

Index! - field in class GxClientModels.GxClientRowModel

The row index


Index=-1 - field in class Dashboard.Series

INFO() - method in class BBjGridExWidget.GxLogger

Constant value to define "info" log messages


init() - method in class GDocsService

initFrame() - method in class WidgetWizardFrameIntf

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame1

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame2

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame3

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame4

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame5

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame6

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame7

Method initFrame: Frame initialization


initFrame() - method in class WidgetWizardFrame8

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrame

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrame1

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrame2

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrame3

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrame4

Method initFrame: Frame initialization


initFrame() - method in class DialogWizard.DialogWizardFrameIntf

Method initFrame: Frame initialization


initialize(HttpRequest request!) - method in class gappsv3.GAppsAuthorization

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.


initialize(BBjString p_archive$, BBjNumber p_allowClientConfig, BBjNumber p_visible) - method in class BBLaunchDock

injectCss(BBjString css!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


injectCss(BBjString css!, BBjString location!, BBjString description!, BBjNumber removePrevious!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


injectCss(BBjString css!, BBjString location!, BBjString description!, BBjNumber removePrevious!, BBjHtmlView htmlView!) - method in class DemoUtils.DemoUtils

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.


injectCssFile(BBjString cssPath!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


injectCssFile(BBjString cssPath!, BBjString location!, BBjString description!, BBjNumber removePrevious!, BBjHtmlView htmlView!) - method in class DemoUtils.DemoUtils

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.


injectJavaScriptLibrary(BBjString p_library$, BBjHtmlView p_htmlView!) - method in class DemoUtils.DemoUtils

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.


injectJQuery(BBjHtmlView p_htmlView!) - method in class DemoUtils.DemoUtils

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.


injectScript(BBjString p_script$) - method in class Dashboard.HtmlViewWidget

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.


injectScript(BBjString script!) - method in class BBjCalendarWidget.BBjCalendarWidget

Injects the provided JavaScript string at the top-level window.


injectScript(BBjString script!, BBjNumber top!) - method in class BBjGridExWidget.BBjGridExWidget

Inject a js Script.


injectScript(BBjString script!) - method in class BBjGridExWidget.BBjGridExWidget

Inject a js Script at the top window (iframe's parent window if any).


injectScriptFile(BBjString scriptPath!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


injectScripts(BBjString p_script$, BBjString p_poppedOutScript$) - method in class Dashboard.HtmlViewWidget

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.


injectUrl(BBjString p_url$) - method in class Dashboard.HtmlViewWidget

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.


injectUrl(BBjString url!) - method in class BBjCalendarWidget.BBjCalendarWidget

Injects the specified JavaScript URL into the HTML DOM, making it available for subsequent use by client-side JavaScript.


injectUrls(BBjString p_url$, BBjString p_poppedOutUrl$) - method in class Dashboard.HtmlViewWidget

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.


InnerRenderer! - field in class GxRenderers.GxRendererGroupCellRenderer

Provide an inner renderer


INPUT_FILE$ - field in class BBJasper.BBJasperExporterParameter

INPUT_FILE_NAME$ - field in class BBJasper.BBJasperExporterParameter

INPUT_STREAM$ - field in class BBJasper.BBJasperExporterParameter

INPUT_URL$ - field in class BBJasper.BBJasperExporterParameter

InRangeInclusive! - field in class GxFilters.GxFilterNumber

If true then doing 'inRange' filter option will include values equal to the start and end of the range.


InRangeInclusive! - field in class GxFilters.GxFilterBasicDateTime

If true then doing 'inRange' filter option will include values equal to the start and end of the range.


INSENSITIVE$=#Translations!.getTranslation("insensitive") - field in class BBJasper.BBJasperView

Translated text for insensitive


insertColumn(BBjNumber index) - method in class QVGrid.QVGrid

Inserts a column


insertRow(BBjNumber index) - method in class QVGrid.QVGrid

Inserts a row


Interval!=null() - field in class gappsv3.SimpleRULE

Interval. If frequency is set to "WEEKLY" and Interval is set to 3, then the recurrence or exception is once every 3 weeks.


is3D() - method in class Dashboard.ChartWidget

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.


isActive() - method in class Dashboard.DashboardWidget

Returns that active status


isActive() - method in class Dashboard.WidgetControl

Returns the active status of the widget control


IsAltDown! - field in class GxClientModels.GxClientKeypressModel

A Boolean that is true if the Alt key was active when the key event was generated.


isAnyoneCanAddSelf() - method in class gappsv3.GEvent

Alias to getAnyoneCanAddSelf()


isAreaChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is an Area Chart


isAttendeesOmitted() - method in class gappsv3.GEvent

Alias to getAttendeesOmitted()


isAuthenticated(BBjNumber p_promptForAuth) - method in class GAppsService

isAutoRefreshConfigurationMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the auto refresh configuration menu item in the options menu


isAutoRefreshEnabled() - method in class Dashboard.DashboardWidget

Returns if auto refresh is enabled or disabled


isAutoRefreshMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the auto refresh menu item in the options menu


isBarChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Bar Chart


isBuiAndroidDevice() - method in class BBUtils.BBUtils

Indicates if BBj is running in a BUI environment in Android as determined by the client browser's user agent string.


isBuiIosDevice() - method in class BBUtils.BBUtils

Indicates if BBj is running in a BUI environment in iOS as determined by the client browser's user agent string.


isBuiTouchSupported() - method in class BBUtils.BBUtils

Indicates if BBj is running in a touch-enabled environment or not as determined by the BBjBuiManager.


isCellEditable(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Returns whether a cell is editable


IsCircular - field in class Dashboard.PieChartWidget

A number indicating whether the pie chart is circular or stretched into an elliptical shape


isClientBBjInstalled() - method in class BBConfig

isClientWindowsOS() - method in class BBConfig

isCloseButtonEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the close button in the widget control


isCloseEnabled() - method in class Dashboard.DashboardWidget

Returns if close is enabled or disabled


isColumnEditable(BBjNumber column) - method in class QVGrid.QVGrid

Returns whether a column is editable Note: The QVGird is not editable, so this method always returns FALSE


isColumnSortedByRelatedData(BBjNumber column) - method in class QVGrid.QVGrid

Returns an indication of whether a given column is sorted by related data rather than by cell text


isColumnUserSortable(BBjNumber column) - method in class QVGrid.QVGrid

Returns whether the grid sorts a specified column when the user clicks in the header of that column


isColumnVisible(BBjNumber column) - method in class QVGrid.QVGrid

Returns whether a column is visible


isControlContainer() - method in class WidgetWizard

Method isControlContainer: Returns if the container is a control


IsCtrlDown! - field in class GxClientModels.GxClientKeypressModel

A Boolean that is true if the Ctrl key was active when the key event was generated.


isDataAware() - method in class QVGrid.QVGrid

Returns whether the grid is data aware Note: The QVGird is a BBjStandardGrid, so this method returns FALSE.


isDataBound() - method in class QVGrid.QVGrid

Returns whether the grid is data bound Note: The QVGird cannot be configured as a data bound control, so this method returns FALSE.


isDataSetEmpty() - method in class Dashboard.ChartWidget

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.


isDefault() - method in class BBTranslator.BBTranslations

Returns true if this is the default translations, otherwise false is returned


isDeleted() - method in class gappsv3.GCalendar

Indicates whether this calendar has been deleted.


isDestroyed() - method in class Dashboard.DashboardWidget

Returns if the widget is destroyed


isDestroyed() - method in class Dashboard.WidgetControl

Returns if the widget control is destroyed


isDestroyed() - method in class Dashboard.EmbeddedWidgetWindow

Returns if the EmbeddedWidgetWindow is destroyed


isDestroyed() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns if the EmbeddedWidgetSetWindow is destroyed


isDestroyed() - method in class Dashboard.Widget

Called to determine if the widget is destroyed


isDestroyed() - method in class Dashboard.BaseWidget

Determins if the widget is destroyed


isDestroyed() - method in class Dashboard.BBjWidget

Returns whether the BBjWidget is destroyed


isDestroyed() - method in class Dashboard.ImageWidget

Returns if the ImageWidget is destroyed


isDestroyed() - method in class Dashboard.HtmlViewWidget

Returns if the HtmlViewWidget is destroyed


isDestroyed() - method in class Dashboard.GridExWidget

Returns if the GridExWidget is destroyed


isDestroyed() - method in class Dashboard.GridWidget

Returns if the GridWidget is destroyed


isDestroyed() - method in class Dashboard.PieChartWidget

Returns if the PieChartWidget is destroyed


isDestroyed() - method in class Dashboard.BarChartWidget

Returns if the BarChartWidget is destroyed


isDestroyed() - method in class Dashboard.LineChartWidget

Returns if the LineChartWidget is destroyed


isDestroyed() - method in class Dashboard.JasperViewerWidget

Returns if the JasperViewerWidget is destroyed


isDestroyed() - method in class QVGrid.QVGrid

Returns whether the QVGrid component child window has been destroyed


isDraggingEnabled() - method in class Dashboard.WidgetControl

Returns the dragging enable status of the widget control


isEditable() - method in class QVGrid.QVGrid

Returns whether the grid is editable Note: The QVGrid is not editable, so this always returns FALSE.


isEditing() - method in class QVGrid.QVGrid

Returns whether the grid is currently in edit mode Note: The QVGird is not editable, so this method always returns FALSE


isEmailEnabled() - method in class Dashboard.DashboardWidget

Returns if email is enabled or disabled


isEmailMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the email menu item in the options menu


isEmpty() - method in class Dashboard.GridExWidget

Indicates whether the widget's dataset is empty or not


isEmpty() - method in class Dashboard.GridWidget

Indicates whether the widget's dataset is empty or not


isEmpty() - method in class Dashboard.PieChartWidget

Indicates whether the widget's dataset is empty or not


isEmpty() - method in class Dashboard.BarChartWidget

Indicates whether the widget's dataset is empty or not


isEmpty() - method in class Dashboard.LineChartWidget

Indicates whether the widget's dataset is empty or not


isEmpty() - method in class Dashboard.XYChartWidget

Indicates whether the widget's dataset is empty or not


isEnabled() - method in class QVGrid.QVGrid

Returns whether the grid control is enabled


isEnabled() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns whether the widget is enabled or disabled.


isEndTimeUnspecified() - method in class gappsv3.GEvent

Alias to getEndTimeUnspecified()


isEnterAsTab() - method in class QVGrid.QVGrid

Returns whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]


isExportDataEnabled() - method in class Dashboard.DashboardWidget

Returns if export data is enabled or disabled


isExportDataMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the export data menu item in the options menu


isFilterActive() - method in class GxClientModels.GxClientFilterModel

Check if the filter is action or not


#API


isFilterActive() - method in class GxClientModels.GxClientFilterAbstractModel

Check if the filter is action or not


#API


isFitToGrid() - method in class QVGrid.QVGrid

Returns all columns are fitted into the displayed width of the grid


isFlat() - method in class Dashboard.ChartWidget

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.


isFocusable() - method in class QVGrid.QVGrid

Returns a value indicating whether or not the user can focus the grid control


isFolder() - method in class GDoc

isGridEditable() - method in class QVGrid.QVGrid

This method is deprecated. Use isEditable() instead. Note: The QVGrid is not editable, so FALSE is always returned.


isGrouped() - method in class QVGrid.QVGrid

see BBjControl


isGuestsCanInviteOthers() - method in class gappsv3.GEvent

Alias to getGuestsCanInviteOthers()


isGuestsCanModify() - method in class gappsv3.GEvent

Alias to getGuestsCanModify()


isGuestsCanSeeOtherGuests() - method in class gappsv3.GEvent

Alias to getGuestsCanSeeOtherGuests()


isLicensed() - method in class BBjGridExWidget.BBjGridExWidget

The method will check whether the grid has license key or not.


isLineChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Line Chart


isLocked() - method in class gappsv3.GEvent

Alias to getLocked()


isManualRefreshMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the manual refresh menu item in the options menu


isMultipleSelectionAllowed() - method in class QVGrid.QVGrid

Returns whether multiple selection is allowed


isOpaque() - method in class QVGrid.QVGrid

Returns the opaque property of the grid control


isOptional() - method in class gappsv3.GEventAttendee

Alias to getOptional()


isOptionsButtonEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the options button in the widget control


isOptionsEnabled() - method in class Dashboard.DashboardWidget

Returns if the options is enabled or disabled


isPaging() - method in class QVGrid.QVGrid

Returns whether the grid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no meaning


isPieChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Pie Chart


isPopoutButtonEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the popout button in the widget control


isPopoutEnabled() - method in class Dashboard.DashboardWidget

Returns if the poput is enabled or disabled


isPrimary() - method in class gappsv3.GCalendar

Specifies whether this is the user's default calendar. There is one primary calendar per Google Account.


isPrivateCopy() - method in class gappsv3.GEvent

Alias to getPrivateCopy()


IsReady! - field in class BBjGridExWidget.BBjGridExWidget

A flag which defines when the grid is ready and the process events started


isRecordSetBased() - method in class Dashboard.GridExWidget

Indicates whether the widget's dataset was built from a BBjRecordSet


isRecordSetBased() - method in class Dashboard.GridWidget

Indicates whether the widget's dataset was built from a BBjRecordSet


isRecordSetBased() - method in class Dashboard.PieChartWidget

Indicates whether the widget's dataset was built from a BBjRecordSet


isRecordSetBased() - method in class Dashboard.BarChartWidget

Indicates whether the widget's dataset was built from a BBjRecordSet


isRecordSetBased() - method in class Dashboard.LineChartWidget

Indicates whether the widget's dataset was built from a BBjRecordSet


isRecordSetBased() - method in class Dashboard.XYChartWidget

Indicates whether the chart's dataset was built from a BBjRecordSet


isRefreshEnabled() - method in class Dashboard.DashboardWidget

Returns if refresh is enabled or disabled


isRefreshMenuEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the refresh menu in the options menu


isRefreshMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the refresh menu item in the options menu


isResource() - method in class gappsv3.GEventAttendee

Alias to getResource()


isRingChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Ring Chart


isRowEditable(BBjNumber row) - method in class QVGrid.QVGrid

Returns whether a row is editable Note: The QVGrid is not editable, so FALSE is always returned.


isRowVisible(BBjNumber row) - method in class QVGrid.QVGrid

Returns whether a row is currently visible in the grid


isSaveEnabled() - method in class Dashboard.DashboardWidget

Returns if save is enabled or disabled


isSaveMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the save menu item in the options menu


isSelected() - method in class Dashboard.DashboardWidget

Returns that selected status


isSelected() - method in class gappsv3.GCalendar

Indicates whether the calendar is selected.


IsSelected! - field in class GxClientModels.GxClientRowModel

True when the row is selected, false otherwise


isSelectEnabled() - method in class Dashboard.WidgetControl

Returns the selectability of the widget control


isSelf() - method in class gappsv3.GEventAttendee

Alias to getSelf()


isServerBBjInstalled() - method in class BBConfig

isServerWindowsOS() - method in class BBConfig

IsShiftDown! - field in class GxClientModels.GxClientKeypressModel

A Boolean that is true if the Shift key was active when the key event was generated.


isSQLBased() - method in class Dashboard.GridExWidget

Indicates whether the widget's dataset was built from an SQL query


isSQLBased() - method in class Dashboard.GridWidget

Indicates whether the widget's dataset was built from an SQL query


isSQLBased() - method in class Dashboard.PieChartWidget

Indicates whether the widget's dataset was built from an SQL query


isSQLBased() - method in class Dashboard.BarChartWidget

Indicates whether the chart's dataset was built from an SQL query


isSQLBased() - method in class Dashboard.LineChartWidget

Indicates whether the chart's dataset was built from an SQL query


isSQLBased() - method in class Dashboard.XYChartWidget

Indicates whether the chart's dataset was built from an SQL query


isStackedAreaChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Stacked Area Chart


isStackedBarChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Stacked Bar Chart


isStackedPercentageBarChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is a Stacked Percentage Bar Chart


isTabTraversable() - method in class QVGrid.QVGrid

Returns a value indicating whether or not the user can navigate to the grid control using the tab key


isUpdateAvailable(BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%) - method in class BUS

isUserResizable() - method in class QVGrid.QVGrid

Returns whether the columns in the grid can be resized by the user


isUserValid(BBjString p_user$, BBjString p_password$) - method in class BUS

isVectorBased() - method in class Dashboard.GridExWidget

Indicates whether the widget's dataset was built from BBjVectors for the column header and row data


isViewDataEnabled() - method in class Dashboard.DashboardWidget

Returns if view data is enabled or disabled


isViewDataMenuItemEnabled() - method in class Dashboard.WidgetControl

Returns the enable status of the view data menu item in the options menu


isVisible() - method in class Dashboard.EmbeddedWidgetWindow

Returns the visiblity of the EmbeddedWidgetWindow


isVisible() - method in class Dashboard.EmbeddedWidgetSetWindow

Returns the visiblity of the EmbeddedWidgetSetWindow


isVisible() - method in class QVGrid.QVGrid

Returns whether the QVGrid component child window is visible


isVisible() - method in class BBjCalendarWidget.BBjCalendarWidget

Returns whether the widget is visible or hidden.


isVPRO5Installed() - method in class BBConfig

isWebGui() - method in class BBjGridExWidget.BBjGridExWidget

isWebServerEnabled() - method in class BBUtils.BBUtils

Returns a number indicating whether the Web Server is enabled or not


isWebServerEnabled() - method in class BBLaunchDock

isWebServerHttpEnabled() - method in class BBUtils.BBUtils

Returns a number indicating whether the Web Server has enabled the HTTP protocol or not


isWebServerHttpEnabled() - method in class BBLaunchDock

isWebServerSSLEnabled() - method in class BBUtils.BBUtils

Returns a number indicating whether the Web Server has enabled the SSL protocol or not


isWebServerSSLEnabled() - method in class BBLaunchDock

isWellFormed(BBjString xmlFileName$) - method in class BBXMLDoc

isWidgetBuildType() - method in class WidgetWizard

Method isWidgetBuildType: Returns if the build type is a widget


isWidgetDashboardBuildType() - method in class WidgetWizard

Method isWidgetDashboardBuildType: Returns if the build type is a widget dashboard


isWidgetSetBuildType() - method in class WidgetWizard

Method isWidgetSetBuildType: Returns if the build type is a widget set


isWindowContainer() - method in class WidgetWizard

Method isWindowContainer: Returns if the container is a window


isXYChart() - method in class Dashboard.ChartWidget

Indicates whether the chart is an XY Chart


Item! - field in class Dashboard.XYSeriesDataItem

The item number of the data item


J

JASPER_PRINT$ - field in class BBJasper.BBJasperExporterParameter

JASPER_PRINT_LIST$ - field in class BBJasper.BBJasperExporterParameter

JASPER_VIEWER$ - field in class WidgetWizard

JASPER_VIEWER_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Jasper Viewer widget type constant


JasperDesign! - field in class BBJasper.BBJasperDesign

JasperViewerWidget - class in Dashboard

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


JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) - constructor in class Dashboard.JasperViewerWidget

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.


JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!) - constructor in class Dashboard.JasperViewerWidget

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.


JasperViewerWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) - constructor in class Dashboard.JasperViewerWidget

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 - class in Dashboard

JasperViewerWidgetControlEvent Contains information for a jasper viewer widget control event


JasperViewerWidgetControlEvent(Widget p_widget!, BBjSysGuiEvent p_sysguiEvent!) - constructor in class Dashboard.JasperViewerWidgetControlEvent

Constructs a jasper viewer widget control event


JAVA_HOME_PROPERTY$="java.home" - field in class BBConfig

JDBC_CONNECTIONS - field in class Admin

JQueryFileLocation$ - field in class DemoUtils.DemoUtils

A BBjString that defines the fully-qualified path to the jQuery library


JQuerySlimFileLocation$ - field in class DemoUtils.DemoUtils

A BBjString that defines the fully-qualified path to the jQuery library's 'slim' build, which excludes the ajax and effects modules


JQueryUIFileLocation$ - field in class DemoUtils.DemoUtils

A BBjString that defines the fully-qualified path to the jQuery UI library


JQueryUITouchFileLocation$ - field in class DemoUtils.DemoUtils

A BBjString that defines the fully-qualified path to the jQueryUI Touch library


K

Key! - field in class Dashboard.KeyedValueDataItem

The key of the data item


Key! - field in class GxClientEvents.GxClientEventsRowSelection

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()


Key! - field in class GxClientEvents.GxClientEventsKeypress

A keypress model which is received from the client


Key$ - field in class Dashboard.DashboardWidgetFilter

Filter key


KeyCode! - field in class GxClientModels.GxClientKeypressModel

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 - class in Dashboard

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:

  • BBjString key$
  • Number value!

KeyedValueDataItem(BBjString p_key$, Number p_value!) - constructor in class Dashboard.KeyedValueDataItem

Contructs a KeyedValueDataItem


keySet() - method in class GDocsResultSet

L

Label! - field in class GxColumns.GxColumnDefinition

The name to render in the column header.
#Configuration
#ColumnsRenderer


Label! - field in class GxContextMenu.GxContextMenuItem

The item's label


Label! - field in class GxSidebar.GxToolpanel

The default label of the toolpanel


LABEL_POSITION_DOWN_45 - field in class Dashboard.BarChartWidget

LABEL_POSITION_DOWN_45 - field in class Dashboard.LineChartWidget

LABEL_POSITION_DOWN_90 - field in class Dashboard.BarChartWidget

LABEL_POSITION_DOWN_90 - field in class Dashboard.LineChartWidget

LABEL_POSITION_STANDARD - field in class Dashboard.BarChartWidget

LABEL_POSITION_STANDARD - field in class Dashboard.LineChartWidget

LABEL_POSITION_UP_45 - field in class Dashboard.BarChartWidget

LABEL_POSITION_UP_45 - field in class Dashboard.LineChartWidget

LABEL_POSITION_UP_90 - field in class Dashboard.BarChartWidget

LABEL_POSITION_UP_90 - field in class Dashboard.LineChartWidget

Language$ - field in class BBjGridExWidget.GxLanguageManager

LanguageManager! - field in class GxOptions.GxOptions

The grid language manager


Languages! - field in class BBjGridExWidget.GxLanguageManager

LAST_PAGE$=#Translations!.getTranslation("last.page") - field in class BBJasper.BBJasperViewerControl

Translated text for last page


LAST_PAGE$=#Translations!.getTranslation("last.page") - field in class BBJasper.BBJasperView

Translated text for last page


LAST_PAGE_MENU_ITEM_NAME$="BBJVLastPageMenuItem" - field in class BBJasper.BBJasperView

Last page menu item name


LAST_PAGE_MENU_ITEM_NAME$=BBJasperView.getLAST_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Last page menu item name


LAST_PAGE_TOOL_BUTTON_NAME$="BBJVLastPageToolButton" - field in class BBJasper.BBJasperViewerControl

Last page tool button name


LAST_PAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getLAST_PAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Last page tool button name


LastErrorMessage$ - field in class GApps

LastName$ - field in class Email.EmailContact

Contact last name


lastPage() - method in class BBJasper.BBJasperView

lastPage Changes the view to display the last page, if it's not already on the last page


LastRenderedImage! - field in class Dashboard.ChartWidget

The last rendered version of the chart in a BBjImage format used for the Customize window's preview


launchIDE(BBjString pPgmFilePath$) - method in class DialogWizard.DialogWizard

Method launchIDE: Try to launch resultant program in the IDE


layout() - method in class Dashboard.DashboardControl

Lays out the widets in the currently selected category


layoutAll() - method in class Dashboard.DashboardControl

Lays out the widets in all categories


layoutReport(BBJasperDesign p_bbJasperDesign!) - method in class BBJasper.BBJasperTemplate

layoutReport Lays out the report.

This should be abstract, as by default, there will be no layout performed.


layoutReport(BBJasperDesign p_bbJasperDesign!) - method in class BBJasper.BBJasperTabularTemplate

layoutReport Lays out the report in a tabular fashion


layoutReport(BBJasperDesign p_bbJasperDesign!) - method in class BBJasper.BBJasperColumnarTemplate

layoutReport Lays out the report in a columnar fashion


layoutWidgets() - method in class Dashboard.DashboardCategoryControl

Laysout the widget contained in the dashboard category control


LEFT_UP_ARROW$=#Translations!.getTranslation("left.up.arrow") - field in class BBJasper.BBJasperView

Translated text for left/up arrow


leg1() - method in class gappsv3.GOAuth2

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.


leg3(BBjString code!) _break_ - method in class gappsv3.GOAuth2

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.


LEGENDSHAPE_CAPSULE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_CIRCLE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_DIAMOND - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_ELLIPSE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_RECTANGLE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_ROUNDEDRECTANGLE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LEGENDSHAPE_SQUARE - field in class Dashboard.ChartWidget

A constant to define the legend items' shape


LESS_THAN() - method in class GxFilters.GxColumnFilterDateTimeFilterOptions

LESS_THAN_OR_EQUALS() - method in class GxFilters.GxColumnFilterNumberFilterOptions

LicenseKey$ - field in class BBjGridExWidget.BBjGridExWidget

The Grid enterprise key


lightenColor(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Make a color lighter


LINE_CHART$ - field in class WidgetWizard

LINE_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Line chart widget type constant


LineChartWidget - class in Dashboard

LineChartWidget A Dashboard Utility Widget that displays a line chart which can display multiple data series simultaneously


LineChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.LineChartWidget

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.


LineChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.LineChartWidget

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.


LineChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.LineChartWidget

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.


LineChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.LineChartWidget

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.


LinkSelectCallbackObject! - field in class Dashboard.DashboardWidgetLink

CustomObject that contains the routine to handle a link select event


LinkSelectCallbackRoutine! - field in class Dashboard.DashboardWidgetLink

Routine to handle a link select event


LinkSelectEventName! - field in class Dashboard.DashboardWidgetLink

Name of the link select event


List! - field in class GxCellEditors.GxCellEditorSuggestionResolver

A json array which is used by the addItem methods and it will be returned by the implemented resolve method


List! - field in class GxRenderers.GxRendererImageRenderer

A json object


loadAppServer() - method in class BBUtils.BBUtils

loadClientSettings() - method in class BBLaunchDock

LoadedLanguages! - field in class BBjGridExWidget.GxLanguageManager

loadEmailContacts() - method in class Email.EmailDialog

loadEmailContacts Loads contacts from the HashMap into the contacts grid


loadEmailContacts(BBjString p_emailAddress$) - method in class Email.EmailDialog

loadEmailContacts Loads email contacts from the HashMap into the contacts grid


loadEvents() - method in class DialogWizard.Control

Method loadEvents: Load valid events for a control type


loadFindOptions() - method in class BBJasper.BBJasperView

Loads the find options


loadGrid() - method in class QVGrid.QVGrid

Loads grid initally


loadValidEvents() - method in class DialogWizard.Event

Method loadValidEvents: Load all valid events


loadValidTypes() - method in class DialogWizard.Control

Method loadValidTypes: Load all valid control type information


Locale! - field in class GxExpressions.GxExpressionDateTimesFormatter

The date / timestamp locale to use.


Locale! - field in class GxOptions.GxOptionsDateTime

The locale used to format and display dates and times. default to the System settings


localhostleg2() - method in class gappsv3.GOAuth2

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.)


locateFile(String p_fileName!) - method in class BBJasper.BBjFileRepositoryService

LockPinned! - field in class GxColumns.GxDefaultColumnDefinition

Set to true block pinning column via the UI (API will still work).


#Configuration
#ColumnsRenderer


LockPosition! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to always have column displayed first.


#Configuration
#ColumnsRenderer


LockVisible! - field in class GxColumns.GxDefaultColumnDefinition

Set to true block making column visible / hidden via the UI (API will still work).


#Configuration
#ColumnsRenderer


log(BBjString type!, BBjString section!, BBjString message!) - method in class BBjGridExWidget.GxLogger

Output a log message on the console and Debug.log file


log(BBjString section!, BBjString message!) - method in class BBjGridExWidget.GxLogger

Output a log message on the console and Debug.log file


log(BBjString message!) - method in class BBjGridExWidget.GxLogger

Output a log message on the console and Debug.log file


logError(BBjNumber p_errorNumber, BBjString p_errorMessage$, BBjNumber p_lineNumber) - method in class Dashboard.BaseWidget

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.


logQueryPerformance(BBjString p_widgetName$, BBjString p_sql$, BBjNumber p_startTime) - method in class Dashboard.BBjWidget

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


M

mailhost$ - field in class Email.Email

Mail server host


mailport - field in class Email.Email

Mail server port, default = 25


makeColorVectorFromCommaDelimitedHexColorString(BBjString p_colorString!) - method in class Dashboard.ChartWidget

Return a vector of java colors given a comma delimited string of hex colors


makeColorVectorFromCommaDelimitedHexColorString(BBjString p_colorString!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Return a vector of Java Colors given a comma delimited string of hex colors and an opacity amount to be applied to all colors


makeHexColor(BBjColor color!) - method in class BBjGridExWidget.BBjGridExWidget

Make Hex Color

Convert the given BBjColor to a hex color string


makeLargerColorVectorByDarkening(BBjVector p_colorVector!, BBjNumber p_size) - method in class Dashboard.ChartWidget

Gets a larger vector of colors by repeating the source vector, darkening it each time


makeLargerColorVectorByLightening(BBjVector p_colorVector!, BBjNumber p_size) - method in class Dashboard.ChartWidget

Gets a larger vector of colors by repeating the source vector, lightening it each time


makeLargerColorVectorByReducingOpacity(BBjVector p_colorVector!, BBjNumber p_size) - method in class Dashboard.ChartWidget

Gets a larger vector of colors by repeating the source vector, decreasing the opacity each time


MarryChildren! - field in class GxColumns.GxDefaultColumnGroup

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.


Mask! - field in class GxCellEditors.GxCellEditorBasicText

A bbj string mask When set we use it to validate the value


Mask! - field in class GxColumns.GxDefaultColumnDefinition

The default column mask


Mask! - field in class GxExpressions.GxExpressionStringsFormatter

The String mask to use.


Mask! - field in class GxExpressions.GxExpressionNumbersFormatter

The Number mask to use.


Mask! - field in class GxExpressions.GxExpressionDateTimesFormatter

The date / timestamp mask to use.


Mask! - field in class GxOptions.GxOptionsDateTime

The Date mask for calender input


MATCH$=#Translations!.getTranslation("match") - field in class BBJasper.BBJasperView

Translated text for match


Max! - field in class GxCellEditors.GxCellEditorBasicNumber

The max allowed value


Max! - field in class GxOptions.GxOptionsDateTime

A valid iso 8601 datetime which defines the max allowed value in the calender


MAX_FILE_SIZE=10240000 - field in class BBUtils.BBUtils

This constant is ignored in BBj 24.12 and higher.


MAX_FILE_SIZE=10240000 - field in class BBJasper.BBJasper

Max file size of jrxml and jasper report files, default is 10 MB


MAX_FILE_SIZE=10240000 - field in class BBTranslator.BBTranslator

A field variable that defines the maximum file size


MaxAttendees!=null() - field in class gappsv3.GCalendar

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+)


MaximumBarWidth - field in class Dashboard.BarChartWidget

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.


MaxLength! - field in class GxCellEditors.GxCellEditorLargeText

Max number of characters to allow. Default is 200.


MaxResults!=null() - field in class gappsv3.GCalendar

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+)


MaxRetries=12 - field in class GDocsService

MaxWidgetWidth - field in class Dashboard.DashboardCategory

Maximum width in pixels of widgets


MaxWidgetWidth - field in class Dashboard.DashboardCategoryAttribute

MaxWidgetWidth attribute


MaxWidth! - field in class GxColumns.GxDefaultColumnDefinition

Initial max width in pixels


#Configuration
#ColumnsRenderer


MEDIA_ERROR=309 - field in class GDocsService

MENU_TAB_COLUMNS() - method in class GxColumns.GxColumn

MENU_TAB_FILTER() - method in class GxColumns.GxColumn

MENU_TAB_GENERAL() - method in class GxColumns.GxColumn

MENU_TRIGGER_LEFT_CLICK=0 - field in class Dashboard.DashboardWidget

Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods.


MENU_TRIGGER_OPTIONS_CLICK=2 - field in class Dashboard.DashboardWidget

Constant for DashboardWidget popup menu triggered by clicking on the Options tool button used in the addMenu() and getDashboardWidgetMenu() methods.


MENU_TRIGGER_RIGHT_CLICK=1 - field in class Dashboard.DashboardWidget

Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods.


MenuItemSelectCallbackObject! - field in class Dashboard.DashboardWidgetMenu

CustomObject that contains the routine to handle a selection event from the custom popup menu.


MenuItemSelectCallbackRoutine! - field in class Dashboard.DashboardWidgetMenu

Routine to handle a selection event from the custom popup menu.


MenuItemSelectName! - field in class Dashboard.DashboardWidgetMenu

Name of the menu selection event.


MenuTabs! - field in class GxColumns.GxDefaultColumnDefinition

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.


MenuTriggerType - field in class Dashboard.DashboardWidgetMenu

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().


message! - field in class Email.Email

MimeMessage object


Method!="GET" - field in class BBWebClient.BBWebRequest

Specifies the operation that the webserver should perform. Supported operations include:


MIME$="application/vnd.google-apps." - field in class GDoc

MIME_TYPE_CSS$ - field in class BBUtils.BBUtils

A constant to define CSS text mime type


MIME_TYPE_GIF$ - field in class BBUtils.BBUtils

A constant to define GIF image mime type


MIME_TYPE_JPG$ - field in class BBUtils.BBUtils

A constant to define JPG image mime type


MIME_TYPE_PNG$ - field in class BBUtils.BBUtils

A constant to define PNG image mime type


Min! - field in class GxCellEditors.GxCellEditorBasicNumber

The min allowed value


Min! - field in class GxOptions.GxOptionsDateTime

A valid iso 8601 datetime which defines the min allowed value in the calender


MinHeight=400 - field in class Dashboard.DashboardWindow

Minimum height of the window


MinLength! - field in class GxCellEditors.GxCellEditorSuggestion

Specify the minimum length, when autocomplete should appear on the screen.


MINUTES=1 - field in class Dashboard.AutoRefreshUnit

Constant for minutes


MinWidgetWidth - field in class Dashboard.DashboardCategory

Minimum width in pixels of widgets


MinWidgetWidth - field in class Dashboard.DashboardCategoryAttribute

MinWidgetWidth attribute


MinWidth! - field in class GxColumns.GxDefaultColumnDefinition

Initial min width in pixels


#Configuration
#ColumnsRenderer


MinWidth=320 - field in class Dashboard.DashboardWindow

Minimum width of the window


MM_UNITS=1 - field in class BBJasper.BBJasperPrintMediaSizeName

Constant that represents that millimeters should be used for units


MORE_OPTIONS$=#Translations!.getTranslation("more.options") - field in class BBJasper.BBJasperView

Translated text for more options


moveColumn(BBjString Field$, BBjNumber toIndex!) - method in class BBjGridExWidget.BBjGridExWidget

Change column position


#API


moveDir(BBjString p_localDir$, BBjString p_destDirectory$) - method in class BBJasper.BBJasper

moveDir Moves a local directory. The directory can be moved accross machines when DS syntax is used for a destination directory


moveFile(BBjString p_localFile$, BBjString p_destFile$) - method in class BBJasper.BBJasper

moveFile Moves a local file. The file can be moved accross machines when DS syntax is used for a destination directory


MoveParentWindow=0 - field in class Dashboard.WidgetControl

Indicates if the parent window that houses the widget control should be dragged when the widget control is dragged


moveToNextCell() - method in class QVGrid.QVGrid

Moves the selection to the next cell


moveToNextCell() - method in class BBjGridExWidget.BBjGridExWidget

Start Next Cell Editing


#API


moveToPreviousCell() - method in class BBjGridExWidget.BBjGridExWidget

Move to previous cell


#API


multipart! - field in class Email.Email

Multipart object


MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR=5 - field in class BBJasper.BBJasperView

Constant that represents the multiple sheet XLS save contributor


MULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR=BBJasperView.getMULTIPLE_SHEETS_XLS_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the multiple sheet XLS save contributor


MultipleSelection! - field in class GxOptions.GxOptions

Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
#Configuration
#GridRenderer


MultipleSelection=0 - field in class GDocSelectionDialog

N

NAME() - method in class GxStatusBar.GxStatusBarComponentInterface

Get the component name


NAME() - method in class GxStatusBar.GxStatusBarSelectedRowCountComponent
{@inheritDoc}

NAME() - method in class GxStatusBar.GxStatusBarFilteredRowCountComponent
{@inheritDoc}

NAME() - method in class GxStatusBar.GxStatusBarTotalAndFilteredRowCountComponent
{@inheritDoc}

NAME() - method in class GxStatusBar.GxStatusBarTotalRowCountComponent
{@inheritDoc}

NAME() - method in class GxStatusBar.GxStatusBarAggregationComponent
{@inheritDoc}

name() - method in class Dashboard.Widget

Returns the unique name of the widget


name() - method in class Dashboard.BaseWidget

Returns the name of the widget


Name! - field in class BBWebClient.BBHeader

The name of the header attribute.


Name$ - field in class Dashboard.DashboardWidgetFilter

Filter name


Name$ - field in class Dashboard.DashboardWidgetAttribute

Name attribute


Name$ - field in class Dashboard.DashboardCategoryAttribute

Name attribute


Name$ - field in class Dashboard.Series

Name$ - field in class Dashboard.CallbackInfo

Name$ - field in class FolderInfo

Name$ - field in class TreeNode

Name$ - field in class BBJasper.ProcedureParam

NAME_ERROR=256 - field in class BBTranslator.BBTranslationBundle

navigateDate(BBjString date!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


navigateNext() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


navigateNextYear() - method in class BBjCalendarWidget.BBjCalendarWidget

Navigates the calendar programmatically forward one year, and is the same as the user clicking on the 'nextYear' toolbar button.


navigatePrev() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


navigatePrevYear() - method in class BBjCalendarWidget.BBjCalendarWidget

Navigates the calendar programmatically back one year, and is the same as the user clicking on the 'prevYear' toolbar button.


navigateTime(BBjString time!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.

  • "hh:mm:ss.sss"
  • "hh:mm:ss"
  • "hh:mm"
but the parser should be able to interpret various formats.

navigateToday() - method in class BBjCalendarWidget.BBjCalendarWidget

Navigates the calendar programmatically to the current date, and is the same as the user clicking on the 'today' toolbar button.


NavigationBehavior! - field in class GxOptions.GxOptions

Defines how users can move between rows using arrow keys.
#Configuration
#GridRenderer


NEW_ACTIVE_TAB_HYPERLINK_TARGET - field in class BBJasper.BBJasperHyperlink

NEW_INACTIVE_TAB_HYPERLINK_TARGET - field in class BBJasper.BBJasperHyperlink

NEW_ROWS_ACTION_CLEAR() - method in class GxFilters.GxColumnFilterAG

A constant which describes the NewRowsAction behavior


NEW_ROWS_ACTION_KEEP() - method in class GxFilters.GxColumnFilterAG

A constant which describes the NewRowsAction behavior


NEW_WINDOW_HYPERLINK_TARGET - field in class BBJasper.BBJasperHyperlink

NewRowsAction! - field in class GxFilters.GxColumnFilterAG

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'


NEXT_PAGE$=#Translations!.getTranslation("next.page") - field in class BBJasper.BBJasperViewerControl

Translated text for next page


NEXT_PAGE$=#Translations!.getTranslation("next.page") - field in class BBJasper.BBJasperView

Translated text for next page


NEXT_PAGE_MENU_ITEM_NAME$="BBJVNextPageMenuItem" - field in class BBJasper.BBJasperView

Next page menu item name


NEXT_PAGE_MENU_ITEM_NAME$=BBJasperView.getNEXT_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Next page menu item name


NEXT_PAGE_TOOL_BUTTON_NAME$="BBJVNextPageToolButton" - field in class BBJasper.BBJasperViewerControl

Next page tool button name


NEXT_PAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getNEXT_PAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Next page tool button name


nextFindPage() - method in class BBJasper.BBJasperView

nextFindPage Finds and sets the page to where the next find element is found


nextHighlight() - method in class BBJasper.BBJasperView

nextHighlight Finds the next find element


nextPage() - method in class BBJasper.BBJasperView

nextPage Changes the view to display the next page, if there is one


NO_PERMISSIONS - field in class Admin

NO_ROLE=0 - field in class GDoc

NodeID - field in class FolderInfo

NodeID - field in class TreeNode

NoneValue! - field in class GxFilters.GxFilterBasicBoolean

None value Translation


NOT_CONTAINS() - method in class GxFilters.GxColumnFilterTextFilterOptions

NOT_EQUALS() - method in class GxFilters.GxColumnFilterTextFilterOptions

NOT_EQUALS() - method in class GxFilters.GxColumnFilterDateTimeFilterOptions

Notes$ - field in class BBJasper.ProcedureType

Notes$ - field in class BBJasper.ProcedureParam

NumConsolePrints - field in class BBTranslator.BBTranslationBundle

NumSlices - field in class Dashboard.PieChartWidget

A number indicating the number of slices in the pie chart


O

OAuthAccessToken$ - field in class Email.Email

OAuth access token


obtainBundleLock(BBjString p_name!, BBjString p_directory!) - method in class BBTranslator.BBTranslationBundle

ODS_SAVE_CONTRIBUTOR=15 - field in class BBJasper.BBJasperView

Constant that represents the ODS save contributor


ODS_SAVE_CONTRIBUTOR=BBJasperView.getODS_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the ODS save contributor


ODSExporter! - field in class BBJasper.BBJasperView

ODS exporter which contains export options


ODT_SAVE_CONTRIBUTOR=9 - field in class BBJasper.BBJasperView

Constant that represents the ODT save contributor


ODT_SAVE_CONTRIBUTOR=BBJasperView.getODT_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the ODT save contributor


ODTExporter! - field in class BBJasper.BBJasperView

ODT exporter which contains export options


OF$=#Translations!.getTranslation("of") - field in class BBJasper.BBJasperView

Translated text for of


OFFSET_X$ - field in class BBJasper.BBJasperExporterParameter

OFFSET_Y$ - field in class BBJasper.BBJasperExporterParameter

OK=1 - field in class GAppsLoginDialog

OldValue! - field in class GxClientEvents.GxClientEventsCell

The old value of the cell


ON_CALENDAR_DATE_CLICK() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_DATE_CLICK() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_DATES_SET() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_DATES_SET() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_DROP() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_DROP() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRIES_SET() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRIES_SET() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_ADD() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_ADD() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_CHANGE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_CHANGE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_CLICK() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_CLICK() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_DRAG_START() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has started dragging an event.


ON_CALENDAR_ENTRY_DRAG_START() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_DRAG_STOP() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has stopped dragging an event.


ON_CALENDAR_ENTRY_DRAG_STOP() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_DROP() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_DROP() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_LEAVE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_LEAVE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_MOUSE_ENTER() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_MOUSE_ENTER() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_MOUSE_LEAVE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_MOUSE_LEAVE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_RECEIVE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_RECEIVE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_REMOVE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_REMOVE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_RESIZE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_ENTRY_RESIZE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_RESIZE_START() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has started resizing an event.


ON_CALENDAR_ENTRY_RESIZE_START() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_RESIZE_STOP() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has stopped resizing an event.


ON_CALENDAR_ENTRY_RESIZE_STOP() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_SOURCE_FAILURE() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that fetching a CalendarEntrySource failed.


ON_CALENDAR_ENTRY_SOURCE_FAILURE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_ENTRY_SOURCE_SUCCESS() - method in class BBjCalendarWidget.BBjCalendarWidget

A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that fetching a CalendarEntrySource succeeded.


ON_CALENDAR_ENTRY_SOURCE_SUCCESS() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_READY() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_READY() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_SELECT() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_SELECT() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_CALENDAR_UNSELECT() - method in class BBjCalendarWidget.BBjCalendarWidget

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 user clicks away from the current selection (doesn't happen when EnableUnselectAuto is false).
  • The user makes a new selection. The unselect callback will be fired before the new selection occurs.
  • The user moves forward or backward in the current view, or switches to a new view.
  • The unselect method is called through the API.

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.


ON_CALENDAR_UNSELECT() - method in class BBjCalendarWidget.CalendarAPI

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 user clicks away from the current selection (doesn't happen when EnableUnselectAuto is false).
  • The user makes a new selection. The unselect callback will be fired before the new selection occurs.
  • The user moves forward or backward in the current view, or switches to a new view.
  • The unselect method is called through the API.

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.


ON_CALENDAR_VIEW_CHANGE() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


ON_CALENDAR_VIEW_CHANGE() - method in class BBjCalendarWidget.CalendarAPI

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.


ON_FILE_SAVE_NOTIFY - field in class Dashboard.JasperViewerWidget

File save notify event


ON_FILL_ERROR_IGNORE - field in class Dashboard.Dashboard

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).


ON_FILL_ERROR_IGNORE - field in class Dashboard.DashboardCategory

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).


ON_FILL_ERROR_IGNORE - field in class Dashboard.BaseWidget

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).


ON_FILL_ERROR_STOP - field in class Dashboard.Dashboard

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).


ON_FILL_ERROR_STOP - field in class Dashboard.DashboardCategory

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).


ON_FILL_ERROR_STOP - field in class Dashboard.BaseWidget

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).


ON_FILL_ERROR_WARN - field in class Dashboard.Dashboard

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).


ON_FILL_ERROR_WARN - field in class Dashboard.DashboardCategory

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.


ON_FILL_ERROR_WARN - field in class Dashboard.BaseWidget

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.


ON_FILTER_SELECT=1 - field in class Dashboard.DashboardWidgetFilter

Constant for a filter select event, used in the setCallback() method


ON_GOOGLE_DOC_SAVE_NOTIFY - field in class Dashboard.JasperViewerWidget

Google Doc save notify event


ON_GRID_CELL_CLICK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define cell click event


ON_GRID_CELL_DOUBLE_CLICK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define cell double-click event


ON_GRID_CELL_EDITING_STARTED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define cell editing start event


ON_GRID_CELL_EDITING_STOPPED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define cell editing stop event


ON_GRID_CELL_VALUE_CHANGED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define cell value changed event


ON_GRID_COLUMN_STATE_CHANGE() - method in class BBjGridExWidget.BBjGridExWidget

Alias for ON_GRID_STATE_CHANGE()


ON_GRID_DOUBLE_CLICK() - method in class BBjGridExWidget.BBjGridExWidget

Alias to ON_GRID_ROW_DOUBLE_CLICK()


ON_GRID_FILTER_CHANGED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define A filter changed event.


ON_GRID_KEYPRESS() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define keyboard keypress


ON_GRID_RANGE_SELECTION_CHANGED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define range selection event


ON_GRID_READY() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define the grid ready event.


ON_GRID_REFRESH - field in class Dashboard.GridWidget

Constant for widget refresh event.


ON_GRID_ROW_CLICK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row click events


ON_GRID_ROW_DOUBLE_CLICK() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row double-click event


ON_GRID_ROW_EDITING_STARTED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row editing start event


ON_GRID_ROW_EDITING_STOPPED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define row editing stop event


ON_GRID_ROW_SELECT() - method in class BBjGridExWidget.BBjGridExWidget

Alias for ON_GRID_SELECT_ROW


ON_GRID_ROW_VALUE_CHANGED() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define A row has changed. This event corresponds to Full Row Editing only.


ON_GRID_SELECT_ROW() - method in class BBjGridExWidget.BBjGridExWidget

A Constant value to define row selection (selected/deselected) change events


ON_GRID_STATE_CHANGE() - method in class BBjGridExWidget.BBjGridExWidget

Constant value to define grid state changes


ON_LINK_SELECT=1 - field in class Dashboard.DashboardWidgetLink

Constant for a link select event


ON_POPUP_ITEM_SELECT=BBjAPI().ON_POPUP_ITEM_SELECT - field in class Dashboard.DashboardWidget

Constant for the popup menu selection event used in the DashboardWidgetMenu::setCallback() method.


ON_POPUP_ITEM_SELECT=BBjAPI().ON_POPUP_ITEM_SELECT - field in class Dashboard.DashboardWidgetMenu

Constant for the popup menu selection event used in the setCallback() method.


ON_WIDGET_CLICK - field in class Dashboard.DashboardWidget

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.


ON_WIDGET_LEFT_CLICK - field in class Dashboard.DashboardWidget

Constant for widget left click event used in the setCallback() method


ON_WIDGET_REFRESH - field in class Dashboard.DashboardWidget

Constant for widget refresh event used in the setCallback() method


ON_WIDGET_RIGHT_CLICK - field in class Dashboard.DashboardWidget

Constant for widget right click event used in the setCallback() method


ON_WIDGET_SELECT - field in class Dashboard.DashboardWidget

Constant for widget select event used in the setCallback() method


OnActualSize(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnActualSize Callback for when the actual size menu item is selected


OnActualSizeToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnActualSizeToolButton Callback for when the acutal size tool button is pushed


OnAddCategory(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame4

Method OnAddCategory: Called when the Add button is pressed


OnAddWidget(BBjToolButtonPushEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Add Widget button is pushed in the Customize window, changing a widget's state from inactive to active


OnAdvanced(BBjButtonPushEvent p_event!) - method in class GDocSaveDialog

OnAppClose(BBjCloseEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnAppClose Closes the application


OnAttachmentDialogApprove(BBjFileChooserApproveEvent p_event!) - method in class Email.EmailDialog

OnAttachmentDialogApprove Callback when a file is choosen in the attachment dialog


OnAttachmentDialogClose(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnAttachmentDialogClose Callback when the attachment dialog should be closed


OnAttachmentRemove(BBjToolButtonPushEvent p_event!) - method in class Email.EmailDialog

OnAttachmentRemove Callback for when a remove attachment tool button is pushed


OnAutoRefresh(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the auto refresh menu item is selected


OnAutoRefreshClose(BBjCloseEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected


OnAutoRefreshConfiguration(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the auto refresh configuratoin menu item is selected


OnAutoRefreshDone(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected


OnAutoRefreshTimer(BBjTimerEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnBackButton(BBjButtonPushEvent p_event!) - method in class WidgetWizard

Method OnBackButton: Button push event handler for the "Back" button


OnBrowse(BBjButtonPushEvent p_event!) - method in class Dashboard.ExportDataDialog

OnBrowse Called when the browse button is pressed by the user to select the client side export file


OnBrowse(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnBrowse Browse for a report file


onBtnBackPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizard

Method onBtnBackPush: Button push event handler for the "Back" button


onBtnFinishPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizard

Method onBtnFinishPush: Button push event handler for the "Finish" button


onBtnGeneratePush(BBjButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

onBtnNextPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizard

Method onBtnNextPush: Button push event handler for the "Next" button


onBtnRunWizardPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardRun

Method onBtnRunWizardPush: Button push event handler for the "Run Wizard Again" button


onBtnTestInBUIPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardRun

Method onBtnTestInBUIPush: Button push event handler for the "Test in BUI" button


onBtnTestInGUIPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardRun

Method onBtnTestInGUIPush: Button push event handler for the "Test in GUI" button


OnCancel(BBjButtonPushEvent p_event!) - method in class BBJasper.BBJasperProgress

OnCancel Callback called when the user selects the cancel button


OnCategoryListSelect(BBjListSelectEvent p_event!) - method in class WidgetWizardFrame5

Method OnCategoryListSelect: Called when the widget category is selected


OnCategoryListSelect(BBjListSelectEvent p_event!) - method in class WidgetWizardFrame6

Method OnCategoryListSelect: Called when a category is selected from the BBjListButton


OnCategorySelect(BBjCustomEvent p_event!) - method in class WidgetWizardFrame4

Method OnCategorySelect Called when a category is selected


OnCategorySelect(BBjCustomEvent p_event!) - method in class WidgetWizardFrame5

Method OnCategorySelect Called when a category is selected


OnCategorySelect(BBjCustomEvent p_event!) - method in class WidgetWizardFrame6

Method OnCategorySelect Called when a category is selected


OnCategoryTitleModify(BBjEditModifyEvent p_event!) - method in class WidgetWizardFrame4

Method OnCategoryTitleModify:
Called when the category title is modified


OnClearTip(BBjTimerEvent p_event!) - method in class Dashboard.ChartWidget

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.


OnClose(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

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(BBjSysGuiEvent p_event!) - method in class BBJasper.BBJasperViewerWindow

OnClose Called when the window is closed by the user


OnCloseLeftTabs(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Called when the close left tabs menu item is selected


OnCloseOtherTabs(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Called when the close other tabs menu item is selected


OnCloseRightTabs(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Called when the close right tabs menu item is selected


OnCloseTab(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Called when the close tab menu item is selected


OnColorThemeSelect(BBjListChangeEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user selects a color theme from the Customize window


OnConnectButtonPush(BBjButtonPushEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnConnectButtonPush Loads databases from selected host


OnContactChangeDialogClose(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnContactChangeDialogClose Callback for when the contact change dialog is closed


OnContactChangeEmailEdit(BBjEditModifyEvent p_event!) - method in class Email.EmailDialog

OnContactChangeEmailEdit Callback for when the contact change email is edited


OnContactChangeFirstNameEdit(BBjEditModifyEvent p_event!) - method in class Email.EmailDialog

OnContactChangeFirstNameEdit Callback for when the contact change first name is edited


OnContactChangeLastNameEdit(BBjEditModifyEvent p_event!) - method in class Email.EmailDialog

OnContactChangeLastNameEdit Callback for when the contact change last name is edited


OnContactChangeSave(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnContactChangeSave Callback for when the contact change save button is pressed


OnContactDialogEdit(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnContactDialogEdit Callback when the contact edit button is pressed


OnContactDialogNew(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnContactDialogEdit Callback when the contact new button is pressed


OnContactsDialogClose(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnContactsDialogClose Callback to close the Contacts dialog


OnContactsDialogRemove(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnContactsDialogRemove Callback for when the Contacts remove button is pressed


OnContactsDialogSelect(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnContactsDialogSelect Callback for when the contacts select button is preseed


OnContactsGridDoubleClick(BBjGridDoubleClickEvent p_event!) - method in class Email.EmailDialog

OnContactsGridDoubleClick Callback when the user double clicks on the contacts grid


OnControlPopupRequest(BBjPopupRequestEvent p_event!) - method in class Dashboard.HtmlViewWidget

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.


OnControlPopupRequest(BBjPopupRequestEvent p_event!) - method in class Dashboard.GridWidget

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.


OnCreateFolder(BBjButtonPushEvent p_event!) - method in class GDocSelectionDialog

OnCreateFolderCancel(BBjSysGuiEvent p_event!) - method in class GDocSelectionDialog

OnCreateFolderOK(BBjButtonPushEvent p_event!) - method in class GDocSelectionDialog

OnCreateImageToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnCreateImageToolButton Callback for when the create image tool button is pushed


OnCustomize(BBjButtonPushEvent p_event!) - method in class Dashboard.DashboardControl

Called when the customize button is pressed


OnCustomizeDone(BBjSysGuiEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Done tool button is pushed in the Customize window


OnCustomizeNext(BBjSysGuiEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Next tool button is pushed in the Customize window


OnCustomizePrev(BBjSysGuiEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Prev tool button is pushed in the Customize window


OnCustomizeResize(BBjResizeEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Customize window is resized.


OnCustomizeResizeTimer(BBjTimerEvent p_event!) - method in class Dashboard.DashboardControl

Called when the resize timer is triggered


OnCustomPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomPage Callback for when the custom page menu item is selected


OnCustomPageClose(BBjCloseEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomPageClose Callback for when the custom page window is close


OnCustomPageEdit(BBjEditModifyEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomPageEdit Callback for when a key is pressed in the custom page inputN


OnCustomZoom(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomZoom Callback for when the custom zoom menu item is selected


OnCustomZoomClose(BBjCloseEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomZoomClose Callback for when the custom zoom window is close


OnCustomZoomListEditSelect(BBjListSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnCustomZoomListEditSelect Callback for when the custom zoom list selection event occurs


OnDashboardWidgetMenuItemSelect(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnDataListSelect(BBjListSelectEvent p_event!) - method in class WidgetWizardFrame6

Method OnDataListSelect: Called when a data option is selected from the BBjListButton


OnDataResultsClose(BBjSysGuiEvent p_event!) - method in class WidgetWizardFrame6

Method OnDataResultsClose Called when the Data Results Window is closed


OnDesignTreeSelect(BBjTreeNodeSelectedEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnDesignTreeSelect Called when a node in the design tree is selected


OnDisconnect(BBjButtonPushEvent p_event!) - method in class GDocSelectionDialog

OnDocumentNameEdit(BBjEditModifyEvent p_event!) - method in class GDocSaveDialog

OnDoNotUseWidgetFontScaling(BBjCheckOffEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user chooses to use a dynamic widget size


OnEmail(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

Called when the email popup menu item is selected on the widget control


OnEmail(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnEmail Callback for when the email menu item is selected


OnEmailAddressEdit(BBjEditModifyEvent p_event!) - method in class Email.EmailDialog

OnEmailAddressEdit Callback for when an email address text is changed


OnEmailAddressLostFocus(BBjLostFocusEvent p_event!) - method in class Email.EmailDialog

OnEmailAddressLostFocus Callback for when an email address loses focus


OnEmailAddressRemove(BBjToolButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailAddressRemove Callback for when the email dialog remove email address button is pushed


OnEmailAddressSelect(BBjListDoubleClickEvent p_event!) - method in class Email.EmailDialog

OnEmailAddressSelect Callback for when an email address is selected from the address list box


OnEmailBCCAddressKeypress(BBjEditKeypressEvent p_event!) - method in class Email.EmailDialog

OnEmailBCCAddressKeypress Callback for when a key is pressed in the email bcc edit box


OnEmailCCAddressKeypress(BBjEditKeypressEvent p_event!) - method in class Email.EmailDialog

OnEmailCCAddressKeypress Callback for when a key is pressed in the email cc edit box


OnEmailDialogAttachmentClient(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogAttachmentClient Callback to add a client file as an attachment to the email


OnEmailDialogAttachmentServer(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogAttachmentServer Callback to add a server file as an attachment to the email


OnEmailDialogBCCAdd(BBjPopupSelectEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogBCCAdd Callback for when the email dialog BCC add menu item is selected


OnEmailDialogBCCContacts(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogBCContacts Callback to bring up the contacts dialog for the BCC addresees


OnEmailDialogBCCRemove(BBjPopupSelectEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogBCCRemove Callback for when the email dialog BCC remove menu item is selected


OnEmailDialogCCAdd(BBjPopupSelectEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogCCAdd Callback for when the email dialog CC add menu item is selected


OnEmailDialogCCContacts(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogCCContacts Callback to bring up the contacts dialog for the CC addresees


OnEmailDialogCCRemove(BBjPopupSelectEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogCCRemove Callback for when the email dialog CC remove menu item is selected


OnEmailDialogClose(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogClose Callback for when the email dialog is to be closed


OnEmailDialogSend(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogSend Callback for when the email dialog send button is pressed


OnEmailDialogSettings(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogSettings Callback for when the email dialog settings button is pressed


OnEmailDialogToContacts(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

OnEmailDialogToContacts Callback to bring up the contacts dialog for the To addresees


OnEmailSettingsDialogClose(BBjSysGuiEvent p_event!) - method in class Email.EmailDialog

OnEmailSettingsDialogClose Callback for when the email settings dialog is to be closed


OnEmailSettingsDialogSave(BBjButtonPushEvent p_event!) - method in class Email.EmailDialog

Callback for when the email settings dialog save button is pressed


OnEmailToAddressKeypress(BBjEditKeypressEvent p_event!) - method in class Email.EmailDialog

OnEmailToAddressKeypress Callback for when a key is pressed in the email to edit box


OnEmailToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnEmailToolButton Callback for when the email tool button is pushed


OnExport(BBjButtonPushEvent p_event!) - method in class Dashboard.ExportDataDialog

OnExport Called when the export button is pressed to export the data to the client side file


OnExportData(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

Called when the export data popup menu item is selected on the widget control


OnFileChooserApprove(BBjFileChooserApproveEvent p_event!) - method in class BBJasper.BBJasperView

OnFileChooserApprove Callback when a file is choosen in the file chooser window


OnFileChooserClose(BBjSysGuiEvent p_event!) - method in class BBJasper.BBJasperView

OnFileChooserClose Callback when the file chooser window is closed/canceled


OnFileChooserFilter(BBjFileChooserFilterEvent p_event!) - method in class BBJasper.BBJasperView

OnFileChooserFilter Callback run when user selects a filter in the file chooser


OnFileModify(BBjEditModifyEvent p_event!) - method in class Dashboard.ExportDataDialog

OnFileModify Called when the export file name is changed


OnFilterSelect(BBjEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnFilterSelect(BBjListSelectEvent p_event!) - method in class GDocSelectionDialog

OnFind(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnFind Callback for when the find menu item is selected


OnFindCaseInsensitive(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindCaseSensitive(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindClear(BBjToolButtonPushEvent p_toolButtonPushEvent!) - method in class BBJasper.BBJasperView

OnFindClose(BBjCloseEvent p_closeEvent!) - method in class BBJasper.BBJasperView

OnFindGainedFocus(BBjGainedFocusEvent p_gainedFocusEvent!) - method in class BBJasper.BBJasperView

OnFindHighlightField(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindHighlightText(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindIncrementalOff(BBjCheckOffEvent p_event!) - method in class BBJasper.BBJasperView

OnFindIncrementalOn(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindKeypress(BBjEditKeypressEvent p_editKeyPressEvent!) - method in class BBJasper.BBJasperView

OnFindKeypress Callback method for key press events find list edit


OnFindLostFocus(BBjLostFocusEvent p_lostFocusEvent!) - method in class BBJasper.BBJasperView

OnFindMatchContains(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindMatchFullWord(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindMatchStartsWith(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindModify(BBjEditModifyEvent p_editModifyEvent!) - method in class BBJasper.BBJasperView

OnFindMoreOptions(BBjToolButtonPushEvent p_toolButtonPushEvent!) - method in class BBJasper.BBJasperView

OnFindNext(BBjToolButtonPushEvent p_toolButtonPushEvent!) - method in class BBJasper.BBJasperView

OnFindPrevious(BBjToolButtonPushEvent p_toolButtonPushEvent!) - method in class BBJasper.BBJasperView

OnFindScopeCurrentPage(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindScopeReport(BBjCheckOnEvent p_event!) - method in class BBJasper.BBJasperView

OnFindToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnFindToolButton Callback for when the find tool button is pushed


OnFinishButton(BBjButtonPushEvent p_event!) - method in class WidgetWizard

Method OnFinishButton: Button push event handler for the "Finish" button


OnFirstPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnFirstPage Callback for when the first page menu item is selected


OnFirstToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnFirstToolButton Callback for when the first page tool button is pushed


OnFitPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnFitPage Callback for when the fit page menu item is selected


OnFitPageToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnFitPageToolButton Callback for when the fit to page tool button is pushed


OnFitWidth(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnFitWidth Callback for when the fit width menu item is selected


OnFitWidthToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnFitWidthToolButton Callback for when the fit to width tool button is pushed


onFlush(BBjTimerEvent event!) - method in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


onFlush(BBjTimerEvent event!) - method in class BBjGridExWidget.GxExecutor

A BBjTimerEvent listener which will be invoked when the executor count down reaches 0 to flush the enqueued scripts


OnFontSelect(BBjListChangeEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user selects a custom font from the Customize window


onGainedFocus(BBjGainedFocusEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

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(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnGetFields Gets the fields


onGrdControlVariablesKeyPress(BBjGridKeypressEvent pEvent!) - method in class DialogWizard.DialogWizardFrame2

Method onGrdControlVariablesKeyPress: Key press event handler for the control variables grid control


onGrdControlVariablesMouseUp(BBjGridMouseUpEvent pEvent!) - method in class DialogWizard.DialogWizardFrame2

Method onGrdControlVariablesMouseUp: Mouse up event handler for the control variables grid control


onGrdControlVariablesTypeQuery(BBjGridCellQueryEvent pEvent!) - method in class DialogWizard.DialogWizardFrame2

Method onGrdControlVariablesTypeQuery: Cell query event handler for the "type" column


onGrdToolBarCellModify(BBjGridCellModifyEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarCellModify: Grid cell modify event handler for the "Toolbar" grid


onGrdToolBarGainedFocus(BBjGridGainedFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarGainedFocus: Grid gained focus event handler for the "Toolbar" grid


onGrdToolBarImgPathQuery(BBjGridCellQueryEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarImgPathQuery: Grid cell query event handler for the "Image Path" column


onGrdToolBarKeyPress(BBjGridKeypressEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarKeyPress: Grid keypress event handler for the "Toolbar" grid


onGrdToolBarLostFocus(BBjGridLostFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarLostFocus: Grid lost focus event handler for the "Toolbar" grid


onGrdToolBarMouseUp(BBjGridMouseUpEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGrdToolBarMouseUp: Grid mouse up event handler for the "Toolbar" grid


onGridToolBarSelectRow(BBjGridSelectRowEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onGridToolBarSelectRow: Grid select row event handler for the "Move To Last" tool button


OnGridWidgetEvent(BBjSysGuiEvent p_event!) - method in class Dashboard.GridWidget

An internal method that is called when the user initiates an event on a GridWidget for which a callback event has been registered


OnHTMLTextSelected(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame6

Called when the HTML Text radio button is selected


OnHTMLURLSelected(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame6

Called when the HTML URL radio button is selected


OnHtmlViewEvent(BBjSysGuiEvent p_event!) - method in class Dashboard.HtmlViewWidget

An internal method that is called when an event occurs on the HtmlViewerWidget for which a callback event has been registered


OnHyperlink(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperView

OnHyperlink Callback when a hyperlink (tool button) is pushed


OnHyperlinkPopup(BBjPopupRequestEvent p_event!) - method in class BBJasper.BBJasperView

OnHyperlink Callback when a hyperlink (tool button) is right clicked


OnImageBrowse(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnImageBrowse Called when the image browse button is pushed


OnImageFileSelected(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame6

Called when the Image file radio button is selected


OnImageUrlSelected(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame6

Called when the Image url radio button is selected


onInePgmFilePathLostFocus(BBjLostFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method onInePgmFilePathLostFocus: Focus lost event handler for the program file path input control


onIneResFilePathLostFocus(BBjLostFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method onIneResFilePathLostFocus: Lost focus event handler for the resource file path input control


onInit(BBjEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

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.


onInnBtnSizeLostFocus(BBjLostFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onInnBtnSizeLostFocus: Lost focus event handler for the "Button Size" input control


onInnSepWidthLostFocus(BBjLostFocusEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onInnSepWidthLostFocus: Lost focus event handler for the "Separator Width" input control


OnJasperBrowse(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnJasperBrowse Called when the Jasper browse button is pushed


OnJasperViewerMouseClick(BBjCustomEvent p_event!) - method in class Dashboard.WidgetControl

Called when the mouse is clicked in a Jasper Viewer


OnKeypress(BBjKeypressEvent p_event!) - method in class WidgetWizardFrame5

Method OnKeypress Called when a key is pressed in the Frame5 child window


OnKeypress(BBjKeypressEvent p_keyPressEvent!) - method in class BBJasper.BBJasperViewerControl

OnKeypress(BBjKeypressEvent p_keyPressEvent!) - method in class BBJasper.BBJasperView

OnKeypress Callback method for key press events in the view


OnLastPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnLastPage Callback for when the last page menu item is selected


OnLastToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnLastToolButton Callback for when the last page tool button is pushed


onLbtBarTplListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onLbtBarTplListChange: List change event handler for the "Toolbar Template" list button


onLbtBtnTypeListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onLbtBtnTypeListChange: List change event handler for the "Button Type" list button


onLbtDbNameListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

onLbtDbTableListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

onLbtDockLocListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onLbtDockLocListChange: List change event handler for the "Dock Location" list button


onLbtWinIdListChange(BBjListChangeEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

onLbxCallbacksClick(BBjListClickEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onLbxCallbacksClick: List click event handler for the "Callbacks" list box


onLbxCallbacksDoubleClick(BBjListDoubleClickEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onLbxCallbacksDoubleClick: List double-click event handler for the "Callbacks" list box


onLbxControlsListClick(BBjListClickEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onLbxControlsListClick: List click event handler for the "Controls" list box


onLbxEventsClick(BBjListClickEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onLbxEventsClick: List click event handler for the "Events" list box


onLbxEventsDoubleClick(BBjListDoubleClickEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onLbxEventsDoubleClick: List double-click event handler for the "Events" list box


OnLinkToolButton(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

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.


onLoaded(BBjEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

An Event listener executed after the second ON_PAGE_LOADED event

At this phase the grid flush all enqueued scripts


onLoadedByTimer(BBjEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

An Event listener for the fallback by timer

Sporadically the ON_PAGE_LOADED event did not fire


onLoadedByWebManager(BBjEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

An Event listener for the loading the script by the WebManager


OnManualRefresh(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the manual refresh menu item is selected


OnMouseDown(BBjMouseDownEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnMouseDown(BBjMouseDownEvent p_event!) - method in class BBjDialChartProgress.BBjDialChartProgress

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.


OnMouseMove(BBjMouseMoveEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnMouseMove(BBjMouseMoveEvent p_event!) - method in class BBjDialChartProgress.BBjDialChartProgress

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.


OnMouseUp(BBjMouseUpEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnMouseUp(BBjMouseUpEvent p_event!) - method in class Dashboard.DashboardWidgetControl

Called when mouse is released on the dashboard widget control


OnMouseUp(BBjMouseUpEvent p_event!) - method in class BBjDialChartProgress.BBjDialChartProgress

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.


onNativeEvent(BBjNativeJavaScriptEvent ev!) - method in class BBjCalendarWidget.BBjCalendarWidget

An internal event handler for native JavaScript events from the BBjHtmlView control that converts a JavaScript calendar event to a BBj callback event.


onNativeEvent(BBjNativeJavaScriptEvent ev!) - method in class BBjGridExWidget.BBjGridExWidget

On NativeEvent

Event Handler for Native JavaScript Event coming from the client Determines and dispatches the actual event


OnNextButton(BBjButtonPushEvent p_event!) - method in class WidgetWizard

Method OnNextButton: Button push event handler for the "Next" button


OnNextPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnNextPage Callback for when the next page menu item is selected


OnNextToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnNextToolButton Callback for when the next page tool button is pushed


OnOpenLinkInCurrentWindow(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

Called when open link in current window menu item is selected


OnOpenLinkInNewActiveTab(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

Called when open link in new active tab menu item is selected


OnOpenLinkInNewInactiveTab(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

Called when open link in new inactive tab menu item is selected


OnOpenLinkInNewWindow(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

Called when open link in new window menu item is selected


OnOptions(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl that is called when the Options tool button is pushed on the widget control


OnPageLoaded(BBjPageLoadedEvent p_event!) - method in class Dashboard.HtmlViewWidget

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(BBjEditModifyEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnPageNumberEdit Callback for when a key is pressed in the page number inputN


OnPopout(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl in response to the widget's popout button press event


OnPopout(BBjToolButtonPushEvent p_event!) - method in class Dashboard.DashboardWidgetControl

Called popout button is pressed on the dashboard widget control


OnPopoutClose(BBjToolButtonPushEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl in response to the popout window's close button's pressed event


OnPopoutClose(BBjToolButtonPushEvent p_event!) - method in class Dashboard.DashboardWidgetControl

Called when the popout window close button is pressed


OnPopoutWindowClose(BBjCloseEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl in response to the popout window's close event


OnPopoutWindowResize(BBjResizeEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl in response to the popout window's resize event


OnPreview(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnPreview Previews the report


OnPreviewScroll(BBjWindowScrollEvent p_event!) - method in class Dashboard.DashboardControl

Called when the preview window is scrolled in the Customize window


OnPreviousPage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnPrevousPage Callback for when the previous page menu item is selected


OnPreviousToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnPreviousToolButton Callback for when the previous page tool button is pushed


OnPrint(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnPrint Callback for when the email menu item is selected


OnPrintToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnPrintToolButton Callback for when the print tool button is pushed


OnProgressChange(BBjNamespaceEvent p_event!) - method in class BBJasper.BBJasperProgress

OnProgressChange Called when the namespace progress key value is changed


OnQueryModify(BBjEditModifyEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnQueryModify Called when the SQL query is modified


OnRefresh(BBjButtonPushEvent p_event!) - method in class Dashboard.DashboardControl

Called when the Refresh tool button is pushed


OnRefresh(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

Called when the refresh popup menu item is selected on the widget control


OnRefresh(BBjButtonPushEvent p_event!) - method in class GDocSelectionDialog

OnRefresh(BBjButtonPushEvent p_event!) - method in class GDocOpenDialog

OnRefresh(BBjButtonPushEvent p_event!) - method in class GDocSaveDialog

OnReload(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnReload Callback for when the reload menu item is selected


OnReloadToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnReloadToolButton Callback for when the reload tool button is pushed


OnRemoveCategory(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame4

Method OnRemoveCategory: Called when the Remove button is pressed


OnReportNameModify(BBjEditModifyEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnReportNameModify Report name modification


OnReportTabClose(BBjTabCloseEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Callback method that handles a view tab being close


OnReportTabPopup(BBjTabPopupEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Callback method that handles a view tab popup request


OnReportTabSelected(BBjTabSelectedEvent p_event!) - method in class BBJasper.BBJasperTabbedView

Callback method that handles a view tab being selected


OnReportWindowMouseUp(BBjMouseUpEvent p_event!) - method in class BBJasper.BBJasperViewerControl

Called when the mouse is pressed up over the report window


OnReportWindowMouseUp(BBjMouseUpEvent p_event!) - method in class BBJasper.BBJasperView

Called when the mouse is pressed up over the view


OnResize(BBjResizeEvent p_event!) - method in class Dashboard.DashboardWindow

Called when the window is resized by the user


OnResize(BBjResizeEvent p_event!) - method in class GDocSelectionDialog

OnResize(BBjResizeEvent p_event!) - method in class GDocFolderSelectionDialog

OnResize(BBjResizeEvent p_event!) - method in class GDocOpenDialog

OnResize(BBjResizeEvent p_event!) - method in class GDocSaveDialog

OnResizeTimer(BBjTimerEvent p_event!) - method in class Dashboard.DashboardWindow

Called when the resize timer is triggered


OnRSBrowse(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSBrowse Called when the RS browse button is pushed


OnRSColumns(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSColumns Called when the RS Fields button is pushed


OnRSColumnsCheckOff(BBjGridCheckOffEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSColumnsCheckOff Called a check box is checked off in the fields grid


OnRSColumnsCheckOn(BBjGridCheckOnEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSColumnsCheckOn Called a check box is checked on in the fields grid


OnRSColumnsClose(BBjSysGuiEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSColumnsClose Called when the RS Window is closed


OnRSColumnsExecute(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnRSColumnsExecute Called when the RS Fields Execute button is pushed


OnSave(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

Called when the save popup menu item is selected on the widget control


OnSave(BBjSysGuiEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnSave Callback run when user selects to save the report


OnSave(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnSave Callback run when user selects to save the report


OnSave(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnSave Saves the design


OnSaveAs(BBjSysGuiEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnSaveAs Callback run when user selects to save-as the report


OnSaveAs(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnSaveAs Callback run when user selects to save-as the report


OnSaveCurrentPageAsImage(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnSaveCurrentPageAsImage Callback for when the create current page as image menu item is selected


OnSaveGoogleDoc(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnSaveGoogleDoc Callback for when the save google doc menu item is selected


OnSaveGoogleDoc(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnSaveGoogleDoc Callback for when the save google doc menu item is selected


OnScreenResize(BBjScreenResizeEvent p_event!) - method in class BBJasper.BBJasperViewerWindow

OnWindowResize Called when the screen is resized by the user


OnScreenResizeTimer(BBjTimerEvent p_event!) - method in class BBJasper.BBJasperViewerWindow

OnScreenResizeTimer Called when the screen resize timer is triggered


OnSearch(BBjButtonPushEvent p_event!) - method in class GDocSelectionDialog

OnSelectDocument(BBjGridSelectRowEvent p_event!) - method in class GDocOpenDialog

OnSelectDocument(BBjGridSelectRowEvent p_event!) - method in class GDocSaveDialog

OnSelectDocumentType(BBjListSelectEvent p_event!) - method in class GDocSaveDialog

OnSelection() - method in class GDocSelectionListener

OnSelection() - method in class GDocSelectionDialog

OnSelection() - method in class GDocFolderSelectionDialog

OnSelection() - method in class GDocOpenDialog

OnSelection() - method in class GDocSaveDialog

OnSeriesAdd(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesAdd: Called when the series add button is pushed


OnSeriesClose(BBjSysGuiEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesClose: Called when the series window is close


OnSeriesListSelect(BBjListSelectEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesListSelect: Called when a series is selected from the BBjListButton


OnSeriesRemove(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesRemove: Called when the series remove button is pushed


OnSeriesSelect(BBjListClickEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesSelect: Called when a series is selected from the BBjListBox


OnSeriesUpdate(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnSeriesUpdate: Called when the series update button is pushed


OnSourceFileBrowseButton(BBjButtonPushEvent ev!) - method in class WidgetWizardFrame7

Method OnSourceFileBrowseButton:
Generates the FileChooser to select a bbj file


OnSQLExecute(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnSQLExecute Called when the SQL Execute button is pushed


OnTableCheckOff(BBjGridCheckOffEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnTableCheckOff Called when a check box in the table contents grid is unchecked


OnTableCheckOn(BBjGridCheckOnEvent p_event!) - method in class BBJasper.BBJasperDesigner

OnTableCheckOn Called when a check box in the table contents grid is checked


OnTabSelect(BBjTabSelectedEvent p_event!) - method in class Dashboard.DashboardControl

Called when a tab is selected


OnTabSelect(BBjTabSelectedEvent p_event!) - method in class WidgetDashboardBuildItem

Method OnTabSelect Called when the a tab is selected in the DashboardControl


onTbtAddPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onTbtAddPush: Push event handler for the "Add" tool button


onTbtAddPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtAddPush: Tool button push event handler for the "Add" tool button


onTbtInsertPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtInsertPush: Tool button push event handler for the "Insert" tool button


onTbtMoveDownPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtMoveDownPush: Tool button push event handler for the "Move Down" tool button


onTbtMoveFirstPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtMoveFirstPush: Tool button push event handler for the "Move To First" tool button


onTbtMoveLastPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtMoveLastPush: Tool button push event handler for the "Move To Last" tool button


onTbtMoveUpPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtMoveUpPush: Tool button push event handler for the "Move Up" tool button


onTbtPgmFileFindPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method onTbtPgmFileFindPush: Tool button push event handler for the program file find tool button


onTbtRemovePush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame3

Method onTbtRemovePush: Push event handler for the "Remove" tool button


onTbtRemovePush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame4

Method onTbtRemovePush: Tool button push event handler for the "Remove" tool button


onTbtResFileFindPush(BBjToolButtonPushEvent pEvent!) - method in class DialogWizard.DialogWizardFrame1

Method onTbtResFileFindPush: Tool button push event handler for the resource file find tool button


OnTitleModify(BBjEditModifyEvent p_event!) - method in class WidgetWizardFrame3

Method OnTitleModify:
Called when the title is modified


OnToolBarWindowMouseUp(BBjMouseUpEvent p_event!) - method in class BBJasper.BBJasperViewerControl

Called when the mouse is pressed up over the tool bar window


OnToolButtonPush(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnToolButtonPush Callback called when a tool button is pushed


OnTreeExpand(BBjTreeNodeExpandedEvent p_event!) - method in class GDocSelectionDialog

OnTreeSelect(BBjTreeNodeSelectedEvent p_event!) _break_ - method in class GDocSelectionDialog

onTypeSelectBtnCancelPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardFrame2

Method onTypeSelectBtnCancelPush: Button push event handler for the type selection "Cancel" button


onTypeSelectBtnOkPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardFrame2

Method onTypeSelectBtnOkPush: Button push event handler for the type selection "OK" button


onTypeSelectBtnSearchPush(BBjButtonPushEvent p_event!) - method in class DialogWizard.DialogWizardFrame2

Method onTypeSelectBtnSearchPush: Button push event handler for the type selection "Search" button


onTypeSelectLbtTypeChange(BBjListChangeEvent p_event!) - method in class DialogWizard.DialogWizardFrame2

Method onTypeSelectLbtTypeChange: List change event handler for the type selection "Type" list button


OnUpdate(BBjSysGuiEvent p_event!) - method in class AdminLoginDialog

OnUpdateCategory(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame4

Method OnUpdateCategory: Called when the Update button is pressed


OnUseDynamicWidgetSize(BBjCheckOffEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user chooses to use a dynamic widget size


OnUseFixedWidgetSize(BBjCheckOnEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user chooses to use a fixed widget size


OnUseWidgetFontScaling(BBjCheckOnEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user chooses to use a fixed widget size


OnViewData(BBjPopupSelectEvent p_event!) - method in class Dashboard.WidgetControl

Called when the view data popup menu item is selected on the widget control


OnViewerControlEvent(BBjSysGuiEvent p_event!) - method in class Dashboard.JasperViewerWidget

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(BBjCloseEvent p_event!) - method in class BBJasper.BBJasperView

OnViewWindowClose Callback invoked when a view window is closed


OnWidgetAdd(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetAdd: Called when the widget add button is pressed


OnWidgetControlMouseUp(BBjMouseUpEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnWidgetControlPopup(BBjPopupRequestEvent p_event!) - method in class Dashboard.WidgetControl

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.


OnWidgetDashboardSelect(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame1

Method OnWidgetDashboardSelect: Called when the widget dashboard radio button is selected


OnWidgetFontScalingScroll(BBjControlScrollEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user selects a custom font scaling factor from the Customize window


OnWidgetListSelect(BBjListSelectEvent p_event!) - method in class WidgetWizardFrame6

Method OnWidgetListSelect: Called when a widget is selected from the BBjListButton


OnWidgetRemove(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetRemove: Called when the widget remove button is pressed


OnWidgetSelect(BBjCustomEvent p_event!) - method in class Dashboard.DashboardCategoryControl

Called when a widget is selected


OnWidgetSelect(BBjCustomEvent p_event!) - method in class BaseBuildItem

Called when a widget is selected


OnWidgetSelect(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame1

Method OnWidgetSelect: Called when the widget radio button is selected


OnWidgetSelect(BBjCustomEvent p_event!) - method in class WidgetWizardFrame5

Called when a widget is selected


OnWidgetSelect(BBjCustomEvent p_event!) - method in class WidgetWizardFrame6

Called when a widget is selected


OnWidgetSetSelect(BBjCheckOnEvent p_event!) - method in class WidgetWizardFrame1

Method OnWidgetSetSelect: Called when the widget set radio button is selected


OnWidgetSetWindowResize(BBjResizeEvent p_event!) - method in class Dashboard.EmbeddedWidgetSetWindow

Called when the window is resized by the user


OnWidgetSetWindowResizeTimer(BBjTimerEvent p_event!) - method in class Dashboard.EmbeddedWidgetSetWindow

Called when the resize timer is triggered


OnWidgetSizeScroll(BBjControlScrollEvent p_event!) - method in class Dashboard.DashboardControl

Called when the user selects a color theme from the Customize window


OnWidgetTitleModify(BBjEditModifyEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetTitleModify: Called when the widget title is modified


OnWidgetTypeGainedFocus(BBjGainedFocusEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetTypeGainedFocus Called when the widget type menu button gains focus


OnWidgetTypeLostFocus(BBjLostFocusEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetTypeLostFocus Called when the widget type menu button loses focus


OnWidgetTypePushed(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetTypePushed Called when the widget type menu buton is pushed


OnWidgetTypeSelect(BBjPopupSelectEvent p_event!) - method in class WidgetWizardFrame5

Called when a widget type is selected


OnWidgetUpdate(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame5

Method OnWidgetUpdate: Called when the widget update button is pressed


OnWidgetUpdate(BBjButtonPushEvent p_event!) - method in class WidgetWizardFrame6

Method OnUpdateWidget: Called when the update button is pressed


OnWindowResize(BBjResizeEvent p_event!) - method in class BBJasper.BBJasperViewerWindow

OnWindowResize Called when the window is resized by the user


OnWindowResizeTimer(BBjTimerEvent p_event!) - method in class BBJasper.BBJasperViewerWindow

OnWindowResizeTimer Called when the window resize timer is triggered


onWndActivate(BBjActivateEvent pEvent!) - method in class DialogWizard.BBDialog

Method onWndActivate: Set this task as the active task when window is activated


onWndRestore(BBjRestoreEvent pEvent!) - method in class DialogWizard.BBDialog

Method onWndRestore: Set this task as the active task when window is restored


onWndRunSelectClose(BBjCloseEvent p_event!) _break_ - method in class DialogWizard.DialogWizardRun

Method onWndRunSelectClose: Window close event handler for the "Run Selection" dialog


onWndTypeSelectClose(BBjCloseEvent p_event!) _break_ - method in class DialogWizard.DialogWizardFrame2

Method onWndTypeSelectClose: Window close event handler for the type selection dialog


onWndWizardClose(BBjCloseEvent p_event!) _break_ - method in class DialogWizard.DialogWizard

Method onWndWizardClose: Close event handler for the main window


OnZoomGainedFocus(BBjGainedFocusEvent p_gainedFocusEvent!) - method in class BBJasper.BBJasperViewerControl

OnZoomIn(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnZoomIn Callback for when the zoom in menu item is selected


OnZoomInToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnZoomInToolButton Callback for when the zoom in tool button is pushed


OnZoomListEditSelect(BBjListSelectEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnZoomListEditSelect Callback for when a zoom level selection is made


OnZoomLostFocus(BBjLostFocusEvent p_lostFocusEvent!) - method in class BBJasper.BBJasperViewerControl

OnZoomOut(BBjPopupSelectEvent p_event!) - method in class BBJasper.BBJasperView

OnZoomOut Callback for when the zoom out menu item is selected


OnZoomOutToolButton(BBjToolButtonPushEvent p_event!) - method in class BBJasper.BBJasperViewerControl

OnZoomOutToolButton Callback for when the zoom out tool button is pushed


Opacity - field in class Dashboard.AlphaColor

OPEN_FILES - field in class Admin

OPEN_FILTER_KEY$ - field in class GDocOpenDialog

OPEN_FOLDER_KEY$ - field in class GDocOpenDialog

OPEN_LINK_IN_CURRENT_WINDOW$=#Translations!.getTranslation("open.link.in.current.window") - field in class BBJasper.BBJasperView

Translated text for open link in current window


OPEN_LINK_IN_CURRENT_WINDOW_MENU_ITEM_NAME$="BBJVOpenLinkInCurrentWindowMenuItem" - field in class BBJasper.BBJasperView

Open link in current window menu item name


OPEN_LINK_IN_NEW_ACTIVE_TAB$=#Translations!.getTranslation("open.link.in.new.active.tab") - field in class BBJasper.BBJasperView

Translated text for open link in new active tab


OPEN_LINK_IN_NEW_ACTIVE_TAB_MENU_ITEM_NAME$="BBJVOpenLinkInNewActiveTabMenuItem" - field in class BBJasper.BBJasperView

Open link in new active tab menu item name


OPEN_LINK_IN_NEW_INACTIVE_TAB$=#Translations!.getTranslation("open.link.in.new.inactive.tab") - field in class BBJasper.BBJasperView

Translated text for open link in new inactive tab


OPEN_LINK_IN_NEW_INACTIVE_TAB_MENU_ITEM_NAME$="BBJVOpenLinkInNewInactiveTabMenuItem" - field in class BBJasper.BBJasperView

Open link in new inactive tab menu item name


OPEN_LINK_IN_NEW_WINDOW$=#Translations!.getTranslation("open.link.in.new.window") - field in class BBJasper.BBJasperView

Translated text for open link in new window


OPEN_LINK_IN_NEW_WINDOW_MENU_ITEM_NAME$="BBJVOpenLinkInNewWindowMenuItem" - field in class BBJasper.BBJasperView

Open link in new window menu item name


OpenByDefault! - field in class GxColumns.GxDefaultColumnGroup

Set to 'true' if this group should be opened by default.


openExportFile(BBjString p_exportFile$) - method in class Dashboard.ExportData

openExportFile Opens the passed export file. This is a NOOP in BUI.


openInBrowser() - method in class GDoc

openToolpanel(BBjString id!) - method in class GxSidebar.GxSidebar

Open toolpanel

Open the given toolpanel


Operator! - field in class GxClientModels.GxClientFilterCombinedModel

The combine operator


OPERATOR_AND() - method in class GxClientModels.GxClientFilterCombinedModel

Constant value which defines the AND operator


OPERATOR_OR() - method in class GxClientModels.GxClientFilterCombinedModel

Constant value which defines the OR operator


Options! - field in class BBjGridExWidget.BBjGridExWidget

Instance of the grid options class


OrderBy!=null() - field in class gappsv3.GCalendar

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"


ORIENTATION_HORIZONTAL=1 - field in class Dashboard.BarChartWidget

ORIENTATION_HORIZONTAL=1 - field in class Dashboard.LineChartWidget

ORIENTATION_VERTICAL=0 - field in class Dashboard.BarChartWidget

ORIENTATION_VERTICAL=0 - field in class Dashboard.LineChartWidget

OUTPUT_FILE$ - field in class BBJasper.BBJasperExporterParameter

OUTPUT_FILE_NAME$ - field in class BBJasper.BBJasperExporterParameter

OUTPUT_STREAM$ - field in class BBJasper.BBJasperExporterParameter

OUTPUT_STRING_BUFFER$ - field in class BBJasper.BBJasperExporterParameter

OUTPUT_WRITER$ - field in class BBJasper.BBJasperExporterParameter

OverlayLoadingTemplate! - field in class GxOptions.GxOptions

Provide a template for 'loading' overlay if not happy with the default one.
#Configuration
#GridRenderer


OverlayNoRowsTemplate! - field in class GxOptions.GxOptions

Provide a template for 'no rows' overlay if not happy with the provided.
#Configuration
#GridRenderer


OverwriteDocument! - field in class GDocSaveDialog

OverwriteID$=$$ - field in class GDocSaveDialog

OWNER_ROLE=1 - field in class GDoc

P

Page=-1 - field in class Dashboard.JasperViewerWidget

Page to display


PAGE_INDEX$ - field in class BBJasper.BBJasperExporterParameter

PAGE_INPUTN_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the page inputn, the default is 40


PAGE_NUMBER_INPUTN_NAME$="BBJVPageNumberInputN" - field in class BBJasper.BBJasperViewerControl

Page number inputn name


PAGE_NUMBER_INPUTN_NAME$=BBJasperViewerControl.getPAGE_NUMBER_INPUTN_NAME() - field in class Dashboard.JasperViewerWidget

Page number inputn name


PAGE_STATUS$=#Translations!.getTranslation("page.status") - field in class BBJasper.BBJasperViewerControl

Translated text for page status


PageToken!=null() - field in class gappsv3.GCalendar

Filter for getEvents() method: Token specifying which result page to return. Optional. (string)


PaintGlossOnFlatChart - field in class Dashboard.BarChartWidget

A number that indicates whether to paint a glossy layer on a flat bar chart


PARAMETERS_OVERRIDE_REPORT_HINTS$ - field in class BBJasper.BBJasperExporterParameter

ParamVector! - field in class BBJasper.ProcedureType

Parent! - field in class BBTranslator.BBTranslations

A field variable that contains the parent translations


ParentHref$ - field in class FolderInfo

ParentKey! - field in class GxClientModels.GxClientRowModel

The row parent key, if any


ParentViewerControl! - field in class BBJasper.BBJasperViewerWindow

The parent BBJasperViewerControl


Password$ - field in class UserCredentials

Password$ - field in class DSUDDB

Password$ - field in class GAppsLoginDialog

Password$ - field in class BBJasper.BBJasperDesigner

password$ - field in class Email.Email

Password to use for authentication to the mail server


Password$="admin123" - field in class AdminLoginDialog

Password$=#DEFAULT_PASSWORD$ - field in class Admin

PASSWORD_VAR!="passwd=" - field in class DSUDDB

PasswordRequiredValue - field in class Admin

Pattern! - field in class GxCellEditors.GxCellEditorBasicText

A regular expression that the input's value must match in order for the value to pass constraint validation


Pattern! - field in class GxCellEditors.GxCellEditorSuggestion

A regular expression that the input's value must match In order for the value to pass constraint validation


PDF_FILES_FILTER_NAME$="PDF_FILES" - field in class GDocSelectionDialog

PDF_SAVE_CONTRIBUTOR=1 - field in class BBJasper.BBJasperView

Constant that represents the PDF save contributor


PDF_SAVE_CONTRIBUTOR=BBJasperView.getPDF_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the PDF save contributor


PDF_TYPE$="application/pdf" - field in class GDoc

PDF_TYPE_NAME$="PDF" - field in class GDocSaveDialog

PDFExporter! - field in class BBJasper.BBJasperView

PDF exporter which contains export options


PDFFaxJob - class in this project



PDFFaxJob() - constructor in class PDFFaxJob

PDFFaxJob(BBjString port$) - constructor in class PDFFaxJob

PEEKER_ROLE=2 - field in class GDoc

PERMISSIONS_ERROR=309 - field in class GDoc

PersistUserSettings - field in class Dashboard.Dashboard

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$ - field in class WidgetWizard

PIE_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Pie chart widget type constant


PieChartWidget - class in Dashboard

PieChartWidget A Dashboard Utility Widget that displays a pie chart where the data values all add up to 100%


PieChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - constructor in class Dashboard.PieChartWidget

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.


PieChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - constructor in class Dashboard.PieChartWidget

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.


PieChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.PieChartWidget

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.


PieChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.PieChartWidget

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.


PieChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.PieChartWidget

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.


pinColumn(BBjNumber p_column, BBjNumber p_side) - method in class Dashboard.GridExWidget

Pins a column in the grid to the left or right margin


pinColumn(BBjString field$, BBjString pin$) - method in class BBjGridExWidget.BBjGridExWidget

Pin a column of the grid to the left or the right margin


#API


Pinned! - field in class GxColumns.GxDefaultColumnDefinition

Set to 'left' or 'right' to pin.


#Configuration
#ColumnsRenderer


PINNED_LEFT() - method in class GxColumns.GxDefaultColumnDefinition

Get pinned left constant


PINNED_RIGHT() - method in class GxColumns.GxDefaultColumnDefinition

Get pinned right constant


PinnedBottomRows! - field in class GxOptions.GxOptions

The ResultSet instance which contains the bottom pinned rows


PinnedRowCellRenderer! - field in class GxColumns.GxDefaultColumnDefinition

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


PinnedTopRows! - field in class GxOptions.GxOptions

The ResultSet instance which contains the top pinned rows


PivotGroupHeaderHeight! - field in class GxOptions.GxOptions

The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
#Configuration
#GridRenderer


PivotHeaderHeight! - field in class GxOptions.GxOptions

The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
#Configuration
#GridRenderer


PivotIndex! - field in class GxColumns.GxDefaultColumnDefinition

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


PivotMode! - field in class GxOptions.GxOptions

Set to true to enable pivot mode
#Configuration
#API


PivotPanelShow! - field in class GxOptions.GxOptions

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! - field in class Dashboard.DashboardWidgetFilter

Placeholder text to be shown when the filter is of type FILTER_TYPE_LISTEDIT or FILTER_TYPE_EDITBOX and the control is empty


PNG_IMAGE$=#Translations!.getTranslation("png.image") - field in class BBJasper.BBJasperViewerControl

Translated text for png image


PNG_IMAGE$=#Translations!.getTranslation("png.image") - field in class BBJasper.BBJasperView

Translated text for png image


PopoutWidgetHeight - field in class Dashboard.DashboardWidget

The desired height of the widget when popped out


PopoutWidgetWidth - field in class Dashboard.DashboardWidget

The desired width of the widget when popped out


popoutWindowResizeTimerEvent(BBjTimerEvent p_event!) - method in class Dashboard.WidgetControl

An internal method used by the WidgetControl to resize the window when the popout window's resize timer event fires


PoppedOutText$ - field in class Dashboard.HtmlViewWidget

A string with HTML contents to be used for the popped-out version of the widget.


PoppedOutUrl$ - field in class Dashboard.HtmlViewWidget

A string representation of the URL, such as "http://www.basis.cloud" to be used for the popped-out version of the widget.


PopupMenu! - field in class Dashboard.DashboardWidgetMenu

The BBjPopupMenu to display when triggered by a user event.


Port - field in class BBJasper.BBJasperDesigner

Port% - field in class UserCredentials

Port%=#DEFAULT_PORT% - field in class Admin

Port%=2002 - field in class AdminLoginDialog

PortRequiredValue - field in class Admin

Position - field in class Dashboard.DashboardWidgetAttribute

Position of widget in category


PossibleFalseValues! - field in class GxOptions.GxOptionsBoolean

A hashset of what is considered false


PossibleTrueValues! - field in class GxOptions.GxOptionsBoolean

A hashset of what is considered true


PPTX_SAVE_CONTRIBUTOR=14 - field in class BBJasper.BBJasperView

Constant that represents the PPTX save contributor


PPTX_SAVE_CONTRIBUTOR=BBJasperView.getPPTX_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the PPTX save contributor


PPTXExporter! - field in class BBJasper.BBJasperView

PPTX exporter which contains export options


preferAsyncExecution(BBjNumber enable!) - method in class BBjGridExWidget.BBjGridExWidget

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.


PreferAsyncExecution! - field in class BBjGridExWidget.GxExecutor

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.


Prefix! - field in class GxExpressions.GxExpressionStringsFormatter

A prefix to append to the value after it is formatted


Prefix! - field in class GxExpressions.GxExpressionNumbersFormatter

A prefix to append to the value after it is formatted


PRESENTATION_TYPE$=#MIME$+"presentation" - field in class GDoc

PRESENTATION_TYPE_NAME$="PRESENTATION" - field in class GDocSaveDialog

PRESENTATIONS_FILTER_NAME$="PRESENTATIONS" - field in class GDocSelectionDialog

previewImage() - method in class Dashboard.Widget

Returns the preview image of the widget


previewImage() - method in class Dashboard.BaseWidget

previewText() - method in class Dashboard.Widget

Returns the preview text of the widget


previewText() - method in class Dashboard.BaseWidget

PREVIOUS_PAGE$=#Translations!.getTranslation("previous.page") - field in class BBJasper.BBJasperViewerControl

Translated text for previous page


PREVIOUS_PAGE$=#Translations!.getTranslation("previous.page") - field in class BBJasper.BBJasperView

Translated text for previous page


PREVIOUS_PAGE_MENU_ITEM_NAME$="BBJVPreviousPageMenuItem" - field in class BBJasper.BBJasperView

Previous page menu item name


PREVIOUS_PAGE_MENU_ITEM_NAME$=BBJasperView.getPREVIOUS_PAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Previous page menu item name


PREVIOUS_PAGE_TOOL_BUTTON_NAME$="BBJVPreviousPageToolButton" - field in class BBJasper.BBJasperViewerControl

Previous page tool button name


PREVIOUS_PAGE_TOOL_BUTTON_NAME$=BBJasperViewerControl.getPREVIOUS_PAGE_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Previous page tool button name


previousHighlight() - method in class BBJasper.BBJasperView

previousHighlight Finds the previous find element


previousPage() - method in class BBJasper.BBJasperView

previousPage Changes the view to display the previous page, if there is one


print(BBjNumber p_onClient, BBjNumber p_dialog) - method in class BBJasper.BBJasperReport

print Prints the report


print(BBjNumber p_onClient, BBjNumber p_dialog, BBJasperPrintServiceExporter p_bbjasperPrintServiceExporter!) - method in class BBJasper.BBJasperReport

print Prints the report


print() - method in class BBJasper.BBJasperView

print Prints the current report


print(JasperPrint@ p_jasperPrint!, BBjNumber p_dialog, BBJasperPrintServiceExporter p_printServiceExporter!) - method in class BBJasper.BBJasperPrint

print Prints a report to a client printer with or without printer dialog


print(JasperPrint p_jasperPrint!, BBjNumber p_dialog, BBJasperPrintServiceExporter p_printServiceExporter!) - method in class BBJasper.BBJasperPrint

print Prints a report to a server printer with or without printer dialog


print(BBjNumber p_printChan, BBjString p_text$) - method in class BBTranslator.BBTranslationBundle

print(BBjNumber p_printChan, BBjString p_text!, BBjNumber p_wrapText, BBjNumber p_pauseConsole) - method in class BBTranslator.BBTranslationBundle

PRINT$=#Translations!.getTranslation("print") - field in class BBJasper.BBJasperViewerControl

Translated text for print


PRINT$=#Translations!.getTranslation("print") - field in class BBJasper.BBJasperView

Translated text for print


PRINT_MENU_ITEM_NAME$="BBJVPrintMenuItem" - field in class BBJasper.BBJasperView

Print menu item name


PRINT_MENU_ITEM_NAME$=BBJasperView.getPRINT_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Print menu item name


PRINT_REQUEST_ATTRIBUTE_SET$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

PRINT_SAVE_CONTRIBUTOR=11 - field in class BBJasper.BBJasperView

Constant that represents the PRINT save contributor


PRINT_SAVE_CONTRIBUTOR=BBJasperView.getPRINT_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the PRINT save contributor


PRINT_SERVICE$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

PRINT_SERVICE_ATTRIBUTE_SET$ - field in class BBJasper.BBJasperPrintServiceExporterParameter

PRINT_TOOL_BUTTON_NAME$="BBJVPrintToolButton" - field in class BBJasper.BBJasperViewerControl

Print tool button name


PRINT_TOOL_BUTTON_NAME$=BBJasperViewerControl.getPRINT_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Print tool button name


PrintFrame! - field in class BBJasper.FindElement

PrintServiceExporter! - field in class BBJasper.BBJasperView

Print service exporter which contains export options


PrintText! - field in class BBJasper.FindElement

PrivateExtendedProperty!=null() - field in class gappsv3.GCalendar

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)


PROCEDURE_TYPE=8 - field in class BBJasper.DesignType

ProcedureName$ - field in class BBJasper.ProcedureType

ProcedureParam - class in BBJasper

ProcedureParam class


ProcedureParam() - constructor in class BBJasper.ProcedureParam

Constructor Constructs a ProcedureParam.


PROCEDURES_LABEL_TYPE=7 - field in class BBJasper.DesignType

ProcedureType - class in BBJasper

ProcedureType class


ProcedureType(BBjString p_databaseName$, BBjString p_procedureName$) - constructor in class BBJasper.ProcedureType

Constructor Constructs a ProcedureType for the given database and procedure name.


PROCESSES - field in class Admin

processRecord(QVGrid QVGrid!, DataRow dr!) - method in class QVGrid.RowListener

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


ProgDirectory$ - field in class Dashboard.ExportData

Program directory


PROGRESS_MONITOR$ - field in class BBJasper.BBJasperExporterParameter

PropDirectory$ - field in class Dashboard.ExportData

Prop directory which contains the resource bundle


Properties! - field in class BBTranslator.BBTranslations

A field variable that contains the properties


PROPERTY_CHARACTER_ENCODING$ - field in class BBJasper.BBJasperExporterParameter

PROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS$ - field in class BBJasper.BBJasperExporterParameter

PROPERTY_IGNORE_PAGE_MARGINS$ - field in class BBJasper.BBJasperExporterParameter

protocol$ - field in class Email.Email

Mail server protocol, which can be smtp or smtps


publishBUIApp(BBjString p_appName!, BBjAppConfig p_config!) - method in class BBUtils.BBUtils

putClientProperty(Object p_key!, Object p_value!) - method in class QVGrid.QVGrid

see BBjControl


putParam(BBjString p_key$, Object p_value!) - method in class BBJasper.BBJasperReport

putParam Sets an individual report parameter


putParams(HashMap p_hashMap!) - method in class BBJasper.BBJasperReport

putParams Sets report parameters


Q

Q!=null() - field in class gappsv3.GCalendar

Filter for getEvents() method: Free text search terms to find events that match these terms in any field, except for extended properties. Optional. (string)


Queue! - field in class BBjGridExWidget.GxExecutor

A map of scripts which must be executed


quotePath(BBjString p_path!) - method in class BBLaunchDock

QVGrid - class in QVGrid

QuickView Grid utility class


QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!) - constructor in class QVGrid.QVGrid

Constructs QVGrid component on passed parent window in existing child window.


QVGrid(BBjWindow parentWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h) - constructor in class QVGrid.QVGrid

Constructs QVGrid component on passed parent window using given id and dimensions.


QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h) - constructor in class QVGrid.QVGrid

Constructs QVGrid component on passed parent window in existing child window using given id and dimensions.


R

RangeSelection! - field in class GxClientModels.GxClientAddRangeChartModel

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).


Rate! - field in class BBjCalendarWidget.BBjJavaScriptExecutor

The number of milliseconds before the executor tries to flush the enqueued scripts on the client.


Rate! - field in class BBjGridExWidget.GxExecutor

The number of milliseconds before the executor tries to flush the enqueued scripts on the client


READER_ROLE=3 - field in class GDoc

ReadOnlyScope!="https://www.googleapis.com/auth/calendar.readonly" - field in class gappsv3.GCalendarAPI

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.


ReadWriteScope!="https://www.googleapis.com/auth/calendar" - field in class gappsv3.GCalendarAPI

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.


READY$=#Translations!.getTranslation("ready") - field in class BBJasper.BBJasperView

Translated text for ready


rebuildGrid(BBjNamespaceEvent ev!) - method in class DialogWizard.DialogWizardFrame2

Method rebuildGrid: Namespace event handler to rebuild grid from "ControlVariables" vector


rebuildGrid(BBjNamespaceEvent ev!) - method in class DialogWizard.DialogWizardFrame4

Method rebuildGrid: Namespace event handler to rebuild the toolbar grid


rebuildLists(BBjNamespaceEvent ev!) - method in class DialogWizard.DialogWizardFrame3

Method rebuildLists: BBjNamespaceEvent event handler to rebuild the lists


RECORD_SET_SERIES_TYPE - field in class Dashboard.Series

RecordSet! - field in class Dashboard.GridExWidget

A developer-provided BBjRecordSet used to provide data for the widget


RecordSet! - field in class Dashboard.GridWidget

A BBjRecordSet used to provide data for the widget


RecordSet! - field in class Dashboard.PieChartWidget

A BBjRecordSet used to provide data for the widget


RecordSet! - field in class Dashboard.BarChartWidget

A BBjRecordSet used to provide data for the widget


RecordSet! - field in class Dashboard.LineChartWidget

A BBjRecordSet used to provide data for the widget


Recordset! - field in class Dashboard.RecordsetSeries

RecordsetSeries - class in Dashboard

An BBjRecordset-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.


RecordsetSeries(BBjString p_name$, BBjNumber p_index, BBjRecordSet p_recordset!, BBjVector p_columns!) - constructor in class Dashboard.RecordsetSeries

RedirectURL! - field in class gappsv3.GOAuth2

URL or URI to which the authorization token will be sent.


RedirectURLProperty!="com.basis.util.goauth2.redirecturl" - field in class gappsv3.GOAuth2

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.


redraw(BBjNumber shouldCreate!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


redraw(Boolean f_init!) - method in class BBjGridExWidget.BBjGridExWidget

@Override

This method is called whenever the widget needs to be rendered


redrawRows() - method in class BBjGridExWidget.BBjGridExWidget

Gets the grid to remove a row from the DOM and recreate it again from scratch.


refetchAllEntries() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


refetchAllEntrySources() - method in class BBjCalendarWidget.BBjCalendarWidget

Refetches all CalendarEntrySource objects in the calendar, causing them to retrieve their entries again.


refetchEntrySource(BBjString id!) - method in class BBjCalendarWidget.BBjCalendarWidget

Refetches the CalendarEntrySource object in the calendar given its unique ID, causing it to retrieve its entries again.


refresh() - method in class Dashboard.DashboardWidget

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.


refresh() - method in class Dashboard.DashboardControl

Refreshes the widgets in the currently selected category


refresh() - method in class Dashboard.DashboardCategoryControl

Refreshes the control


refresh() - method in class Dashboard.WidgetControl

Refreshes the widget control


refresh(BBjNumber p_refreshType) - method in class Dashboard.WidgetControl

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.


refresh() - method in class Dashboard.RefreshableWidget

Called to refresh the widget


refresh() - method in class Dashboard.ImageWidget

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


refresh() - method in class Dashboard.HtmlViewWidget

Refreshes the HtmlViewWidget contents by reloading the URL or setting the HTML text, and injecting/executing JavaScripts if applicable


refresh() - method in class Dashboard.GridExWidget

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.


refresh() - method in class Dashboard.GridWidget

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.


refresh() - method in class Dashboard.ChartWidget

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.


refresh() - method in class Dashboard.PieChartWidget

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


refresh() - method in class Dashboard.BarChartWidget

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


refresh() - method in class Dashboard.StackedPercentageBarChartWidget

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


refresh() - method in class Dashboard.LineChartWidget

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


refresh() - method in class Dashboard.XYChartWidget

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


refresh() - method in class Dashboard.JasperViewerWidget

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() - method in class BBLaunchDock

refresh() - method in class BBJasper.BBJasperViewerControl

refresh Refreshes the image for the current report page and zoom level


refresh() - method in class BBJasper.BBJasperView

refresh Refreshes the image for the current report page and zoom level


REFRESH_TYPE_AUTO=2 - field in class Dashboard.DashboardWidgetRefreshEvent

A constant for a refresh initiated by the widget's AutoRefresh timer, used in conjunction with the getRefreshType() method.


REFRESH_TYPE_CATEGORY=1 - field in class Dashboard.DashboardWidgetRefreshEvent

A constant for a refresh initiated by the category's Refresh button, used in conjunction with the getRefreshType() method.


REFRESH_TYPE_WIDGET=0 - field in class Dashboard.DashboardWidgetRefreshEvent

A constant for a refresh initiated by the widget's Refresh menu or toolbutton, used in conjunction with the getRefreshType() method.


RefreshableWidget - interface in Dashboard

RefreshableWidget Interface that facilitates refreshing the widget


refreshAll() - method in class Dashboard.DashboardControl

Refreshes the widgets in all categories


refreshBuildItemWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

refreshFields() - method in class BBJasper.BBJasperDesigner

refreshFields Refreshes the fields in the fields grid


refreshProcedure() - method in class BBJasper.BBJasperDesigner

refreshProcedure Refreshes the procedure window


refreshToolbar() - method in class BBJasper.BBJasperViewerControl

refreshToolbar Refreshes the toolbar in case controls have been added/removed outside the class


refreshView() - method in class Dashboard.WidgetControl

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


refreshWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

refreshWidget(DashboardWidget p_dashboardWidget!) - method in class BaseBuildItem

refreshWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

refreshWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

refreshWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

registerBUIApp(BBjString p_prog$) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$, BBjString p_configFile$, BBjString p_workingDir$, BBjString p_InterpUser$) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$, BBjString p_configFile$, BBjString p_workingDir$, BBjString p_InterpUser$, BBjVector p_args!) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$, BBjString p_configFile$, BBjString p_workingDir$, BBjString p_InterpUser$, BBjVector p_args!, BBjNumber p_quiet) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$, BBjString p_configFile$, BBjString p_workingDir$, BBjString p_InterpUser$, BBjVector p_args!, BBjNumber p_quiet, BBjString p_cpName$) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerBUIApp(BBjString p_prog$, BBjString p_app$, BBjString p_configFile$, BBjString p_workingDir$, BBjString p_InterpUser$, BBjVector p_args!, BBjNumber p_quiet, BBjString p_cpName$, BBjString p_bbjAppName$, BBjString p_userName$, BBjString p_term$) - method in class BBUtils.BBUtils

Registers a BUI app given the provided parameters.


registerJDBCDriver(BBjString p_jdbcDriverClass$) - method in class BBJasper.BBJasperReport

registerJDBCDriver Registers the passed JDBC driver class


registerService() - method in class GoldMineIntegration.GoldMineIntegrationWebService

Register the web service with the default name (GMWS) and publish it.


registerService(BBjString p_serviceName$) - method in class GoldMineIntegration.GoldMineIntegrationWebService

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.


relatedPart! - field in class Email.Email

Multipart object


releaseBundleLock(BBjString p_name!, BBjString p_directory!) - method in class BBTranslator.BBTranslationBundle

ReleaseOnClose - field in class BBJasper.BBJasperViewerWindow

When set to TRUE (1), the interpreter running the viewer window will release when closed by the user


ReleaseOnClose - field in class BBJasper.BBJasperDesigner

reload() - method in class BBJasper.BBJasperViewerControl

reload Refills the report and refreshes the viewer


reload() - method in class BBJasper.BBJasperView

reload Refills the report and refreshes the view


RELOAD$=#Translations!.getTranslation("reload") - field in class BBJasper.BBJasperViewerControl

Translated text for reload


RELOAD$=#Translations!.getTranslation("reload") - field in class BBJasper.BBJasperView

Translated text for reload


RELOAD_MENU_ITEM_NAME$="BBJVReloadMenuItem" - field in class BBJasper.BBJasperView

Reload menu item name


RELOAD_MENU_ITEM_NAME$=BBJasperView.getRELOAD_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Reload menu item name


RELOAD_TOOL_BUTTON_NAME$="BBJVReloadToolButton" - field in class BBJasper.BBJasperViewerControl

Reload tool button name


RELOAD_TOOL_BUTTON_NAME$=BBJasperViewerControl.getRELOAD_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Reload tool button name


Remember% - field in class Admin

Remember%=1 - field in class AdminLoginDialog

Remember=1 - field in class GAppsLoginDialog

RememberGroupStateWhenNewData! - field in class GxOptions.GxOptions

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


RememberRequiredValue - field in class Admin

remove() - method in class GDoc

remove(BBjString column!) - method in class GxClientModels.GxClientSortModel

Remove a column from the model


remove(DataRow row!) - method in class GxClientModels.GxClientTransactionModel

Add new row


remove(BBjString language$) - method in class BBjGridExWidget.GxLanguageManager

Remove an added language


Remove! - field in class GxClientModels.GxClientTransactionModel

An array of row to remove


REMOVE_LOCALE_ERROR=257 - field in class BBTranslator.BBTranslationBundle

removeAlignedGrid(BBjGridExWidget widget!) - method in class BBjGridExWidget.BBjGridExWidget

Disable the current grid alignment with the passed one


removeAllEmailContacts() - method in class Email.EmailDialog

removeAllEmailContacts Removes all email contacts from the contact list


removeAllEntries() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


removeAllEntrySources() - method in class BBjCalendarWidget.BBjCalendarWidget

Removes all CalendarEntrySource objects from the calendar.


removeAllFilters() - method in class GDocSelectionDialog

removeAllMatchingNodes(BBjString p_name!) - method in class BBXMLDoc

removeAllMatchingNodes(Node p_node!, BBjString p_name!) - method in class BBXMLDoc

removeAllMatchingNodes(Node p_node!, BBjString p_name!, BBjNumber p_nodeType) - method in class BBXMLDoc

removeAllTypes() - method in class GDocSaveDialog

removeAllUserCredentialsCookies() - method in class Admin

removeAttribute(String attribute!) - method in class QVGrid.QVGrid

Removes a control attribute from the grid control


removeBuildItemCategory(BBjString p_categoryName$) - method in class WidgetWizard

removeBuildItemWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

Removes a widget


removeBuildItemWidgetSeries(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetWizard

removeCategory(BBjString p_categoryName$) - method in class BuildItem

removeCategory(BBjString p_categoryName$) - method in class WidgetBuildItem

removeCategory(BBjString p_categoryName$) - method in class WidgetSetBuildItem

removeCategory(BBjString p_categoryName$) - method in class WidgetDashboardBuildItem

removeCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$) - method in class QVGrid.QVGrid

Removes a CSS style name from a grid cell


removeChartToolbarItem(BBjString item!) - method in class BBjGridExWidget.BBjGridExWidget

Disable a chart toolbar item


#Enterprise
#Configuration
#API


removeChild(Locale p_locale!) - method in class BBTranslator.BBTranslations

Removes a child translation from the translations


removeChildren() - method in class BBTranslator.BBTranslations

Removes all children BBTranslationBundles


removeClassName(BBjString className!) - method in class BBjCalendarWidget.CalendarEntry

Removes the provided class name string (or CSS style) from the entry's vector of class names.


removeColumn(BBjString field!) - method in class BBjGridExWidget.BBjGridExWidget

Remove a column definition


#Configuration
#ColumnsRenderer


removeColumn(BBjString field!) - method in class GxColumns.GxColumnsManagerInterface

Remove a column definition


#Configuration
#ColumnsRenderer


removeColumn(BBjString field!) - method in class GxColumns.GxColumnsManager

Remove a column definition


#Configuration
#ColumnsRenderer


removeColumn(BBjString field!) - method in class GxColumns.GxColumnGroup

Remove a column definition


#Configuration
#ColumnsRenderer


removeColumnGroup(BBjString id!) - method in class BBjGridExWidget.BBjGridExWidget

Remove a column group definition


#Configuration
#ColumnsRenderer


removeColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManagerInterface

Remove a column group definition


#Configuration
#ColumnsRenderer


removeColumnGroup(BBjString id!) - method in class GxColumns.GxColumnsManager

Remove a column group definition


#Configuration
#ColumnsRenderer


removeColumnGroup(BBjString id!) - method in class GxColumns.GxColumnGroup

Remove a column group definition


#Configuration
#ColumnsRenderer


removeColumnStyleName(BBjNumber column, BBjString styleName$) - method in class QVGrid.QVGrid

Removes a CSS style name from a grid column


removeComponent(BBjString id!) - method in class GxStatusBar.GxStatusBar

Remove statusbar component


removeComponent(GxStatusBarComponentInterface component!) - method in class GxStatusBar.GxStatusBar

Remove statusbar component


removeDashboardCategory(BBjString p_categoryName$) - method in class Dashboard.Dashboard

Removes a dashboard category from the dashboard


removeDashboardCategoryControl(BBjString p_categoryName$) - method in class Dashboard.DashboardControl

Remove a dashboard category control


removeDashboardWidget(BBjString p_widgetName$) - method in class Dashboard.DashboardCategory

Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one


removeDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!) - method in class Dashboard.DashboardCategoryControl

An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object


removeDashboardWidgetControl(BBjString p_widgetName$) - method in class Dashboard.DashboardCategoryControl

An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name


removeEmail(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_emailAddress$) - method in class BUS

removeEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType) - method in class Email.EmailDialog

removeEmailAddress Removes an email address from the appropriate list


removeEmailAddresses(BBjVector p_emailAddresses!, BBjNumber p_emailType) - method in class Email.EmailDialog

removeEmailAddresses Removes email addresses from the appropriate list


removeEmailAttachment(BBjString p_emailAttachment$) - method in class Email.EmailDialog

removeEmailAttachment Removes an email attachment


removeEmailContact(EmailContact p_emailContact!) - method in class Email.EmailDialog

removeEmailContact Removes an email contact from the contact list


removeEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType) - method in class Email.EmailDialog

removeEmailContact Removes an email contact from the appropriate list


removeEmailContacts(BBjVector p_emailContacts!) - method in class Email.EmailDialog

removeEmailContacts Removes email contacts from the contact list


removeEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType) - method in class Email.EmailDialog

removeEmailContacts Removes email contacts from the appropriate list


removeEntries(BBjVector entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


removeEntry(CalendarEntry entry!) - method in class BBjCalendarWidget.BBjCalendarWidget

Removes an entry from the calendar.


removeEntryById(BBjString id!) - method in class BBjCalendarWidget.BBjCalendarWidget

Removes an entry from the calendar given its optional unique ID which must have previously been set.


removeEntrySource(BBjString id!) - method in class BBjCalendarWidget.BBjCalendarWidget

Removes a CalendarEntrySource and its entries from the calendar given its unique ID.


removeExtendedProperty(BBjString key!) - method in class BBjCalendarWidget.CalendarEntry

Removes the extended property from the entry's HashMap of extended properties given the property key.


removeField(BBjString p_field$) - method in class BBJasper.DatabaseType

removeField Removes a field to the database fields vector


removeFilter(BBjString p_filterName$) - method in class GDocSelectionDialog

removeLocale(Locale p_locale!) - method in class BBTranslator.BBTranslationBundle

removeNode(Node p_node!) - method in class BBXMLDoc

removeNotification(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_emailAddress$) - method in class BUS

removeParam(BBjString p_key$) - method in class BBJasper.BBJasperReport

removeParam Removes an individual report parameter


removeParams() - method in class BBJasper.BBJasperReport

removeParams Removes all report parameters


removePivotColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Disable pivot for columns.


#Enterprise
#Configuration
#API


removePopupMenu() - method in class QVGrid.QVGrid

Removes a popup menu from the grid control


removeRow(DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Remove a row from grid by the row reference


#API


removeRow(BBjNumber index!) - method in class BBjGridExWidget.BBjGridExWidget

Remove a row from grid by index


#API


removeRow(BBjString key!) - method in class BBjGridExWidget.BBjGridExWidget

Remove a row from grid by key


#API


removeRowGroupColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Disable row grouping for columns.


#Enterprise
#Configuration
#API


removeRowStyleName(BBjNumber row, BBjString styleName$) - method in class QVGrid.QVGrid

Removes a CSS style name from a grid row


removeSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperViewerControl

removeSaveContributor Removes a save contributor


removeSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperView

removeSaveContributor Removes a save contributor


removeSeries(BBjString p_seriesName$) - method in class Dashboard.XYChartWidget

Removes the requested series


removeStyle(String styleName!) - method in class QVGrid.QVGrid

Removes a CSS style name from the grid control


removeStyle(BBjString style!) - method in class BBjCalendarWidget.BBjCalendarWidget

Removes the provided CSS style name from the widget.


removeStyle(BBjString selector$) - method in class BBjGridExWidget.BBjGridExWidget

Remove Style Block


#API


removeTag(BBjString tag!) - method in class BBjCalendarWidget.CalendarEntry

Removes the provided tag from the entry's vector of tags.


removeTranslation(Locale p_locale!, BBjString p_key$) - method in class BBTranslator.BBTranslationBundle

removeTranslation(BBjString p_key$) - method in class BBTranslator.BBTranslations

Removes a translation given a key


removeTranslations() - method in class BBTranslator.BBTranslations

Removes all translations


removeType(BBjString p_typeName$) - method in class GDocSaveDialog

removeUpdate(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_updateLevel%) - method in class BUS

removeUser(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$) - method in class BUS

removeUserCredentialsCookie() - method in class Admin

removeValueColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Disable value for columns.


#Enterprise
#Configuration
#API


removeViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) - method in class BBJasper.BBJasperViewerControl

removeViewerWindow Removes a viewer window from the vector of viewer windows


removeViewerWindow(BBJasperViewerWindow p_bbJasperViewerWindow!) - method in class BBJasper.BBJasperView

removeViewerWindow Removes a viewer window from the vector of viewer windows


removeWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

removeWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

Removes a widget


removeWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

removeWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

Removes a widget


removeWidgetSeries(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class BuildItem

removeWidgetSeries(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$) - method in class BaseBuildItem

removeWidgetSeries(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetBuildItem

removeWidgetSeries(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetSetBuildItem

removeWidgetSeries(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$) - method in class WidgetDashboardBuildItem

render() - method in class BBjCalendarWidget.BBjCalendarWidget

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() - method in class BBjGridExWidget.BBjGridExWidget

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$="BBJVReportChildWindow" - field in class BBJasper.BBJasperView

Report child window name


REPORT_ERROR=301 - field in class BBJasper.BBJasperReport

Constant value that represents a error return code


REPORT_FILE_RESOLVER$ - field in class BBJasper.BBJasperExporterParameter

REPORT_HYPERLINK_TYPE - field in class BBJasper.BBJasperHyperlink

REPORT_IMAGE_CONTROL_NAME$="BBJVReportImageControl" - field in class BBJasper.BBJasperView

Report image control name


REPORT_TYPE=1 - field in class BBJasper.DesignType

ReportDir$ - field in class BBJasper.BBJasperFill

ReportDir used to locate data such as images for the report


ReportName$ - field in class BBJasper.BBJasperHyperlink

ReportParams! - field in class BBJasper.BBJasperHyperlink

ReportPrefix$ - field in class BBJasper.BBJasperFill

ReportPrefix used to locate data such as images for the report


repositionDashboardWidget(DashboardWidget p_dashboardWidget!, BBjNumber p_destPosition) - method in class Dashboard.DashboardCategory

Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher


repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!) - method in class Dashboard.DashboardCategoryControl

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.


repositionDashboardWidgetControl(BBjString p_widgetName$) - method in class Dashboard.DashboardCategoryControl

An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name


repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!, BBjNumber p_destPosition) - method in class Dashboard.DashboardCategoryControl

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


repositionDashboardWidgetControl(BBjString p_widgetName$, BBjNumber p_destPosition) - method in class Dashboard.DashboardCategoryControl

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


Required! - field in class GxCellEditors.GxCellEditorBasicText

When true , then the input cannot be empty and a value is required to consider the input valid


Required! - field in class GxCellEditors.GxCellEditorSuggestion

When true , then the input cannot be empty and a value is required to consider the input valid


RequiredPermissions - field in class UserCredentials

RequiredPermissions=#DEFAULT_PERMISSIONS - field in class Admin

RequireSSLProperty!="com.basis.util.goauth2.requiressl" - field in class gappsv3.GOAuth2

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.


RESET_COLUMNS() - method in class GxContextMenu.GxContextMenuItem

resetAllColumns() - method in class BBjGridExWidget.BBjGridExWidget

Clear all columns and column groups


#Configuration
#ColumnsRenderer


resetAllColumns() - method in class GxColumns.GxColumnsManagerInterface

Clear all columns and column groups


#Configuration
#ColumnsRenderer


resetAllColumns() - method in class GxColumns.GxColumnsManager

Clear all columns and column groups


#Configuration
#ColumnsRenderer


resetAllColumns() - method in class GxColumns.GxColumnGroup

Clear all columns and column groups


#Configuration
#ColumnsRenderer


resetAuthentication() - method in class GAppsService

resetContainerHeight() - method in class Dashboard.DashboardCategoryControl

Resets the container height based on widget height, number of rows, and row spacing


resetRowHeights() - method in class BBjGridExWidget.BBjGridExWidget

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


Resizable! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to allow column to be resized.


#Configuration
#ColumnsRenderer


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.Widget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.BBjWidget

Resizes the widget using the provided with and height if the BBjWidget's interior BBjControl has already been created


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ImageWidget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.HtmlViewWidget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.GridExWidget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.GridWidget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Resizes the widget using the provided with and height


resize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.JasperViewerWidget

Resizes the widget using the provided with and height


resolve(BBjString term!, GxClientColumnModel column!, GxClientRowModel row!) - method in class GxCellEditors.GxCellEditorSuggestionResolverInterface

Resolve/build the suggestion list


resolve(BBjString term!, GxClientColumnModel column!, GxClientRowModel row!) - method in class GxCellEditors.GxCellEditorSuggestionResolver

Resolve/build the suggestion list


resolvePath(BBjString p_path$, JsonNode p_jsonNode!) - method in class BBJSONResolver.BBJSONResolver

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".


resolvePath(BBjString p_parentNodeName$, BBjString p_path$, JsonNode p_jsonNode!) - method in class BBJSONResolver.BBJSONResolver

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.


resort() - method in class QVGrid.QVGrid

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.


RestButton! - field in class GxFilters.GxColumnFilterAG

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.


RestButton! - field in class GxFilters.GxFilterBasicBoolean

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.


RestButton! - field in class GxFilters.GxFilterBasicDateTime

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.


restoreCell(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Restores a cell to its previous value


restoreCustomColorTheme() - method in class Dashboard.ChartWidget

Restores any custom colors assigned to the chart by the program (after removing user customized theme color)


restoreRow(BBjNumber row) - method in class QVGrid.QVGrid

Restores all cell values in a row


Retries!=0 - field in class Email.EmailDialog

*** Programmatically configurable properties * **


Retries=30 - field in class Email.Email

Number of retries when sending the email


reverseColorVector(BBjVector p_colorVector!) - method in class Dashboard.ChartWidget

Reverses the order of the colors in a vector


revokeAccess() _break_ - method in class gappsv3.GOAuth2

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!


revokeAccess(BBjString token!) - method in class gappsv3.GOAuth2

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!


RIGHT_DOWN_ARROW$=#Translations!.getTranslation("right.down.arrow") - field in class BBJasper.BBJasperView

Translated text for right/down arrow


RING_CHART$ - field in class WidgetWizard

RING_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Ring chart widget type constant


RingChartWidget - class in Dashboard

RingChartWidget A Dashboard Utility Widget that displays a ring or doughnut chart, which is similar to a pie chart with the middle cut out


RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) - constructor in class Dashboard.RingChartWidget

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.


RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) - constructor in class Dashboard.RingChartWidget

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.


RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.RingChartWidget

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.


RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.RingChartWidget

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.


RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.RingChartWidget

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.


ROOT_TYPE=0 - field in class BBJasper.DesignType

RootNodeAlreadyExistsErr=301 - field in class BBXMLDoc

rotate(BBjNumber p_degrees) - method in class BBXImage.BBXImage

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.


rotateColorVector(BBjVector p_colorVector!, BBjNumber p_amount) - method in class Dashboard.ChartWidget

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.


roundBottomCorners(BBjNumber arcWidth, BBjNumber arcHeight) - method in class BBXImage.BBXImage

Method to round the bottom corners (knockout) of the BBXImage given a cornerRadius


roundCorners(BBjNumber arcWidth, BBjNumber arcHeight) - method in class BBXImage.BBXImage

Method to round the corners (knockout) of the BBXImage given a cornerRadius


roundTopCorners(BBjNumber arcWidth, BBjNumber arcHeight) - method in class BBXImage.BBXImage

Method to round the top corners (knockout) of the BBXImage given a cornerRadius


Row! - field in class GxCellEditors.GxCellEditorSuggestionResolver

The row model


Row! - field in class GxClientEvents.GxClientEventsRowEditing

The Row being edited


Row! - field in class GxClientModels.GxClientCellModel

The cell's row.


RowClass! - field in class GxOptions.GxOptions

Property to set CSS class for all rows
#Configuration
#GridRenderer


RowClassRules! - field in class GxOptions.GxOptions

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

RowDeselection! - field in class GxOptions.GxOptions

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


RowGroup! - field in class GxColumns.GxDefaultColumnDefinition

Set to true To group rows by this column


#Enterprise
#Configuration
#ColumnsRenderer


RowGroupIndex! - field in class GxColumns.GxDefaultColumnDefinition

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


RowGroupPanelShow! - field in class GxOptions.GxOptions

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


RowHeight - field in class Dashboard.GridWidget

A number that detmines the grid's row height in pixels


RowHeight! - field in class GxOptions.GxOptions

Default Row Height in pixels. Default is 25 pixels.
#Configuration
#API


RowKey! - field in class Dashboard.CategoryDataItem

The row key of the data item


RowListener - interface in QVGrid

The RowListener interface can be implemented to allow access to the data rows on their way up to the grid.


RowMultiSelectWithClick! - field in class GxOptions.GxOptions

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


RowNodeId$ - field in class BBjGridExWidget.BBjGridExWidget

The unique string to use as row index. default is __ROW_INDEX


Rows! - field in class GxCellEditors.GxCellEditorLargeText

Number of character rows to display. Default is 10.


Rows! - field in class GxClientModels.GxClientRangeSelectionModel

An array of rows objects where every object is instance of GxClientRowModel


rowSelected(BBjGridSelectRowEvent ev!) - method in class QVGrid.QVGrid

Event handler for a row selection


RowSpacing - field in class Dashboard.DashboardCategory

Space in pixels between rows of widgets


RowSpanExpression! - field in class GxColumns.GxDefaultColumnDefinition

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:

  1. Responsibility is with the developer to not span past the last row. This is especially true if sorting and filtering (e.g. a cell may span outside the grid after the data is sorted and the cell's row ends up at the bottom of the grid).
  2. Responsibility is with the developer to apply a background style to spanning cells so that overwritten cells cannot be seen.
  3. Overwritten cells will still exist, but will not be visible. This means cell navigation will go to the other cells - e.g. if a row spanned cell has focus, and the user hits the 'arrow down' key, the focus will go to a hidden cell.
  4. Row span does not work with dynamic row height or auto-height. The row span assumes default row height is used when calculating how high the cell should be.
  5. Sorting and filtering will provide strange results when row spanning. For example a cell may span 4 rows, however applying a filter or a sort will probably change the requirements of what rows should be spanned.
  6. Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.


#Configuration
#ColumnsRenderer.


RowStyle! - field in class GxOptions.GxOptions

Property to set style for all rows. Set to an object of key (style names) and values (style values)
#Configuration
#GridRenderer


RS! - field in class BBjGridExWidget.BBjGridExWidget

The ResultSet instance


RTF_SAVE_CONTRIBUTOR=8 - field in class BBJasper.BBJasperView

Constant that represents the RTF save contributor


RTF_SAVE_CONTRIBUTOR=BBJasperView.getRTF_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the RTF save contributor


RTFExporter! - field in class BBJasper.BBJasperView

RTF exporter which contains export options


run() - method in class BBJasper.BBJasper

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() - method in class BBJasper.BBJasperDesigner

run Runs the BBJasperDesigner


runAsBui(BBjString FilePath$) - method in class DialogWizard.DialogWizardRun

runCommand(BBjString p_command!, BBjString p_workingDir!, BBjNumber p_runOnServer!) - method in class BBLaunchDock

runDemo() - method in class BBWindowUtils

runDemo() - method in class BBXMLDoc

runDemo() - method in class BBJasper.BBJasper

runDemo Runs a demo of BBJasper


runDemo() - method in class BBJasper.BBJasperDesign

runDemo Run a demo of BBJasperDesign with user selected parameters


runDemo() - method in class BBJasper.BBJasperDesigner

runDemo Run a quick demo of BBJasperDesigner


runDemo() - method in class BBjDialChartProgress.BBjDialChartProgress

Method that runs a sample demo program for the BBjDialChartProgress class


runDemo2() - method in class BBJasper.BBJasperDesign

runDemo2 Run a demo of BBJasperDesign with fixed fields and a memory record set


runDemo3() - method in class BBJasper.BBJasperDesign

runDemo3 Run a free-form demo of BBJasperDesign using hard-coded layout and the ChileCompany database


RUNNING=1 - field in class BBJasper.BBJasperProgress

Constant which represents the fill operation is running


runProgram(Program@ p_program!) - method in class BBLaunchDock

S

saturateColor(Color p_color!, BBjNumber p_fraction) - method in class Dashboard.ChartWidget

Make a color more or less saturated


save() - method in class Dashboard.SaveableWidget

Saves the widget as a image.


save() - method in class Dashboard.ImageWidget

Saves the image


save() - method in class Dashboard.HtmlViewWidget

Saves an image representation of the HtmlViewWidget on the client's machine


save() - method in class Dashboard.GridExWidget

Saves an image representation of the grid on the client's machine


save() - method in class Dashboard.GridWidget

Saves an image representation of the grid on the client's machine


save() - method in class Dashboard.ChartWidget

Interactively saves a screenshot of the chart as a PNG file on the client


save() - method in class BBTranslator.BBTranslationBundle

save(BBjString p_directory!) - method in class BBTranslator.BBTranslationBundle

save(BBjString p_directory!, BBjString p_bundleName!) - method in class BBTranslator.BBTranslationBundle

save(BBjString p_directory!, BBjString p_bundleName!, BBjNumber p_forceSave) - method in class BBTranslator.BBTranslationBundle

SAVE$=#Translations!.getTranslation("save") - field in class BBJasper.BBJasperViewerControl

Translated text for save


SAVE$=#Translations!.getTranslation("save") - field in class BBJasper.BBJasperView

Translated text for save


SAVE_AS$=#Translations!.getTranslation("save.as") - field in class BBJasper.BBJasperViewerControl

Translated text for save-as


SAVE_AS$=#Translations!.getTranslation("save.as") - field in class BBJasper.BBJasperView

Translated text for save-as


SAVE_AS_GOOGLE_DOCUMENT$=#Translations!.getTranslation("save.as.google.document") - field in class BBJasper.BBJasperViewerControl

Translated text for save as google document


SAVE_AS_GOOGLE_DOCUMENT$=#Translations!.getTranslation("save.as.google.document") - field in class BBJasper.BBJasperView

Translated text for save as google document


SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$="BBJVSaveAsGoogleDocumentMenuItem" - field in class BBJasper.BBJasperViewerControl

Save as google docment item name


SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$="BBJVSaveAsGoogleDocumentMenuItem" - field in class BBJasper.BBJasperView

Save as google document menu item name


SAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME$=BBJasperViewerControl.getSAVE_AS_GOOGLE_DOCUMENT_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Save as google docment item name


SAVE_AS_MENU_ITEM_NAME$="BBJVSaveAsMenuItem" - field in class BBJasper.BBJasperViewerControl

Save as menu item name


SAVE_AS_MENU_ITEM_NAME$="BBJVSaveAsMenuItem" - field in class BBJasper.BBJasperView

Save as menu item name


SAVE_AS_MENU_ITEM_NAME$=BBJasperViewerControl.getSAVE_AS_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Save as menu item name


SAVE_CURRENT_PAGE_AS_IMAGE$=#Translations!.getTranslation("save.current.page.as.image") - field in class BBJasper.BBJasperView

Translated text for save current page as image


SAVE_ERROR=259 - field in class BBTranslator.BBTranslationBundle

SAVE_FILTER_KEY$ - field in class GDocSaveDialog

SAVE_FOLDER_KEY$ - field in class GDocSaveDialog

SAVE_IMAGE_MENU_ITEM_NAME$="BBJVSaveImageMenuItem" - field in class BBJasper.BBJasperView

Save image menu item name


SAVE_IMAGE_MENU_ITEM_NAME$=BBJasperView.getSAVE_IMAGE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Find previous menu item name


SAVE_MENU_BUTTON_NAME$="BBJVSaveMenuButton" - field in class BBJasper.BBJasperViewerControl

Save menu button name


SAVE_MENU_BUTTON_NAME$=BBJasperViewerControl.getSAVE_MENU_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Save menu button name


SAVE_MENU_BUTTON_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the save menu button, the default is 39


SAVE_MENU_ITEM_NAME$="BBJVSaveMenuItem" - field in class BBJasper.BBJasperViewerControl

Save menu item name


SAVE_MENU_ITEM_NAME$="BBJVSaveMenuItem" - field in class BBJasper.BBJasperView

Save menu item name


SAVE_MENU_ITEM_NAME$=BBJasperViewerControl.getSAVE_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Save menu item name


SAVE_MENU_NAME$="BBJVSaveMenu" - field in class BBJasper.BBJasperView

Save menu name


SAVE_TYPE_KEY$ - field in class GDocSaveDialog

SaveableWidget - interface in Dashboard

SaveableWidget Interface that facilitates saving of the widget


saveAsBMP(BBjString p_imageFile$) - method in class BBXImage.BBXImage

Method to save the BBXImage out to a .bmp file


saveAsGIF(BBjString p_imageFile$) - method in class BBXImage.BBXImage

Method to save the BBXImage out to a .gif file


saveAsJPG(BBjString p_imageFile$, BBjNumber p_compressionLevelPercentage) - method in class BBXImage.BBXImage

Method to save the BBXImage out to a .jpg file


saveAsPNG(BBjString p_imageFile$) - method in class BBXImage.BBXImage

Method to save the BBXImage out to a 32-bit .png file with transparency


saveAsPngImage(BBjString path!) - method in class BBjCalendarWidget.BBjCalendarWidget

Saves a BBjImage screenshot of the BBjCalendarWidget to the specified file path.


saveAsTIFF(BBjString p_imageFile$) - method in class BBXImage.BBXImage

Method to save the BBXImage out to a .tiff file


saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show) - method in class ScreenCapture.ScreenCapture

Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog


saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) - method in class ScreenCapture.ScreenCapture

Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog


saveClientSettings() - method in class BBLaunchDock

saveColorThemePaletteImagesToDirectory(BBjString p_outputDirectory$, BBjString p_namePrefix$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Generates a series of PNG image files that are a visual representation of each Color Theme's palette


saveColorVectorAsPaletteImage(BBjVector p_colorVector!, BBjString p_outputFilename$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

Generates a color palette PNG image file that is a visual representation of all Colors in the supplied vector


saveCurrentPageAsImage() - method in class BBJasper.BBJasperView

saveCurrentPageAsImage Saves the current report page as a image


saveEmailContacts() - method in class Email.EmailDialog

saveEmailContacts Saves the email contacts to the user properties


saveTranslationsToJar(BBjString p_jarFileName$) - method in class BBTranslator.BBTranslationBundle

saveTranslationsToZip(BBjString p_zipFileName$) - method in class BBTranslator.BBTranslationBundle

saveUserCredentialsToCookie(UserCredentials p_userCredentials!) - method in class Admin

saveUserToken() - method in class GAppsService

scale(BBjNumber p_width, BBjNumber p_height) - method in class BBXImage.BBXImage

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.


scale(BBjNumber p_percentage) - method in class BBXImage.BBXImage

Method to scale the BBXImage given a percentage


scaleHeight(BBjNumber p_width) - method in class BBXImage.BBXImage

Method to scale the BBXImage preserving the aspect ratio given the width


scaleProportionally(BBjNumber p_maxDimension) - method in class BBXImage.BBXImage

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.


scaleProportionally(BBjNumber p_maxWidth, BBjNumber p_maxHeight) - method in class BBXImage.BBXImage

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.


scaleProportionallyAndResizeCanvas(BBjNumber p_maxWidth, BBjNumber p_maxHeight) - method in class BBXImage.BBXImage

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.


scaleProportionallyResizeCanvasAndSetImage(BBjNumber p_maxWidth, BBjNumber p_maxHeight, BBjImageCtrl p_imgCtrl!) - method in class BBXImage.BBXImage

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.


scaleWidth(BBjNumber p_height) - method in class BBXImage.BBXImage

Method to scale the BBXImage preserving the aspect ratio given the height


scaleWithHints(BBjNumber p_width, BBjNumber p_height, HashMap p_renderingHintsMap!) - method in class BBXImage.BBXImage

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:

  • VALUE_INTERPOLATION_NEAREST_NEIGHBOR
  • VALUE_INTERPOLATION_BILINEAR
  • VALUE_INTERPOLATION_BICUBIC

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!)
 

SCOPE$=#Translations!.getTranslation("scope") - field in class BBJasper.BBJasperView

Translated text for scope


Scopes!=BBjAPI().makeVector() - field in class gappsv3.GOAuth2

scopes for authorization. Starts out as an empty vector.


ScreenCapture - class in ScreenCapture

ScreenCapture

Screen Capture Class


SCROLL_BAR_SIZE - field in class Dashboard.GridWidget

A constant to define the scroll bar width


SCROLL_BAR_SIZE - field in class BBJasper.BBJasperViewerControl

Height and width of the scroll bars, the defaults are set the UI


scrollTo(BBjNumber pos) - method in class QVGrid.QVGrid

Scroll grid to a given position


scrollToBottom() - method in class QVGrid.QVGrid

Scrolls down in order to set the bottom row visible


search(BBjString p_criteria$) - method in class GDocsService

SecondCondition! - field in class GxClientModels.GxClientFilterCombinedModel

The second filter condition


SECONDS=0 - field in class Dashboard.AutoRefreshUnit

Constant for seconds


selectAll() - method in class BBjGridExWidget.BBjGridExWidget

select all rows


#API


selectAll(BBjNumber x!) - method in class BBjGridExWidget.BBjGridExWidget

select all rows


#API


selectBuildItemCategory(BBjString p_categoryName$) - method in class WidgetWizard

selectBuildItemWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetWizard

selectCategory(BBjString p_categoryName$) - method in class BuildItem

selectCategory(BBjString p_categoryName$) - method in class WidgetBuildItem

selectCategory(BBjString p_categoryName$) - method in class WidgetSetBuildItem

selectCategory(BBjString p_categoryName$) - method in class WidgetDashboardBuildItem

SELECTED=1 - field in class GDocSelectionDialog

SELECTED_FOLDER_KEY$ - field in class GDocFolderSelectionDialog

SelectedRows! - field in class GxClientEvents.GxClientEventsRowSelection

An array of selected rows


SelectEnabled=1 - field in class Dashboard.WidgetControl

Indicates if the widget control is selectable


selectEverything() - method in class GxClientModels.GxClientFilterSetFilterModel

Select all values generated by the UI


#API


selectFilter(BBjString p_filterKey$) - method in class Dashboard.DashboardWidgetFilter

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.


selectFilter(BBjString p_filterName$) - method in class GDocSelectionDialog

selectGoogleDefaultType(BBjString p_selectType$) - method in class BBJasper.BBJasperViewerControl

selectGoogleDefaultType Selects the default Google document type


selectGoogleDefaultType(BBjString p_selectType$) - method in class BBJasper.BBJasperView

selectGoogleDefaultType Selects the default Google document type


selectNothing() - method in class GxClientModels.GxClientFilterSetFilterModel

Clears the selection


#API


selectType(BBjString p_typeName$) - method in class GDocSaveDialog

selectValue(BBjString value!) - method in class GxClientModels.GxClientFilterSetFilterModel

Selects a value


#API


selectValue(BBjNumber value!) - method in class GxClientModels.GxClientFilterSetFilterModel

Selects a value


#API


selectView(BBJasperView p_view!) - method in class BBJasper.BBJasperTabbedView

Selects the current view


selectWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class BuildItem

selectWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetBuildItem

selectWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetSetBuildItem

selectWidget(BBjString p_widgetCategory$, BBjString p_widgetName$) - method in class WidgetDashboardBuildItem

send() - method in class Email.Email

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.


send() - method in class FaxJob

send() - method in class FaxJobBase

sendNotifications(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$) - method in class BUS

sendRequest(BBWebRequest request!) - method in class BBWebClient.BBWebClient

Sends a request to a webserver and retrieves a response. This is performed synchronously and is therefore blocking.


SENSITIVE$=#Translations!.getTranslation("sensitive") - field in class BBJasper.BBJasperView

Translated text for case sensitive


SEPARATOR() - method in class GxContextMenu.GxContextMenuItem

Series - class in Dashboard

A data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.


Series! - field in class Dashboard.XYSeriesDataItem

The series number of the data item


SeriesKey! - field in class Dashboard.XYSeriesDataItem

The series key of the data item


SERVER_CONFIG - field in class Admin

ServiceName$ - field in class GoldMineIntegration.GoldMineIntegrationWebService

The published name of the web service, which defaults to GMWS.


session! - field in class Email.Email

Session object


set(BBjString p_fieldName!, Object p_value!) - method in class GPermission

set(BBjString fieldName!, Object value!) - method in class gappsv3.GCalendar

Can be used to set JSON properties in the calendar.


set(BBjString fieldName!, Object value!) - method in class gappsv3.GEvent

Set specific Event properties


set(java.lang.String fieldName!, java.lang.Object value!) - method in class gappsv3.GEventAttendee

Set properties on the GEventAttendee corresponding to JSON properties.


set3dDepthFactor(BBjNumber p_depthFactor) - method in class Dashboard.PieChartWidget

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_PASSWORDS - field in class Admin

SET_PERMISSIONS - field in class Admin

setAccessRole(BBjString accessRole!) - method in class gappsv3.GCalendar

Set access role.


setActive(BBjNumber p_active) - method in class Dashboard.DashboardWidget

Sets the status to active or inactive


setActive(BBjNumber p_active) - method in class Dashboard.WidgetControl

Sets the active status of the widget control by setting the associated DashboardWidget's active flag


setActive(BBjNumber p_active) - method in class Dashboard.BaseWidget

An internal method that sets the active status of the widget based on its parent


setActiveEnd(BBjString activeEndDate!) - method in class BBjCalendarWidget.CalendarView

Sets the calendar's last visible day to the provided date string.

Note: This value is exclusive, as are all ending dates.


setActiveStart(BBjString activeStartDate!) - method in class BBjCalendarWidget.CalendarView

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() - method in class BBJasper.BBJasperViewerControl

setActualSize Sets the report image to the actual size

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setActualSize() - method in class BBJasper.BBJasperView

setActualSize Sets the report image to the actual size

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setAdditionalGuests(BBjNumber additionalGuests!) - method in class gappsv3.GEventAttendee

Number of guests attendee is bringing.


setAlignment(BBjString alignment!) - method in class BBjCalendarWidget.CalendarToolbarSection

Sets the section's horizontal alignement to one of the three possible alignments, or positions, for the section that include:


setAlignment(BBjNumber align!, BBjNumber alignHeader!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the default alignment for a column


setAlignment(BBjNumber align!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the default alignment for a column


setAlignment(BBjString alignment!) - method in class GxStatusBar.GxStatusBarComponentInterface

Set the component alignment


setAllColumnsUserSortable(BBjNumber sortable) - method in class QVGrid.QVGrid

Sets user-sortable indicator for all columns


setAllDay(BBjNumber allDay!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.


setAllDayEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!) - method in class gappsv3.GEvent

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.


setAllDayEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjString timeZone!) - method in class gappsv3.GEvent

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.


setAllDayEnd(java.util.Date date!) - method in class gappsv3.GEvent

Set event end time using a java.util.Date This method is used to specify the end time for an all-day event.


setAllDayEnd(java.util.Date date!, BBjString timeZone!) - method in class gappsv3.GEvent

Set event end time using a java.util.Date This method is used to specify the end time for an all-day event.


setAllDayStart(BBjNumber year!, BBjNumber month!, BBjNumber day!) - method in class gappsv3.GEvent

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.


setAllDayStart(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjString timeZone!) - method in class gappsv3.GEvent

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.


setAllDayStart(java.util.Date date!) - method in class gappsv3.GEvent

Set event start time using a java.util.Date This method is used to specify the start time for an all-day event.


setAllowedAggFuncs(BBjString funcs!) - method in class GxColumns.GxDefaultColumnDefinition

Set the allowed aggregation functions allowed on this column


setAllowInput(BBjNumber allow!) - method in class GxOptions.GxOptionsDateTime

setAlwaysOnTop(BBjInt p_alwaysOnTop!) - method in class BBLaunchDock

setAnnotation(BBjString p_title$, BBjFont p_font!, BBjColor color!, BBjNumber radius, BBjNumber angle) - method in class BBjBUIDialChart.BBjBUIDialChart

setAnyoneCanAddSelf(BBjNumber anyoneCanAddSelf!) - method in class gappsv3.GEvent

Indicates whether people can invite themselves to the event regardless of ownership.


setAppServer(BBjAppServer p_appServer!) - method in class BBUtils.BBUtils

setAspectRatio(BBjNumber aspectRatio) - method in class BBjCalendarWidget.CalendarOptions

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.


setAttendees(BBjVector gattendees!) - method in class gappsv3.GEvent

Add a list of people who are going to attend a meeting.


setAttendeesOmitted(BBjNumber attendeesOmitted!) - method in class gappsv3.GEvent

Indicates whether attendees have been omitted from the event.


setAttribute(String attribute!, String value!) - method in class QVGrid.QVGrid

Sets a control attribute for the grid control


setAuthorization(BBjString authorization!) - method in class BBWebClient.BBWebRequest

Adds an authorization header to the request.


setAutoExtForType(BBjString p_documentType$, BBjString p_documentExt$) - method in class GDocSaveDialog

setAutoRefreshConfigurationMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the auto refresh configuration menu item in the options menu


setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled) - method in class Dashboard.DashboardWidget

Sets the auto refresh enabled or disabled


setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled) - method in class Dashboard.WidgetControl

Sets the auto refresh enabled or disabled


setAutoRefreshMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the auto refresh menu item in the options menu


setAutoRefreshRate(BBjNumber p_autoRefreshRate) - method in class Dashboard.DashboardWidget

Sets the auto refresh rate


setAutoRefreshRate(BBjNumber p_rate) - method in class Dashboard.WidgetControl

Sets the auto refresh rate


setAutoRefreshUnit(BBjNumber p_autoRefreshUnit) - method in class Dashboard.DashboardWidget

Sets the auto refresh unit


setAutoRefreshUnit(BBjNumber p_unit) - method in class Dashboard.WidgetControl

Sets the auto refresh unit


setAutoResizeColumns(BBjNumber p_autoResizeColumns) - method in class Dashboard.GridWidget

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.


setAutoResizeGrid(BBjNumber p_autoResizeGrid) - method in class Dashboard.GridWidget

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.


setBackColor(BBjColor p_backColor!) - method in class Dashboard.DashboardItem

Sets the background color of the dashboard item


setBackColor(BBjColor p_backColor!) - method in class Dashboard.DashboardWindow

Sets the window background color


setBackColor(BBjColor p_backColor!) - method in class Dashboard.DashboardControl

Sets the background color of the dashboard control


setBackColor(BBjColor p_backColor!) - method in class Dashboard.DashboardCategoryControl

Sets the background color of the dashboard category control


setBackColor(BBjColor p_backColor!) - method in class Dashboard.WidgetControl

Sets the background color of the widget control


setBackColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the background color for the grid control


setBackColor(BBjColor backColor!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets the background color of the calendar's containing window.


setBackColor(BBjColor color!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the background color of a column


setBackColor(BBjString color!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the background color of a column


setBackgroundColor(BBjString backgroundColor!) - method in class gappsv3.GCalendar

Set the background color of the calendar. param backgroundColor! String representing the color to set the calendar's background to.


setBackgroundColor(BBjString backgroundColor!) - method in class BBjCalendarWidget.CalendarEntry

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.


setBackgroundColor(BBjString backgroundColor!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setBackgroundImage(BBjString p_backgroundImage!, BBjInt p_barEndcapWidth!) - method in class BBLaunchDock

setBackgroundImage(BBjString imageFile$) - method in class BBjBUIDialChart.BBjBUIDialChart

setBackgroundImageResized(BBjString imageFile$, BBjNumber p_width, BBjNumber p_height) - method in class BBjBUIDialChart.BBjBUIDialChart

setBarOutlineColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.BarChartWidget

Sets the color and opacity for the outline of each bar


setBarOutlineWidth(BBjNumber p_width) - method in class Dashboard.BarChartWidget

Sets the width of the outline for each bar in pixels with the default value set to 1. Notes:

  • The outline will be multiplied by the device's pixel ratio
  • The value does not have to be an integer, so 0.5 is an acceptible value

setBcc(BBjString bcc$) - method in class Email.Email

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.


setBeepOnValidationFailure(BBjNumber shouldBeep) - method in class QVGrid.QVGrid

Sets whether the grid should beep when the program calls 'accept(0)' in response to a validation event


setBorder(BBjNumber borderSize, BBjColor color!) - method in class BBXImage.BBXImage

Method to add a border to the BBXImage


setBorder(BBjNumber borderSize, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity) - method in class BBXImage.BBXImage

Method to add a border to the BBXImage


setBorderColor(BBjString borderColor!) - method in class BBjCalendarWidget.CalendarEntry

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.


setBorderColor(BBjString borderColor!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setBUIAppIcon(BBjString p_app$, BBjString p_iconFile$, BBjNumber p_overwrite) - method in class BBUtils.BBUtils

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.


setBuiBusyIndicatorText(BBjString p_BuiBusyIndicatorText$) - method in class Dashboard.DashboardWindow

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.


setBUICSS(BBjString p_app$, BBjString p_cssFile$, BBjNumber p_overwrite) - method in class BBUtils.BBUtils

Sets the custom CSS for the specified BUI app.

This is similar to the applyCss() method.


setBuildItemCallback(BBjString p_event$, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class WidgetWizard

setBuildItemName(BBjString p_buildName$) - method in class WidgetWizard

setBuildItemTitle(BBjString p_buildTitle$) - method in class WidgetWizard

setBuildItemWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlText$) - method in class WidgetWizard

setBuildItemWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlUrl$) - method in class WidgetWizard

setBuildItemWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_imageFile$) - method in class WidgetWizard

setBuildItemWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, URL p_imageURL!) - method in class WidgetWizard

setBuildItemWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetWizard

setBuildItemWidgetReportSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetWizard

setBuildItemWidgetSeriesRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetWizard

setBuildItemWidgetSeriesSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetWizard

setBuildItemWidgetSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetWizard

setBUISplash(BBjString p_app$, BBjString p_imageFile$, BBjNumber p_overwrite) - method in class BBUtils.BBUtils

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.


setBusyText(BBjString p_busyText$) - method in class Dashboard.DashboardWindow

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.


setBusyText(BBjString p_busyText$) - method in class Dashboard.DashboardControl

Sets the specified text to be displayed when loading widgets into the DashboardCategory


setButtonCustomXOffset(BBjInt p_buttonXOffset!) - method in class BBLaunchDock

setButtonCustomYOffset(BBjInt p_buttonYOffset!) - method in class BBLaunchDock

setButtonHoverOpacity(BBjNumber p_buttonHoverOpacity!) - method in class BBLaunchDock

setButtonNormalOpacity(BBjNumber p_buttonNormalOpacity!) - method in class BBLaunchDock

setButtonSizeHovered(BBjInt p_buttonSizeHovered!) - method in class BBLaunchDock

setButtonSizeNormal(BBjInt p_buttonSizeNormal!) - method in class BBLaunchDock

setButtonSizeZoomed(BBjInt p_buttonSizeZoomed!) - method in class BBLaunchDock

setButtonSpacing(BBjInt p_buttonSpacing!) - method in class BBLaunchDock

setButtonText(BBjString buttonName!, BBjString buttonText!) - method in class BBjCalendarWidget.CalendarOptions

Sets the text of the provided button, where the button is identified via a constant like CalenarAPI.CALENDAR_TOOLBAR_BUTTON_TODAY.


setCalendarId(BBjString calendarId!) - method in class BBjCalendarWidget.CalendarEntrySourceGoogle

Sets the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".


setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidget

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


setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidget

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


setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetFilter

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.


setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetFilter

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.


setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetMenu

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.


setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetMenu

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.


setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetLink

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(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class Dashboard.DashboardWidgetLink

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(BBjNumber p_event, BBjString p_callbackRoutine$) - method in class Dashboard.HtmlViewWidget

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(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class Dashboard.HtmlViewWidget

setCallback Sets a callback for the HtmlViewWidget, given a control event, callback object, and a callback routine


setCallback(BBjNumber p_event, BBjString p_callbackRoutine$) - method in class Dashboard.GridWidget

Sets a callback for a GridWidget event


setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class Dashboard.GridWidget

Sets a callback for a GridWidget event


setCallback(BBjString p_name$, BBjNumber p_event, BBjString p_callbackRoutine$) - method in class Dashboard.JasperViewerWidget

setCallback Sets a callback for the widget, given a control name, control event, and a callback routine


setCallback(BBjString p_name$, BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class Dashboard.JasperViewerWidget

setCallback Sets a callback for the widget, given a control name, control event, callback object, and a callback routine


setCallback(BBjString p_event$, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class BuildItem

setCallback(BBjString p_event$, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class WidgetBuildItem

setCallback(BBjString p_event$, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class WidgetSetBuildItem

setCallback(BBjString p_event$, CustomObject p_callbackObject!, BBjString p_callbackRoutine$) - method in class WidgetDashboardBuildItem

setCallback(int eventType!, String subRoutineName!) - method in class QVGrid.QVGrid

Registers a legacy callback routine for a specified event in the grid


setCallback(int eventType!, CustomObject customObj!, String methodName!) - method in class QVGrid.QVGrid

Registers an object oriented callback routine for a specified event in the grid


setCallback(BBjNumber event!, BBjString callback!) - method in class BBjCalendarWidget.BBjCalendarWidget

Registers a callback in a procedural program for the provided event type.

These are the valid callback event type options:

Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.


setCallback(BBjNumber event!, CustomObject instance!, BBjString method!) - method in class BBjCalendarWidget.BBjCalendarWidget

Registers a callback in an object-oriented program for the provided event type.

These are the valid callback event type options:

Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.


setCallback(int type!, String callback!) - method in class BBjGridExWidget.BBjGridExWidget

Register an event handler


setCallback(int type!, CustomObject instance!, String method!) - method in class BBjGridExWidget.BBjGridExWidget

Register an event handler


setCanvasSize(BBjNumber p_width, BBjNumber p_height) - method in class BBXImage.BBXImage

Method to resize the BBXImage's canvas, specifying transparent for the fill color.


setCanvasSize(BBjNumber p_width, BBjNumber p_height, BBjColor p_color!) - method in class BBXImage.BBXImage

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.


setCanvasSize(BBjNumber p_width, BBjNumber p_height, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity) - method in class BBXImage.BBXImage

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.


setCausesControlValidation(boolean causesValidation!) - method in class QVGrid.QVGrid

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(BBjString cc$) - method in class Email.Email

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.


setCellAlignment(BBjNumber row, BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets the alignment of a cell


setCellBackColor(BBjNumber row, BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the background color of a cell


setCellData(BBjNumber row, BBjNumber column, BBjString text$, BBjString related$) - method in class QVGrid.QVGrid

Sets both the displayed and related text of a cell


setCellEditable(BBjNumber row, BBjNumber column, BBjNumber editable) - method in class QVGrid.QVGrid

Sets whether a cell is editable Note: The QVGrid is non-editable, so this method does not change any state.


setCellEditorSelector(BBjString expression!, HashMap editors!) - method in class GxColumns.GxDefaultColumnDefinition

Set a cell editor selector to use for this column.


setCellFont(BBjNumber row, BBjNumber column, BBjFont font!) - method in class QVGrid.QVGrid

Sets the font of a cell


setCellForeColor(BBjNumber row, BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the foreground color of a cell


setCellHasQuery(BBjNumber row, BBjNumber column, BBjNumber hasQuery) - method in class QVGrid.QVGrid

Specifies whether a cell should have an associated query button


setCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Sets the icon for a cell


setCellImage(BBjNumber p_row, BBjNumber p_column, BBjImage p_image!) - method in class Dashboard.GridWidget

Sets a cell image in a cell of the grid.


setCellImage(BBjNumber row, BBjNumber column, BBjImage image!) - method in class QVGrid.QVGrid

Sets the image displayed in a cell


setCellListControl(BBjNumber row, BBjNumber column, BBjComboBox list!) - method in class QVGrid.QVGrid

Sets a list control for a cell so that the cell will display as a list control when edited


setCellListSelection(BBjNumber row, BBjNumber column, BBjNumber sel, BBjNumber repaint) - method in class QVGrid.QVGrid

Sets the list selection for a list control in a cell


setCellMask(BBjNumber row, BBjNumber column, BBjString mask$) - method in class QVGrid.QVGrid

Sets the cell mask for both displaying and editing Note: Only applicable to InputD, InputE, and InputN style cells.


setCellRelated(BBjNumber row, BBjNumber column, BBjString text$) - method in class QVGrid.QVGrid

Sets the "related" text that is associated with a cell


setCellRelated(BBjNumber row, BBjNumber column, BBjVector strings!) - method in class QVGrid.QVGrid

Sets the "related" text that for a range of cells


setCellRestore(BBjNumber row, BBjNumber column, BBjString restore$) - method in class QVGrid.QVGrid

Sets the restore value for a cell


setCellState(BBjNumber row, BBjNumber column, BBjNumber state) - method in class QVGrid.QVGrid

Sets the checked state of a check box or button style cell


setCellStyle(BBjNumber row, BBjNumber column, BBjNumber style) - method in class QVGrid.QVGrid

Sets the style of a cell


setCellText(BBjVector strings!) - method in class QVGrid.QVGrid

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).


setCellText(BBjNumber row, BBjNumber column, BBjVector strings!) - method in class QVGrid.QVGrid

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).


setCellText(BBjNumber row, BBjNumber column, BBjString text$) - method in class QVGrid.QVGrid

Sets the text displayed in a cell


setCellVerticalAlignment(BBjNumber row, BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets vertical alignment in a cell


setCharacterEncoding(BBjString p_characterEncoding$) - method in class BBJasper.BBJasperExporter

setCharacterEncoding Sets the character encoding for export operations


setChartBackground(BBjNumber p_red, BBjNumber p_green, BBjNumber p_blue, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background color for the entire chart


setChartBackground(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background color for the entire chart


setChartBackground(Paint p_paint!) - method in class Dashboard.ChartWidget

Sets a background paint for the entire chart


setChartBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha) - method in class BBjBUIDialChart.BBjBUIDialChart

setChartBackgroundGradient(BBjString p_colors!, BBjNumber p_orientation) - method in class Dashboard.ChartWidget

Sets the colors for the chart's background as a gradient


setChartBackgroundImage(BBjImage p_image!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background image for the entire chart


setChartBackgroundImage(BBjString p_imageFile$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background image for the entire chart


setChartColors(BBjString p_colorDescStart$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

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.


setChartColors(BBjString p_colorDescStart$, BBjString p_colorDescMiddle$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaMiddle!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

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.


setChartColors(BBjNumber p_numColors, BBjString p_colorDescStart$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

Sets the colors for the chart by generating a series of colors given a starting and ending color


setChartColors(BBjNumber p_numColors, Color p_colorStart!, Color p_colorFinish!) - method in class Dashboard.ChartWidget

Sets the colors for the chart by generating a series of colors given starting and ending Java Colors which may include an opacity


setChartColors(BBjString p_colors!) - method in class Dashboard.ChartWidget

Sets the colors for the chart given a fixed number of hex color descriptions in a string


setChartColors(BBjString p_colors!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets the colors for the chart given a fixed number of hex color descriptions in a string and an opacity value


setChartColors(BBjVector p_colors!) - method in class Dashboard.ChartWidget

Sets the colors for the chart given a fixed number of Java Colors in a BBjVector


setChartColorTheme(BBjNumber p_colorThemeIndex) - method in class Dashboard.ChartWidget

Sets the colors for the chart given a color theme number


setChartDataItemLabelFormat(BBjString p_customLabelFormat$) - method in class Dashboard.ChartWidget

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.


setChartDataItemLabelFormat(BBjString p_customLabelFormat$, NumberFormat p_numberFormat!, NumberFormat p_percentageFormat!) - method in class Dashboard.ChartWidget

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:


 myBarChart!.setChartDataItemLabelFormat("{1}: {2}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
 
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:

 Current: $218.10
 
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.

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.


setChartDataItemLabels(BBjString p_colorHexString$) - method in class Dashboard.ChartWidget

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.


setChartDataItemLabels(BBjString p_colorHexString$, BBjNumber p_labelLocation) - method in class Dashboard.ChartWidget

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.


setChartDataItemLabels(BBjString p_colorHexString$, ItemLabelAnchor p_itemLabelAnchor!, TextAnchor p_textAnchor!, TextAnchor p_rotationAnchor!, BBjNumber p_angle) - method in class Dashboard.ChartWidget

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.


setChartDomainAxisFontScaling(BBjNumber p_scaleFonts) - method in class Dashboard.ChartWidget

Sets whether the font for the domain axis should be scaled down when the axis contains a large number of entries


setChartDomainAxisFormat(BBjString p_format$) - method in class Dashboard.ChartWidget

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


setChartDomainAxisFormat(DecimalFormat p_format!) - method in class Dashboard.ChartWidget

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


setChartDomainAxisMargins(BBjNumber p_lowerMargin, BBjNumber p_upperMargin) - method in class Dashboard.ChartWidget

Sets the lower and upper margins on the domain axis as a percentage of the length of the axis


setChartDomainAxisNumLines(BBjNumber p_numLines) - method in class Dashboard.ChartWidget

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.


setChartDomainAxisTitle(BBjString p_title$) - method in class Dashboard.ChartWidget

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.


setChartDomainAxisTitle(BBjString p_title$) - method in class Dashboard.BarChartWidget

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.


setChartDomainAxisTitle(BBjString p_title$) - method in class Dashboard.LineChartWidget

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.


setChartDomainAxisVisible(BBjNumber p_visible) - method in class Dashboard.ChartWidget

Sets whether the domain axis is visible or not


setChartDomainMarker(BBjString p_key$, BBjString p_colorDesc$, BBjNumber p_opacity, BBjNumber p_markerType) - method in class Dashboard.ChartWidget

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


setChartDomainMarker(BBjString p_key$, BBjString p_colorDesc$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

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


setChartDomainMarker(BBjString p_key$, Color p_color!) - method in class Dashboard.ChartWidget

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


setChartEmptyDisplayImage(BBjString p_imageFile$) - method in class Dashboard.ChartWidget

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()


setChartEmptyDisplayText(BBjString p_displayText$) - method in class Dashboard.ChartWidget

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()


setChartFontColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets the color for the fonts used in the chart for the labels, legend, title, etc.


setChartFontColor(BBjColor p_color!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets the color for the fonts used in the chart for the labels, legend, title, etc.


setChartFontColors(BBjString p_colors!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

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.


 widget!.setChartFontColor("#000000", .5)
 widget!.setChartFontColors("#1a4065, , , , #732626, #267326, ", 0.9)
 
Note that all colors are hex color strings. An example would be "#ff00cc" or "#f0c"

setChartFontFile(BBjString p_fontFile$) - method in class Dashboard.ChartWidget

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


setChartFontFile(BBjString p_fontFile$, BBjNumber p_throwError) - method in class Dashboard.ChartWidget

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 /utils/dashboard/fonts directory.

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:


 widget!.setChartFontFile("SourceSansPro-Regular.ttf")
 

The following code sets the widget's font by specifying the fully qualified font name:


 widget!.setChartFontFile("/Users/bbj/Fonts/TypewriterKeys.ttf")
 

setChartFontSizes(BBjNumber p_titleSize, BBjNumber p_subtitleSize, BBjNumber p_legendItemSize, BBjNumber p_labelSize, BBjNumber p_domainItemSize, BBjNumber p_rangeItemSize, BBjNumber p_annotationSize) - method in class Dashboard.ChartWidget

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.


setChartFontStyles(BBjNumber p_titleStyle, BBjNumber p_subtitleStyle, BBjNumber p_legendItemStyle, BBjNumber p_labelStyle, BBjNumber p_domainItemStyle, BBjNumber p_rangeItemStyle, BBjNumber p_annotationStyle) - method in class Dashboard.ChartWidget

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:

  • PLAIN = 0
  • BOLD = 1
  • ITALIC = 2
They also correspond to the plain/bold/italic constants used with the BBjFont object. This means that if you want to set the style for an element to ITALIC, you may enter a number, e.g. 2, a BBjFont constant, e.g. BBjFont.FONT_ITALIC, or a java.awt.Font constant, e.g. Font.ITALIC. The font styles are additive, so you can specify that a font be both bold and italic by specifying the number 3, BBjFont.FONT_BOLD+BBjFont.FONT_ITALIC, or Font.BOLD+Font.ITALIC.

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)
 

setChartLegendBackground(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Applies the background color for the legend


setChartLegendFrame(BBjNumber p_width, BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Applies the border width and color for the legend


setChartLegendPadding(BBjNumber p_top, BBjNumber p_right, BBjNumber p_bottom, BBjNumber p_left) - method in class Dashboard.ChartWidget

Sets the padding between the legend border and the legend items


setChartLegendShape(BBjNumber p_shape, BBjNumber p_outlineWidth, Color p_outlineColor!) - method in class Dashboard.ChartWidget

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

  • Circle
  • Square
  • Rectangle
  • RoundedRectangle
  • Capsule
  • Ellipse
  • Diamond

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"))
 

setChartLegendShape(BBjNumber p_shape, BBjNumber p_outlineWidth, BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

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

  • Circle
  • Square
  • Rectangle
  • RoundedRectangle
  • Capsule
  • Ellipse
  • Diamond

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"))
 

setChartLegendShapeRadius(BBjNumber p_radius) - method in class Dashboard.ChartWidget

Sets the radius for a chart's legend shape (typically a circle) in pixels, overriding the default.


setChartLegendShapeRadiusScalingFactor(BBjNumber p_factor) - method in class Dashboard.ChartWidget

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.


setChartMaximumDomainLabelWidthRatio(BBjNumber p_widthRatio) - method in class Dashboard.ChartWidget

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


setChartPadding(BBjNumber p_top, BBjNumber p_right, BBjNumber p_bottom, BBjNumber p_left) - method in class Dashboard.ChartWidget

Sets the padding between the chart border and the chart drawing area


setChartPlotShadow(BBjNumber p_size, BBjString p_colorString!, BBjNumber p_opacity, BBjNumber p_distance, BBjNumber p_angle) - method in class Dashboard.ChartWidget

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


setChartRangeAxisFormat(BBjString p_format$) - method in class Dashboard.ChartWidget

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


setChartRangeAxisFormat(DecimalFormat p_format!) - method in class Dashboard.ChartWidget

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.


setChartRangeAxisMinimumSize(BBjNumber p_minimumSize) - method in class Dashboard.ChartWidget

Sets the minimum size allowed for the axis range when it is automatically calculated


setChartRangeAxisTitle(BBjString p_title$) - method in class Dashboard.ChartWidget

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.


setChartRangeAxisTitle(BBjString p_title$) - method in class Dashboard.BarChartWidget

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.


setChartRangeAxisTitle(BBjString p_title$) - method in class Dashboard.LineChartWidget

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.


setChartRangeAxisToCurrency() - method in class Dashboard.ChartWidget

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.


setChartRangeAxisToCurrencyWithFractionalDigits(BBjNumber p_fractionDigits) - method in class Dashboard.ChartWidget

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.


setChartRangeAxisToPercent() - method in class Dashboard.ChartWidget

Sets the range axis to show its values formatted as a percentage, which multiplies the values by 100 and appends the percent sign


setChartRangeAxisUseIntegers(BBjNumber p_useIntegers) - method in class Dashboard.ChartWidget

Sets whether the range axis is limited to integer values or not


setChartRangeAxisVisible(BBjNumber p_visible) - method in class Dashboard.ChartWidget

Sets whether the range axis is visible or not


setChartRangeColors(BBjString p_colorDescStart$, BBjString p_colorDescFinish$, BBjNumber p_alphaStart!, BBjNumber p_alphaFinish!) - method in class Dashboard.ChartWidget

Sets the range Paint for each bar in the chart


setChartRangeColors(BBjString p_colors!) - method in class Dashboard.ChartWidget

Sets the colors for the chart's bars as a gradient going across the range


setChartRangeColors(BBjString p_colors!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets the colors for the chart's bars as a gradient going across the range


setChartRangeColors(BBjVector p_colors!) - method in class Dashboard.ChartWidget

Sets the range Paint for each bar in the chart


setChartRangeMarker(BBjNumber p_value, BBjString p_colorDesc$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

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.


setChartRangeMarker(BBjNumber p_value, Color p_color!) - method in class Dashboard.ChartWidget

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


setChartTitle(BBjString p_chartTitle$) - method in class Dashboard.ChartWidget

Sets the title of the chart


setChartTitles(BBjString p_chartTitle$, BBjString p_chartDomainTitle$, BBjString p_chartRangeTitle$) - method in class Dashboard.ChartWidget

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.


setChartTitles(BBjString p_chartTitle$, BBjString p_chartDomainTitle$, BBjString p_chartRangeTitle$) - method in class Dashboard.BarChartWidget

setChartTitles(BBjString p_chartTitle$, BBjString p_chartDomainTitle$, BBjString p_chartRangeTitle$) - method in class Dashboard.LineChartWidget

setChromaticity(BBJasperPrintChromaticity p_bbjasperPrintChromaticity!) - method in class BBJasper.BBJasperPrintServiceExporter

setChromaticity Sets the chromaticity


setClassName(BBjString className!) - method in class BBjCalendarWidget.CalendarEntry

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.


setClassName(BBjString className!) - method in class BBjCalendarWidget.CalendarEntrySource

Sets the source's entry class name string (or CSS style).


setClassNames(BBjVector classNames!) - method in class BBjCalendarWidget.CalendarEntry

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; } ")


setClassNames(BBjString classNames!) - method in class BBjCalendarWidget.CalendarEntry

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; } ")


setClickCallback(DashboardWidget p_dashboardWidget!) - method in class Dashboard.WidgetControl

Sets a callback for a left click event that occurs on the passed dashboard widget


setClickTarget(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.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.


setClickTarget(BBjControl p_control!, BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.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.


setClientEdge(boolean client!) - method in class QVGrid.QVGrid

Sets the grid control to have a client (lowered) border


setCloseButtonEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the close button in the widget control


setCloseEnabled(BBjNumber p_closeEnabled) - method in class Dashboard.DashboardWidget

Sets the close enabled or disabled


setCloseOnSend(BBjNumber p_closeOnSend) - method in class Email.EmailDialog

setCloseOnSend Sets whether dialog should be closed on a send


setColor(BBjString color!) - method in class BBjCalendarWidget.CalendarEntry

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.


setColor(BBjString color!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setColorId(BBjString colorId!) - method in class gappsv3.GCalendar

Set color id


setColorId(BBjString colorId!) - method in class gappsv3.GEvent

Gets the color id of the event.


setColors(BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!) - method in class BBjCalendarWidget.CalendarEntry

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.


setColumn(BBjString column!) - method in class GxClientModels.GxClientFilterModel

Set the working column


setColumnAggFunc(BBjString field!, BBjString AggFunc!) - method in class BBjGridExWidget.BBjGridExWidget

Set an aggregation function for the passed column field


#Enterprise
#Configuration
#ColumnsRenderer


setColumnAlignment(BBjNumber p_column, BBjNumber p_alignment) - method in class Dashboard.GridExWidget

Sets the alignment of a grid's column


setColumnAlignment(BBjNumber p_column, BBjNumber p_alignment) - method in class Dashboard.GridWidget

Sets the alignment of a grid's column


setColumnAlignment(BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets the default horizontal alignment for a column


setColumnAlignment(BBjString field!, BBjNumber align!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the default alignment for a column


#Configuration
#ColumnsRenderer


setColumnAttributes(BBjString column$, BBjString label$, BBjNumber length, BBjString type$, BBjString mask$, BBjString justification$, BBjString expression$) - method in class BBJasper.BBJasperDesign

setColumnAttributes Sets all of a column's attributes


setColumnBackColor(BBjNumber p_column, BBjColor p_color!) - method in class Dashboard.GridWidget

Sets the background color for the specified grid column.

To more easily set the colors of multiple columns at once, see the setColumnBackColors() method.


setColumnBackColor(BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the default background color of a column


setColumnBackColor(BBjString field$, BBjColor color!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the background color of a column


#Configuration
#ColumnsRenderer


setColumnBackColor(BBjString field$, BBjString color!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the background color of a column


#Configuration
#ColumnsRenderer


setColumnBackColors(BBjString p_colors!) - method in class Dashboard.GridWidget

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.


setColumnEditable(BBjNumber column, BBjNumber editable) - method in class QVGrid.QVGrid

Sets whether a column is editable Note: The QVGird is not editable, so this method has no effect.


setColumnExpression(BBjString column$, BBjString expression$) - method in class BBJasper.BBJasperDesign

setColumnExpression Sets a column's expression


setColumnFont(BBjNumber column, BBjFont font!) - method in class QVGrid.QVGrid

Sets the default font of a column


setColumnForeColor(BBjNumber p_column, BBjColor p_color!) - method in class Dashboard.GridWidget

Sets the foreground color for the specified grid column.

To more easily set the colors of multiple columns at once, see the setColumnForeColors() method.


setColumnForeColor(BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the default foreground color for a colum


setColumnForeColor(BBjString field$, BBjColor color!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the foreground color for a column


#Configuration
#ColumnsRenderer


setColumnForeColor(BBjString field$, BBjString color!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the foreground color for a column


#Configuration
#ColumnsRenderer


setColumnForeColors(BBjString p_colors!) - method in class Dashboard.GridWidget

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.


setColumnGutter(BBjNumber pixels) - method in class QVGrid.QVGrid

Sets the number of pixels separating the column header and the main grid area


setColumnHasQuery(BBjNumber column, BBjNumber hasQuery) - method in class QVGrid.QVGrid

Specifies whether all cells in the specified column should have associated query buttons


setColumnHeaderAlignment(BBjNumber p_column, BBjNumber p_alignment) - method in class Dashboard.GridExWidget

Sets the alignment of a grid's column header


setColumnHeaderAlignment(BBjNumber p_column, BBjNumber p_alignment) - method in class Dashboard.GridWidget

Sets the alignment of a grid's column header


setColumnHeaderAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default column header horizontal alignment


setColumnHeaderAlignment(BBjString field!, BBjNumber align!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the default alignment for a column's header


#Configuration
#ColumnsRenderer


setColumnHeaderAlignments(BBjNumber p_alignment) - method in class Dashboard.GridExWidget

Sets the alignment for all column headers in the grid


setColumnHeaderAlignments(BBjNumber p_alignment) - method in class Dashboard.GridWidget

Sets the alignment for all column headers in the grid


setColumnHeaderBackColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default background color of the column header


setColumnHeaderCellAlignment(BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets the horizontal alignment for the column header cell


setColumnHeaderCellBackColor(BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the background color of a column header cell


setColumnHeaderCellForeColor(BBjNumber column, BBjColor color!) - method in class QVGrid.QVGrid

Sets the foreground color of a column header cell


setColumnHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber column) - method in class QVGrid.QVGrid

Sets the icon in a column header cell


setColumnHeaderCellImage(BBjNumber p_column, BBjImage p_image!) - method in class Dashboard.GridWidget

Sets an image in a column header of the grid.


setColumnHeaderCellImage(BBjNumber column, BBjImage image!) - method in class QVGrid.QVGrid

Sets the image displayed in a column header cell


setColumnHeaderCellStyle(BBjNumber column, BBjNumber style) - method in class QVGrid.QVGrid

Sets the cell style used for a column header cell


setColumnHeaderCellText(BBjNumber column, BBjString text$) - method in class QVGrid.QVGrid

Sets the text to be displayed in a column header cell


setColumnHeaderCellVerticalAlignment(BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets the vertical alignment for a column header cell


setColumnHeaderData(BBjVector p_colHeaderData!) - method in class Dashboard.GridExWidget

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


setColumnHeaderData(BBjVector p_colHeaderData!) - method in class Dashboard.GridWidget

Sets the grid's column header data using the passed vector


setColumnHeaderFont(BBjFont font!) - method in class QVGrid.QVGrid

Sets the default font of the column header


setColumnHeaderForeColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default foreground color of the column header


setColumnHeaderHeight(BBjNumber p_height) - method in class Dashboard.GridExWidget

Sets the row height for the grid's header cells


setColumnHeaderHeight(BBjNumber height) - method in class QVGrid.QVGrid

Sets the height of the column header


setColumnHeaderStyle(BBjNumber style) - method in class QVGrid.QVGrid

Sets the style used by default for the column headers


setColumnHeaderText(BBjVector strings!) - method in class QVGrid.QVGrid

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.


setColumnHeaderVerticalAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default vertical alignment for the column header


setColumnImageList(BBjString field!, BBjImage imagelist!) - method in class BBjGridExWidget.BBjGridExWidget

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(BBjString column$, BBjString justification$) - method in class BBJasper.BBJasperDesign

setColumnJustification Sets a column's justification


setColumnLabel(BBjString column$, BBjString label$) - method in class BBJasper.BBJasperDesign

setColumnLabel Sets a column's label


setColumnLength(BBjString column$, BBjNumber length) - method in class BBJasper.BBJasperDesign

setColumnLength Sets a column's output length


setColumnListControl(BBjNumber column, BBjComboBox list!) - method in class QVGrid.QVGrid

Sets a list control for a column so that each cell in the column will display as a list button when editing


setColumnListSelection(BBjNumber column, BBjNumber index, BBjNumber repaint) - method in class QVGrid.QVGrid

Sets the selected index for the list control in the specified column


setColumnMask(BBjNumber p_column, BBjString p_mask$) - method in class Dashboard.GridWidget

Sets the output mask for the all cells in a grid's column, similar to CommonGrid::setColumnMask()


setColumnMask(BBjNumber column, BBjString mask$) - method in class QVGrid.QVGrid

Sets the default mask for all cells in a column


setColumnMask(BBjString column$, BBjString mask$) - method in class BBJasper.BBJasperDesign

setColumnMask Sets a column's output mask


setColumnMask(BBjString field!, BBjString mask!) - method in class BBjGridExWidget.BBjGridExWidget

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, ...)


setColumnMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

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


setColumns(BBjString columns!) - method in class GxClientModels.GxClientAddRangeSelectionModel

Add columns as comma separated string


setColumnSortedByRelatedData(BBjNumber column, BBjNumber sortByRelated) - method in class QVGrid.QVGrid

Specifies whether a particular column is to be sorted by related data rather than by the text in the cells


setColumnSpanExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as column span expression


setColumnState(GxState state!) - method in class BBjGridExWidget.BBjGridExWidget

Apply the grid's columns , sorbing and filtering state


#API


setColumnStyle(BBjNumber p_column, BBjNumber p_style) - method in class Dashboard.GridWidget

Sets the control style of a grid's column, similar to CommonGrid::setColumnStyle()


setColumnStyle(BBjNumber column, BBjNumber style) - method in class QVGrid.QVGrid

Sets the default style of a column in the grid


setColumnType(BBjString column$, BBjString type$) - method in class BBJasper.BBJasperDesign

setColumnType Sets a column's type


setColumnUserSortable(BBjNumber column, BBjNumber sortable) - method in class QVGrid.QVGrid

Causes the grid to sort a specified column when the user clicks in the header of that column


setColumnVerticalAlignment(BBjNumber column, BBjNumber align) - method in class QVGrid.QVGrid

Sets the default vertical alignment for all of the cells in a particular column


setColumnVisible(BBjNumber column) - method in class QVGrid.QVGrid

Sets a column in the grid to be visible


setColumnVisible(BBjString columns!, BBjNumber hidden!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the visibility of column(s)


setColumnVisible(GxColumn column!, BBjNumber hidden!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the visibility of a column


setColumnWidth(BBjNumber p_column, BBjNumber p_width) - method in class Dashboard.GridExWidget

Sets the width of a grid's column given the 0-based column index


setColumnWidth(BBjNumber p_column, BBjNumber p_width) - method in class Dashboard.GridWidget

Sets the width of a grid's column


setColumnWidth(BBjNumber column, BBjNumber width) - method in class QVGrid.QVGrid

Sets the width of a column


setColumnWidth(BBjString field$, BBjNumber width!) - method in class BBjGridExWidget.BBjGridExWidget

Sets the width of a column


#Configuration
#API


Note: Unlike setting the width in the column definition, this method will update a column width without a full re-render.

setColumnWidth(BBjNumber width!) - method in class GxOptions.GxOptions

Sets the default column width for all columns


#Configuration
#ColumnsRenderer


setColumnWidthPercentages(BBjString p_columnWidthPercentages!) - method in class Dashboard.GridExWidget

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.


setColumnWidthPercentages(BBjVector p_columnWidthPercentages!) - method in class Dashboard.GridExWidget

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.


setColumnWidthPercentages(BBjString p_columnWidthPercentages!) - method in class Dashboard.GridWidget

Sets the widths of all grid columns by providing a string containing width percentages


setColumnWidthPercentages(BBjVector p_columnWidthPercentages!) - method in class Dashboard.GridWidget

Sets the widths of all grid columns by providing a vector containing width percentages


setColumnWidths(BBjNumber p_columnWidthsConstant) - method in class Dashboard.GridWidget

Sets the widths of the grid's columns based on an algorithm determined by the provided parameter.

Parameter options:

  • COLUMN_WIDTHS_FROM_DATA: Sizes the columns to be wide enough to avoid truncating the cell data
  • COLUMN_WIDTHS_FROM_HEADER: Sizes the columns to be wide enough to avoid truncating the header data
  • COLUMN_WIDTHS_FROM_HEADER_AND_DATA: Sizes the columns to be wide enough to avoid truncating the header and cell data
  • COLUMN_WIDTHS_FROM_WIDGET: Sizes the columns to be narrow enough to fit within the widget, potentially truncating the data

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.


setComment(BBjString comment!) - method in class gappsv3.GEventAttendee

Attendee's comment for the event. Example: "I am bringing cherry cobbler to the party."


setComponentVisibility(BBjString id!, BBjNumber visibility!) - method in class GxStatusBar.GxStatusBar

Hide/show statusbar component


setComponentVisibility(GxStatusBarComponentInterface component!, BBjNumber visibility!) - method in class GxStatusBar.GxStatusBar

Hide/show statusbar component


setContainer(BBjNumber p_container) - method in class WidgetWizard

Method setContainter Sets the build container


setCookies(BBjString p_cookieKey$, HashMap p_cookieHashMap!) - method in class DemoUtils.DemoUtils

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(BBjNumber p_copies) - method in class BBJasper.BBJasperPrintServiceExporter

setCopies Sets the number of copies


setCornerWaterMark(BBXImage watermarkImage!, BBjNumber opacity, BBjNumber width, BBjNumber height, BBjNumber anchorPoint) - method in class BBXImage.BBXImage

Method to add a watermark logo to the BBXImage


setCount(BBjNumber count) - method in class gappsv3.SimpleRULE

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(BBjNumber p_createContactsOnSend) - method in class Email.EmailDialog

setCreateContactsOnSend Sets whether contacts should be created for new email addresses on a send


setCreated(com.google.api.client.util.DateTime created!) - method in class gappsv3.GEvent

Sets the creation time of the event.


setCreator(Event.Creator creator!) - method in class gappsv3.GEvent

Sets the creator of the event.


setCSVExporter(BBJasperCSVExporter p_csvExporter!) - method in class BBJasper.BBJasperViewerControl

setCSVExporter Sets the CSV exporter which contains export options


setCurrentEnd(BBjString currentEndDate!) - method in class BBjCalendarWidget.CalendarView

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.


setCurrentStart(BBjString currentStartDate!) - method in class BBjCalendarWidget.CalendarView

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.


setCursor(int cursor!) - method in class QVGrid.QVGrid

Sets the cursor style on the grid control


setCustom3DAxisColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.BarChartWidget

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.


setCustom3DAxisColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.LineChartWidget

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.


setData(ResultSet rs!, BBjNumber render!, BBjNumber addAll!, BBjString indexdBy$) - method in class BBjGridExWidget.BBjGridExWidget

Feed the grid with data


setData(ResultSet rs!, BBjNumber render!, BBjNumber all!) - method in class BBjGridExWidget.BBjGridExWidget

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


setData(ResultSet rs!, BBjNumber render!) - method in class BBjGridExWidget.BBjGridExWidget

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


setData(ResultSet rs!, BBjString indexdBy$) - method in class BBjGridExWidget.BBjGridExWidget

Feed the grid with data


setData(ResultSet rs!) - method in class BBjGridExWidget.BBjGridExWidget

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


setDataSetValue(BBjString p_key$, BBjNumber p_value) - method in class Dashboard.PieChartWidget

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.


setDataSetValue(BBjString p_rowKey$, BBjString p_colKey$, BBjNumber p_value) - method in class Dashboard.BarChartWidget

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.


setDataSetValue(BBjString p_rowKey$, BBjString p_colKey$, BBjNumber p_value) - method in class Dashboard.LineChartWidget

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.


setDataSetValue(BBjString p_seriesName$, BBjNumber p_xValue, BBjNumber p_yValue) - method in class Dashboard.XYChartWidget

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.


setDBAttributes(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_host$, BBjInt p_port%, BBjString p_user$, BBjString p_password$) - method in class BUS

setDebug(BBjNumber debug) - method in class QVGrid.QVGrid

Sets the general debug flag and brings up the BBjSysConsole, if not running in BUI


setDebug(BBjNumber debug!, BBjNumber port!) - method in class BBjGridExWidget.BBjGridExWidget

Enable remote debugging on the given port


setDebug(BBjNumber debug!) - method in class BBjGridExWidget.BBjGridExWidget

Enable remote debugging on the 9222 port


setDefaultAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default horizontal alignment for all of the cells in the grid


setDefaultColumnText(BBjNumber col, BBjString text$) - method in class QVGrid.QVGrid

Sets the default text that is displayed in a column


setDefaultColumnWidth(BBjNumber width) - method in class QVGrid.QVGrid

Sets the default width of all columns


setDefaultDatesMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

setDefaultDocument(BBjString p_defaultDocument$) - method in class GDocSaveDialog

setDefaultFolder(BBjString p_defaultFolder$) - method in class GDocSelectionDialog

setDefaultGridStyle(BBjNumber style) - method in class QVGrid.QVGrid

Sets the default style of all the cells in the grid


setDefaultHour(BBjNumber hour!) - method in class GxOptions.GxOptionsDateTime

Set the initial value of the hour element.


setDefaultMinute(BBjNumber minute!) - method in class GxOptions.GxOptionsDateTime

Set the initial value of the minute element.


setDefaultNumbersMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

setDefaults() - method in class BBJasper.BBJasperViewerWindow

setDefaults Sets the default X, Y, width, height for the window


setDefaultSave(BBjNumber p_defaultSave) - method in class BBJasper.BBJasperViewerControl

setDefaultSave Sets the default save location


setDefaultSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperViewerControl

setDefaultSaveContributor Sets the default save contributor


setDefaultSaveContributor(BBjNumber p_type) - method in class BBJasper.BBJasperView

setDefaultSaveContributor Sets the default save contributor


setDefaultSaveFile(BBjString p_saveFile$) - method in class BBJasper.BBJasperViewerControl

setDefaultSaveFile Sets the default save file


setDefaultSaveFile(BBjString p_saveFile$) - method in class BBJasper.BBJasperView

setDefaultSaveFile Sets the default save file


setDefaultSaveFolder(BBjString p_saveFolder$) - method in class BBJasper.BBJasperViewerControl

setDefaultSaveFolder Sets the default save folder


setDefaultSaveFolder(BBjString p_saveFolder$) - method in class BBJasper.BBJasperView

setDefaultSaveFolder Sets the default save folder


setDefaultStringsMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

setDefaultTimedEntryDuration(BBjString defaultTimedEntryDuration!) - method in class BBjCalendarWidget.CalendarOptions

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.


setDefaultTimesMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

setDefaultTimestampsMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

setDefaultType(BBjString p_defaultType$) - method in class GDocSaveDialog

setDefaultVerticalAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default vertical alignment for all of the cells in the grid


setDeleted(BBjNumber deleted!) - method in class gappsv3.GCalendar

Set calendar's "deleted" attribute


setDeltaColumnMode(BBjNumber enabled!) - method in class GxOptions.GxOptions

Enable/disable DeltaColumn Mode


setDescription(BBjString p_description$) - method in class BBXImage.BBXImage

Method to set the description of the BBXImage


setDescription(BBjString description!) - method in class gappsv3.GCalendar

Set calendar's description


setDescription(BBjString description!) - method in class gappsv3.GEvent

Sets the event's description.


setDescription(BBjString description!) - method in class BBjCalendarWidget.CalendarEntry

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.


setDescription(BBjString description!) - method in class BBjCalendarWidget.CalendarEntrySource

Sets the source's extended information that can be used to further describe the source.


setDevicePixelRatio(BBjNumber p_pixelRatio) - method in class Dashboard.BBjWidget

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


setDevicePixelRatio(BBjNumber p_pixelRatio) - method in class Dashboard.ChartWidget

Sets the screen's device pixel ratio used for modifying ChartWidgets


setDialBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha) - method in class BBjBUIDialChart.BBjBUIDialChart

setDialCap(BBjNumber dialCapSize, BBjColor outlineColor!, BBjColor fillColor!) - method in class BBjBUIDialChart.BBjBUIDialChart

setDialSize(BBjNumber p_sizePercentage) - method in class BBjBUIDialChart.BBjBUIDialChart

setDialSize(BBjNumber p_sizePercentageWidth, BBjNumber p_sizePercentageHeight) - method in class BBjBUIDialChart.BBjBUIDialChart

setDisplay(BBjString display!) - method in class BBjCalendarWidget.CalendarEntry

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:


setDisplay(BBjString display!) - method in class BBjCalendarWidget.CalendarEntrySource

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:


setDisplayName(BBjString p_displayName!) - method in class GPermission

setDisplayName(BBjString displayName!) - method in class gappsv3.GEventAttendee

The attendee's name, if available.


setDOCXExporter(BBJasperDOCXExporter p_docxExporter!) - method in class BBJasper.BBJasperViewerControl

setDOCXExporter Sets the DOCX exporter which contains export options


setDomain(BBjString p_domain!) - method in class GPermission

setDomainAxisLabelGridBandColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.XYChartWidget

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.


setDomainAxisLabels(BBjString p_domainAxisTitle$, BBjString p_labels!) - method in class Dashboard.XYChartWidget

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.


setDomainLabelAngle(BBjNumber p_labelPosition) - method in class Dashboard.BarChartWidget

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


setDomainLabelAngle(BBjNumber p_labelPosition) - method in class Dashboard.LineChartWidget

Sets the angle of the labels on the domain axis


setDragAccept(BBjNumber drag) - method in class QVGrid.QVGrid

Sets whether the grid will accept drag and drop operations


setDragActions(BBjNumber actions) - method in class QVGrid.QVGrid

Sets the available drag actions for the grid control


setDragEnabled(BBjNumber mode) - method in class QVGrid.QVGrid

Sets whether the grid control should allow drag operations


setDraggingEnabled(BBjNumber p_draggingEnabled) - method in class Dashboard.WidgetControl

Sets the dragging enable status of the widget control


setDragType(BBjNumber row, BBjNumber column, BBjString type$) - method in class QVGrid.QVGrid

Sets an optional type string that an individual grid cell advertises to potential drop targets when the grid acts as a drag source


setDragType(BBjNumber column, BBjString type$) - method in class QVGrid.QVGrid

Sets an optional type string that an individual grid column advertises to potential drop targets when the grid acts as a drag source


setDragType(BBjString type$) - method in class QVGrid.QVGrid

Sets an optional type string that the grid control advertises to potential drop targets when it acts as a drag source


setDropActions(BBjNumber actions) - method in class QVGrid.QVGrid

Sets the actions that will be allowed when the grid control acts as a drop target


setDropShadow(BBjNumber shadowSize, BBjNumber shadowOpacity, BBjNumber xOffset, BBjNumber yOffset) - method in class BBXImage.BBXImage

Method to add a drop shadow to the BBXImage


setDropTypes(BBjNumber column, BBjVector types!) - method in class QVGrid.QVGrid

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.


setDropTypes(BBjNumber row, BBjNumber column, BBjVector types!) - method in class QVGrid.QVGrid

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.


setDropTypes(BBjVector types!) - method in class QVGrid.QVGrid

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.


setEditable(BBjNumber editable) - method in class QVGrid.QVGrid

Sets whether the cells in the grid are editable Note: The QVGrid is not editable, so this method has no effect.


setEditable(BBjNumber editable!) - method in class GxOptions.GxOptions

Enable / disable column editing


#Configuration
#ColumnsRenderer


setEditableExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as editable expression


setEditClickCount(BBjNumber count) - method in class QVGrid.QVGrid

Sets the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.


setEmail(BBjString email!) - method in class gappsv3.GEventAttendee

The attendee's email address, if available. This field must be present when adding an attendee.


setEmailAddress(BBjString p_emailAddress!) - method in class GPermission

setEmailAttributes(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_host$, BBjInt p_port%, BBjString p_protocol$, BBjString p_headerType$, BBjString p_headerValue$, BBjString p_user$, BBjString p_password$, BBjString p_from$, BBjString p_replyTo$, BBjString p_cc$, BBjString p_subject$, BBjString p_text$) - method in class BUS

setEmailCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setEmailCallback Sets a callback routine to call when email is requested


setEmailCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setEmailCallback Sets a callback routine to call when email is requested


setEmailCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setEmailCallback Sets a callback routine to call when email is requested


setEmailCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setEmailCallback Sets a callback routine to call when email is requested


setEmailEnabled(BBjNumber p_emailEnabled) - method in class Dashboard.DashboardWidget

Sets the email enabled or disabled


setEmailFrom(BBjString p_emailFrom$) - method in class Email.EmailDialog

setEmailFrom Sets the email from address


setEmailMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the email menu item in the options menu


setEmailMessage(BBjString p_emailMessage$) - method in class Email.EmailDialog

setEmailMessage Sets the email message


setEmailServerHost(BBjString p_emailServerHost$) - method in class Email.EmailDialog

setEmailServerHost Sets the email server host


setEmailServerPassword(BBjString p_emailServerPassword$) - method in class Email.EmailDialog

setEmailServerPassword Sets password that will be used to authenticate to the email server


setEmailServerPort(BBjNumber p_emailServerPort) - method in class Email.EmailDialog

setEmailServerPort Sets the email server port


setEmailServerSSL(BBjNumber p_emailServerSSL) - method in class Email.EmailDialog

setEmailServerSSL Sets the email server ssl protocol on or off


setEmailServerUserName(BBjString p_emailServerUserName$) - method in class Email.EmailDialog

setEmailServerUserName Sets user name that will be used to authenticate to the email server


setEmailSubject(BBjString p_emailSubject$) - method in class Email.EmailDialog

setEmailSubject Sets the email subject


setEmbeddedLabels(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.PieChartWidget

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.


setEnable24HR(BBjNumber enabled!) - method in class GxOptions.GxOptionsDateTime

Enable / disable time 24 format.


setEnabled(boolean enabled!) - method in class QVGrid.QVGrid

Sets whether the grid control is to be enabled or disabled


setEnabled(boolean enabled!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets whether the widget should be enabled.


setEnableDayHeaders(BBjNumber enableDayHeaders) - method in class BBjCalendarWidget.CalendarOptions

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().


setEnableDebug(BBjNumber enableDebug) - method in class BBjCalendarWidget.BBjCalendarWidget

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:

  • use unminified JavaScript and CSS when possible
  • display the debugger console in a browser when run in GUI if your !CHROMIUM_SWITCHES global string entry is properly set before instantiating the BBjCalendarWidget, as in: chromium_switches$ = stbl("!CHROMIUM_SWITCHES", "--remote-debugging-port=9223")
  • log messages to the console from both the BBj programs and the JavaScript code

setEnableDurationEditable(BBjNumber durationEditable!) - method in class BBjCalendarWidget.CalendarEntry

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.


setEnableDurationEditable(BBjNumber durationEditable!) - method in class BBjCalendarWidget.CalendarEntrySource

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).


setEnableEditable(BBjNumber enableEditable) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableEditable(BBjNumber editable!) - method in class BBjCalendarWidget.CalendarEntry

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)


setEnableEditable(BBjNumber editable!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setEnableEntryDurationEditable(BBjNumber enableEntryDurationEditable) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableEntryOverlap(BBjNumber enableEntryOverlap) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableEntryOverlap(BBjNumber overlap!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's overlap status that determines if the entries may be dragged/resized over one another.


setEnableEntryResizableFromStart(BBjNumber enableEntryResizableFromStart) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableEntryStartEditable(BBjNumber enableEntryStartEditable) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableExpandRows(BBjNumber enableExpandRows) - method in class BBjCalendarWidget.CalendarOptions

Sets whether a calendar view's rows will expand to fit the available height (1) or not (0), where the default value is 0.


setEnableFilter(BBjNumber enable!, BBjNumber enableFiltersToolpanel!) - method in class GxOptions.GxOptions

Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.


#Configuration
#ColumnsRenderer


setEnableFilter(BBjNumber enable!) - method in class GxOptions.GxOptions

Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.


#Configuration
#ColumnsRenderer


setEnableFixedWeekCount(BBjNumber enableFixedWeekCount) - method in class BBjCalendarWidget.CalendarOptions

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()


setEnableNavLinks(BBjNumber enableNavLinks) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableNowIndicator(BBjNumber enableNowIndicator) - method in class BBjCalendarWidget.CalendarOptions

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()


setEnableOverlap(BBjNumber overlap!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setEnableSelectable(BBjNumber enableSelectable) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableShowNonCurrentDates(BBjNumber enableShowNonCurrentDates) - method in class BBjCalendarWidget.CalendarOptions

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()


setEnableSlotEntryOverlap(BBjNumber enableSlotEntryOverlap) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableStartEditable(BBjNumber startEditable!) - method in class BBjCalendarWidget.CalendarEntry

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.


setEnableStartEditable(BBjNumber startEditable!) - method in class BBjCalendarWidget.CalendarEntrySource

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).


setEnableUnselectAuto(BBjNumber enableUnselectAuto) - method in class BBjCalendarWidget.CalendarOptions

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.


setEnableWeekends(BBjNumber enableWeekends) - method in class BBjCalendarWidget.CalendarOptions

Sets whether to include Saturday/Sunday columns in any of the calendar views (1) or not (0), where the default value is 1.


setEnableWeekNumbers(BBjNumber enableWeekNumbers) - method in class BBjCalendarWidget.CalendarOptions

Sets whether week numbers should be displayed on the calendar (1) or not (0), where the default value is 0.


setEnd(EventDateTime end!) - method in class gappsv3.GEvent

Set the end time for the event using an EventDateTime object


setEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!) - method in class gappsv3.GEvent

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.


setEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!, BBjString timezone!) - method in class gappsv3.GEvent

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.


setEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!) - method in class gappsv3.GEvent

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.


setEnd(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjString timeZone!) - method in class gappsv3.GEvent

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.


setEnd(java.util.Date date!) - method in class gappsv3.GEvent

Set event end time using a java.util.Date This method is used to specify the end time for a timed event.


setEnd(java.util.Date date!, BBjString timezone!) - method in class gappsv3.GEvent

Set event end time using a java.util.Date This method is used to specify the end time for a timed event.


setEnd(BBjString end!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's exclusive ending date/time. If the entry is explicitly all-day, then the time portion will be ignored.


setEndPageIndex(BBjNumber p_endPageIndex) - method in class BBJasper.BBJasperExporter

setEndPageIndex Sets the ending page index for export operations


setEndTimeUnspecified(BBjNumber endTimeUnspecified!) - method in class gappsv3.GEvent

Sets whether the end time for the event is unspecified.


setEnterAsTab(BBjNumber enterAsTab) - method in class QVGrid.QVGrid

Sets whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]


setEntryBackgroundColor(BBjColor entryBackgroundColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryBackgroundColor(BBjString backgroundColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryBorderColor(BBjColor entryBorderColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryBorderColor(BBjString borderColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryColor(BBjColor entryColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryColor(BBjString color!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryDisplay(BBjString entryDisplay!) - method in class BBjCalendarWidget.CalendarOptions

Sets how entries are rendered on the calendar, where the default value is "auto".

Valid options are for the entry display are:

  • "auto" - The default. When in dayGrid view, renders the entry as a solid rectangle if it is all-day or multi-day. If a timed entry, will render it with a dot. When in other views, will render normally.
  • "block" - When in dayGrid view, renders the entry as a solid rectangle. When in other views, will render normally.
  • "list-item" - When in dayGrid view, renders the entry with a dot. When in other views, will render normally.
  • "background" - Renders the entry by coloring in the entire cell/slot background.
  • "inverse-background" - Renders the entry by coloring in the spans of time not occupied by the entry.

setEntryTextColor(BBjColor entryTextColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEntryTextColor(BBjString textColor!) - method in class BBjCalendarWidget.CalendarOptions

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.


setEtag(BBjString etag!) - method in class gappsv3.GCalendar

Set calendar's "deleted" attribute


setEtag(BBjString etag!) - method in class gappsv3.GEvent

ETag for the event. ETags are used in caching to determine whether a resource has changed.


setExplodeAllSlicesPercent(BBjNumber p_percentExplode) - method in class Dashboard.PieChartWidget

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


setExplodePercent(BBjString p_sliceName$, BBjNumber p_percentExplode) - method in class Dashboard.PieChartWidget

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


setExportDataEnabled(BBjNumber p_exportDataEnabled) - method in class Dashboard.DashboardWidget

Sets the export data enabled or disabled


setExportDataMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the export data menu item in the options menu


setExtendedProperties(Event.ExtendedProperties extendedProperties!) - method in class gappsv3.GEvent

ExtendedProperties for the event.


setExtendedProperties(HashMap extendedProperties!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's extended properties, i.e. custom properties.


setField(BBjString field!) - method in class GxColumns.GxColumn

Throw an error when called because the field becomes immutable after the column's definition creation


setFileSaveAsCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setFileSaveAsCallback Sets a callback routine to call after a file save-as occurs


setFileSaveAsCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setFileSaveAsCallback Sets a callback routine to call when a file save-as occurs


setFileSaveAsCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setFileSaveAsCallback Sets a callback routine to call after a file save-as occurs


setFileSaveAsCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setFileSaveAsCallback Sets a callback routine to call when a file save-as occurs


setFileSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setFileSaveCallback Sets a callback routine to call when a file save occurs


setFileSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setFileSaveCallback Sets a callback routine to call when a file save occurs


setFileSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setFileSaveCallback Sets a callback routine to call after a file save occurs


setFileSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setFileSaveCallback Sets a callback routine to call when a file save occurs


setFileSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setFileSaveCallback Sets a callback routine to call after a file save occurs


setFileSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setFileSaveCallback Sets a callback routine to call when a file save occurs


setFillErrorDisplayImage(BBjString p_imageFile$) - method in class Dashboard.BaseWidget

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()


setFillErrorDisplayText(BBjString p_displayText$) - method in class Dashboard.BaseWidget

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()


setFilterBlur(BBjNumber p_blurAmount) - method in class BBXImage.BBXImage

Method to filter the BBXImage and increase the blurriness


setFilterBrightness(BBjNumber p_fraction) - method in class BBXImage.BBXImage

Method to adjust the brightness of the BBXImage


setFilterContrast(BBjNumber p_fraction) - method in class BBXImage.BBXImage

Method to adjust the contrast of the BBXImage


setFilterGrayscale() - method in class BBXImage.BBXImage

Method to filter the BBXImage and convert it to grayscale (completely desaturated)


setFilterModel(BBjString column!, GxClientFilterModel model!) - method in class BBjGridExWidget.BBjGridExWidget

Set and apply filter model for the given column


setFilterSharpen(BBjNumber p_sharpenAmount) - method in class BBXImage.BBXImage

Method to filter the BBXImage and increase the sharpness


setFilterValues(JsonArray values!) - method in class GxClientModels.GxClientFilterSetFilterModel

Change on the fly the available options


#API


setFindCaseSensitivity(BBjNumber p_findCaseSensitivity) - method in class BBJasper.BBJasperViewerControl

setFindCaseSensitivity(BBjNumber p_findCaseSensitivity) - method in class BBJasper.BBJasperView

setFindCaseSensitivity Sets case sensitivity of the find


setFindHighlight(BBjNumber p_findHighlight) - method in class BBJasper.BBJasperViewerControl

setFindHighlight(BBjNumber p_findHighlight) - method in class BBJasper.BBJasperView

setFindHighlight Sets highlight option for the find


setFindIncremental(BBjNumber p_findIncremental) - method in class BBJasper.BBJasperView

setFindIncremental Sets incremental find option for the find


setFindMatch(BBjNumber p_findMatch) - method in class BBJasper.BBJasperViewerControl

setFindMatch(BBjNumber p_findMatch) - method in class BBJasper.BBJasperView

setFindMatch Sets match option for the find


setFindScope(BBjNumber p_findScope) - method in class BBJasper.BBJasperViewerControl

setFindScope(BBjNumber p_findScope) - method in class BBJasper.BBJasperView

setFindScope Sets scope option for the find


setFindText(BBjString p_findText$) - method in class BBJasper.BBJasperViewerControl

setFindText Sets the find text


setFindText(BBjString p_findText$) - method in class BBJasper.BBJasperView

setFindWindowVisible(BBjNumber p_findWindowVisible) - method in class BBJasper.BBJasperView

setFindWindowVisible Set the find window visibility


setFirstCondition(GxClientFilterModel condition!) - method in class GxClientModels.GxClientFilterCombinedModel

Set the first condition


setFirstDay(BBjNumber firstDay) - method in class BBjCalendarWidget.CalendarOptions

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() - method in class BBJasper.BBJasperViewerControl

setFitPage Sets the report image to the fit the page

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setFitPage() - method in class BBJasper.BBJasperView

setFitPage Sets the report image to the fit the page

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setFitToGrid(BBjNumber fit) - method in class QVGrid.QVGrid

Specifies whether to fit all columns into the displayed width of the grid


setFitToGrid() - method in class BBjGridExWidget.BBjGridExWidget

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


setFitToGrid(BBjNumber width!) - method in class BBjGridExWidget.BBjGridExWidget

Gets the grid to size the columns to the specified with


#API


setFitType(BBjNumber p_fitType) - method in class Dashboard.JasperViewerWidget

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(BBjNumber p_fitType) - method in class BBJasper.BBJasperViewerControl

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(BBjNumber p_fitType) - method in class BBJasper.BBJasperView

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() - method in class BBJasper.BBJasperViewerControl

setFitWidth Sets the report image to the fit the width of the container

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setFitWidth() - method in class BBJasper.BBJasperView

setFitWidth Sets the report image to the fit the width of the container

All Fit Methods: setFitWidth(), setFitPage(), setActualSize(), and setFitType()


setFocusable(BBjNumber canFocus) - method in class QVGrid.QVGrid

Sets whether the grid control can be focused


setFont(BBjFont font!) - method in class QVGrid.QVGrid

Sets the font for the grid control


setFonts(BBjString p_pathToTitleFontFile!, BBjInt p_titleFontSize!, BBjString p_pathToTooltipFontFile!, BBjInt p_tooltipFontSize!) - method in class BBLaunchDock

setFonts(BBjString p_pathToTitleFontFile!, BBjInt p_titleFontSize!, BBjString p_pathToTooltipFontFile!, BBjInt p_tooltipFontSize!, BBjInt p_tooltipDescriptionFontSize!) - method in class BBLaunchDock

setFontScalingFactor(BBjNumber p_factor) - method in class Dashboard.ChartWidget

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.


setFooterToolbar(CalendarToolbar toolbar!) - method in class BBjCalendarWidget.CalendarOptions

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.


setFooterValueGetterExpression(BBjString expression!) - method in class GxRenderers.GxRendererGroupCellRenderer

Create a GxExpression from string and set it a footer value getter


setForeColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the foreground (text) color for the grid control


setForeColor(BBjColor color!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the foreground color for a column


setForeColor(BBjString color!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the foreground color for a column


setFormatterExpression(BBjString expression!) - method in class GxOptions.GxOptionsDateTime

Create a GxExpression from string and set it as FormatterExpression


setFrequency(BBjString frequency$) - method in class gappsv3.SimpleRULE

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(BBjString from$) - method in class Email.Email

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.


setFunctionsReadOnly(BBjNumber readonly!) - method in class BBjGridExWidget.BBjGridExWidget

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


setGadget(Event.Gadget gadget!) - method in class gappsv3.GEvent

Sets the Gadget for the event.


setGlassPaneVisible(BBjNumber p_visible) - method in class Dashboard.DashboardControl

Called when the visibiliy of the glass pane


setGoogleCalendarApiKey(BBjString googleCalendarApiKey!) - method in class BBjCalendarWidget.CalendarOptions

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(BBjString p_defaultDocument$) - method in class BBJasper.BBJasperViewerControl

setGoogleDefaultDocument Sets the default Google document


setGoogleDefaultDocument(BBjString p_defaultDocument$) - method in class BBJasper.BBJasperView

setGoogleDefaultDocument Sets the default Google document


setGoogleDefaultFolder(BBjString p_defaultFolder$) - method in class BBJasper.BBJasperViewerControl

setGoogleDefaultFolder Sets the default Google folder


setGoogleDefaultFolder(BBjString p_defaultFolder$) - method in class BBJasper.BBJasperView

setGoogleDefaultFolder Sets the default Google folder


setGoogleDefaultType(BBjString p_defaultType$) - method in class BBJasper.BBJasperViewerControl

setGoogleDefaultType Sets the default Google document type


setGoogleDefaultType(BBjString p_defaultType$) - method in class BBJasper.BBJasperView

setGoogleDefaultType Sets the default Google document type


setGoogleDocSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs


setGoogleDocSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs


setGoogleDocSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setGoogleDocSaveCallback Sets a callback routine to call after a Google Doc save occurs


setGoogleDocSaveCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs


setGoogleDocSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setGoogleDocSaveCallback Sets a callback routine to call after a Google Doc save occurs


setGoogleDocSaveCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setGoogleDocSaveCallback Sets a callback routine to call when a Google Doc save occurs


setGradient(BBjColor color1!, BBjColor color2!, BBjNumber verticalOrientation) - method in class BBjBUIDialChart.BBjBUIDialChart

setGradientShadingAmount(BBjNumber p_gradientShadingAmount) - method in class Dashboard.ChartWidget

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.


setGradientWithAlpha(BBjColor color1!, BBjNumber alpha1, BBjColor color2!, BBjNumber alpha2, BBjNumber verticalOrientation) - method in class BBjBUIDialChart.BBjBUIDialChart

setGridEditable(BBjNumber editable) - method in class QVGrid.QVGrid

This method is deprecated. Use setEditable() instead. Note: The QVGrid is not editable, so this has no effect.


setGroupColumnLabel(BBjString label!) - method in class GxOptions.GxOptions

Set the default label used when a new group is created


#Configuration
#ColumnsRenderer


setGrouped(boolean arg0!) - method in class QVGrid.QVGrid

see BBjControl


setGroupId(BBjString groupId!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.


setGroupId() - method in class GxColumns.GxColumnGroup

Throw an error when called because the group id becomes immutable after the column group's definition creation


setGuestsCanInviteOthers(BBjNumber guestsCanInviteOthers!) - method in class gappsv3.GEvent

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.


setGuestsCanModify(BBjNumber guestsCanModify!) - method in class gappsv3.GEvent

Sets whether participants can modify the event.


setGuestsCanSeeOtherGuests(BBjNumber guestsCanSeeOtherGuests!) - method in class gappsv3.GEvent

Sets whether participants can see what other participants are invited to the meeting.


setHangoutLink(BBjString hangoutLink!) - method in class gappsv3.GEvent

Sets the hangout link associated with the meeting.


setHasColumnHeader(BBjNumber hasHeader) - method in class QVGrid.QVGrid

Sets whether the grid has a column header


setHasRowHeader(BBjNumber hasHeader) - method in class QVGrid.QVGrid

Sets whether the grid has a row header


setHasToolBar(BBjNumber p_showToolBar) - method in class Dashboard.JasperViewerWidget

Sets whether the widget should use a BBJasperViewerControl with a toolbar or a BBJasperView without a toolbar


setHeader(BBjString header$, BBjString value$) - method in class Email.Email

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.


setHeaderAlignment(BBjNumber align!) - method in class GxColumns.GxDefaultColumnDefinition

Sets the default alignment for a column's header


setHeaderGroupTooltip(BBjString tooltip!) - method in class GxColumns.GxDefaultColumnGroup

Set the tooltip for the column group header


setHeaderSelection(BBjNumber select) - method in class QVGrid.QVGrid

Sets whether a header cell will display as recessed if the row/column is selected


setHeaderToolbar(CalendarToolbar toolbar!) - method in class BBjCalendarWidget.CalendarOptions

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.


setHeight(BBjString height!) - method in class BBjCalendarWidget.CalendarOptions

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:

  • "100%" - The default, which means that the internal height fits inside the BBjCalendarWidget's height.
  • "auto" - The internal height will assume a natural height and no scrollbars will be used.
  • "50px" - The internal height in the exact height specified in pixels, e.g. "250px" for a 250 pixel height - note that you must include the units.

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.


setHiddenDays(BBjVector hiddenDays!) - method in class BBjCalendarWidget.CalendarOptions

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.


setHiddenDays(BBjString hiddenDays!) - method in class BBjCalendarWidget.CalendarOptions

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.


setHiddenTags(BBjString tags!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setHiddenTags(BBjVector tags!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setHighlightMethod(BBjNumber highlight) - method in class QVGrid.QVGrid

Sets the selection highlight method


setHighResolutionReportImages(BBjNumber p_highResolutionImages) - method in class BBJasper.BBJasperView

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.


setHorizontalCellSpacing(BBjNumber space) - method in class QVGrid.QVGrid

Sets the amount of horizontal space between the columns


setHorizontalLinesVisible(BBjNumber visible) - method in class QVGrid.QVGrid

Sets whether the horizontal lines between the rows are to be visible


setHorizontalScrollable(BBjNumber p_horizontalScrollable) - method in class Dashboard.GridWidget

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.


setHorizontalScrollable(BBjNumber scrollable) - method in class QVGrid.QVGrid

Sets whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid


setHorizontalScrollBarAlways(BBjNumber always) - method in class QVGrid.QVGrid

Sets whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed


setHostRequired(BBjNumber p_required) - method in class AdminLoginDialog

setHtml(BBjString html$, BBjString basedir$) - method in class Email.Email

setHtml Sets the html for the email


setHTMLExporter(BBJasperHTMLExporter p_htmlExporter!) - method in class BBJasper.BBJasperViewerControl

setHTMLExporter Sets the HTML exporter which contains export options


setHtmlLink(BBjString htmlLink!) - method in class gappsv3.GEvent

Gets the HTML Link for the meeting


setICalUID(BBjString iCalUID!) - method in class gappsv3.GEvent

Sets the iCalendar User ID for the meeting.


setIcon(BBjString url$, BBjNumber width!, BBjNumber height!) - method in class GxContextMenu.GxContextMenuItem

Construct an html image to use as an icon


setIcon(BBjString url$, BBjNumber width!) - method in class GxContextMenu.GxContextMenuItem

Construct an html image to use as an icon


setIcons(BBjString json!) - method in class GxColumns.GxDefaultColumnDefinition

Set the grid icons


setIcons(BBjString json!) - method in class GxOptions.GxOptions

Set the grid icons


#Configuration
#GridRenderer


setId(BBjString p_id!) - method in class GPermission

setId(BBjString id!) - method in class gappsv3.GEvent

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.


setId(BBjString id!) - method in class gappsv3.GEventAttendee

The attendee's Profile ID, if available.


setId(BBjString id!) - method in class BBjCalendarWidget.CalendarEntry

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.


setIgnoreZeroValues(BBjNumber p_ignoreZeroValues) - method in class Dashboard.PieChartWidget

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.


setImage(BBjString p_imageName$) - method in class Dashboard.ImageWidget

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.


setImage(URL p_imageURL!) - method in class Dashboard.ImageWidget

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.


setImageIcon(ImageIcon p_imageIcon!) - method in class BBXImage.BBXImage

Method to set the ImageIcon for the BBXImage


setImmutableColumns(BBjNumber enabled!) - method in class GxOptions.GxOptions

Enable/disable DeltaColumn Mode


setInitialDate(BBjString initialDate!) - method in class BBjCalendarWidget.CalendarOptions

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.


setInitialView(BBjString initialView!) - method in class BBjCalendarWidget.CalendarOptions

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.


setInputNBeep(BBjNumber shouldBeep) - method in class QVGrid.QVGrid

Determines whether InputN style cells will beep when the user enters an invalid character public void QVGrid.setInputNBeep(BBjNumber) throws BBjException


setInputNCommaCharacter(BBjString charString$) - method in class QVGrid.QVGrid

Sets the 'thousands' replacement character for all InputN style grid cells


setInputNDotCharacter(BBjString charString$) - method in class QVGrid.QVGrid

Sets the decimal character for all InputN style grid cells


setInputNUseEditCommas(BBjNumber shouldUse) - method in class QVGrid.QVGrid

Determines whether InputN style cells in the grid will display a character at each 'thousands' position


setInsertMode(BBjNumber shouldInsert) - method in class QVGrid.QVGrid

Controls whether the editor is in insert mode Note: The QVGrid is not editable, so this method has no effect.


setInterspace(BBjNumber param_0!) - method in class QVGrid.QVGrid

Method setInterspace: Note: This method has been deprecated since BBj 5.0. Use setHorizontalCellSpacing().


setJasperReport(JasperReport p_report!) - method in class BBJasper.BBJasperReport

setJasperReport Sets the working JasperReport object


setJobName(BBjString p_jobName$) - method in class BBJasper.BBJasperPrintServiceExporter

setJobName Sets the job name


setJobPriority(BBjNumber p_jobPriority) - method in class BBJasper.BBJasperPrintServiceExporter

setJobPriority Sets the job priority


setKind(BBjString p_kind!) - method in class GPermission

setKind(BBjString kind!) - method in class gappsv3.GEvent

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"


setLabelBackgroundColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.PieChartWidget

Sets the label's background color for the pie chart


setLabelFormat(BBjString p_customLabelFormat$) - method in class Dashboard.PieChartWidget

Define a custom label format for the pie chart


setLabelFormat(BBjString p_customLabelFormat$, NumberFormat p_numberFormat!, NumberFormat p_percentageFormat!) - method in class Dashboard.PieChartWidget

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:


 widget!.setLegendLabelFormat("{0}: {1}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
 
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:

 Current: $218.10
 
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.

setLabelsInBarChartColor(BBjString p_colorHexString$) - method in class Dashboard.BarChartWidget

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.


setLabelsOff() - method in class Dashboard.PieChartWidget

Turns off the pie chart's labels (the labels for the pie's slices, not the legend)


setLastExportDir(BBjString p_lastExportDir$) - method in class Dashboard.ExportData

setLastExportDir Sets the last export directory used. In BUI, this is a NOOP.


setLastFieldDelimiter(BBjString p_lastFieldDelimiter$) - method in class Dashboard.ExportData

setLastFieldDelimiter Sets the last field delimiter used.


setLastRecordDelimiter(BBjString p_lastRecordDelimiter$) - method in class Dashboard.ExportData

setLastRecordDelimiter Sets the last record delimiter used.


setLastSaveAsDefault(BBjNumber p_lastSaveAsDefault) - method in class Dashboard.ExportData

setLastSaveAsDefault Sets the last save as default used.


setLastSaveDir(BBjString p_lastSaveDir$) - method in class Dashboard.BaseWidget

setLastSaveDir Sets the last save directory used. In BUI, this is a NOOP.


setLastTextQualifier(BBjString p_lastTextQualifier$) - method in class Dashboard.ExportData

setLastTextQualifier Sets the last text qualifier used.


setLayeredBars(BBjNumber p_layeredBars) - method in class Dashboard.BarChartWidget

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.


setLeftClickCallback(DashboardWidget p_dashboardWidget!) - method in class Dashboard.WidgetControl

Sets a callback for a left click event that occurs on the passed dashboard widget


setLeftColumn(BBjNumber column) - method in class QVGrid.QVGrid

Sets a column in the grid to be the left-most visible column


setLegendBackground(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background color for the legend


setLegendBackground(Paint p_paint!) - method in class Dashboard.ChartWidget

Sets a background paint for the legend


setLegendLabelFormat(BBjString p_customLabelFormat$) - method in class Dashboard.ChartWidget

Define a custom label format for chart's legend items


setLegendLabelFormat(BBjString p_customLabelFormat$, NumberFormat p_numberFormat!, NumberFormat p_percentageFormat!) - method in class Dashboard.ChartWidget

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:


 widget!.setLegendLabelFormat("{0}: {1}", java.text.NumberFormat.getCurrencyInstance(), java.text.NumberFormat.getPercentInstance())
 
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:

 Current: $218.10
 
If the currency format is not specified, the value would display as "218.0" which does not include the pennies or currency unit.

setLegendPosition(RectangleEdge p_side!, HorizontalAlignment p_halign!, VerticalAlignment p_valign!) - method in class Dashboard.ChartWidget

Sets the position of the legend in the chart

Use code like widget!.getSideLeft(), widget!.getHAlignLeft(), widget!.getVAlignTop(), etc.


setLineColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the line color of the vertical and horizontal lines


setLineShapeRadius(BBjNumber p_radius) - method in class Dashboard.LineChartWidget

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


setLineWidth(BBjNumber p_width) - method in class Dashboard.LineChartWidget

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(Locale p_locale!) - method in class BBJasper.BBJasperReport

setLocale Sets the report locale parameter given a Java Locale object


setLocale(BBjString p_localeString$) - method in class BBJasper.BBJasperReport

setLocale Sets the report locale parameter given a string


setLocale(BBjString locale!) - method in class BBjCalendarWidget.CalendarOptions

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.


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.WidgetControl

Sets the location of the widget control


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.EmbeddedWidgetWindow

Sets the location of the EmbeddedWidgetWindow


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.EmbeddedWidgetSetWindow

Sets the location of the EmbeddedWidgetSetWindow


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class Dashboard.ExportDataDialog

setLocation Sets the screen location of the dialog


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class Email.EmailDialog

setLocation Sets the X, Y location of the dialog


setLocation(BBjString location!) - method in class gappsv3.GEvent

Sets a string representing the event location


setLocation(BBjNumber x!, BBjNumber y!) - method in class QVGrid.QVGrid

Sets the location of the QVGrid component child window


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class BBJasper.BBJasperViewerControl

setLocation Sets the location of the viewer control


setLocation(BBjNumber p_x, BBjNumber p_x) - method in class BBJasper.BBJasperTabbedView

setLocation Sets the location of the tabbed view


setLocation(BBjNumber p_x, BBjNumber p_y) - method in class BBJasper.BBJasperView

setLocation Sets the location of the viewer control


setLocation(BBjNumber x!, BBjNumber y!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets the location of the calendar widget given the provided X and Y coordinates.


setLocation(BBjString location!) - method in class BBjCalendarWidget.CalendarEntry

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.


setLocked(BBjNumber locked!) - method in class gappsv3.GEvent

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.


setLongCue(String text!) - method in class QVGrid.QVGrid

Sets the text that appears in the status bar when the mouse pointer hovers over the grid control


setMainGridAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.


setMainGridBackColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default background color of the grid


setMainGridFont(BBjFont font!) - method in class QVGrid.QVGrid

Sets the default font used in the grid


setMainGridForeColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default foreground color of the grid


setMainGridStripeColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the background stripe color of the grid


setMainGridVerticalAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.


setManualRefreshMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the manual refresh menu item in the options menu


setMask(BBjString mask!) - method in class GxColumns.GxDefaultColumnDefinition

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


setMaxColumns(BBjNumber max) - method in class QVGrid.QVGrid

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(BBjNumber p_maxPages) - method in class BBJasper.BBJasperReport

setMaxPages Sets the max number of report pages


setMaxRows(BBjNumber max) - method in class QVGrid.QVGrid

Sets the maximum number of rows allowed in the data set


setMediaSizeName(BBJasperPrintMediaSizeName p_bbjasperPrintMediaSizeName!) - method in class BBJasper.BBJasperPrintServiceExporter

setMediaSizeName Sets the media size name


setMediaTray(BBJasperPrintMediaTray p_bbjasperPrintMediaTray!) - method in class BBJasper.BBJasperPrintServiceExporter

setMediaTray Sets the media tray


setMiniFilter(BBjString miniFilter!) - method in class GxClientModels.GxClientFilterSetFilterModel

Sets the filter at the top of the filter (the 'quick search' in the popup)


#API


setMiniFilter(BBjNumber miniFilter!) - method in class GxClientModels.GxClientFilterSetFilterModel

Sets the filter at the top of the filter (the 'quick search' in the popup)


#API


setMouseCapture(BBjNumber capture) - method in class QVGrid.QVGrid

Sets whether to capture mouse movement events


setMouseClickCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setMouseClickCallback Sets a callback routine to call when the mouse is clicked


setMouseClickCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperViewerControl

setMouseClickCallback Sets a callback routine to call when the mouse is clicked


setMultipleSelection(BBjNumber p_multipleSelection) - method in class GDocSelectionDialog

setMultipleSelection(BBjNumber multiple) - method in class QVGrid.QVGrid

Sets whether multiple cells/rows/columns can be selected


setName(BBjString p_name$) - method in class Dashboard.DashboardItem

Sets the name of the dashboard item


setName(BBjString p_name$) - method in class BuildItem

setName(BBjString p_name$) - method in class WidgetBuildItem

setName(BBjString p_name$) - method in class WidgetSetBuildItem

setName(BBjString p_name$) - method in class WidgetDashboardBuildItem

setName(String name!) - method in class QVGrid.QVGrid

Sets the name of the grid control


setName(BBjString name!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setNextRetrieveToken(BBjString nextRetrieveToken!) - method in class gappsv3.GEvents

setNoEdge(boolean noEdge!) - method in class QVGrid.QVGrid

Sets the grid control to have no border


setNumColumns(BBjNumber columns) - method in class QVGrid.QVGrid

Sets the number of columns in the grid


setNumRows(BBjNumber rows) - method in class QVGrid.QVGrid

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(BBjString accesToken$) - method in class Email.Email

setOAuthAccessToken Set the OAuth access token for authentication when sending an email


setObjects(BBjString objects!) - method in class BBjCalendarWidget.CalendarToolbarSection

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.


setObjects(BBjVector objects!) - method in class BBjCalendarWidget.CalendarToolbarSection

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(BBJasperODSExporter p_odsExporter!) - method in class BBJasper.BBJasperViewerControl

setODSExporter Sets the ODS exporter which contains export options


setODTExporter(BBJasperODTExporter p_odtExporter!) - method in class BBJasper.BBJasperViewerControl

setODTExporter Sets the ODT exporter which contains export options


setOpacity(BBjNumber p_percentTransparent) - method in class BBXImage.BBXImage

Method to set the transparency of the BBXImage


setOpaque(boolean opaque!) - method in class QVGrid.QVGrid

Sets the opaque property of the grid control


setOptional(BBjNumber optional!) - method in class gappsv3.GEventAttendee

Whether this is an optional attendee. Optional. The default is False (0).


setOptions(CalendarOptions options!) - method in class BBjCalendarWidget.BBjCalendarWidget

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:

  1. Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration:

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()

  1. Get the options instance, call setter methods on it, then use it to set the calendar's options:

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!)


setOptionsButtonEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the options button in the widget control


setOptionsEnabled(BBjNumber p_optionsEnabled) - method in class Dashboard.DashboardWidget

Sets the options enabled or disabled


setOrganizer(Event.Organizer organizer!) - method in class gappsv3.GEvent

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.


setOrganizer(BBjNumber organizer!) - method in class gappsv3.GEventAttendee

Whether this attendee is also the organizer. Default is 0.


setOrientation(BBJasperPrintOrientation p_bbjasperPrintOrientation!) - method in class BBJasper.BBJasperPrintServiceExporter

setOrientation Sets the orientation


setOriginalStartTime(EventDateTime originalStartTime!) - method in class gappsv3.GEvent

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.


setOriginalStartTime(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!) - method in class gappsv3.GEvent

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.


setOriginalStartTime(java.util.Date javaDate!) - method in class gappsv3.GEvent

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.


setPadding(BBjNumber padding!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setPadding(BBjNumber paddingTop!, BBjNumber paddingRight!, BBjNumber paddingBottom!, BBjNumber paddingLeft!) - method in class BBjCalendarWidget.BBjCalendarWidget

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(BBjNumber p_page) - method in class BBJasper.BBJasperViewerControl

setPage Sets the current page


setPage(BBjNumber p_page) - method in class BBJasper.BBJasperView

setPage Sets the current page


setPageIndex(BBjNumber p_pageIndex) - method in class BBJasper.BBJasperExporter

setPageIndex Sets the page index for export operations


setPageRange(BBjNumber p_startPage, BBjNumber p_endPage) - method in class BBJasper.BBJasperPrintServiceExporter

setPageRange Sets the page range


setPaging(BBjNumber page) - method in class QVGrid.QVGrid

Sets whether the BBjGrid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no effect


setPagingAmount(BBjNumber lines) - method in class QVGrid.QVGrid

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(BBjString p_exportParameter$, Object p_value!) - method in class BBJasper.BBJasperExporter

setParameter Set a report parameter value


setPassword(BBjString password$) - method in class GAppsLoginDialog

setPasswordRequired(BBjNumber p_required) - method in class AdminLoginDialog

setPDFExporter(BBJasperPDFExporter p_pdfExporter!) - method in class BBJasper.BBJasperViewerControl

setPDFExporter Sets the PDF exporter which contains export options


setPermissions(BBjString p_id$, BBjNumber p_scopeType, BBjNumber p_role) - method in class GDoc

setPermissions(BBjString p_id$, BBjString p_scopeType$, BBjString p_role$) - method in class GDoc

setPhotoLink(BBjString p_photoLink!) - method in class GPermission

setPinnedBottomRows(ResultSet rs!) - method in class BBjGridExWidget.BBjGridExWidget

Set a result set of pinned rows on bottom


setPinnedBottomRows(ResultSet rs!) - method in class GxOptions.GxOptions

Set a result set of pinned rows on bottom


setPinnedTopRows(ResultSet rs!) - method in class BBjGridExWidget.BBjGridExWidget

Set a result set of pinned rows on top


setPinnedTopRows(ResultSet rs!) - method in class GxOptions.GxOptions

Set a result set of pinned rows on top


setPivotColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Disable pivot for all columns and enable it for the passed columns


#Enterprise
#Configuration
#API


setPivotMode(BBjNumber mode!) - method in class BBjGridExWidget.BBjGridExWidget

Enable / disable pivot mode


#Configuration
#API


setPlotBackground(BBjNumber p_red, BBjNumber p_green, BBjNumber p_blue, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background color for the plot, not the entire chart


setPlotBackground(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background color for the plot, not the entire chart


setPlotBackground(Paint p_paint!) - method in class Dashboard.ChartWidget

Sets a background paint for the plot, not the entire chart


setPlotBackgroundImage(BBjImage p_image!, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background image for the plot, not the whole chart


setPlotBackgroundImage(BBjString p_imageFile$, BBjNumber p_opacity) - method in class Dashboard.ChartWidget

Sets a background image for the plot, not the whole chart


setPlotPadding(BBjNumber p_padding) - method in class Dashboard.PieChartWidget

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.


setPopoutButtonEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the popout button in the widget control


setPopoutEnabled(BBjNumber p_popoutEnabled) - method in class Dashboard.DashboardWidget

Sets the popout enabled or disabled


setPopoutSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.DashboardWidget

Sets the desired size of the widget when it's popped out


setPopupMenu(BBjPopupMenu popupMenu!) - method in class QVGrid.QVGrid

Binds a pre-existing popup menu to the grid control


setPortRequired(BBjNumber p_required) - method in class AdminLoginDialog

setPosition(BBjString position!) - method in class BBjCalendarWidget.CalendarToolbar

Sets the position of the calendar's toolbar to the top or bottom of the calendar, which defaults to the top position.


setPPTXExporter(BBJasperPPTXExporter p_pptxExporter!) - method in class BBJasper.BBJasperViewerControl

setPPTXExporter Sets the PPTX exporter which contains export options


setPreviewImage(BBjImage p_previewImage!) - method in class Dashboard.WidgetControl

Sets the preview image for the widget control that will be displayed in the customize dialog


setPrintCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setPrintCallback Sets a callback routine to call after report is printed


setPrintCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setPrintCallback Sets a callback routine to call when report is printed


setPrintCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setPrintCallback Sets a callback routine to call after report is printed


setPrintCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setPrintCallback Sets a callback routine to call when report is printed


setPrinterName(BBjString p_printerName$) - method in class BBJasper.BBJasperPrintServiceExporter

setPrinterName Sets the printer name


setPrintQuality(BBJasperPrintQuality p_bbjasperPrintQuality!) - method in class BBJasper.BBJasperPrintServiceExporter

setPrintQuality Sets the print quality


setPrintServiceExporter(BBJasperPrintServiceExporter p_printServiceExporter!) - method in class BBJasper.BBJasperViewerControl

setPrintServiceExporter Sets the PrintService exporter which contains export options


setPrivateCopy(BBjNumber privateCopy!) - method in class gappsv3.GEvent

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).


setProcCallback(BBjNumber eventType, BBjString subRoutineName$) - method in class QVGrid.QVGrid

Registers a legacy custom event callback routine for a specified 'processing' event


setProcCallback(BBjNumber eventType, CustomObject customObj!, BBjString methodName$) - method in class QVGrid.QVGrid

Registers an object oriented custom event callback routine for a specified 'processing' event


setQuickFilter(BBjString filter!) - method in class BBjGridExWidget.BBjGridExWidget

Perform throw columns search


#API


setQuickFilter(BBjNumber filter!) - method in class BBjGridExWidget.BBjGridExWidget

Perform throw columns search


#API


setRaisedEdge(boolean raised!) - method in class QVGrid.QVGrid

Sets the grid control to have a raised border


setRangeValues(BBjNumber p_minRangeValue, BBjNumber p_maxRangeValue) - method in class Dashboard.ChartWidget

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


setRecurrence(BBjVector recurrence!) - method in class gappsv3.GEvent

Makes an event a recurring event.


setRecurringEventId(BBjString recurringEventId!) - method in class gappsv3.GEvent

For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.


setReflection(BBjNumber reflectionLength, BBjNumber reflectionOpacity, BBjNumber blurred, BBjNumber verticalSpace) - method in class BBXImage.BBXImage

Method to add a reflection to the BBXImage


setRefreshCallback(DashboardWidget p_dashboardWidget!) - method in class Dashboard.WidgetControl

Sets a callback for a refresh event that occurs on the passed dashboard widget


setRefreshConfigurationMenuEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the refresh configuration menu in the options menu


setRefreshEnabled(BBjNumber p_refreshEnabled) - method in class Dashboard.DashboardWidget

Sets the refresh enabled or disabled


setRefreshMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the refresh menu item in the options menu


setReloadCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setReloadCallback Sets a callback routine to call after report is reloaded


setReloadCallback(BBjString p_eventName$, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setReloadCallback Sets a callback routine to call when report is reloaded


setReloadCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperView

setReloadCallback Sets a callback routine to call after report is reloaded


setReloadCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!, BBjNumber p_override) - method in class BBJasper.BBJasperView

setReloadCallback Sets a callback routine to call when report is reloaded


setRemember(BBjNumber remember) - method in class GAppsLoginDialog

setRememberRequired(BBjNumber p_required) - method in class AdminLoginDialog

setReminders(Event.Reminders reminders!) - method in class gappsv3.GEvent

Sets information about reminders such as email and popup notifications.


setReplyTo(BBjString replyTo$) - method in class Email.Email

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(BBJasperReport p_report!) - method in class Dashboard.JasperViewerWidget

setReport Sets the BBJasperReport for the widget


setReportConfiguration(JRAbstractExporter p_exporter!, SimpleReportExportConfiguration p_simpleReportExportConfiguration!) - method in class BBJasper.BBJasperExporter

setReportConfiguration Sets a simple report configuration from parameters


setReportConfiguration(JRAbstractExporter@ p_exporter!, SimpleReportExportConfiguration@ p_simpleReportExportConfiguration!) - method in class BBJasper.BBJasperExporter

setReportConfiguration Sets a simple report configuration from parameters


setReportTabSelectedCallback(BBjString p_eventName$, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperTabbedView

setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected


setReportTabSelectedCallback(BBjString p_eventName$, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) - method in class BBJasper.BBJasperTabbedView

setReportTabSelectedCallback Sets a callback routine to call when a Report Tab is selected


setRequiredPermissions(BBjNumber p_requiredPermissions) - method in class Admin

setResource(BBjNumber resource!) - method in class gappsv3.GEventAttendee

Whether the attendee is a resource. Read-only. The default is False (0)


setResponseStatus(java.lang.String responseStatus!) - method in class gappsv3.GEventAttendee

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.


setResultSet(ResultSet bcrs!) - method in class QVGrid.QVGrid

Registers the underlying BASIS Components ResultSet


setRightClickCallback(DashboardWidget p_dashboardWidget!) - method in class Dashboard.WidgetControl

Sets a callback for a right click event that occurs on the passed dashboard widget


setRingDepth(BBjNumber p_ringDepth) - method in class Dashboard.RingChartWidget

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.


setRole(BBjString p_role!) - method in class GPermission

setRowAlignment(BBjNumber row, BBjNumber align) - method in class QVGrid.QVGrid

Sets the horizontal alignment of a row


setRowBackColor(BBjNumber row, BBjColor color!) - method in class QVGrid.QVGrid

Sets the background color of a row


setRowData(BBjVector p_rowData!) - method in class Dashboard.GridWidget

Sets the grid's row data using the passed vector


setRowData(BBjNumber index!, DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Update row data


#API


setRowData(DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Update row data


#API


setRowDeselection(BBjNumber value!) _break_ - method in class GxOptions.GxOptions

setRowEditable(BBjNumber row, BBjNumber editable) - method in class QVGrid.QVGrid

Sets whether a row is editable Note: The QVGrid is not editable, so this has no effect.


setRowFont(BBjNumber row, BBjFont font!) - method in class QVGrid.QVGrid

Sets the default font of a row


setRowForeColor(BBjNumber row, BBjColor color!) - method in class QVGrid.QVGrid

Sets the foreground color of a row


setRowGroupColumns(BBjString columns!) - method in class BBjGridExWidget.BBjGridExWidget

Disable row grouping for all columns and enable it for the passed columns


#Enterprise
#Configuration
#API


setRowGutter(BBjNumber pixels) - method in class QVGrid.QVGrid

Sets the number of pixels separating the row header and the main grid area


setRowHeaderAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the default alignment of the row header


setRowHeaderBackColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default background color of the row header


setRowHeaderCellAlignment(BBjNumber row, BBjNumber align) - method in class QVGrid.QVGrid

Sets the alignment of a row header cell


setRowHeaderCellBackColor(BBjNumber row, BBjColor color!) - method in class QVGrid.QVGrid

Sets the background color of a row header cell


setRowHeaderCellForeColor(BBjNumber row, BBjColor color!) - method in class QVGrid.QVGrid

Sets the foreground color of a row header cell


setRowHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row) - method in class QVGrid.QVGrid

Sets the icon in a row header cell


setRowHeaderCellImage(BBjNumber row, BBjImage image!) - method in class QVGrid.QVGrid

Sets the image displayed in a row header cell


setRowHeaderCellStyle(BBjNumber row, BBjNumber style) - method in class QVGrid.QVGrid

Sets the style of a row header cell


setRowHeaderCellText(BBjNumber row, BBjString text$) - method in class QVGrid.QVGrid

Sets the text to be displayed in a row header cell


setRowHeaderCellVerticalAlignment(BBjNumber row, BBjNumber align) - method in class QVGrid.QVGrid

Sets the vertical alignment of the row header cell


setRowHeaderFont(BBjFont font!) - method in class QVGrid.QVGrid

Sets the default font of the row header


setRowHeaderForeColor(BBjColor color!) - method in class QVGrid.QVGrid

Sets the default foreground color of the row header


setRowHeaderStyle(BBjNumber style) - method in class QVGrid.QVGrid

Sets the style of the row header


setRowHeaderText(BBjVector strings!) - method in class QVGrid.QVGrid

Sets the row header text


setRowHeaderVerticalAlignment(BBjNumber align) - method in class QVGrid.QVGrid

Sets the vertical alignment of the row header


setRowHeaderWidth(BBjNumber width) - method in class QVGrid.QVGrid

Sets the width of the row header


setRowHeight(BBjNumber p_height) - method in class Dashboard.GridExWidget

Sets the row height for the grid's body cells


setRowHeight(BBjNumber height) - method in class QVGrid.QVGrid

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.


setRowHeight(BBjNumber height!) - method in class BBjGridExWidget.BBjGridExWidget

Set all rows height


#API


setRowHeight(BBjString key!, BBjNumber height!) - method in class BBjGridExWidget.BBjGridExWidget

Set the given row height


#API


setRowHeight(BBjNumber index!, BBjNumber height!) - method in class BBjGridExWidget.BBjGridExWidget

Set the given row height


#API


setRowListener(BBjString listener$) - method in class QVGrid.QVGrid

Registers row listener to CALL when processing a data row on its way to the grid


setRowListener(Object listener!) - method in class QVGrid.QVGrid

Registers row listener object to invoke when processing a data row on its way to the grid


setRowsData(ResultSet rs!) - method in class BBjGridExWidget.BBjGridExWidget

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


setRowSpanExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as row span expression


setRowStyle(BBjNumber row, BBjNumber style) - method in class QVGrid.QVGrid

Sets the default style of a row


setRowVerticalAlignment(BBjNumber row, BBjNumber align) - method in class QVGrid.QVGrid

Sets the default vertical alignment for a row


setRowVisible(BBjNumber row) - method in class QVGrid.QVGrid

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(BBJasperRTFExporter p_rtfExporter!) - method in class BBJasper.BBJasperViewerControl

setRTFExporter Sets the RTF exporter which contains export options


setSaveEnabled(BBjNumber p_saveEnabled) - method in class Dashboard.DashboardWidget

Sets the save enabled or disabled


setSaveMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the save menu item in the options menu


setScale(BBjNumber scaleNumber, BBjNumber rangeBottom, BBjNumber rangeTop, BBjNumber majorTickIncrement, BBjNumber scaleStartDegrees, BBjNumber scaleRangeDegrees, BBjNumber scaleRadius, BBjNumber scaleLength, BBjFont p_font!, BBjNumber labelOffset, BBjColor tickColor!, BBjNumber minorTickCount) - method in class BBjBUIDialChart.BBjBUIDialChart

setScrollOutside(BBjNumber outside) - method in class QVGrid.QVGrid

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.


setScrollUpdate(BBjNumber update) - method in class QVGrid.QVGrid

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.


setScrollWheelBehavior(BBjNumber mode) - method in class QVGrid.QVGrid

Configures under what situations the grid control will respond to the mouse scroll wheel


setSecondCondition(GxClientFilterModel condition!) - method in class GxClientModels.GxClientFilterCombinedModel

Set the first condition


setSelectCallback(DashboardWidget p_dashboardWidget!) - method in class Dashboard.WidgetControl

Sets a callback for a select event that occurs on the passed dashboard widget


setSelected(BBjNumber p_selected) - method in class Dashboard.DashboardWidget

Sets the DashboardWidget to be selected or deselected


setSelected(BBjNumber p_selected) - method in class Dashboard.WidgetControl

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.


setSelectedCell(BBjNumber row, BBjNumber col) - method in class QVGrid.QVGrid

Selects a cell


setSelectedColumn(BBjNumber column) - method in class QVGrid.QVGrid

Selects a column


setSelectedColumns(BBjVector selection!) - method in class QVGrid.QVGrid

Selects multiple columns


setSelectedRow(BBjNumber row) - method in class QVGrid.QVGrid

Selects a row


setSelectedRow(BBjNumber index!) - method in class BBjGridExWidget.BBjGridExWidget

Select a row by its index


#API


setSelectedRow(BBjString key!) - method in class BBjGridExWidget.BBjGridExWidget

Select a row by its key


#API


setSelectedRows(BBjVector selections!) - method in class QVGrid.QVGrid

Selects multiple rows in the grid


setSelectedRows(BBjVector x!) - method in class BBjGridExWidget.BBjGridExWidget

Select a vector of rows. The vector can contain a mix of row indices and row keys


#API


setSelectEnabled(BBjNumber p_selectEnabled) - method in class Dashboard.WidgetControl

Sets the selectability of the widget control


setSelectionMode(BBjNumber mode) - method in class QVGrid.QVGrid

Sets the method to select cells Note: The QVGrid always uses row selection (GRID_SELECT_ROW), so this method has no effect


setSentDate(Date date!) - method in class Email.Email

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.


setSequence(BBjNumber sequence!) - method in class gappsv3.GEvent

iCalendar sequence number.


setSeriesConfiguration(BBjString p_seriesName$, BBjNumber p_drawLines, BBjNumber p_drawShapes, BBjNumber p_shapeNumber, BBjNumber p_smoothLines, Color p_fillColor!, BBjNumber p_lineWidth, BBjNumber p_shapeSize, BBjNumber p_drawOutline, BBjNumber p_outlineWidth, Color p_outlineColor!) - method in class Dashboard.XYChartWidget

Configure a series in the XYSeriesCollection for the chart by setting various parameters


setSeriesXYValue(BBjString p_seriesName$, BBjNumber p_xValue, BBjNumber p_yValue) - method in class Dashboard.XYChartWidget

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.


setShadowColor(BBjString p_shadowHexString$, BBjNumber p_opacity, BBjNumber p_xOffset, BBjNumber p_yOffset) - method in class Dashboard.PieChartWidget

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


setShadowColor(BBjString p_shadowHexString$, BBjNumber p_opacity, BBjNumber p_xOffset, BBjNumber p_yOffset) - method in class Dashboard.BarChartWidget

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


setShortCue(String cue!) - method in class QVGrid.QVGrid

Sets the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as setToolTipText().


setShouldHighlightSelectedColumn(BBjNumber should) - method in class QVGrid.QVGrid

Sets whether the grid will highlight the entire column containing the currently selected cell


setShouldHighlightSelectedRow(BBjNumber should) - method in class QVGrid.QVGrid

Sets whether the grid should highlight the entire row containing the currently selected cell


setShowBrowserWarning(BBjString p_app$, BBjNumber p_show) - method in class BBUtils.BBUtils

setShowBuiBusyOnLoad(BBjNumber p_showBuiBusyOnLoad) - method in class Dashboard.DashboardWindow

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.


setShowClientConfirmationDialog(BBjString p_app$, BBjNumber p_show) - method in class BBUtils.BBUtils

setShowFileDialogOnInitDefaultSave(BBjNumber p_showFileDialogOnInitDefaultSave) - method in class BBJasper.BBJasperViewerControl

setShowFileDialogOnInitDefaultSave Sets if the file save dialog should be shown on the intitial save


setShowGoogleDialogOnInitDefaultSave(BBjNumber p_showGoogleDialogOnInitDefaultSave) - method in class BBJasper.BBJasperViewerControl

setShowGoogleDialogOnInitDefaultSave Sets if the Google save dialog should be shown on the intitial save


setShowGroupChildCount(BBjNumber enabled!) - method in class GxOptions.GxOptions

Enable / disable showing row counts beside group labels


#Configuration
#ColumnsRenderer


setShowGroupSelectionCheckbox(BBjNumber enabled!) - method in class GxOptions.GxOptions

Enable/ disable checkbox selection on groups


#Configuration
#ColumnsRenderer


setShowMaskWhenRendering(BBjNumber show) - method in class QVGrid.QVGrid

Controls whether the input style cells display decoration characters of their mask in non-edit mode Note: This method has been deprecated.


setSides(BBJasperPrintSides p_bbjasperPrintSides!) - method in class BBJasper.BBJasperPrintServiceExporter

setSides Sets the sides


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.DashboardWindow

Sets the window size


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.DashboardControl

Sets the control size


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.DashboardCategoryControl

Sets the size of the dashboard category control


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.WidgetControl

Sets the size of the widget control


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.EmbeddedWidgetWindow

Sets the size of the EmbeddedWidgetWindow


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.EmbeddedWidgetSetControl

Sets the size of the EmbeddedWidgetSetControl


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.EmbeddedWidgetSetWindow

Sets the size of the EmbeddedWidgetSetWindow


setSize(BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ExportDataDialog

setSize Sets the size of the dialog


setSize(BBjNumber width!, BBjNumber height!) - method in class QVGrid.QVGrid

Sets the size of the QVGrid component child window


setSize(BBjNumber p_width, BBjNumber p_height) - method in class BBJasper.BBJasperViewerWindow

setSize Sets the size of the viewer window and control


setSize(BBjNumber p_width, BBjNumber p_height) - method in class BBJasper.BBJasperViewerControl

setSize Sets the sizes of the viewer control


setSize(BBjNumber p_width, BBjNumber p_height) - method in class BBJasper.BBJasperTabbedView

setSize Sets the size of the tabbed view


setSize(BBjNumber p_width, BBjNumber p_height) - method in class BBJasper.BBJasperView

setSize Sets the size of the view


setSize(BBjNumber width!, BBjNumber height!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets the size of the calendar widget given the provided width and height.


setSize(BBjNumber w!, BBjNumber h!) - method in class BBjGridExWidget.BBjGridExWidget

setSize - set the size of the control


#API


setSliceOutlineColor(BBjString p_colorHexString$, BBjNumber p_opacity) - method in class Dashboard.PieChartWidget

Sets the color and opacity for the outline of each pie slice and its corresponding legend item


setSliceOutlineWidth(BBjNumber p_width) - method in class Dashboard.PieChartWidget

Sets the width of the outline for each pie slice and its corresponding legend with the default value set to 1.

Notes:

  • The value does not have to be an integer, so 0.5 is an acceptible value

setSlotDuration(BBjString slotDuration!) - method in class BBjCalendarWidget.CalendarOptions

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()


setSlotMaxTime(BBjString slotMaxTime!) - method in class BBjCalendarWidget.CalendarOptions

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.


setSlotMinTime(BBjString slotMinTime!) - method in class BBjCalendarWidget.CalendarOptions

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".


setSlotScrollTime(BBjString slotScrollTime!) - method in class BBjCalendarWidget.CalendarOptions

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:

  • "15:45" or "15:45:30" - a time string.
  • "current" - a special value that indicates that the calendar should scroll to the current time.

setSnapToRowHeight(BBjNumber shouldSnap) - method in class QVGrid.QVGrid

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.


setSortByMultipleColumns(BBjNumber sortByMultiple) - method in class QVGrid.QVGrid

Sets whether a grid allows sorting by multiple columns


setSortModel(GxClientSortModel model!) - method in class BBjGridExWidget.BBjGridExWidget

Set a sorting for one or more columns


#API


setSource(Event.Source source!) - method in class gappsv3.GEvent

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.


setSourceFile(BBjString p_sourceFile$) - method in class WidgetWizard

Method setSourceFile: Sets the source file


setSSLRequired(BBjNumber p_required) - method in class AdminLoginDialog

setStart(EventDateTime start!) - method in class gappsv3.GEvent

Set the start time for the event using an EventDateTime object


setStart(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!) - method in class gappsv3.GEvent

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.


setStart(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjNumber hour!, BBjNumber minute!, BBjNumber second!, BBjString timezone!) - method in class gappsv3.GEvent

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.


setStart(BBjNumber year!, BBjNumber month!, BBjNumber day!) - method in class gappsv3.GEvent

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.


setStart(BBjNumber year!, BBjNumber month!, BBjNumber day!, BBjString timeZone!) - method in class gappsv3.GEvent

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.


setStart(java.util.Date date!) - method in class gappsv3.GEvent

Set event start time using a java.util.Date This method is used to specify the start time for a timed event.


setStart(java.util.Date date!, BBjString timezone!) - method in class gappsv3.GEvent

Set event start time using a java.util.Date This method is used to specify the start time for a timed event.


setStart(BBjString start!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's starting date/time. If the entry is explicitly all-day, then the time portion will be ignored.


setStartCellEditing(BBjString key!, BBjString column!, BBjNumber keyPress!, BBjString charPress!, BBjString floating!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjNumber index!, BBjString column!, BBjNumber keyPress!, BBjString charPress!, BBjString floating!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjString key!, BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjNumber index!, BBjString column!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjString key!, BBjString column!, BBjString charPress!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjNumber index!, BBjString column!, BBjString charPress!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjString key!, BBjString column!, BBjNumber keyPress!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartCellEditing(BBjNumber index!, BBjString column!, BBjNumber keyPress!) - method in class BBjGridExWidget.BBjGridExWidget

Start Cell Editing at the given row and column


#API


setStartEditSelectionMode(BBjNumber mode) - method in class QVGrid.QVGrid

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(BBjNumber p_startPageIndex) - method in class BBJasper.BBJasperExporter

setStartPageIndex Sets the starting page index for export operations


setState(GxState state!) - method in class BBjGridExWidget.BBjGridExWidget

Apply the grid's columns , sorbing and filtering state


#API


setStatus(BBjString status!) - method in class gappsv3.GEvent

Whether the event is occurring. Values are "confirmed", "tenative", and "cancelled". The default is "confirmed".


setStatusBarText(BBjString p_statusBarText$) - method in class BBJasper.BBJasperViewerControl

setStatusBarText Sets the text in the status bar


setString(BBjString jsonstr$) - method in class BBjGridExWidget.GxState

setStripeCount(BBjNumber count) - method in class QVGrid.QVGrid

Sets the number of grid rows to alternate between the stripe color and the default background color


setStyle(String arg!, String style!) - method in class QVGrid.QVGrid

see BBjControl


setStyle(BBjString property!, BBjString style!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets a CSS property on the widget.


setSubject(BBjString subject$) - method in class Email.Email

setSubject Sets the subject of the email message represented by the email object


setSummary(BBjString summary!) - method in class gappsv3.GEvent

Set the title of the event.


setSuppressBuiDebouncing(BBjNumber suppressBuiDebouncing!) - method in class BBjGridExWidget.GxExecutor

setTabAction(BBjNumber action) - method in class QVGrid.QVGrid

Sets the current tab action of the grid


setTabActionSkipsNonEditableCells(BBjNumber skips) - method in class QVGrid.QVGrid

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(BBjNumber p_tabOnParentHyperlinkTarget) - method in class BBJasper.BBJasperTabbedView

setTabOnParentHyperlinkTarget Sets whether a tabe will be created when hyperlink targets are set to blank, othwerwise a window will be created


setTabTraversable(BBjNumber trav) - method in class QVGrid.QVGrid

Sets a value indicating whether or not the user can navigate to the grid control using the tab key


setTags(BBjVector tags!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.


setTags(BBjString tags!) - method in class BBjCalendarWidget.CalendarEntry

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.


setText(BBjString p_text$) - method in class Dashboard.HtmlViewWidget

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(BBjString text$) - method in class Email.Email

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.


setText(String text!) - method in class QVGrid.QVGrid

Sets the control text for the grid control Note: The relevance of this method for a grid control is questionable, but provided for compatibility.


setTextColor(BBjString textColor!) - method in class BBjCalendarWidget.CalendarEntry

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.


setTextColor(BBjString textColor!) - method in class BBjCalendarWidget.CalendarEntrySource

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.


setTexts(BBjString p_text$, BBjString p_poppedOutText$) - method in class Dashboard.HtmlViewWidget

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.


setTextShadows(BBjInt p_shadowSize!, Color p_shadowColor!, BBjNumber p_shadowOpacity!) - method in class BBLaunchDock

setTheme(BBjInt p_themeNumber!) - method in class BBLaunchDock

setTheme(BBjString theme!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setTheme(BBjString theme!) - method in class BBjCalendarWidget.CalendarOptions

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.

setTheme(BBjString theme$) - method in class BBjGridExWidget.BBjGridExWidget

Set the grid theme


#Configuration
#API


setTimeoutRequired(BBjNumber p_required) - method in class AdminLoginDialog

setTimeZone(BBjString timeZone!) - method in class BBjCalendarWidget.CalendarOptions

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".


setTitle(BBjString p_title$) - method in class Dashboard.DashboardItem

Sets the title of the dashboard item


setTitle(BBjString p_title$) - method in class Dashboard.DashboardWindow

Sets the dashboard window's title


setTitle(BBjString p_title$) - method in class Dashboard.DashboardControl

Sets the title of the dashboard control


setTitle(BBjString p_title$) - method in class Dashboard.DashboardCategoryControl

Sets the title of the dashboard category control


setTitle(BBjString p_title$) - method in class Dashboard.WidgetControl

Sets the title for the widget control


setTitle(BBjString p_title$) - method in class Dashboard.EmbeddedWidgetWindow

Sets the title of the EmbeddedWidgetWindow


setTitle(BBjString p_title$) - method in class BuildItem

setTitle(BBjString p_title$) - method in class WidgetBuildItem

setTitle(BBjString p_title$) - method in class WidgetSetBuildItem

setTitle(BBjString p_title$) - method in class WidgetDashboardBuildItem

setTitle(BBjString p_title$) - method in class Email.EmailDialog

setTitle Sets the title of the dialog


setTitle(BBjString p_title$) - method in class GDocSelectionDialog

setTitle(BBjString title!) - method in class BBjCalendarWidget.CalendarEntry

Sets entry's title that is the description/summary text that will appear on an entry.


setTitle(BBjString p_title$) - method in class BBjBUIDialChart.BBjBUIDialChart

setTitleAlpha(BBjNumber p_titleAlpha!) - method in class BBLaunchDock

setTitleColor(BBjInt p_red!, BBjInt p_green!, BBjInt p_blue!) - method in class BBLaunchDock

setTitleFont(BBjString p_pathToFontFile!, BBjInt p_titleFontSize!) - method in class BBLaunchDock

setTitleFontName(BBjString p_fontName!) - method in class BBLaunchDock

setTitleFontSize(BBjInt p_titleFontSize!) - method in class BBLaunchDock

setTitleOffset(BBjInt p_titleOffset!) - method in class BBLaunchDock

setTitleShadowColor(BBjInt p_red!, BBjInt p_green!, BBjInt p_blue!) - method in class BBLaunchDock

setTitleShadowOpacity(BBjNumber p_titleShadowOpacity!) - method in class BBLaunchDock

setTitleShadowSize(BBjInt p_titleShadowSize!) - method in class BBLaunchDock

setTo(BBjString to$) - method in class Email.Email

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.


setToolbarSection(CalendarToolbarSection section!) - method in class BBjCalendarWidget.CalendarToolbar

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.


setToolbarSections(CalendarToolbarSection startSection!, CalendarToolbarSection centerSection!, CalendarToolbarSection endSection!) - method in class BBjCalendarWidget.CalendarToolbar

Sets all three CalendarToolbarSections on the toolbar in a single method call.


setTooltipAlpha(BBjNumber p_tooltipAlpha!) - method in class BBLaunchDock

setTooltipColor(BBjInt p_red!, BBjInt p_green!, BBjInt p_blue!) - method in class BBLaunchDock

setTooltipDescriptionFontSize(BBjInt p_descriptionFontSize!) - method in class BBLaunchDock

setTooltipFont(BBjString p_pathToFontFile!, BBjInt p_tooltipFontSize!) - method in class BBLaunchDock

setTooltipFontName(BBjString p_fontName!) - method in class BBLaunchDock

setTooltipFontSize(BBjInt p_tooltipFontSize!) - method in class BBLaunchDock

setTooltipOffset(BBjInt p_tooltipOffset!) - method in class BBLaunchDock

setTooltipShadowColor(BBjInt p_red!, BBjInt p_green!, BBjInt p_blue!) - method in class BBLaunchDock

setTooltipShadowOpacity(BBjNumber p_tooltipShadowOpacity!) - method in class BBLaunchDock

setTooltipShadowSize(BBjInt p_tooltipShadowSize!) - method in class BBLaunchDock

setToolTipText(BBjNumber row!, BBjNumber column!, BBjString text!) - method in class QVGrid.QVGrid

Sets the tooltip text (also known as short cue) for a cell


setToolTipText(BBjNumber column!, BBjString text!) - method in class QVGrid.QVGrid

Sets the tooltip text (also known as short cue) for a column


setToolTipText(String text!) - method in class QVGrid.QVGrid

Sets the tooltip text (also known as short cue) for the grid control


setTooltipValueGetterExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as tooltip value getter


setTopRow(BBjNumber row) - method in class QVGrid.QVGrid

Sets a row to be the top visible row or at least shown if on the last grid page.


setTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$) - method in class BBTranslator.BBTranslationBundle

setTranslation(BBjString p_key$, BBjString p_value$) - method in class BBTranslator.BBTranslations

Sets a translation value


setTransparency(BBjString transparency!) - method in class gappsv3.GEvent

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".


setTrimBlankSpace(BBjNumber shouldTrim) - method in class QVGrid.QVGrid

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(BBJasperTXTExporter p_txtExporter!) - method in class BBJasper.BBJasperViewerControl

setTXTExporter Sets the TXT exporter which contains export options


setType(BBjString p_type!) - method in class GPermission

setType(BBjString viewType!) - method in class BBjCalendarWidget.CalendarView

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.


setType(BBjNumber type!) - method in class GxColumns.GxDefaultColumnDefinition

Set the column type


setType(BBjNumber type!) - method in class GxColumns.GxAutoGroupColumn

Set the column type


setUntilDate(java.util.Date date!) - method in class gappsv3.SimpleRULE

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().


setUntilDateTime(java.util.Date dateTime!) - method in class gappsv3.SimpleRULE

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().


setUpdateActive(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjInt p_active%) - method in class BUS

setUpdateAttributes(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjString p_location$, BBjString p_date$, BBjInt p_size%, BBjString p_comment$, BBjInt p_active%) - method in class BUS

setUpdateCached(BBjNumber update) - method in class QVGrid.QVGrid

Sets whether the grid sends table update notification events when cells already have data


setUpdateComment(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjString p_comment$) - method in class BUS

setUpdated(com.google.api.client.util.DateTime updated!) - method in class gappsv3.GEvent

The time the event was last updated.


setUpdateDate(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjString p_date$) - method in class BUS

setUpdateLocation(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjString p_location$) - method in class BUS

setUpdateSize(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_vendor$, BBjString p_application$, BBjString p_version$, BBjInt p_level%, BBjInt p_size%) - method in class BUS

setupVirtualization() - method in class BBJasper.BBJasperReport

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(BBjNumber p_thresholdSize) - method in class BBJasper.BBJasperReport

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(BBjNumber p_thresholdSize, BBjString p_virtualizationDirectory$) - method in class BBJasper.BBJasperReport

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.


setURL(BBjString p_url$) - method in class Dashboard.HtmlViewWidget

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.


setUrl(BBjString p_url$) - method in class Dashboard.HtmlViewWidget

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.


setUrl(BBjString url!) - method in class BBjCalendarWidget.CalendarEntry

Sets an entry's associated URL that may be visited when this entry is clicked by the user.


setUrl(BBjString url!) - method in class BBjCalendarWidget.CalendarEntrySource

Sets the source's URL parameter.


setUrls(BBjString p_url$, BBjString p_poppedOutUrl$) - method in class Dashboard.HtmlViewWidget

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.


setUsedFalseValue(BBjString falseValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanSelect

Set The value to use when when the component needs to return a true value.


setUsedFalseValue(BBjString falseValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Set The value to use when when the component needs to return a true value.


setUsedNoneValue(BBjString noneValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanSelect

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


setUsedNoneValue(BBjString noneValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

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


setUsedTrueValue(BBjString trueValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanSelect

Set The value to use when when the component needs to return a true value.


setUsedTrueValue(BBjString trueValue!) - method in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

Set The value to use when when the component needs to return a true value.


setUser(BBjString username$) - method in class GAppsLoginDialog

setUserAgent(BBjString p_userAgent$) - method in class Dashboard.HtmlViewWidget

Sets the user agent string for the HtmlViewWidget

This requires a BBj 15 or greater interpreter


setUserAttributes(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_user$, BBjString p_password$, BBjInt p_adminUpdates%, BBjInt p_adminDatabase%, BBjInt p_adminEmail%, BBjInt p_adminNotifications%, BBjInt p_adminUsers%) - method in class BUS

setUserCredentials(BBjString p_user$, BBjString p_password$) - method in class GAppsService

setUserCredentials(BBjString p_user$, BBjString p_password$, BBjNumber p_remember) - method in class GAppsService

setUserData(Object p_userData!) - method in class Dashboard.DashboardItem

Sets the user data object of the dashboard item


setUserData(Object userData!) - method in class QVGrid.QVGrid

Associates an object as user data with the grid control


setUserData(Object userData!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets a custom, arbitrary object to be associated with the widget which can be retrieved later via the getUserData() method.


setUserFontScalingFactor(BBjNumber p_factor) - method in class Dashboard.ChartWidget

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(BBjString p_userName$) - method in class BBJasper.BBJasperPrintServiceExporter

setUserName Sets the user name


setUserRequired(BBjNumber p_required) - method in class AdminLoginDialog

setUserResizable(BBjNumber resizable) - method in class QVGrid.QVGrid

Sets whether the columns in the grid can be resized by the user


setUserToken(BBjString p_userToken$) - method in class GAppsService

setUserToken(BBjString p_userToken$, BBjNumber p_save) - method in class GAppsService

setValidRangeEnd(BBjString validRangeEnd!) - method in class BBjCalendarWidget.CalendarOptions

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:

  • The calendar's date navigation buttons are intelligently hooked into the valid date range, so the user can only navigate to days, weeks, or months within the valid range.
  • The calendar makes the invalid dates gray, making it easy to tell which dates are available and which are off-limits.
  • The calendar takes care of handling the case where the user tries to reschedule an entry to an invalid date by repositioning it to its original time and date. The calendar handles this scenario 100%, so your application doesn't have to provide any code to deal with invalid dates.
Note that it's possible to set only the starting date or the ending date. For example, you can set only the starting date so that users can only reschedule entries into the future:

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()


setValidRangeStart(BBjString validRangeStart!) - method in class BBjCalendarWidget.CalendarOptions

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:

  • The calendar's date navigation buttons are intelligently hooked into the valid date range, so the user can only navigate to days, weeks, or months within the valid range.
  • The calendar makes the invalid dates gray, making it easy to tell which dates are available and which are off-limits.
  • The calendar takes care of handling the case where the user tries to reschedule an entry to an invalid date by repositioning it to its original time and date. The calendar handles this scenario 100%, so your application doesn't have to provide any code to deal with invalid dates.
Note that it's possible to set only the starting date or the ending date. For example, you can set only the starting date so that users can only reschedule entries into the future:

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()


setValue(BBjNumber p_value) - method in class BBjDialChartProgress.BBjDialChartProgress

Method to set the dial chart's value where the acceptible value ranges from 0 to 100, indicating percentage complete


setValue(BBjNumber p_datasetNumber, BBjNumber p_value) - method in class BBjBUIDialChart.BBjBUIDialChart

Method to set the value of the dial chart


setValueFormatterExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as value formatter


setValueGetterExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as value getter


setValueIndicator(BBjNumber datasetNumber, BBjFont p_font!, BBjColor p_fgColor!, BBjColor p_bgColor!, BBjColor outlineColor!, BBjNumber radius, BBjNumber angle) - method in class BBjBUIDialChart.BBjBUIDialChart

setValueParserExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as value parser


setValueSetterExpression(BBjString expression!) - method in class GxColumns.GxDefaultColumnDefinition

Create a GxExpression from string and set it as value setter


setVerticalCellSpacing(BBjNumber space) - method in class QVGrid.QVGrid

Sets the amount of vertical space between the rows


setVerticalLinesVisible(BBjNumber visible) - method in class QVGrid.QVGrid

Sets whether the vertical lines between the columns are to be visible


setVerticalScrollable(BBjNumber scrollable) - method in class QVGrid.QVGrid

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.


setVerticalScrollBarAlways(BBjNumber always) - method in class QVGrid.QVGrid

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(BBJasperView p_view!) - method in class BBJasper.BBJasperViewerControl

setView Set the current view for the viewer control


setView(BBJasperView p_view!) - method in class BBJasper.BBJasperTabbedView

Sets the current view


setView(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height) - method in class BBjBUIDialChart.BBjBUIDialChart

setViewDataEnabled(BBjNumber p_viewDataEnabled) - method in class Dashboard.DashboardWidget

Sets the view data enabled or disabled


setViewDataMenuItemEnabled(BBjNumber p_enable) - method in class Dashboard.WidgetControl

Sets the enable status of the view data menu item in the options menu


setViewType(BBjString viewType!) - method in class BBjCalendarWidget.BBjCalendarWidget

setVisibility(BBjString visibility!) - method in class gappsv3.GEvent

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.


setVisible(BBjNumber p_visible) - method in class Dashboard.DashboardWindow

Sets the window visibility


setVisible(BBjNumber p_visible) - method in class Dashboard.DashboardControl

Sets the control visibility


setVisible(BBjNumber p_visible) - method in class Dashboard.DashboardCategoryControl

Sets the control visibility


setVisible(BBjNumber p_visible) - method in class Dashboard.WidgetControl

Sets the widget control's visibility


setVisible(BBjNumber p_visible) - method in class Dashboard.EmbeddedWidgetWindow

Sets the visiblity of the EmbeddedWidgetWindow


setVisible(BBjNumber p_visible) - method in class Dashboard.EmbeddedWidgetSetWindow

Sets the visiblity of the EmbeddedWidgetSetWindow


setVisible(boolean visible!) - method in class QVGrid.QVGrid

Sets whether the QVGrid component child window is visible


setVisible(BBjNumber p_visible) - method in class BBJasper.BBJasperViewerControl

setVisible Sets the visibility of the viewer control


setVisible(BBjNumber p_visible) - method in class BBJasper.BBJasperTabbedView

setVisible Sets the visibility of the tabbed view


setVisible(BBjNumber p_visible) - method in class BBJasper.BBJasperView

setVisible Sets the visibility of the view


setVisible(boolean visible!) - method in class BBjCalendarWidget.BBjCalendarWidget

Sets whether the widget should be visible or hidden.


setVisible(BBjNumber visible!) - method in class GxSidebar.GxSidebar

Set Visible

Enable / Disable the grid sidebar


setVisible(BBjNumber p_visible) - method in class BBjDialChartProgress.BBjDialChartProgress

Method to set the dial chart's window visible


setVisibleColumn(BBjString columnId!) - method in class BBjGridExWidget.BBjGridExWidget

Ensures the column is visible, scrolling the table if needed.


#API


setVisibleRow(BBjNumber index!, BBjString position!) - method in class BBjGridExWidget.BBjGridExWidget

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


setVisibleTags(BBjString tags!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setVisibleTags(BBjVector tags!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


setWidget(BBjGridExWidget widget!) - method in class GxClientModels.GxClientFilterModel

Set the widget instance


setWidgetBorderColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the border color of the widgets


setWidgetBorderSelectedColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the border selected color of the widgets


setWidgetControl(WidgetControl p_WidgetControl!) - method in class Dashboard.DashboardWidget

Sets the WidgetControl (view) that's associated with the DashboardWidget (model)


setWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlText$) - method in class BuildItem

setWidgetHtmlText(DashboardWidget p_dashboardWidget!, BBjString p_htmlText$) - method in class BaseBuildItem

setWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlText$) - method in class WidgetBuildItem

setWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlText$) - method in class WidgetSetBuildItem

setWidgetHtmlText(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlText$) - method in class WidgetDashboardBuildItem

setWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlUrl$) - method in class BuildItem

setWidgetHtmlUrl(DashboardWidget p_dashboardWidget!, BBjString p_htmlUrl$) - method in class BaseBuildItem

setWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlUrl$) - method in class WidgetBuildItem

setWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlUrl$) - method in class WidgetSetBuildItem

setWidgetHtmlUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_htmlUrl$) - method in class WidgetDashboardBuildItem

setWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_imageFile$) - method in class BuildItem

setWidgetImageFile(DashboardWidget p_dashboardWidget!, BBjString p_imageFile$) - method in class BaseBuildItem

setWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_imageFile$) - method in class WidgetBuildItem

setWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_imageFile$) - method in class WidgetSetBuildItem

setWidgetImageFile(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_imageFile$) - method in class WidgetDashboardBuildItem

setWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, URL p_imageURL!) - method in class BuildItem

setWidgetImageUrl(DashboardWidget p_dashboardWidget!, URL p_imageURL!) - method in class BaseBuildItem

setWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, URL p_imageURL!) - method in class WidgetBuildItem

setWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, URL p_imageURL!) - method in class WidgetSetBuildItem

setWidgetImageUrl(BBjString p_widgetCategory$, BBjString p_widgetName$, URL p_imageURL!) - method in class WidgetDashboardBuildItem

setWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class BuildItem

setWidgetRecordsetData(DashboardWidget p_dashboardWidget!, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class BaseBuildItem

setWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetBuildItem

setWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetSetBuildItem

setWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetSetBuildItem

setWidgetRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetDashboardBuildItem

setWidgetReportSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class BuildItem

setWidgetReportSQLData(DashboardWidget p_dashboardWidget!, BBjString p_connectString$, BBjString p_sql$) - method in class BaseBuildItem

setWidgetReportSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetBuildItem

setWidgetReportSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetSetBuildItem

setWidgetReportSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetDashboardBuildItem

setWidgetSeriesRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class BuildItem

setWidgetSeriesRecordsetData(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class BaseBuildItem

setWidgetSeriesRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetBuildItem

setWidgetSeriesRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetSetBuildItem

setWidgetSeriesRecordsetData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_rsFileName$, BBjString p_rsMode$, BBjString p_rsTemplate$, BBjVector p_rsCols!) - method in class WidgetDashboardBuildItem

setWidgetSeriesSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class BuildItem

setWidgetSeriesSQLData(DashboardWidget p_dashboardWidget!, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class BaseBuildItem

setWidgetSeriesSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetBuildItem

setWidgetSeriesSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetSetBuildItem

setWidgetSeriesSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_seriesName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetDashboardBuildItem

setWidgetSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class BuildItem

setWidgetSQLData(DashboardWidget p_dashboardWidget!, BBjString p_connectString$, BBjString p_sql$) - method in class BaseBuildItem

setWidgetSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetBuildItem

setWidgetSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetSetBuildItem

setWidgetSQLData(BBjString p_widgetCategory$, BBjString p_widgetName$, BBjString p_connectString$, BBjString p_sql$) - method in class WidgetDashboardBuildItem

setWidgetTitlebarDecorationBackColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar decoration background color of the widgets


setWidgetTitlebarDecorationSelectedBackColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar decoration selected background color of the widgets


setWidgetTitlebarNameBackColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar name background color of the widgets


setWidgetTitlebarNameFont(Font p_font!) - method in class Dashboard.DashboardCategory

Sets the title bar font of the widgets


setWidgetTitlebarNameFont(BBjString p_fontFile$, BBjNumber p_style, BBjNumber p_fontSize) - method in class Dashboard.DashboardCategory

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 /utils/dashboard/fonts directory.


setWidgetTitlebarNameForeColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar name foreground color of the widgets


setWidgetTitlebarNameSelectedBackColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar name selected background color of the widgets


setWidgetTitlebarSeparatorColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar separator background color of the widgets


setWidgetTitlebarSeparatorSelectedColor(BBjColor p_color!) - method in class Dashboard.DashboardCategory

Sets the title bar separator selected background color of the widgets


setWindowFont(BBjWindow p_window!, BBjFont p_font!) - method in class BBWindowUtils

setWindowOnBlankHyperlinkTarget(BBjNumber p_windowOnBlankHyperlinkTarget) - method in class BBJasper.BBJasperTabbedView

setWindowOnBlankHyperlinkTarget Sets whether a window will be created when hyperlink targets are set to blank, othwerwise a tab will be created


setWindowTitle(BBjString p_windowTitle!) - method in class BBJasper.BBJasperViewerWindow

setWindowTitle Sets the title of the viewer window


setWizardWindowEnabled(BBjNumber p_enabled) - method in class WidgetWizard

Method setWizardWindowEnabled: Sets the Wizard Window enabled or not


setXHTMLExporter(BBJasperXHTMLExporter p_xhtmlExporter!) - method in class BBJasper.BBJasperViewerControl

setXHTMLExporter Sets the XHTML exporter which contains export options


setXLSExporter(BBJasperXLSExporter p_xlsExporter!) - method in class BBJasper.BBJasperViewerControl

setXLSExporter Sets the XLS exporter which contains export options


setXLSXExporter(BBJasperXLSXExporter p_xlsxExporter!) - method in class BBJasper.BBJasperViewerControl

setXLSXExporter Sets the XLSX exporter which contains export options


setXMLExporter(BBJasperXMLExporter p_xmlExporter!) - method in class BBJasper.BBJasperViewerControl

setXMLExporter Sets the XML exporter which contains export options


setZoomLevel(BBjNumber p_zoomLevel) - method in class BBJasper.BBJasperViewerControl

setZoomLevel Sets the report image to the specifed zoom level


setZoomLevel(BBjNumber p_zoomLevel) - method in class BBJasper.BBJasperView

setZoomLevel Sets the report image to the specifed zoom level


ShadowColor - class in Dashboard

ShadowColor(BBjString p_colorHexString$, BBjNumber p_opacity, BBjNumber p_xOffset, BBjNumber p_yOffset) - constructor in class Dashboard.ShadowColor

SHAPE_CIRCLE - field in class Dashboard.XYChartWidget

SHAPE_DIAGONALCROSS - field in class Dashboard.XYChartWidget

SHAPE_DIAMOND - field in class Dashboard.XYChartWidget

SHAPE_DOWNTRIANGLE - field in class Dashboard.XYChartWidget

SHAPE_RECTANGLE - field in class Dashboard.XYChartWidget

SHAPE_REGULARCROSS - field in class Dashboard.XYChartWidget

SHAPE_ROUNDRECTANGLE - field in class Dashboard.XYChartWidget

SHAPE_UPTRIANGLE - field in class Dashboard.XYChartWidget

SharedExtendedProperty!=null() - field in class gappsv3.GCalendar

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.


SHIFT$=#Translations!.getTranslation("shift") - field in class BBJasper.BBJasperView

Translated text for shift


ShouldHighlightSelectedRow - field in class Dashboard.GridWidget

A number that acts as a boolean, determining whether the grid should highlight the selected row


show() - method in class WidgetWizardFrameIntf

Method show: Show frame


show() - method in class WidgetWizardFrame

Method show: Display frame


show() - method in class WidgetWizardFrame1

Method show: Display frame


show() - method in class WidgetWizardFrame2

Method show: Display frame


show() - method in class WidgetWizardFrame3

Method show: Shows the frame


show() - method in class WidgetWizardFrame4

Method show: Shows the frame


show() - method in class WidgetWizardFrame5

Method show: Shows the frame


show() - method in class WidgetWizardFrame6

Method show: Shows the frame


show() - method in class WidgetWizardFrame7

Method show: Shows the frame


show() - method in class WidgetWizardFrame8

Method show: Shows the frame


show() - method in class DialogWizard.DialogWizardFrame

Method show: Display frame


show() - method in class DialogWizard.DialogWizardFrameIntf

Method show: Show frame


show(BBjNumber p_processEvents) - method in class BBJasper.BBJasperViewerWindow

show Shows the viewer window for non empty reports, and optionally process events for the window


show(BBjNumber p_processEvents, BBjNumber p_showEmpty) - method in class BBJasper.BBJasperViewerWindow

show Shows the viewer window for empty or non empty reports, and optionally process events for the window


ShowBuiBusyOnLoad=0 - field in class Dashboard.DashboardControl

A number acting as a boolean that determines whether the DashboardControl should show the BUI BBjBusyIndicator when loading the widgets.


ShowDeleted!=null() - field in class gappsv3.GCalendar

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)


ShowFileDialogOnInitDefaultSave=1 - field in class BBJasper.BBJasperView

Set to TRUE if the file save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE


ShowFileOverwriteMsg - field in class BBJasper.BBJasperViewerControl

Flag to show overwrite save warning, by default this is TRUE


ShowFileOverwriteMsg - field in class BBJasper.BBJasperView

Flag to show overwrite save warning, by default this is TRUE


showFontInfo(BBjFont font!) - method in class FontChooser

ShowGoogleDialogOnInitDefaultSave=1 - field in class BBJasper.BBJasperView

Set to TRUE if the Google save dialog should be shown on the initial save, otherwise FALSE. Default is TRUE


ShowHeaderSelectionCheckbox! - field in class GxOptions.GxOptions

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


ShowHiddenInvitations!=null() - field in class gappsv3.GCalendar

Whether to include hidden invitations in the result. Optional. The default is False. (boolean)


showLoadingOverlay() - method in class BBjGridExWidget.BBjGridExWidget

Show loading overlay


#API


showMsgText(BBjString p_msgTitle$, BBjString p_msgText$, BBjInt p_expr%) - method in class WidgetWizardFrame

showNoRowsOverlay() - method in class BBjGridExWidget.BBjGridExWidget

Show 'no rows' overlay


#API


ShowOnFocus! - field in class GxCellEditors.GxCellEditorSuggestion

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.


ShowSelectionCheckbox! - field in class GxOptions.GxOptions

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


showTip(BBjString p_tip$) - method in class Dashboard.ChartWidget

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.


showToolTipText(BBjNumber x!, BBjNumber y!) - method in class QVGrid.QVGrid

Shows the tooltip text (also known as short cue) for the grid control


showToolTipText() - method in class QVGrid.QVGrid

Shows the tooltip text (also known as short cue) for the grid control


showUsage() - method in class BBJasper.BBJasper

run Shows the BBJasper usage


shuffleColorVector(BBjVector p_colorVector!) - method in class Dashboard.ChartWidget

Shuffles the order of the colors in a vector


Sidebar! - field in class GxOptions.GxOptions

The grid sidebar


SideBottom! - field in class Dashboard.ChartWidget

A constant to define the bottom edge used when setting the position of the chart legend


SideLeft! - field in class Dashboard.ChartWidget

A constant to define the left edge used when setting the position of the chart legend


SideRight! - field in class Dashboard.ChartWidget

A constant to define the right edge used when setting the position of the chart legend


SideTop! - field in class Dashboard.ChartWidget

A constant to define the top edge used when setting the position of the chart legend


SimpleEXDATE - class in gappsv3

Represents an exception date Not implemented. Subject to change or removal.


SimpleEXRULE - class in gappsv3

Represents an exception rule


SimpleRDATE - class in gappsv3

Represents a recurrence date


SimpleRRULE - class in gappsv3

Represents a recurrence rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.


SimpleRRULE() - constructor in class gappsv3.SimpleRRULE

SimpleRULE - class in gappsv3

Represents a base rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.


SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR=4 - field in class BBJasper.BBJasperView

Constant that represents the single sheet XLS save contributor


SINGLE_SHEET_XLS_SAVE_CONTRIBUTOR=BBJasperView.getSINGLE_SHEET_XLS_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the single sheet XLS save contributor


SingleClickEdit! - field in class GxOptions.GxOptions

Set to true to enable Single Click Editing for cells, to start editing with a single click.
#Configuration
#GridRenderer


SingleEvents!=null() - field in class gappsv3.GCalendar

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)


size() - method in class GDocsResultSet

skipFrame(BBjNumber p_frame, BBjNumber p_skip) - method in class WidgetWizard

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


SkipHeaderOnAutoSize! - field in class GxOptions.GxOptions

Set this to true to skip the headerName when autoSize is called by default


#Configuration
#GridRenderer


SnapToRowHeight - field in class Dashboard.GridWidget

A number that acts as a boolean, determining whether the grid should snap to the row height


Sort! - field in class GxColumns.GxDefaultColumnDefinition

Set to 'asc' or 'desc' to sort by this column by default.


#Configuration
#ColumnsRenderer


SORT_ASC() - method in class GxColumns.GxDefaultColumnDefinition

Get sort direction constant


SORT_DESC() - method in class GxColumns.GxDefaultColumnDefinition

Get sort direction constant


Sortable! - field in class GxColumns.GxDefaultColumnDefinition

Set to true to allow sorting on this column.


#Configuration
#ColumnsRenderer


sortByColumn(BBjNumber column, BBjNumber sortOrder) - method in class QVGrid.QVGrid

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.


SortByMultipleColumns - field in class Dashboard.GridWidget

A number that acts as a boolean, determining whether the grid should sort by multiple columns


sortColumn(BBjString column!, BBjString direction!) - method in class BBjGridExWidget.BBjGridExWidget

Sort the given column with the given direction


#API


spacesValid() - method in class Dashboard.BaseWidget

spacesValid Determines if spaces are valid on the client OS as part a file name.


SPREADSHEET_TYPE$=#MIME$+"spreadsheet" - field in class GDoc

SPREADSHEET_TYPE_NAME$="SPREADSHEET" - field in class GDocSaveDialog

SPREADSHEETS_FILTER_NAME$="SPREADSHEETS" - field in class GDocSelectionDialog

SQL$ - field in class Dashboard.GridExWidget

A developer-provided SQL query used to provide data for the widget


SQL$ - field in class Dashboard.GridWidget

A SQL query used to provide data for the widget


SQL$ - field in class Dashboard.PieChartWidget

A SQL query used to provide data for the widget


SQL$ - field in class Dashboard.BarChartWidget

A SQL query used to provide data for the widget


SQL$ - field in class Dashboard.LineChartWidget

A SQL query used to provide data for the widget


SQL$ - field in class Dashboard.SQLSeries

SQL_SERIES_TYPE - field in class Dashboard.Series

SQLSeries - class in Dashboard

An SQL-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data.


SQLSeries(BBjString p_name$, BBjNumber p_index, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.SQLSeries

SSL% - field in class UserCredentials

SSL%=#DEFAULT_SSL% - field in class Admin

SSL%=0 - field in class AdminLoginDialog

SSLRequiredValue - field in class Admin

STACKED_AREA_CHART$ - field in class WidgetWizard

STACKED_AREA_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Stacked area chart widget type constant


STACKED_BAR_CHART$ - field in class WidgetWizard

STACKED_BAR_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Stacked Bar chart widget type constant


STACKED_PERCENTAGE_BAR_CHART$ - field in class WidgetWizard

STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

Stacked Percentage Bar chart widget type constant


StackedAreaChartWidget - class in Dashboard

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


StackedAreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.StackedAreaChartWidget

Create an empty Stacked Area Chart specifying all parameters to be filled after creation with setDataSetValue()


StackedAreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.StackedAreaChartWidget

Create an SQL-based Stacked Area Chart specifying all parameters


StackedAreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.StackedAreaChartWidget

Create a BBjRecordSet-based Stacked Area Chart specifying all parameters


StackedAreaChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.StackedAreaChartWidget

Create an SQL-based Stacked Area Chart specifying all parameters


StackedBarChartWidget - class in Dashboard

StackedBarChartWidget A Dashboard Utility Widget that displays a stacked bar chart where the bars for each column key are stacked upon one another


StackedBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.StackedBarChartWidget

Create an empty Stacked Bar Chart specifying all parameters to be filled after creation with setDataSetValue()


StackedBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.StackedBarChartWidget

Create an SQL-based Stacked Bar Chart specifying all parameters


StackedBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.StackedBarChartWidget

Create a BBjRecordSet-based Stacked Bar Chart specifying all parameters


StackedBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_rectangular, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.StackedBarChartWidget

Create an SQL-based Stacked Bar Chart specifying all parameters


StackedPercentageBarChartWidget - class in Dashboard

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


StackedPercentageBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.StackedPercentageBarChartWidget

Create an empty Stacked Bar Chart specifying all parameters to be filled after creation with setDataSetValue()


StackedPercentageBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.StackedPercentageBarChartWidget

Create an SQL-based Stacked Bar Chart specifying all parameters


StackedPercentageBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.StackedPercentageBarChartWidget

Create a BBjRecordSet-based Stacked Bar Chart specifying all parameters


StackedPercentageBarChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.StackedPercentageBarChartWidget

Create an SQL-based Stacked Bar Chart specifying all parameters


Start! - field in class GxClientModels.GxClientAddRangeSelectionModel

Start row id or index


START_PAGE_INDEX$ - field in class BBJasper.BBJasperExporterParameter

StartAngle - field in class Dashboard.PieChartWidget

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.


startEdit(BBjNumber row, BBjNumber column) - method in class QVGrid.QVGrid

Begins editing an editable cell in the grid Note: The QVGrid is not editable, so this method has no effect.


startNextCellEditing() - method in class BBjGridExWidget.BBjGridExWidget

Navigates the grid focus to the next cell, as if tabbing.


#API


startPreviousCellEditing() - method in class BBjGridExWidget.BBjGridExWidget

Navigates the grid focus to the previous cell, as if shift-tabbing.


#API


STARTS_WITH() - method in class GxFilters.GxColumnFilterTextFilterOptions

STARTS_WITH$=#Translations!.getTranslation("starts.with") - field in class BBJasper.BBJasperView

Translated text for starts with


StartTime! - field in class gappsv3.GTimePeriod

STATUS_BAR_HEIGHT - field in class BBJasper.BBJasperViewerControl

Height of the status bar, the default is 20


STATUS_BAR_NAME$="BBJVStatusBar" - field in class BBJasper.BBJasperViewerControl

Status bar name


STATUS_BAR_NAME$=BBJasperViewerControl.getSTATUS_BAR_NAME() - field in class Dashboard.JasperViewerWidget

Status bar name


Statusbar! - field in class GxOptions.GxOptions

The grid statusbar


Step! - field in class GxCellEditors.GxCellEditorBasicNumber

The increment / decrement step


stopEditing() - method in class BBjGridExWidget.BBjGridExWidget

Stop editing and accepts changes


#API


stopEditing(BBjNumber cancel!) - method in class BBjGridExWidget.BBjGridExWidget

Stop Editing


#API


StopEditingWhenGridLosesFocus! - field in class GxOptions.GxOptions

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


storeFindOptions() - method in class BBJasper.BBJasperView

Stores the find options


storeWidgetProps() - method in class Dashboard.DashboardControl

Stores the properties of all DashboardCategories and Widgets in the current Dashboard


SubMenu! - field in class GxContextMenu.GxContextMenuItem

if this menu is a submenu, contains a list of submenu item definitions


SUCCESS=0 - field in class BBJasper.BBJasperReport

Constant value that represents a successful return code


SUCCESS=1 - field in class GApps

Suffix! - field in class GxExpressions.GxExpressionStringsFormatter

A suffix to append to the value after it is formatted


Suffix! - field in class GxExpressions.GxExpressionNumbersFormatter

A suffix to append to the value after it is formatted


SuggestionGroupTemplate! - field in class GxCellEditors.GxCellEditorSuggestion

An HTML template to be used for rendering the suggestion groups

ex:

 template! = "
<%= groupName %>
" editor!.setSuggestionItemTemplate(template!)

SuggestionItemTemplate! - field in class GxCellEditors.GxCellEditorSuggestion

An HTML template to be used for rendering the suggestion items

ex:

 template! = "
<%= item.label %> - <%= item.value %> - <%= item.group %>
" editor!.setSuggestionItemTemplate(template!)

supportsCombinedModel() - method in class GxClientModels.GxClientFilterModel

Check if the filter supported the combined model


supportsCombinedModel() - method in class GxClientModels.GxClientFilterCombinedModel
{@inheritDoc}

supportsCombinedModel() - method in class GxClientModels.GxClientFilterTextModel
{@inheritDoc}

supportsCombinedModel() - method in class GxClientModels.GxClientFilterNumberModel
{@inheritDoc}

supportsCombinedModel() - method in class GxClientModels.GxClientFilterDateTimeModel
{@inheritDoc}

supportsCombinedModel() - method in class GxClientModels.GxClientFilterBooleanModel
{@inheritDoc}

supportsCombinedModel() - method in class GxClientModels.GxClientFilterSetFilterModel
{@inheritDoc}

SuppressAggAtRootLevel! - field in class GxOptions.GxOptions

When true, the aggregations won't be computed for root node of the grid
#Configuration
#GridRenderer


SuppressAggFuncInHeader! - field in class GxOptions.GxOptions

When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
#Configuration
#GridRenderer


SuppressAndOrCondition! - field in class GxFilters.GxColumnFilterAG

If true, the filter will only offer Condition 1.


SuppressAndOrCondition! - field in class GxFilters.GxFilterBasicDateTime

If true, the filter will only offer Condition 1.


SuppressAnimationFrame! - field in class GxOptions.GxOptions

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


SuppressAutoSize! - field in class GxOptions.GxOptions

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


suppressBuiDebouncing(BBjNumber suppress!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


suppressBuiDebouncing(BBjNumber suppress!) - method in class BBjGridExWidget.BBjGridExWidget

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"


SuppressBuiDebouncing! - field in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


SuppressBuiDebouncing! - field in class BBjGridExWidget.GxExecutor

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"


SuppressCellSelection! - field in class GxOptions.GxOptions

If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. Default: false


SuppressChartRanges! - field in class GxClientModels.GxClientAddRangeChartModel

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


SuppressClickEdit! - field in class GxOptions.GxOptions

Set to true so that neither single or double-click starts editing.
#Configuration
#GridRenderer


SuppressColumnExpandAll! - field in class GxSidebar.GxColumnsToolpanel

suppress Expand / Collapse all widget.


SuppressColumnFilter! - field in class GxSidebar.GxColumnsToolpanel

suppress Column Filter section.


SuppressColumnMove! - field in class GxSidebar.GxColumnsToolpanel

Suppress Column Move section


SuppressColumnMoveAnimation! - field in class GxOptions.GxOptions

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


SuppressColumnSelectAll! - field in class GxSidebar.GxColumnsToolpanel

suppress Select / Un-select all widget.


SuppressColumnVirtualisation! - field in class GxOptions.GxOptions

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


SuppressConsole! - field in class BBjGridExWidget.GxLogger

When true , the logger will not output messages in the console


SuppressContextMenu! - field in class GxOptions.GxOptions

Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
#Configuration
#GridRenderer


SuppressCount! - field in class GxRenderers.GxRendererGroupCellRenderer

When true show row counts, hide otherwise


suppressDebouncing(BBjNumber suppress!) - method in class BBjCalendarWidget.BBjCalendarWidget

Supressesss JavaScript debouncing for both GUI and BUI.


suppressDebouncing(BBjNumber suppress!) - method in class BBjGridExWidget.BBjGridExWidget

Suppress scripts debouncing for GUI and BUI


SuppressDebugFile! - field in class BBjGridExWidget.GxLogger

When true , the logger will not output messages in debug file


SuppressDoubleClickExpand! - field in class GxRenderers.GxRendererGroupCellRenderer

When true disable double-click for expand, enable otherwise


SuppressDragLeaveHidesColumns! - field in class GxOptions.GxOptions

If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
#Configuration
#GridRenderer


suppressExpandAll! - field in class GxSidebar.GxFiltersToolpanel

To suppress Expand / Collapse All


SuppressFilterSearch! - field in class GxSidebar.GxFiltersToolpanel

To suppress the Filter Search


SuppressFiltersToolPanel! - field in class GxColumns.GxColumnDefinition

Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.


#Configuration
#ColumnsRenderer


suppressGuiDebouncing(BBjNumber suppress!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


suppressGuiDebouncing(BBjNumber suppress!) - method in class BBjGridExWidget.BBjGridExWidget

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"


SuppressGuiDebouncing! - field in class BBjCalendarWidget.BBjJavaScriptExecutor

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.


SuppressGuiDebouncing! - field in class BBjGridExWidget.GxExecutor

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"


SuppressHorizontalScroll! - field in class GxOptions.GxOptions

Set to true to never show the horizontal scroll.
#Configuration
#GridRenderer


SuppressLoadingOverlay! - field in class GxOptions.GxOptions

Disables the 'loading' overlay.
#Configuration
#GridRenderer


SuppressMaintainUnsortedOrder! - field in class GxOptions.GxOptions

Set to true to suppress sorting of un-sorted data to match original row data
#Configuration
#GridRenderer


SuppressMakeVisibleAfterUnGroup! - field in class GxOptions.GxOptions

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


SuppressMenu! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if no menu should be shown for this column header.


#Configuration
#ColumnsRenderer


SuppressMenuHide! - field in class GxOptions.GxOptions

Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
#Configuration
#GridRenderer


SuppressMiddleClickScrolls! - field in class GxOptions.GxOptions

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


SuppressMiniFilter! - field in class GxFilters.GxFilterSetFilter

Set to true to hide the mini filter.


SuppressMovable! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you do not want this column to be movable via dragging.


#Configuration
#ColumnsRenderer


SuppressMovableColumns! - field in class GxOptions.GxOptions

Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
#Configuration
#GridRenderer


SuppressMultiRangeSelection! - field in class GxOptions.GxOptions

Enable / disable one range selection even if ctrl key is held down


#Enterprise
#Configuration


SuppressMultiSort! - field in class GxOptions.GxOptions

Set to true to suppress multi-sort when the user shift-clicks a column header.
#Configuration
#GridRenderer


SuppressNavigable! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.


#Configuration
#ColumnsRenderer


SuppressNoRowsOverlay! - field in class GxOptions.GxOptions

Disables the 'no rows' overlay.
#Configuration
#GridRenderer


SuppressPivotMode! - field in class GxSidebar.GxColumnsToolpanel

suppress Pivot Mode section.


SuppressPivots! - field in class GxSidebar.GxColumnsToolpanel

suppress Column Labels (Pivot) section.


SuppressRemoveEntries! - field in class GxFilters.GxFilterSetFilter

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.


SuppressRowClickSelection! - field in class GxOptions.GxOptions

If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer


SuppressRowDeselection! - field in class GxOptions.GxOptions

If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer


SuppressRowGroups! - field in class GxSidebar.GxColumnsToolpanel

Suppress Row Groups section.


SuppressRowHoverHighlight! - field in class GxOptions.GxOptions

Set to true to not highlight rows by adding the ag-row-hover CSS class.
#Configuration
#GridRenderer


SuppressRowTransform! - field in class GxOptions.GxOptions

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


SuppressScrollOnNewData! - field in class GxOptions.GxOptions

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


SuppressSelectAll! - field in class GxFilters.GxFilterSetFilter

Set to true to remove the "select all" checkbox.


SuppressSetColumnStateEvents! - field in class GxOptions.GxOptions

Set to true to suppress column events being raised when state is changed throw the API methods
#Configuration
#GridRenderer


SuppressSizeToFit! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you want this columns width to be fixed during 'size to fit' operation.


#Configuration
#ColumnsRenderer


SuppressSorting! - field in class GxFilters.GxFilterSetFilter

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.


SuppressSuggestionOnInvalidInput! - field in class GxCellEditors.GxCellEditorSuggestion

When true , then the suggestion will not be triggered for invalid inputs


SuppressSyncLayoutWithGrid! - field in class GxSidebar.GxColumnsToolpanel

Suppress updating the layout of columns as they are rearranged in the grid


SuppressSyncLayoutWithGrid! - field in class GxSidebar.GxFiltersToolpanel

Suppress updating the layout of columns as they are rearranged in the grid


SuppressSyncValuesAfterDataChange! - field in class GxFilters.GxFilterSetFilter

Set to true to have the values inside the set filter NOT refresh after values are changed inside the grid.


SuppressToolPanel! - field in class GxColumns.GxColumnDefinition

Set to true if you do not want this column or group to appear in the tool panel.


#Configuration
#ColumnsRenderer


SuppressTouch! - field in class GxOptions.GxOptions

Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
#Configuration
#GridRenderer


suppressUpdatesWhileScrolling(BBjNumber shouldSuppress) - method in class QVGrid.QVGrid

Suppresses update requests to the program while the user scrolls


SuppressValues! - field in class GxSidebar.GxColumnsToolpanel

suppress Values section


suppressWebDebouncing(BBjNumber suppress!) - method in class BBjGridExWidget.BBjGridExWidget

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"


SuppressWebDebouncing! - field in class BBjGridExWidget.GxExecutor

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"


SWITCH_RENDERER() - method in class GxRenderers.GxRendererBoolean

A special html string which uses the switch button to render true/false values


SyncToken!=null() - field in class gappsv3.GCalendar

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)


SysGuiEvent! - field in class Dashboard.HtmlViewWidgetEvent

The BBjSysGuiEvent that occurred


SysGuiEvent! - field in class Dashboard.JasperViewerWidgetControlEvent

Event that occurred


System.getProperty("basis.BBjHome")+"/utils/admin/") - field in class Admin

System.getProperty("basis.BBjHome")+"/utils/gapps/") - field in class GApps

T

TABLE_ANALYSIS_QUEUE - field in class Admin

TABLE_TYPE=6 - field in class BBJasper.DesignType

TableName$ - field in class BBJasper.TableType

TABLES_LABEL_TYPE=5 - field in class BBJasper.DesignType

TableType - class in BBJasper

TableType class


TableType(BBjString p_databaseName$, BBjString p_tableName$) - constructor in class BBJasper.TableType

Constructor Constructs a TableType for the given database and table name.


TabTitle! - field in class BBJasper.BBJasperHyperlink

TabTitle$ - field in class BBJasper.BBJasperView

Tab Title


tabToNextCell() - method in class BBjGridExWidget.BBjGridExWidget

Navigates the grid focus to the next cell, as if tabbing.


#API


tabToPreviousCell() - method in class BBjGridExWidget.BBjGridExWidget

Navigates the grid focus to the previous cell, as if shift-tabbing.


#API


Template! - field in class GxRenderers.GxRendererCustomHTML

String template which will be compiled in the client.

 
 <%= '' + (params.valueFormatted || params.value) + '' %>
 
 

Term! - field in class GxCellEditors.GxCellEditorSuggestionResolver

The search term


Text$ - field in class Dashboard.DashboardWidgetLink

Text of link


Text$ - field in class Dashboard.HtmlViewWidget

A string with HTML contents


TEXT$=#Translations!.getTranslation("text") - field in class BBJasper.BBJasperView

Translated text for text


TEXT_DOCUMENTS_FILTER_NAME$="TEXT_DOCUMENTS" - field in class GDocSelectionDialog

Theme! - field in class Dashboard.GridExWidget

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


Theme! - field in class GxOptions.GxOptions

Set the grid theme


#Configuration
#API


ThinClient! - field in class Dashboard.ExportData

BBjThinClient object


throwError(BBjString p_errorMessage$, BBjNumber p_error) - method in class GApps

throwError(BBjString p_errorMessage$, BBjNumber p_errorNumber) - method in class BBJasper.BBJasper

throwError Throws the passed error message and error number


throwError(BBjString p_errorMessage$, BBjNumber p_errorNumber, BBjNumber p_lineNumber) - method in class BBJasper.BBJasper

throwError Throws the passed error message and error number. Adds the line number, line code, and last exception (if available)


TimeMax!=null() - field in class gappsv3.GCalendar

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)


TimeMin!=null() - field in class gappsv3.GCalendar

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. (string)


Timeout% - field in class UserCredentials

Timeout%=#DEFAULT_TIMEOUT% - field in class Admin

Timeout%=3000 - field in class AdminLoginDialog

Timeout=120 - field in class gappsv3.GOAuth2

Authentication timeout in seconds. Default is 120 seconds, 0 means "forever."


TimeoutRequiredValue - field in class Admin

Timezone! - field in class GxExpressions.GxExpressionDateTimesFormatter

The date / timezone timezone to use.


TimeZone!=null() - field in class gappsv3.GCalendar

Filter for getEvents() method: Time zone used in the response. Optional. The default is the time zone of the calendar. (string)


TipBackColor$ - field in class Dashboard.ChartWidget

The background color of the chart's tip, specified as a hex color string


TipBackColorOpacity - field in class Dashboard.ChartWidget

The background color's opacity of the chart's tip, specified as a number between 0 and 1 (0=transparent, 1=opaque)


TipDisplayTime - field in class Dashboard.ChartWidget

The display time in seconds of the chart's tip


TipForeColor$ - field in class Dashboard.ChartWidget

The foreground color of the chart's tip, specified as a hex color string


TipForeColorOpacity - field in class Dashboard.ChartWidget

The foreground color's opacity of the chart's tip, specified as a number between 0 and 1 (0=transparent, 1=opaque)


title() - method in class Dashboard.Widget

Returns the title of the widget


title() - method in class Dashboard.BaseWidget

Returns the title of the widget


Title! - field in class GxCellEditors.GxCellEditorBasicText

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


Title! - field in class GxCellEditors.GxCellEditorSuggestion

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$ - field in class Dashboard.DashboardCategoryControl

Title of the dashboard category control


Title$ - field in class GDocSelectionDialog

TitlebarAlignment! - field in class Dashboard.DashboardWidget

The alignment of the titlebar's text, based on one of the ALIGN_* constants. The default is ALIGN_CENTER.


TitlebarDecorationBackColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's window decoration section


TitlebarDecorationSelectedBackColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's window decoration section when it is selected


TitleBarHeight - field in class Dashboard.DashboardControl

Height of the title bar


TitlebarNameBackColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's name section


TitlebarNameFont! - field in class Dashboard.DashboardWidget

Font for the text in the widget titlebar's name section


TitlebarNameForeColor! - field in class Dashboard.DashboardWidget

Color of the text in the widget titlebar's name section


TitlebarNameSelectedBackColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's name section when it is selected


TitlebarSeparatorColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's window decoration section separator


TitlebarSeparatorSelectedColor! - field in class Dashboard.DashboardWidget

Background color of the widget titlebar's window decoration section separator when it is selected


toJSON() - method in class Email.Email

toJSON Converts the email to a JSON string.


TOOL_BAR_CHILD_WINDOW_NAME$="BBJVToolBarChildWindow" - field in class BBJasper.BBJasperViewerControl

Tool bar child window name


TOOL_BAR_CHILD_WINDOW_NAME$=BBJasperViewerControl.getTOOL_BAR_CHILD_WINDOW_NAME() - field in class Dashboard.JasperViewerWidget

Tool bar child window name


TOOL_BAR_CONTROL_HEIGHT - field in class BBJasper.BBJasperViewerControl

Height of the tool bar controls, the default is 22


TOOL_BAR_CONTROL_INTERSPACE - field in class BBJasper.BBJasperViewerControl

The space between controls on the tool bar, the default is 2


TOOL_BAR_CONTROL_Y - field in class BBJasper.BBJasperViewerControl

Y location of the tool bar controls, the default is 3


TOOL_BAR_HEIGHT - field in class BBJasper.BBJasperViewerControl

Height of the tool bar, the default is the TOOL_BAR_CONTROL_HEIGHT + 7


TOOL_BAR_SPACER_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the tool bar spacer, the default is 8


TOOL_BUTTON_ERROR=503 - field in class BBJasper.BBJasperViewerControl

Constant that represents a tool button error


TOOL_BUTTON_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the tool buttons, the default is 22


ToolBarHeight - field in class Dashboard.DashboardControl

Height of the tool bar


ToolPanelClass! - field in class GxColumns.GxColumnDefinition

CSS class(es) to use for the tool panel cell.


#Configuration
#ColumnsRenderer


Toolpanels! - field in class GxSidebar.GxSidebar

A map for the registered toolpanels


Tooltip! - field in class GxContextMenu.GxContextMenuItem

Optional tooltip for the menu item


ToolTip$ - field in class Dashboard.DashboardWidgetFilter

Tooltip to be displayed when the mouse is hovered over the filter


ToolTip$ - field in class Dashboard.DashboardWidgetLink

Tool tip to be displayed when the mouse is hovered over the link


TooltipField! - field in class GxColumns.GxDefaultColumnDefinition

The field of the tooltip to apply to the cell.


#Configuration
#ColumnsRenderer


TooltipShowDelay! - field in class GxOptions.GxOptions

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


TooltipValueGetterExpression! - field in class GxColumns.GxDefaultColumnDefinition

A Grid expression which can be executed to return the tooltip value to display for each cell.


#Configuration
#ColumnsRenderer.


toString() - method in class gappsv3.SimpleRULE

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.


toString() - method in class BBXMLDoc

toString() - method in class GxClientModels.GxClientRowModel

Convert row to string


toString() - method in class GxClientModels.GxClientColumnModel

Convert column to string


toString() - method in class GxContextMenu.GxContextMenu

Convert the menu to a JSON string


toString() - method in class GxContextMenu.GxContextMenuItemInterface

Convert the item to String


toString() - method in class GxContextMenu.GxContextMenuItem

Convert the item to String


toString() - method in class GxExpressions.GxExpressionInterface

Get the expression as string


toString() - method in class GxExpressions.GxExpression

toString() - method in class GxExpressions.GxExpressionStringsFormatter
{@inheritDoc}

toString() - method in class GxExpressions.GxExpressionNumbersFormatter
{@inheritDoc}

toString() - method in class GxExpressions.GxExpressionBytesFormatter
{@inheritDoc}

toString() - method in class GxExpressions.GxExpressionDateTimesFormatter
{@inheritDoc}

toString() - method in class BBjGridExWidget.GxState

toString() - method in class GxStatusBar.GxStatusBar

Convert the statusbar into a parsable json string


toTitleCase(BBjString string!) - method in class DemoUtils.DemoUtils

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.


toTitleCase(BBjString string!, BBjNumber forceLowerCase) - method in class DemoUtils.DemoUtils

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


translatePathToFileID(BBjString path$) - method in class GDocsService

TRANSLATION_KEY_ERROR=260 - field in class BBTranslator.BBTranslations

A field variable that defines the TRANSLATION_KEY_ERROR error number


Translator! - field in class Dashboard.ExportData

Translator used to obtain translations


Translator!=BBTranslator.getInstance(#TranslationBundle!) - field in class Admin

Translator!=BBTranslator.getInstance(#TranslationBundle!) - field in class GApps

TranslatorName$="BASIS-GApps-v1:Translator" - field in class GApps

trashFile(BBjString p_resourceID$) - method in class GDocsService

TreeData! - field in class GxOptions.GxOptions

Enable / Disable Tree Data mode
#Enterprise
#Configuration
#GridRenderer


TreeNode - class in this project

TreeNode(BBjString p_name$) - constructor in class TreeNode

TRUE=BBjAPI().TRUE - field in class BBConfig

TrueValue! - field in class GxFilters.GxFilterBasicBoolean

True value translation


TrueValue! - field in class GxRenderers.GxRendererBoolean

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!


TXT_SAVE_CONTRIBUTOR=13 - field in class BBJasper.BBJasperView

Constant that represents the TXT save contributor


TXT_SAVE_CONTRIBUTOR=BBJasperView.getTXT_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the TXT save contributor


TXTExporter! - field in class BBJasper.BBJasperView

TXT exporter which contains export options


Type - field in class Dashboard.Series

Type! - field in class GxClientModels.GxClientAddRangeChartModel

The type of chart to create


Type! - field in class GxClientModels.GxClientFilterSimpleModel

One of the filter options


Type! - field in class GxColumns.GxDefaultColumnDefinition

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.


Type$ - field in class BBJasper.ProcedureParam

TYPE_AREA() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define area chart


TYPE_DOUGHNUT() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define doughnut chart


TYPE_GROUPEDBAR() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define groupedBar chart


TYPE_GROUPEDCOLUMN() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define groupedColumn chart


TYPE_LINE() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define line chart


TYPE_NORMALIZEDAREA() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define normalizedArea chart


TYPE_NORMALIZEDBAR() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define normalizedBar chart


TYPE_NORMALIZEDCOLUMN() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define normalizedColumn chart


TYPE_PIE() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define pie chart


TYPE_STACKEDAREA() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define stackedArea chart


TYPE_STACKEDBAR() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define stackedBar chart


TYPE_STACKEDCOLUMN() - method in class GxClientModels.GxClientAddRangeChartModel

Constant value to define stackedColumn chart


U

UNKNOWN_HYPERLINK_TARGET - field in class BBJasper.BBJasperHyperlink

UNKNOWN_HYPERLINK_TYPE - field in class BBJasper.BBJasperHyperlink

UNKNOWN_TYPE$="application/octet-stream" - field in class GDoc

unquotePath(BBjString p_path!) - method in class BBLaunchDock

unselectValue(BBjString value!) - method in class GxClientModels.GxClientFilterSetFilterModel

Unselects a value


#API


unselectValue(BBjNumber value!) - method in class GxClientModels.GxClientFilterSetFilterModel

Unselects a value


#API


unsort() - method in class QVGrid.QVGrid

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.


unsort(BBjNumber revertAllSortByRelated, BBjNumber revertAllUserSortable) - method in class QVGrid.QVGrid

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.


UnSortIcon! - field in class GxColumns.GxDefaultColumnDefinition

Set to true if you want the unsorted icon to be shown when no sort is applied to this column.


#Configuration
#ColumnsRenderer


UnSortIcon! - field in class GxOptions.GxOptions

Set to true to show the 'no sort' icon.
#Configuration
#GridRenderer


UntilDate!=null() - field in class gappsv3.SimpleRULE

Until date for recurrence or exception. Required if not using Count or UntilDateTime


UntilDateTime!=null() - field in class gappsv3.SimpleRULE

Until date and time for recurrence or exception. Required if not using Count or UntilDate


untrashFile(BBjString p_resourceID$) - method in class GDocsService

update(DataRow row!) - method in class GxClientModels.GxClientTransactionModel

Update a row


update() - method in class GxClientModels.GxClientFilterModel

Update the filter on the client and execute it.


update() - method in class GxClientModels.GxClientFilterAbstractModel

Update the filter on the client and execute it.


update(HashMap meta!, GxDefaultColumnDefinition defaultDefinition!) - method in class GxColumns.GxColumn

Update the column definition from a meta map


Update! - field in class GxClientModels.GxClientTransactionModel

An array of rows to update


UPDATE_ERROR=305 - field in class BUS

updateACL(GACL acl!) - method in class gappsv3.GCalendarAPI

Update Access Control List. (Not implemented. Subject to removal or relocating.)


updateBuildItemCategory(BBjString p_curCategoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class WidgetWizard

updateBuildItemWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetWizard

updateCalendar(GCalendar calendar!) - method in class gappsv3.GCalendarAPI

Update Calendar. (Not implemented. Subject to removal or relocating.)


updateCategory(BBjString p_curCategoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class BuildItem

updateCategory(BBjString p_curCategoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class WidgetBuildItem

updateCategory(BBjString p_curCategoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class WidgetSetBuildItem

updateCategory(BBjString p_curCategoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class WidgetDashboardBuildItem

updateColumns() - method in class BBjGridExWidget.BBjGridExWidget

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.


updateContext() - method in class BBjGridExWidget.BBjGridExWidget

Force the context object update


updateControls() - method in class BBJasper.BBJasperViewerControl

updateControls Updates the controls based on the current view


updateDashboardCategory(BBjString p_categoryName$, BBjString p_newCategoryName$, BBjString p_newCategoryTitle$) - method in class Dashboard.Dashboard

Updates a dashboard category in the dashboard


updateDashboardWidget(BBjString p_widgetName$, Widget p_widget!) - method in class Dashboard.DashboardCategory

Updates a dashboard widget in the dashboard category


updateData(ResultSet rs!) - method in class BBjGridExWidget.BBjGridExWidget

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


UpdatedMin!=null() - field in class gappsv3.GCalendar

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)


updateDocument(BBjString p_fileName$, BBjString p_docID$, BBjString p_title$, BBjString p_type$, BBjVector p_parents!, BBjString p_description$) - method in class GDocsService

updateDocument(BBjString p_docID$, BBjString p_title$, BBjString p_type$, BBjString p_parentId$, BBjString p_description$) - method in class GDocsService

updateEmail(BBjString p_adminUser$, BBjString p_adminPassword$, BBjString p_emailAddress$, BBjString p_firstName$, BBjString p_lastName$) - method in class BUS

updateEntries(JsonArray entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


updateEntries(BBjVector entries!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


updateEntry(CalendarEntry entry!) - method in class BBjCalendarWidget.BBjCalendarWidget

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.


updateEvent(GEvent event!) - method in class gappsv3.GCalendar

Update an event in the calendar.


updateFromClientRow() - method in class GxClientModels.GxClientRowModel

The method will merge the row data coming from the client with the current DataRow.


updateNavButtonControls() - method in class BBJasper.BBJasperViewerControl

updateNavButtons Updates the navigation button to enabled/disabled states


updatePageControls() - method in class BBJasper.BBJasperViewerControl

updatePageControls Updates the page controls


updateRow(DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Update row data


#API


updateRow(BBjNumber index!, DataRow row!) - method in class BBjGridExWidget.BBjGridExWidget

Update row data


#API


updateSize() - method in class BBjCalendarWidget.BBjCalendarWidget

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.


updateWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class BuildItem

updateWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetBuildItem

Updates a widget


updateWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetSetBuildItem

updateWidget(BBjString p_widgetCategory$, BBjString p_widgetType$, BBjString p_widgetName$, BBjString p_widgetTitle$, BBjString p_widgetDescription$) - method in class WidgetDashboardBuildItem

Updates a widget


updateZoomControl() - method in class BBJasper.BBJasperViewerControl

updateZoomControl Updates the zoom control to the current report zoom


UPLOAD_ERROR=305 - field in class GDocsService

uploadDocument(BBjString p_fileName$, BBjString p_title$, BBjString p_type$, BBjString p_parentID$, BBjNumber p_convert) - method in class GDocsService

uploadDocument(BBjString p_fileName$, BBjString p_title$, BBjString p_type$, BBjString p_parentId$, BBjNumber p_convert, BBjNumber p_overwriteIfExists) - method in class GDocsService

@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.)


UploadURL$="https://www.googleapis.com/upload/drive/v2/files" - field in class GDocsService

URI! - field in class BBWebClient.BBWebRequest

The requested web address. Example: "http://www.basis.cloud"


URL$ - field in class Dashboard.DashboardWidgetLink

Target URL of link


URL$ - field in class BBJasper.BBJasperHyperlink

Url$ - field in class Dashboard.HtmlViewWidget

A string representation of the URL, such as "http://www.basis.cloud"


URL_HANDLER_FACTORY$ - field in class BBJasper.BBJasperExporterParameter

URL_HYPERLINK_TYPE - field in class BBJasper.BBJasperHyperlink

UseCtrlForMultiSort! - field in class GxOptions.GxOptions

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.


UsedFalseValue! - field in class GxCellEditors.GxCellEditorBasicBoolean

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!


UsedFalseValue! - field in class GxCellEditors.GxCellEditorBasicBooleanSelect

The value to use when when the component needs to return a false value.


UsedFalseValue! - field in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

The value to use when when the component needs to return a false value.


UsedFalseValue! - field in class GxFilters.GxFilterBasicBoolean

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!


UsedNoneValue! - field in class GxCellEditors.GxCellEditorBasicBooleanSelect

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


UsedNoneValue! - field in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

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


UsedTrueValue! - field in class GxCellEditors.GxCellEditorBasicBoolean

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!


UsedTrueValue! - field in class GxCellEditors.GxCellEditorBasicBooleanSelect

The value to use when when the component needs to return a true value.


UsedTrueValue! - field in class GxCellEditors.GxCellEditorBasicBooleanRichSelect

The value to use when when the component needs to return a true value.


UsedTrueValue! - field in class GxFilters.GxFilterBasicBoolean

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!


User$ - field in class UserCredentials

User$ - field in class DSUDDB

User$ - field in class GAppsLoginDialog

User$ - field in class BBJasper.BBJasperDesigner

User$="admin" - field in class AdminLoginDialog

User$=#DEFAULT_USER$ - field in class Admin

USER_AUTHENTICATION_PROPERTY$="com.basis.server.passwordAuth" - field in class Admin

USER_SCOPE=3 - field in class GDoc

USER_VAR!="user=" - field in class DSUDDB

UserCredentials - class in this project

UserCredentials(BBjString p_host$, BBjInt p_port%, BBjInt p_ssl%, BBjInt p_timeout%, BBjString p_user$, BBjString p_password$, BBjNumber p_requiredPermissions) - constructor in class UserCredentials

UserCredentials!=null() - field in class BBLaunchDock

UserData! - field in class Dashboard.BaseWidget

Contains user-settable data for the widget


UserFormatter! - field in class GxCellEditors.GxCellEditorText

If set to true then the grid will use the provided cell formatter if one is provided.


username$ - field in class Email.Email

User name to use for authentication to the mail server


UserRequiredValue - field in class Admin

V

validate(UserCredentials p_userCredentials!) - method in class Admin

validate() - method in class WidgetWizardFrameIntf

Method validate: Frame validation


validate() - method in class WidgetWizardFrame

Method validate: Frame validation


validate() - method in class WidgetWizardFrame1

Method validate: Frame validation


validate() - method in class WidgetWizardFrame2

Method validate: Frame validation


validate() - method in class WidgetWizardFrame3

Method validate: Frame validation


validate() - method in class WidgetWizardFrame4

Method validate: Frame validation


validate() - method in class WidgetWizardFrame5

Method validate: Frame validation


validate() - method in class WidgetWizardFrame7

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrame

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrame1

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrame2

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrame3

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrame4

Method validate: Frame validation


validate() - method in class DialogWizard.DialogWizardFrameIntf

Method validate: Frame validation


validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!) - method in class BBTranslator.BBTranslationBundle

validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!) - method in class BBTranslator.BBTranslationBundle

validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!, BBjNumber p_removeInvalidTranslations) - method in class BBTranslator.BBTranslationBundle

validateForm() - method in class BBJasper.BBJasperDesigner

validateForm Validates the form data


VAlignBottom! - field in class Dashboard.ChartWidget

A constant to define vertical alignment of the chart legend's container


VAlignCenter! - field in class Dashboard.ChartWidget

A constant to define vertical alignment of the chart legend's container


VAlignTop! - field in class Dashboard.ChartWidget

A constant to define vertical alignment of the chart legend's container


Value! - field in class Dashboard.CategoryDataItem

The value of the data item


Value! - field in class Dashboard.KeyedValueDataItem

The value of the data item


Value! - field in class BBWebClient.BBHeader

The value of the header attribute.


Value! - field in class GxClientModels.GxClientCellModel

The cell's value


Value$ - field in class Dashboard.DashboardWidgetFilter

Filter value


ValueFormatterExpression! - field in class GxColumns.GxDefaultColumnDefinition

An Ag Grid expression which can be executed to format the value for display.


#Configuration
#ColumnsRenderer.


ValueGetterExpression! - field in class GxColumns.GxDefaultColumnDefinition

An Ag Grid expression which can be executed before getting the value from your data for display


#Configuration
#ColumnsRenderer.


ValueParserExpression! - field in class GxColumns.GxDefaultColumnDefinition

An Ag Grid expression which can be executed to parse the value for saving.


#Configuration
#ColumnsRenderer.


Values! - field in class GxCellEditors.GxCellEditorSelect

An array of values to allow the user to select from


Values! - field in class GxClientModels.GxClientFilterSetFilterModel

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


Values! - field in class GxFilters.GxFilterSetFilter

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)


ValueSetterExpression! - field in class GxColumns.GxDefaultColumnDefinition

An Ag Grid expression which can be executed before setting the value into your data for saving.


#Configuration
#ColumnsRenderer.


VERTICAL_ALIGNMENT_BOTTOMT - field in class Dashboard.GridWidget

A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable


VERTICAL_ALIGNMENT_CENTER - field in class Dashboard.GridWidget

A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable


VERTICAL_ALIGNMENT_TOP - field in class Dashboard.GridWidget

A constant to define grid cell vertical alignment, used in conjunction with the VerticalAlignment field variable


VerticalAlignment - field in class Dashboard.GridWidget

A number that determines the default vertical alignment for cells in the grid. The default value is BBjGrid.CENTER_ALIGNMENT


VerticalScrollable - field in class Dashboard.GridWidget

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.


VIEW$=#Translations!.getTranslation("view") - field in class BBJasper.BBJasperView

Translated text for view


VIEW_MENU_NAME$="BBJVViewMenu" - field in class BBJasper.BBJasperView

View menu name


viewCategoryDataSet(DefaultCategoryDataset p_dataset!) - method in class Dashboard.ChartWidget

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.


viewData() - method in class Dashboard.DataFillableWidget

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine


viewData() - method in class Dashboard.GridExWidget

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine


viewData() - method in class Dashboard.GridWidget

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine


viewData() - method in class Dashboard.ChartWidget

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine


viewData() - method in class Dashboard.XYChartWidget

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine


viewDataSet() - method in class Dashboard.PieChartWidget

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:


 myPieChartWidget!.viewDataSet()
 
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's dataset

viewDataSet() - method in class Dashboard.BarChartWidget

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:


 myBarChartWidget!.viewDataSet()
 
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's dataset

viewDataSet() - method in class Dashboard.LineChartWidget

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:


 myLineChartWidget!.viewDataSet()
 
When the code is executed, the dashboard utility will display a message box with a tabular view of the chart's dataset

VIEWER_WINDOW_NAME$="BBJVWindow" - field in class BBJasper.BBJasperViewerWindow

Constant which represents the viewer window name


ViewerWindow! - field in class BBJasper.BBJasperViewerControl

Viewer window


viewPieDataSet(DefaultPieDataset p_dataset!) - method in class Dashboard.ChartWidget

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$="BBJVViewsTabControl" - field in class BBJasper.BBJasperTabbedView

Views tab control name


VIRTUALIZATION_THRESHOLD_SIZE=300 - field in class BBJasper.BBJasperReport

Specifies the number of pages of the filled report created in memory before virutalization will begin.


vScrolled(BBjControlScrollEvent ev!) - method in class QVGrid.QVGrid

Scroll event handler for the vertical scrollbar


vScrollTimer(BBjTimerEvent ev!) - method in class QVGrid.QVGrid

Scroll timer event handler


W

WaitBetweenRetries=10 - field in class GDocsService

warn(BBjString section!, BBjString message!) - method in class BBjGridExWidget.GxLogger

Output a warning message on the console and Debug.log file


warn(BBjString message!) - method in class BBjGridExWidget.GxLogger

Output a warning message on the console and Debug.log file


WARNING() - method in class BBjGridExWidget.GxLogger

Constant value to define "warning" log messages


WarnOnOverwrite=1 - field in class GDocSaveDialog

Widget - interface in Dashboard

Widget Interface that comprises all the functionality required to be a widget


Widget! - field in class Dashboard.HtmlViewWidgetEvent

Widget that the event occurred on


Widget! - field in class Dashboard.JasperViewerWidgetControlEvent

Widget that the event occurred on


Widget! - field in class GxClientModels.GxClientTransactionModel

BBjGridExWidget instance


Widget! - field in class GxClientModels.GxClientFilterAbstractModel

BBjGridExWidget instance


Widget! - field in class BBjGridExWidget.GxExecutor

The widget instance


WIDGET_DASHBOARD_TYPE - field in class BaseBuildItem

WIDGET_SELECT_EVENT$ - field in class BaseBuildItem

WIDGET_SET_TYPE - field in class BaseBuildItem

WIDGET_SIZING_DYNAMIC_SIZE - field in class Dashboard.DashboardCategory

A constant used with WidgetSizingModel to define dynamic widget sizing


WIDGET_SIZING_FIXED_SIZE - field in class Dashboard.DashboardCategory

A constant used with WidgetSizingModel to define fixed widget sizing


WIDGET_TYPE - field in class BaseBuildItem

WidgetBuildItem - class in this project

WidgetBuildItem(WidgetWizard p_widgetWizard!) - constructor in class WidgetBuildItem

WidgetClickCallbackObject! - field in class Dashboard.DashboardWidget

Custom object containing the method to be called when the DashboardWidgetClick event is processed


WidgetClickCallbackRoutine! - field in class Dashboard.DashboardWidget

Name of the subroutine or method that is to be called when the DashboardWidgetClick event is processed


WidgetClickEventName! - field in class Dashboard.DashboardWidget

Unique name to identify the DashboardWidgetClick event


WidgetControl - class in Dashboard

WidgetControl UI class that displays a widget


WidgetControl(DashboardWidget p_dashboardWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) - constructor in class Dashboard.WidgetControl

Contructs a widget control


WidgetControl! - field in class Dashboard.DashboardWidgetEvent

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.


WidgetDashboardBuildItem - class in this project

WidgetDashboardBuildItem(WidgetWizard p_widgetWizard!) - constructor in class WidgetDashboardBuildItem

WidgetDescription$ - field in class WidgetSelectEvent

WidgetLeftClickCallbackObject! - field in class Dashboard.DashboardWidget

Custom object containing the method to be called when the DashboardWidgetLeftClick event is processed


WidgetLeftClickCallbackRoutine! - field in class Dashboard.DashboardWidget

Name of the subroutine or method that is to be called when the DashboardWidgetLeftClick event is processed


WidgetLeftClickEventName! - field in class Dashboard.DashboardWidget

Unique name to identify the DashboardWidgetLeftClick event


WidgetMidpointsVector! - field in class Dashboard.DashboardCategoryControl

BBjVector containing the midpoints for the widgets


WidgetName$ - field in class WidgetSelectEvent

WidgetRefreshCallbackObject! - field in class Dashboard.DashboardWidget

Refresh event callback object


WidgetRefreshCallbackObject! - field in class Dashboard.GridWidget

Refresh event callback object.


WidgetRefreshCallbackRoutine! - field in class Dashboard.DashboardWidget

Refresh event callback routine


WidgetRefreshCallbackRoutine! - field in class Dashboard.GridWidget

Refresh event callback routine.


WidgetRefreshEventName! - field in class Dashboard.DashboardWidget

Refresh event name


WidgetRefreshEventName! - field in class Dashboard.GridWidget

Refresh event name.


WidgetRightClickCallbackObject! - field in class Dashboard.DashboardWidget

Custom object containing the method to be called when the DashboardWidgetRightClick event is processed


WidgetRightClickCallbackRoutine! - field in class Dashboard.DashboardWidget

Name of the subroutine or method that is to be called when the DashboardWidgetRightClick event is processed


WidgetRightClickEventName! - field in class Dashboard.DashboardWidget

Unique name to identify the DashboardWidgetRightClick event


Widgets" - field in class Dashboard.DashboardControl

The text to display when initializing the categories and widgets.


Widgets" - field in class Dashboard.DashboardControl

The text to display when displaying the BUI BBjBusyIndicator.


WidgetSelectCallbackObject! - field in class Dashboard.DashboardWidget

Select event callback object


WidgetSelectCallbackRoutine! - field in class Dashboard.DashboardWidget

Select event callback routine


WidgetSelectEvent - class in this project

WidgetSelectEventName! - field in class Dashboard.DashboardWidget

Select event name


WidgetSetBuildItem - class in this project

WidgetSetBuildItem(WidgetWizard p_widgetWizard!) - constructor in class WidgetSetBuildItem

WidgetSizingModel - field in class Dashboard.DashboardCategory

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 - field in class Dashboard.DashboardCategoryAttribute

WidgetSizingModel attribute


WidgetTitle$ - field in class WidgetSelectEvent

WidgetType$ - field in class WidgetSelectEvent

WidgetWindowX - field in class Dashboard.WidgetControl

X location of the window that houses the widget control


WidgetWindowY - field in class Dashboard.WidgetControl

Y location of the window that houses the widget control


WidgetWizard - class in this project

Wizard uses to create widgets and dashboards


WidgetWizard() - constructor in class WidgetWizard

Constructor WidgetWizard


WidgetWizardFrame - class in this project

Wizard Frame Class


WidgetWizardFrame(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pFrameCwdId, HashMap pDataMap!) - constructor in class WidgetWizardFrame

Constructor WidgetWizardFrame


WidgetWizardFrame1 - class in this project

Dashboard/Widget Type Selection Frame (Frame 1)


WidgetWizardFrame1(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame1

Constructor WidgetWizardFrame1


WidgetWizardFrame2 - class in this project

Generate Container Type Frame (Frame 2)


WidgetWizardFrame2(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame2

Constructor WidgetWizardFrame2


WidgetWizardFrame3 - class in this project

Title, Name, and Source File Frame (Frame 3)


WidgetWizardFrame3(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame3

Constructor WidgetWizardFrame3


WidgetWizardFrame4 - class in this project

Generate Dashboard Category Frame (Frame 4)


WidgetWizardFrame4(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame4

Constructor WidgetWizardFrame4


WidgetWizardFrame5 - class in this project

Generate Dashboard Widgets Frame (Frame 5)


WidgetWizardFrame5(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame5

Constructor WidgetWizardFrame5


WidgetWizardFrame6 - class in this project

Generate Frame


WidgetWizardFrame6(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame6

Constructor WidgetWizardFrame6


WidgetWizardFrame7 - class in this project

Generate Frame


WidgetWizardFrame7(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame7

Constructor WidgetWizardFrame7


WidgetWizardFrame8 - class in this project

Generate Frame


WidgetWizardFrame8(WidgetWizard pWidgetWizard!, BBjTopLevelWindow pWizardWindow!, BBjNumber pControlId, HashMap pDataMap!) - constructor in class WidgetWizardFrame8

Constructor WidgetWizardFrame8


WidgetWizardFrameFactory - class in this project

Wizard Frame Factory Class


WidgetWizardFrameFactory() - constructor in class WidgetWizardFrameFactory

Constructor WidgetWizardFrameFactory


WidgetWizardFrameIntf - interface in this project

Wizard Frame Interface


Width - field in class BBXImage.BBXImage

Width - field in class Dashboard.JasperViewerWidget

Width


Width! - field in class GxCellEditors.GxCellEditorSuggestion

Setup the suggestion list width in pixels


Width! - field in class GxColumns.GxDefaultColumnDefinition

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


Width! - field in class GxRenderers.GxRendererImageRenderer

The image's width


WINDOW_CONTAINER - field in class BaseBuildItem

WINDOW_ERROR=401 - field in class BBJasper.BBJasperViewerWindow

Constant which represents that an error occured in the window


WINDOW_ERROR=501 - field in class BBJasper.BBJasperViewerControl

Constant that represents a window error


WindowCreationFlags! - field in class BBJasper.BBJasperHyperlink

WindowHeight - field in class BBJasper.BBJasperHyperlink

WindowTitle! - field in class BBJasper.BBJasperHyperlink

WindowTitle$ - field in class BBJasper.BBJasperView

Window Title


WindowWidth - field in class BBJasper.BBJasperHyperlink

WindowX - field in class BBJasper.BBJasperHyperlink

WindowY - field in class BBJasper.BBJasperHyperlink

writePNGToServerOnCreation(BBjString p_imageFile$) - method in class Dashboard.ChartWidget

Programmatically saves a screenshot of the chart as a PNG file on the server with the specified path after the chart has been created


writePNGToServerOnCreation(BBjString p_imageFile$, BBjNumber p_width, BBjNumber p_height) - method in class Dashboard.ChartWidget

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


writePropertiesFile(BBjString p_propertiesFileName$, SortedProperties p_properties!) - method in class BBTranslator.BBTranslationBundle

WRITER_ROLE=4 - field in class GDoc

writeToClientFile(BBjString p_clientFile$, BBjString p_exportString$) - method in class Dashboard.ExportData

writeToClientFile Creates a client export file and set it's contents to the passed string


writeToConsole() - method in class BBXMLDoc

writeToConsole(BBjNumber p_indent) - method in class BBXMLDoc

writeToConsole(Node p_node!) - method in class BBXMLDoc

writeToConsole(Node p_node!, BBjNumber p_indent) - method in class BBXMLDoc

writeToFile(BBjString p_fileName$) - method in class BBXMLDoc

writeToServerFile(BBjString p_serverFile$, BBjString p_exportString$) - method in class Dashboard.ExportData

writeToServerFile Creates a server export file and set it's contents to the passed string


X

X! - field in class Dashboard.XYSeriesDataItem

The X value of the data item


XHTMLExporter! - field in class BBJasper.BBJasperView

XHMTL exporter which contains export options


XLSExporter! - field in class BBJasper.BBJasperView

XLS exporter which contains export options


XLSX_SAVE_CONTRIBUTOR=6 - field in class BBJasper.BBJasperView

Constant that represents the multiple sheet XLSX save contributor


XLSX_SAVE_CONTRIBUTOR=BBJasperView.getXLSX_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the multiple sheet XLSX save contributor


XLSXExporter! - field in class BBJasper.BBJasperView

XLSX exporter which contains export options


XML(BBjServletEvent p_event!) - method in class GoldMineIntegration.GoldMineIntegrationWebService

Handle web connections and execute a command via a provided XML string


XML_SAVE_CONTRIBUTOR=3 - field in class BBJasper.BBJasperView

Constant that represents the XML save contributor


XML_SAVE_CONTRIBUTOR=BBJasperView.getXML_SAVE_CONTRIBUTOR() - field in class BBJasper.BBJasperViewerControl

Constant that represents the XML save contributor


XMLExporter! - field in class BBJasper.BBJasperView

XML exporter which contains export options


XOffset - field in class Dashboard.ShadowColor

XY_CHART$ - field in class WidgetWizard

XY_CHART_WIDGET_TYPE - field in class Dashboard.DashboardWidget

XY chart widget type constant


XYChartWidget - class in Dashboard

XYChartWidget A Dashboard Utility Widget that displays an XY line chart that can display multiple data series simultaneously


XYChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) - constructor in class Dashboard.XYChartWidget

Create an empty XY Chart specifying all parameters to be filled after creation with setSeriesXYValue()


XYChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) - constructor in class Dashboard.XYChartWidget

Create an SQL-based XY Chart specifying all parameters


XYChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) - constructor in class Dashboard.XYChartWidget

Create a BBjRecordSet-based XY Chart specifying all parameters


XYChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) - constructor in class Dashboard.XYChartWidget

Create an SQL-based XY Chart specifying all parameters


XYSeriesDataItem - class in Dashboard

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.


XYSeriesDataItem(BBjNumber p_series, BBjString p_seriesKey$, BBjNumber p_item, BBjNumber p_x, BBjNumber p_y) - constructor in class Dashboard.XYSeriesDataItem

Contructs a XYSeriesDataItem


Y

Y! - field in class Dashboard.XYSeriesDataItem

The Y value of the data item


YOffset - field in class Dashboard.ShadowColor

Z

ZOOM_IN$=#Translations!.getTranslation("zoom.in") - field in class BBJasper.BBJasperViewerControl

Translated text for zoom in


ZOOM_IN$=#Translations!.getTranslation("zoom.in") - field in class BBJasper.BBJasperView

Translated text for zoom in


ZOOM_IN_MENU_ITEM_NAME$="BBJVZoomInMenuItem" - field in class BBJasper.BBJasperView

Zoom in menu item name


ZOOM_IN_MENU_ITEM_NAME$=BBJasperView.getZOOM_IN_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Zoom in menu item name


ZOOM_IN_TOOL_BUTTON_NAME$="BBJVZoomInToolButton" - field in class BBJasper.BBJasperViewerControl

Zoom in tool button name


ZOOM_IN_TOOL_BUTTON_NAME$=BBJasperViewerControl.getZOOM_IN_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Zoom in tool button name


ZOOM_LIST_EDIT_BOX_WIDTH - field in class BBJasper.BBJasperViewerControl

Width of the zoom list edit, the default is 80


ZOOM_LIST_EDIT_NAME$="BBJVZoomListEdit" - field in class BBJasper.BBJasperViewerControl

Zoom list edit name


ZOOM_LIST_EDIT_NAME$=BBJasperViewerControl.getZOOM_LIST_EDIT_NAME() - field in class Dashboard.JasperViewerWidget

Zoom list edit name


ZOOM_OUT$=#Translations!.getTranslation("zoom.out") - field in class BBJasper.BBJasperViewerControl

Translated text for zoom out


ZOOM_OUT$=#Translations!.getTranslation("zoom.out") - field in class BBJasper.BBJasperView

Translated text for zoom out


ZOOM_OUT_MENU_ITEM_NAME$="BBJVZoomOutMenuItem" - field in class BBJasper.BBJasperView

Zoom out menu item name


ZOOM_OUT_MENU_ITEM_NAME$=BBJasperView.getZOOM_OUT_MENU_ITEM_NAME() - field in class Dashboard.JasperViewerWidget

Zoom out menu item name


ZOOM_OUT_TOOL_BUTTON_NAME$="BBJVZoomOutToolButton" - field in class BBJasper.BBJasperViewerControl

Zoom out tool button name


ZOOM_OUT_TOOL_BUTTON_NAME$=BBJasperViewerControl.getZOOM_OUT_TOOL_BUTTON_NAME() - field in class Dashboard.JasperViewerWidget

Zoom out tool button name


ZOOM_RATIO$=#Translations!.getTranslation("zoom.ratio") - field in class BBJasper.BBJasperViewerControl

Translated text for zoom ratio


ZOOM_RATIO$=#Translations!.getTranslation("zoom.ratio") - field in class BBJasper.BBJasperView

Translated text for zoom ratio


ZoomLevel=-1 - field in class Dashboard.JasperViewerWidget

Zoom level