Smart GWT EE API

https://smartclient.com/smartgwtee-15.0/javadoc
Admin
Smart GWT EE API provides a comprehensive set of Java packages and classes for developing rich...
Tokens:2,007,914
Snippets:25,325
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Smart GWT Evaluation

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/Npmjs.html

Example of installing a specific version of the Smart GWT Evaluation package by branch and date.

```bash
npm install smartclient-eval --branch=11.1 --date=2018-12-30
```

--------------------------------

### getExamples() / setExamples(SummarizeValueExample... examples)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/ai/AIHoverRequest.html

Gets or sets the examples to be sent in each SummarizeValueRequest.

```APIDOC
## getExamples()

### Description
Retrieves the examples configured to be sent in each SummarizeValueRequest.

## setExamples(SummarizeValueExample... examples)

### Description
Sets the examples to be sent in each SummarizeValueRequest.
```

--------------------------------

### start()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/stream/EventStream.html

Starts capturing events.

```APIDOC
## start()

### Description
Starts capturing all enabled events.
```

--------------------------------

### start()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/stream/EventStream.html

Starts the event capturing process if autoStart is set to false.

```APIDOC
## void start()

### Description
Starts capturing events. This is used when the EventStream is configured with autoStart set to false.
```

--------------------------------

### Install SmartGWT Showcase Project

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SpringBootIntegration.html

Commands to download and execute the Showcase installation script for Linux/macOS and Windows.

```bash
   curl -O
 https://smartclient.com/spring-boot/install-smartgwt-showcase.sh   chmod +x
 install-smartgwt-showcase.sh   ./install-smartgwt-showcase.sh
```

```batch
  
 install-smartgwt-showcase.bat
```

--------------------------------

### Install Smart GWT via NPM

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/Npmjs.html

Use this command to install the desired Smart GWT package, optionally providing configuration flags to customize the installation.

```bash
    npm install <package name> [flags]
```

--------------------------------

### Spring DataSource Configuration Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SqlSettings.html

Example configuration properties for using a Spring-managed DataSource.

```text
_sql.MyDatabase.database.type: mysql_
_sql.MyDatabase.interface.type: spring_
_sql.MyDatabase.spring.dataSourceBean: springDataSourceBeanId_
```

--------------------------------

### Install Compass on Windows

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/ReifyOnSite.html

Command to install the Compass gem on Windows after installing Ruby via RubyInstaller.

```bash
gem install compass
```

--------------------------------

### Component Verification Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/CreateScreenSettings.html

Examples of defining component verification maps for screen validation.

```java
    {'customerListGrid: 'ListGrid'}
```

```java
    {
      'mainTabSet.customersTab': 'ImgTab',
      'mainSectionStack.customersSection': 'SectionHeader',
      'customerDetailsForm.customerNameItem': 'TextItem'
    }
```

--------------------------------

### Example of valueMapSelectedChar usage

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/FormItemEditProxy.html

Example input string showing how the selected character marks a default option.

```text
      Fixed,Won't Fix,Resolved*
```

--------------------------------

### OperationBinding Script Execution Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/OperationBinding.html

Example of executing a script within an operationBinding context.

```xml
var ds = isc.DataSource.get("auditLog");
                      ds.addData({ action: "update", ... });
                  </script>
              </ScriptTask>
          </Process>
      </process>
  </operationBinding>
```

--------------------------------

### Install Ruby and Compass on Linux (RHEL/CentOS)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/ReifyOnSite.html

Commands to install Ruby and the Compass gem on RHEL-based systems.

```bash
sudo yum install ruby
      sudo gem install compass
```

--------------------------------

### Install Ruby and Compass on Linux (Debian/Ubuntu)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/ReifyOnSite.html

Commands to install Ruby and the Compass gem on Debian-based systems.

```bash
sudo apt-get install ruby
      sudo gem install compass
```

--------------------------------

### SQL Server ntext storage strategy example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/DataSourceField.html

Example of the SQL syntax generated when using the ntext storage strategy.

```sql
   UPDATE MyTable SET MyTextColumn = N'some text' WHERE MyPK = N'some key'
```

--------------------------------

### Install SmartGWT with Maven plugin

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/MavenSupport.html

Execute this command to install SmartGWT artifacts into your local Maven repository.

```bash
  mvn com.isomorphic:isc-maven-plugin:1.4.5:install \
     -Dproduct=SMARTGWT -Dlicense=EVAL -DbuildNumber=15.0d
```

--------------------------------

### Tutorial()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/tour/Tutorial.html

Constructs a new Tutorial instance.

```APIDOC
## Tutorial()

### Description
Constructs a new Tutorial instance.

### Constructor
`Tutorial()`
```

--------------------------------

### LoadProject Tag Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/LoadProjectTag.html

Example of using the loadProject tag to load screens from a specific project file.

```jsp
  <isomorphic:loadProject name="test"/>
  
```

--------------------------------

### Tutorial()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/tour/Tutorial.html

Constructs a new Tutorial instance.

```APIDOC
### Constructor
`public Tutorial()`

Creates a new instance of the Tutorial class.
```

--------------------------------

### ValueMap Parsing Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/FormItemEditProxy.html

Examples of how input strings are parsed into valueMap objects based on the separator character.

```text
       1:Fixed, 2:Won't Fix, 3:Resolved
```

```json
    {
       "1" : "Fixed",
       "2" : "Won't Fix",
       "3" : "Resolved"
    }
```

```text
        Fixed:Reported Fixed, WontFix:Won't Fix, Resolved
```

```json
    {
       "Fixed" : "Reported Fixed",
       "WontFix" : "Won't Fix",
       "Resolved" : "Resolved"
    }
```

--------------------------------

### Project.createStartScreen()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/Project.html

Creates a screen from the first definition cached in the project.

```APIDOC
## Canvas createStartScreen()

### Description
Creates screen from first definition cached in the project.
```

--------------------------------

### Initial State Object

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SetterPath.html

The starting state object used for the SetterPath operation examples.

```json
  {
      currentDS: {
          fields: [ { name:"orderId", type:"integer" } ],
          defaults: { timezone:"UTC" }
      }
  }
```

--------------------------------

### Coordinate Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/LinearGradient.html

Methods for setting and getting the start and end coordinates of the linear gradient.

```APIDOC
## setX1(String x1)
### Description
Sets the X coordinate of the start point. Can be a number or a percentage.

## getX1()
### Description
Returns the current X coordinate of the start point.

## setX2(String x2)
### Description
Sets the X coordinate of the end point. Can be a number or a percentage.

## getX2()
### Description
Returns the current X coordinate of the end point.

## setY1(String y1)
### Description
Sets the Y coordinate of the start point. Can be a number or a percentage.

## getY1()
### Description
Returns the current Y coordinate of the start point.

## setY2(String y2)
### Description
Sets the Y coordinate of the end point. Can be a number or a percentage.

## getY2()
### Description
Returns the current Y coordinate of the end point.
```

--------------------------------

### getRelativeStartDate() / setRelativeStartDate(RelativeDate)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/DateRange.html

Methods to get or set the relative start date of the range.

```APIDOC
## getRelativeStartDate()

### Description
Returns the relative start date of the range, or null if not specified.

## setRelativeStartDate(RelativeDate relativeStartDate)

### Description
Set the relative start date of the range.
```

--------------------------------

### start()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/workflow/Process.html

Starts the workflow task by executing the startElement. This method is also used by asynchronous tasks to restart the workflow.

```APIDOC
### void start()

Starts this task by executing the `startElement`. Also used by asynchronous tasks to restart the workflow.
```

--------------------------------

### getStartDate() / setStartDate(Date)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/DateRange.html

Methods to get or set the absolute start date of the range.

```APIDOC
## getStartDate()

### Description
Returns the start date or null if open ended. If the underlying start date is specified as a relativeStartDate, the date is converted to an absolute value and returned.

## setStartDate(Date startDate)

### Description
Set the start date of the range.
```

--------------------------------

### Initialize SmartGWT Hello World Project

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SpringBootIntegration.html

Commands to download and execute the project creation script for Linux/macOS and Windows.

```bash
  
 curl -O https://smartclient.com/spring-boot/create-smartgwt-boot-app.sh   chmod +x
 create-smartgwt-boot-app.sh   ./create-smartgwt-boot-app.sh
```

```batch
  
 create-smartgwt-boot-app.bat
```

--------------------------------

### Implement transformRequest for Paging

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/DataSource.html

Example of overriding transformRequest to inject start and end row parameters into a fetch operation.

```java
       @Override
       protected Object transformRequest (DSRequest dsRequest) {
           JavaScriptObject data = dsRequest.getData();
           if (dsRequest.getOperationType () == DSOperationType.FETCH) {
               JSOHelper.setAttribute (data, "start", dsRequest.getStartRow());
               JSOHelper.setAttribute (data, "end", dsRequest.getEndRow());
           }
           return data;
       }
```

--------------------------------

### addDragRepositionStartHandler

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/events/HasDragRepositionStartHandlers.html

Registers a handler to be executed when dragging first starts. This is used to perform setup tasks for the drag reposition operation.

```APIDOC
### Method
addDragRepositionStartHandler(DragRepositionStartHandler handler)

### Description
Executed when dragging first starts. Create this handler to set things up for the drag reposition.

### Parameters
- **handler** (DragRepositionStartHandler) - The dragRepositionStart handler to be added.

### Returns
- **HandlerRegistration** - An object used to remove the handler.
```

--------------------------------

### Load Framework and Create Components

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/BackgroundDownload.html

Use the FileLoader.load callback to ensure the framework is ready before creating UI components.

```javascript
isc.FileLoader.load(function() {
        isc.Label.create({contents: 'Hello World!'});
      });
```

```javascript
isc.FileLoader.load(function() {
        isc.Label.create({contents: 'Hello World!', htmlElement: 'greeting', matchElement: true});
      });
```

--------------------------------

### addDragResizeStartHandler

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/events/HasDragResizeStartHandlers.html

Registers a handler to be executed when resize dragging first starts. This is used to perform setup operations for the drag resize process.

```APIDOC
## addDragResizeStartHandler(DragResizeStartHandler handler)

### Description
Registers a handler that is triggered when a resize drag operation is initiated on the component. This method returns a HandlerRegistration object which can be used to remove the handler later.

### Parameters
- **handler** (DragResizeStartHandler) - Required - The handler to be executed when the drag resize starts.

### Returns
- **HandlerRegistration** - An object used to manage or remove the registered handler.
```

--------------------------------

### onDragRepositionStart(DragRepositionStartEvent event)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/events/DragRepositionStartHandler.html

Executed when dragging first starts. This method allows developers to perform setup tasks specifically for the drag reposition action.

```APIDOC
## void onDragRepositionStart(DragRepositionStartEvent event)

### Description
Executed when dragging first starts. Create this handler to set things up for the drag reposition.

### Parameters
- **event** (DragRepositionStartEvent) - The event object containing details about the drag start.
```

--------------------------------

### Complete Zoom Detection Implementation

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/BrowserZoom.html

A full EntryPoint example demonstrating how to monitor window resize events to detect and warn users about zoom level changes.

```java
 import com.google.gwt.core.client.EntryPoint;
 import com.google.gwt.event.logical.shared.ResizeEvent;
 import com.google.gwt.event.logical.shared.ResizeHandler;
 import com.google.gwt.user.client.Window;
 import com.smartgwt.client.util.SC;
 
 public class MyEntryPoint implements EntryPoint {
 
     public static native double detectZoom() /*-{
         return $wnd.detectZoom.zoom();
     }-*/;
 
     @Override
     public void onModuleLoad() {
         //...
 
         Window.addResizeHandler(new ResizeHandler() {
             private double lastZoom = detectZoom();
 
             @Override
             public void onResize(ResizeEvent event) {
                 final double newZoom = detectZoom();
                 if (newZoom != lastZoom) {
                     lastZoom = newZoom;
                     SC.warn("After changing the page zoom, you must refresh the page.");
                 }
             }
         });
     }
 }
```

--------------------------------

### Data Display Separator Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/FacetChartEditProxy.html

Example input string format for defining label-value pairs using the default separator.

```text
       North:10, South:20, East:30, West:40
```

--------------------------------

### SQL Prefix Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/OperationBinding.html

Demonstrates using sqlPrefix to inject database-specific hints into generated SQL queries.

```sql
     /* ALL_ROWS */  SELECT * FROM MyTable
```

--------------------------------

### createStartScreen()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/Project.html

Creates a screen from the first definition cached in the project.

```APIDOC
## createStartScreen()

### Description
Creates a screen from the first definition cached in the project.

### Returns
- **Canvas** - Last top-level widget in the screen definition
```

--------------------------------

### startEditing()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/grid/ListGrid.html

Start inline editing at the provided coordinates.

```APIDOC
## startEditing(Integer rowNum, Integer colNum, Boolean suppressFocus)

### Description
Start inline editing at the provided coordinates.
```

--------------------------------

### IncludeVia Configuration Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/IncludeViaSyntax.html

Various configurations for defining includeFrom and includeVia paths, ranging from full explicit paths to minimal overrides.

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="Order.customerNumber:Customer.accountMgrEmployeeNumber:Employee.officeCode"
```

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="customerNumber:accountMgrEmployeeNumber"
```

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="accountMgrEmployeeNumber"
```

```xml
  includeFrom="Employee.Office.city"
  includeVia="Order.customerNumber:Customer.accountMgrEmployeeNumber:Employee.officeCode"
```

```xml
  includeFrom="Office.city"
  includeVia="accountMgrEmployeeNumber"
```

--------------------------------

### Configure PostgreSQL Database in server.properties

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SpringBootIntegration.html

Example configuration for connecting to a local PostgreSQL database by defining driver and connection properties.

```properties
sql.myDatabase.database.type: postgresql  
 sql.myDatabase.driver.serverName: localhost   sql.myDatabase.driver.portNumber: 5432  
 sql.myDatabase.driver: org.postgresql.Driver   sql.myDatabase.driver.databaseName:
 OrderProcessing   sql.myDatabase.driver.name: PostgreSQL   sql.myDatabase.driver.driverName:
 postgresql   sql.myDatabase.interface.type: driverManager   sql.myDatabase.driver.schema:
 public   sql.myDatabase.driver.user: myDBUser   sql.myDatabase.driver.password:
 myDBUserPassword   sql.myDatabase.interface.credentialsInURL: true   sql.defaultDatabase:
 myDatabase
```

--------------------------------

### Export Format Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/OperationBinding.html

Examples of data formats supported for export operations.

```xml
      <List>
          <Object>
              <id>10101</id>
              <displayName>Record 10101</displayName>
          </Object>
     </List>
```

```json
      [
          { id: 10101, displayName: "Record 10101" }
      ]
```

```csv
      id,displayName
      10101,"Record 10101"
```

--------------------------------

### Create PhoneGap Project

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/PhonegapIntegration.html

Use the command line utility to initialize a new PhoneGap project folder.

```bash
phonegap create --id com.mycompany.apps.MyMobileApp --name
 "MyMobileApp" path/to/project_folder
```

--------------------------------

### DataSource Definition Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/grid/ListGridRecord.html

Example XML structure for a DataSource definition used by a ListGrid.

```xml
  <DataSource ... >
       <fields>
           <field name="field1" ... />
           <field name="field2" ... />
       </fields>
  </DataSource>
```

--------------------------------

### XML Schema Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/DataBoundComponent.html

Example of a nested XML structure that can be flattened using useFlatFields.

```xml
<FindServices>
    <searchFor>search text</searchFor>
    <Options>
        <caseSensitive>false</caseSensitive>
    </Options>
    <IncludeInSearch>
        <serviceName>true</serviceName>
        <documentation>true</documentation>
        <keywords>true</keywords>
    </IncludeInSearch>
</FindServices>
```

--------------------------------

### StartProcessTask()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/workflow/StartProcessTask.html

Constructor for creating a new StartProcessTask instance.

```APIDOC
## StartProcessTask()

### Description
Creates a new instance of the StartProcessTask.

### Constructor
`StartProcessTask()`
```

--------------------------------

### Implement a Client-Side DataSource Facade

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/DsFacade.html

This example demonstrates creating a client-side facade that forwards requests to a primary DataSource and ensures caches are updated when data changes.

```java
  DataSource facadeDataSource = null;
  
  DataSource supplyItemDS = DataSource.get("SupplyItem");
  supplyItemDS.addDataChangedHandler(new DataChangedHandler() {
      @Override
      public void onDataChanged(DataChangedEvent event) {
          facadeDataSource.updateCaches(event.getDsResponse());
      }
  });
  facadeDataSource = new DataSource() {
      {
          setDataProtocol(DSProtocol.CLIENTCUSTOM);
          setInheritsFrom(supplyItemDS);
      }
 
      @Override
      public Object transformRequest(final DSRequest dsRequest) {
          final DataSource superDS = DataSource.get(getInheritsFrom()),
                  selfDS = this;
 
          final DSRequest derivedDSRequest = cloneDSRequest(dsRequest);
          derivedDSRequest.setShowPrompt(false);
          derivedDSRequest.setCallback(new DSCallback() {
              @Override
              public void execute(DSResponse dsResponse, Object data, DSRequest derivedDSRequest) {
                  selfDS.processResponse(dsRequest.getRequestId(), superDS.cloneDSResponse(dsResponse));
              }
          });
 
          superDS.execute(derivedDSRequest);
 
          return dsRequest.getData();
      }
  };
```

--------------------------------

### FacetChart Initialization

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/chart/FacetChart.html

Example of how to instantiate a FacetChart, define its facets, set the value property, and provide data.

```APIDOC
## FacetChart Initialization

### Description
Instantiate a new FacetChart, configure its dimensions using facets, and bind data to visualize information.

### Usage
```java
// Creating data
Record sprRec = new Record();
sprRec.setAttribute("season", "Spring");
sprRec.setAttribute("temp", "79");

// Creating chart
FacetChart chart = new FacetChart();
chart.setFacets(new Facet("season", "Season"));
chart.setValueProperty("temp");
chart.setData(new Record[]{sprRec});
chart.setTitle("Average temperature");
```
```

--------------------------------

### Show a Preloaded Wizard

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SmartArchitecture.html

Demonstrates creating a UI component dynamically upon user interaction without requiring server communication.

```JavaScript
     function showNewUserWizard() {
         Window.create({
             items:[
                 DynamicForm.create({ ... })
             ]
         });
     }
     Button.create({
         title:"New User..",
         click:"showNewUserWizard()"
     });
```

--------------------------------

### Example XML Input Message

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/WSRequest.html

An example of a structured XML message for a FindServices operation.

```xml
<FindServices>      <searchFor>search text</searchFor>      <Options>          <caseSensitive>false</caseSensitive>      </Options>      <IncludeInSearch>          <serviceName>true</serviceName>          <documentation>true</documentation>          <keywords>true</keywords>      </IncludeInSearch>  </FindServices>
```

--------------------------------

### BrowserWindowSettings()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/browser/window/BrowserWindowSettings.html

Constructs a new BrowserWindowSettings instance.

```APIDOC
## BrowserWindowSettings()

### Description
Creates a new instance of BrowserWindowSettings to configure child window properties.
```

--------------------------------

### SummarizeValueExample Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/ai/SummarizeValueExample.html

Methods for configuring and retrieving example data for AI summarization.

```APIDOC
## SummarizeValueExample

### Description
Represents an example value and its summary to be used by AI services.

### Methods
- **getRecord()**: Returns the Record containing the example value.
- **setRecord(Record record)**: Sets the Record containing the example value.
- **getSummary()**: Returns the example summary of the value.
- **setSummary(String summary)**: Sets the example summary of the value.
- **getValue()**: Returns the example value.
- **setValue(Object value)**: Sets the example value. Note: valueType must be TEXT or null.
```

--------------------------------

### Install Compass on macOS

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/ReifyOnSite.html

Command to install the Compass gem on macOS systems where Ruby is pre-installed.

```bash
sudo gem install compass
```

--------------------------------

### getRange(int start, int end)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/RecordList.html

Returns a subset of the list between the start and end positions.

```APIDOC
### getRange(int start, int end)

Return the items between position start and end, non-inclusive at the end.

#### Parameters
- **start** (int) - start position
- **end** (int) - end position

#### Returns
- **Record[]** - subset of the array from start -> end-1
```

--------------------------------

### includeVia Configuration Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/IncludeViaAndDomainKey.html

Various configurations for includeVia and includeFrom to resolve relation chains involving composite keys.

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="Order.customerNumber-domainKey:Customer.accountMgrEmployeeNumber-domainKey:Employee.officeCode-domainKey"
```

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="customerNumber-domainKey:accountMgrEmployeeNumber-domainKey"
```

```xml
  includeFrom="Customer.Employee.Office.city"
  includeVia="accountMgrEmployeeNumber-domainKey"
```

```xml
  includeFrom="Employee.Office.city"
  includeVia="Order.customerNumber-domainKey:Customer.accountMgrEmployeeNumber-domainKey:Employee.officeCode-domainKey"
```

```xml
  includeFrom="Office.city"
  includeVia="accountMgrEmployeeNumber-domainKey"
```

--------------------------------

### OpenFinWindow()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/browser/window/OpenFinWindow.html

Constructs a new OpenFinWindow instance.

```APIDOC
### Constructor
OpenFinWindow()

### Description
Creates a new instance of the OpenFinWindow class.
```

--------------------------------

### TimeItem Input Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/form/fields/TimeItem.html

Examples of various time string formats accepted by the TimeItem component.

```text
   11:34:45 AM => 11:34:45
   1:3:5 AM => 01:30:50
   1:3p  => 13:30:00
   11 34 am => 11:34:00
   11-34  => 11:34:00
   113445  => 11:34:45
   13445  => 01:34:45
   1134  => 11:34:00
   134   => 01:34:00
```

--------------------------------

### MultiWindowSettings()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/browser/window/MultiWindowSettings.html

Constructor for creating a new instance of MultiWindowSettings.

```APIDOC
## MultiWindowSettings()

### Description
Creates a new instance of the MultiWindowSettings class.
```

--------------------------------

### DATE_CONSTRUCTOR format example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/types/JSONDateFormat.html

Example of the raw JavaScript code generated when using the DATE_CONSTRUCTOR format.

```javascript
new Date(1238792738633)
```

--------------------------------

### SQL Join Condition Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/DataSourceField.html

Example of a join condition applied to a SQL DataSource field.

```xml
                                 AND $to.isActive = 1" />
```

--------------------------------

### open(String url, String name, DataContext dataContext, RemoteWindowBooleanCallback callback, BrowserWindowSettings windowSettings, MultiWindowSettings classSettings)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/browser/window/MultiWindow.html

Opens a new window with the specified URL, name, and configuration.

```APIDOC
## open(String url, String name, DataContext dataContext, RemoteWindowBooleanCallback callback, BrowserWindowSettings windowSettings, MultiWindowSettings classSettings)

### Description
Opens a new window with the specified URL, name, and DataContext. If the window name already exists, that window will be activated.

### Parameters
- **url** (String) - Required - url to open in the window or null to reuse the current url
- **name** (String) - Required - unique window name to open as a new window
- **dataContext** (DataContext) - Optional - dataContext to apply to window
- **callback** (RemoteWindowBooleanCallback) - Optional - callback run after RemoteWindow created or activated
- **windowSettings** (BrowserWindowSettings) - Optional - settings applied to child browser window
- **classSettings** (MultiWindowSettings) - Optional - settings for child MultiWindow class
```

--------------------------------

### JSON Request Message Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/RestDataSource.html

An example of an AdvancedCriteria fetch operation represented in JSON format.

```json
  {
      data: {
          _constructor: "AdvancedCriteria",
          operator: "or",
          criteria: [
              {
                  fieldName: "continent",
                  operator: "equals",
                  value: "North America
              },
              {
                  operator: "and", criteria: [
                      {
                          fieldName: "continent",
                          operator: "equals",
                          value: "Europe"
                      },
                      {
                          fieldName: "population",
                          operator: "greaterThan",
                          value: 50000000
                      }
                  ]
              }
          ]
      }
      dataSource: "countryDS",
      operationType: "fetch",
      startRow: 0,
      endRow: 75,
      componentId: "worldGrid"
  }
```

--------------------------------

### startDictatingCommand

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/VoiceAssist.html

Begins a command-dictation session.

```APIDOC
## static void startDictatingCommand()

### Description
Initiates the command-dictation process.
```

--------------------------------

### Import Mockup via URL Parameter

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/BalsamiqImport.html

Use the mockup URL parameter to automatically load a specific .bmml file when the importer tool initializes.

```text
    tools/bmmlImporter.jsp?mockup=myMockup.bmml
  
```

--------------------------------

### newInstance(String className, Map<String,Object> properties)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/bean/BeanFactory.html

Creates an instance based on the provided class name and applies the provided properties.

```APIDOC
## public static Object newInstance(String className, Map<String,Object> properties)

### Description
Creates an instance based on the provided class name and applies the provided properties. Properties are applied after construction, or before getOrCreateJsObj() if the constructor triggers it.

### Parameters
- **className** (String) - The class name
- **properties** (Map<String,Object>) - A Map whose key/value pairs represent property names and values

### Returns
- **Object** - A new instance of the class, with the properties applied

### Throws
- **IllegalStateException** - If no factory has been generated for the className
```

--------------------------------

### Install Cypress Drag and Drop Plugin

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/SmartClientCypress.html

Install the required npm package to enable drag-and-drop interactions.

```bash
npm install --save-dev @4tw/cypress-drag-drop
```

--------------------------------

### MultiWindowSettings()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/browser/window/MultiWindowSettings.html

Constructs a new MultiWindowSettings instance.

```APIDOC
## MultiWindowSettings()

### Description
Constructs a new MultiWindowSettings instance.
```

--------------------------------

### ColorStop()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/ColorStop.html

Constructs a new ColorStop instance.

```APIDOC
## ColorStop()

### Description
Constructs a new ColorStop instance.
```

--------------------------------

### Foreign Key Configuration Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/DataSourceField.html

XML configuration demonstrating a foreign key relationship with display fields.

```xml
   <field name="id"     type="sequence"   hidden="true"     primaryKey="true" />
   <field name="name"   type="text"       title="Country"   required="true" />
```

```xml
   <field name="id"        type="sequence" hidden="true"   primaryKey="true" />
   <field name="name"      type="text"     title="City"    required="true" />
   <field name="countryId" type="integer"  editorType="SelectItem" 
              foreignKey="countryDS.id" 
              displayField="countryName" foreignDisplayField="name" title="Country" />
   <field name="countryName" includeFrom="countryDS.name"  hidden="true"   />
```

--------------------------------

### deselectValue(Boolean start)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/form/fields/TextItem.html

Clears the current selection in the text item and optionally moves the cursor to the start.

```APIDOC
## void deselectValue(Boolean start)

### Description
Clears the current selection in the text item if it has focus, leaving the focus in the item. Has no effect if the item is undrawn or unfocused. Only applies to text-based items.

### Parameters
- **start** (Boolean) - Optional - By default the text insertion cursor will be moved to the end of the current value; pass true to move to the start instead.
```

--------------------------------

### Configure contextFiles equivalence

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/OperationBinding.html

Examples of equivalent contextFiles configurations that share a server-side context pool.

```xml
contextFiles="databinding, app/calculations.js"
contextFiles="app/calculations.js, databinding"
```

```xml
contextFiles="core, databinding"
contextFiles="databinding, core"
contextFiles="databinding"
```

--------------------------------

### getRangeAsRecordList(int start, int end)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/ResultSet.html

Returns a RecordList containing the items between position start and end.

```APIDOC
### Method: getRangeAsRecordList

**Signature:** `public RecordList getRangeAsRecordList(int start, int end)`

**Description:** Return a RecordList with the items between position start and end, non-inclusive at the end.

**Parameters:**
- **start** (int) - start position
- **end** (int) - end position

**Returns:** (RecordList) a RecordList containing the items from start to end-1
```

--------------------------------

### Creating a Process with Custom Task Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/workflow/Process.html

Demonstrates how to configure default task and process constructors, and how the engine auto-instantiates nested processes and tasks.

```javascript
  // Plain objects default to CoTTask (AI module) unless specified otherwise.
  isc.Process.create({
    defaultTaskConstructor: "CoTTask",
    defaultProcessConstructor: "CoTProcess",
    tasks: [
      { ID:"decide",  title:"Decide Next" },   // -> CoTTask
 
      // Nested process via wrapper: becomes StartProcessTask; its .process is auto-created.
      { ID:"subflow",
        process: {
          ID:"p1",
          tasks:[ { ID:"leaf", title:"Leaf step" } ] // auto-instantiated as CoTProcess
        }
      },
 
      { _constructor:"MyTask", ID:"apply" }    // -> MyTask
    ]
  });
```

--------------------------------

### Example CellRecord structure

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/cube/CubeGrid.html

Example of a cell record object used in a CubeGrid to represent data values.

```json
{
  product:"chairs", region:"northwest", _value:"$5k"
}
```

--------------------------------

### startProcessing()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/FileDropZone.html

Initiates the UI state indicating that file processing has started.

```APIDOC
### startProcessing

Show UI indicating processing has started.
```

--------------------------------

### JSON Response Format Examples

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/types/DSDataFormat.html

Examples of valid JSON response structures expected when using DSDataFormat.JSON.

```json
  { "property":"value1", "property2" : "value2", ... }
```

```json
  var response = { "property":"value1", "property2" : "value2", ... }
  response;
```

--------------------------------

### dragStart()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/index-all.html

Notification fired when the user starts to drag a DrawGroup.

```APIDOC
## dragStart()

### Description
Notification fired when the user starts to drag this DrawGroup.

### Method
void dragStart()

### Class
com.smartgwt.client.widgets.drawing.DrawGroup
```

--------------------------------

### Configure DataSource Template Reference via server.properties

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/types/DataSourceTemplateReferenceMode.html

Example of a server.properties entry and the corresponding configuration reference used in a DataSource descriptor.

```text
  database.name: MyDatabase
  
```

```text
  dbName="$config['database.name']"
  
```

--------------------------------

### TourWindow()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/tour/TourWindow.html

Creates a new instance of TourWindow.

```APIDOC
### Constructor
`public TourWindow()`

Creates a new instance of the TourWindow class.
```

--------------------------------

### StartProcessTask Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/workflow/StartProcessTask.html

Constructors for initializing a new StartProcessTask instance.

```APIDOC
## StartProcessTask()

### Description
Creates a new instance of StartProcessTask.

## StartProcessTask(JavaScriptObject jsObj)

### Description
Creates a new instance of StartProcessTask from an existing JavaScriptObject.
```

--------------------------------

### Server-Side SimpleType Validator Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/SimpleType.html

An example of defining validators within a server-side SimpleType XML definition.

```xml
    <SimpleType name="countryCodeType" inheritsFrom="text">
      <validators>
        <validator type="lengthRange" min="2" max="2"
          errorMessage="Length of country code should be equal to 2." />
        <validator type="regexp" expression="[A-Z][A-Z]"
          errorMessage="CountryCode should have only uppercase letters." />
      </validators>
    </SimpleType>
```

--------------------------------

### startEditingNew

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/grid/ListGrid.html

Starts editing a new row appended after the last record in the current data set.

```APIDOC
## startEditingNew(Map newValues, Boolean suppressFocus)

### Description
Starts editing a new row, after the last pre-existing record in the current set of data. This new row will be saved via the 'add' DataSource operation.

### Parameters
- **newValues** (Map) - Optional - Initial set of properties for the new record.
- **suppressFocus** (Boolean) - Optional - Whether to suppress the default behavior of moving focus to the newly shown editor.
```

--------------------------------

### Example Data Object Structure

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/SimpleType.html

An example of an opaque data object structure that can be mapped to a simple type.

```javascript
  { stringValue:"A String", length: 9 }
```

--------------------------------

### play()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Sound.html

Methods to initiate audio playback.

```APIDOC
## play()

### Description
Plays the audio file associated with the current instance.

## play(PlaybackCompleteCallback callback)

### Description
Plays the audio file and executes the provided callback upon completion.

## static play(String src)

### Description
Convenience method to load and play a specified audio file.

## static play(String src, PlaybackCompleteCallback callback)

### Description
Convenience method to load and play a specified audio file with a completion callback.
```

--------------------------------

### startEditing

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/grid/ListGrid.html

Starts inline editing at the specified row and column coordinates. If editing is already in progress, it handles the transition between cells.

```APIDOC
## startEditing(Integer rowNum, Integer colNum, Boolean suppressFocus)

### Description
Starts inline editing at the provided coordinates. If this method is called while editing is already in progress, the value from the current editCell will either be stored locally or saved depending on the configuration.

### Parameters
- **rowNum** (Integer) - Optional - Row number of the cell to edit. Defaults to first editable row.
- **colNum** (Integer) - Optional - Column number of the cell to edit. Defaults to first editable column.
- **suppressFocus** (Boolean) - Optional - If passed, this parameter suppresses the default behavior of focusing in the edit form item when the editor is shown.

### Returns
- **Boolean** - true if the cell is being edited, false otherwise.
```

--------------------------------

### setStartPoint(Point startPoint)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/DrawLinePath.html

Sets the start point of the line. If called after the component is drawn, it updates the start point.

```APIDOC
### setStartPoint(Point startPoint)

Sets the start point of the line.

- **Parameters**:
  - **startPoint** (Point) - The start point coordinates.

- **Returns**:
  - DrawLinePath instance for chaining.
```

--------------------------------

### Configuring FacetChart Data

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/chart/FacetChart.html

Examples demonstrating how to populate a FacetChart with Record arrays for single and multi-facet configurations.

```java
    FacetChart chart = new FacetChart();
    chart.setFacets(new Facet("regions"));
    Record[] records = new Record[3]; 
    records[0] = new Record();
    records[0].setAttribute("regions", "west");
    records[0].setAttribute("_value", 4);
    records[1] = new Record();
    records[1].setAttribute("regions", "north");
    records[1].setAttribute("_value", 2);
    records[2] = new Record();
    records[2].setAttribute("regions", "east");
    records[2].setAttribute("_value", 5);
    chart.setData(records);
```

```java
    FacetChart chart = new FacetChart();
    chart.setFacets(new Facet("regions"), new Facet("product"));
    Record[] records = new Record[6]; 
    records[0] = new Record();
    records[0].setAttribute("product", "cars");
    records[0].setAttribute("regions", "west");
    records[0].setAttribute("_value", 4);
    records[1] = new Record();
    records[1].setAttribute("product", "cars");
    records[1].setAttribute("regions", "north");
    records[1].setAttribute("_value", 2);
    records[2] = new Record();
    records[2].setAttribute("product", "cars");
    records[2].setAttribute("regions", "east");
    records[2].setAttribute("_value", 5);
    records[3] = new Record();
    records[3].setAttribute("product", "trucks");
    records[3].setAttribute("regions", "west");
    records[3].setAttribute("_value", 1);
    records[4] = new Record();
    records[4].setAttribute("product", "trucks");
    records[4].setAttribute("regions", "north");
    records[4].setAttribute("_value", 9);
    records[5] = new Record();
    records[5].setAttribute("product", "trucks");
    records[5].setAttribute("regions", "east");
    records[5].setAttribute("_value", 3);           
    chart.setData(records);
```

--------------------------------

### Sound()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Sound.html

Constructor for creating a new Sound instance.

```APIDOC
## Sound()

### Description
Creates a new instance of the Sound widget.
```

--------------------------------

### Strict Quoting Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/JSONEncoder.html

Example of JSON output when strictQuoting is disabled, showing selective property name quoting.

```json
  {
      someProp : "someValue",
      "true" : "otherValue",
      otherProp : "otherValue"
  }
```

--------------------------------

### isSystemDone(SystemDoneConfig options)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/AutoTest.html

Checks if the current application is fully loaded and ready for user interaction, considering various component states and optional configuration criteria.

```APIDOC
## isSystemDone(SystemDoneConfig options)

### Description
Returns a boolean indicating whether the application is fully loaded with no pending operations. It checks page load status, ListGrids, TileGrids, TileLayouts, DynamicForms, and Canvii.

### Parameters
- **options** (SystemDoneConfig|boolean) - Required - Determines specific outstanding actions to check. If passed as a boolean, it specifies whether to wait for pending redraws.
```

--------------------------------

### setRowNumberStart / getRowNumberStart

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/grid/ListGrid.html

Configures or retrieves the starting number for the row count.

```APIDOC
### ListGrid setRowNumberStart(int rowNumberStart)
Sets the starting number for the row count (default is 1).

### int getRowNumberStart()
Returns the current starting number for the row count.
```

--------------------------------

### Structured Data Flattening Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/DataSource.html

Example of incoming structured data and the corresponding target format for a REST server.

```json
  {
       customerId: 2770
       name: "Snape Networks Inc",
       contacts: [
           {name: "Isaura Lopez", title: "IT Manager"},
           {name: "Ngozi Okoduwa", title: "VP Procurement"},
           {name: "Andrew Jenkins", title: "Buyer"}
       ]
  }
```

```json
  {
       Id: 2770, 
       Name: "Snape Networks Inc",  
       Contact1: "Isaura Lopez",
       Contact2: "Ngozi Okoduwa"
  }
```

--------------------------------

### Initialize a Tree with Parent-Child Relationships

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/tree/Tree.html

Demonstrates setting up a tree structure using parent IDs to define hierarchy.

```java
Tree tree = new Tree();
tree.setRoot(root);
tree.setModelType(TreeModelType.PARENT);

TreeNode data[] = new TreeNode[3];
data[0] = new TreeNode("foo");
data[0].setID("foo");
data[0].setParentID("root");
data[1] = new TreeNode("bar");
data[1].setID("bar");
data[1].setParentID("foo");
data[2] = new TreeNode("zoo");
data[2].setID("zoo");
data[2].setParentID("bar");
tree.setData(data);
```

--------------------------------

### Define Menu in Component XML

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/menu/MenuItem.html

Example showing how to define a Menu and its items using Component XML syntax.

```xml
  <Menu>
     <items>
         <MenuItem title="item1" click="alert(1)"/>
         <MenuItem title="item2"/>
     </items>
  </Menu>
```

--------------------------------

### Log Message Format Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/Debugging.html

Example of a standard diagnostic log message generated by the Smart GWT framework.

```text
      11:59:25:806:INFO:Page:Page loading complete.
```

--------------------------------

### Update Smart GWT installation

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/Npmjs.html

Syntax for updating the Smart GWT installation to the latest runtimes using the module directory.

```bash
npm run update [flags]
```

--------------------------------

### setStartPoint(Point startPoint)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/DrawCurve.html

Sets the start point of the curve. If called after initialization, it updates the start point on the drawn component.

```APIDOC
## setStartPoint(Point startPoint)

### Description
Sets the start point of the curve. If the component has already been drawn, this method updates the start point dynamically.

### Parameters
- **startPoint** (Point) - The coordinate for the start point, in pixels. Default is [0,0].
```

--------------------------------

### ToolStrip()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/toolbar/ToolStrip.html

Constructor for creating a new ToolStrip instance.

```APIDOC
## ToolStrip()

### Description
Creates a new instance of the ToolStrip component.
```

--------------------------------

### getRange(int start, int end)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/ResultSet.html

Returns the items between position start and end, triggering an asynchronous fetch if necessary.

```APIDOC
### Method: getRange

**Signature:** `public Record[] getRange(int start, int end)`

**Description:** Return the items between position start and end, non-inclusive at the end. Calling this for records that have not yet loaded will trigger an asynchronous fetch.

**Parameters:**
- **start** (int) - start position
- **end** (int) - end position

**Returns:** (Record[]) subset of the array from start to end-1
```

--------------------------------

### startDictatingCommand()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/VoiceAssist.html

Begins command-dictation by locating a target component that supports voice commands.

```APIDOC
### startDictatingCommand()

Begins command-dictation. VoiceAssist locates a target component by walking up the parent chain from the currently focused widget, looking for one that supports voice commands. The user's speech is transcribed and forwarded to the target for execution.
```

--------------------------------

### XML Request Format Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/types/RESTRequestFormat.html

Example showing how a record is transformed into an XML structure when using the XML request format.

```text
  {
  customerId: 7023,
  customerName: "Bay Financials inc",
  city: "San Francisco",
  countryCode: "US", 
  stateCode: "CA"
  }
```

```xml
  <customer>
  <customerId>7023</customerId>
  <customerName>Bay Financials inc"</customerName>
  <city>San Francisco</city>
  <countryCode>US</countryCode>
  <stateCode>CA"</stateCode>
  </customer>
```

--------------------------------

### Create a Custom Dialog

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Dialog.html

Demonstrates how to instantiate a Dialog, set its message and icon, configure buttons, and handle button clicks.

```java
  final Dialog dialog = new Dialog();
  dialog.setMessage("Please choose whether to proceed");
  dialog.setIcon("[SKIN]ask.png");
  dialog.setButtons(new Button("OK"), new Button("Cancel"));
  dialog.addButtonClickHandler(new ButtonClickHandler() {
      public void onButtonClick(ButtonClickEvent event) {
          dialog.hide();
      }
  });
  dialog.draw();
```

--------------------------------

### Define OperationBinding with contextFiles

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/OperationBinding.html

Example of an operationBinding using contextFiles to pre-load modules for a server-side script.

```xml
<operationBinding operationType="fetch" contextFiles="databinding,/path/to/myModule.js">
  <script language="graal.js">
    // Pre-loaded modules are already available
    var result = isc.DataSource.get("myDS").fetchData();
  </script>
</operationBinding>
```

--------------------------------

### Sound()

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Sound.html

Constructs a new Sound instance.

```APIDOC
## Sound()

### Description
Constructs a new Sound instance.

### Signature
public Sound()
```

--------------------------------

### MySQL Database Configuration in server.properties

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/DbConfigTool.html

Example configuration for a MySQL database connection within the server.properties file.

```properties
    sql.Mysql.database.type: mysql
    sql.Mysql.database.ansiMode: false
    sql.Mysql.interface.type: dataSource
    sql.Mysql.driver: com.mysql.jdbc.jdbc2.optional.MysqlDataSource
    # name of the database to use
    sql.Mysql.driver.databaseName: isomorphic
    # hostname and port where the database server is installed
    sql.Mysql.driver.serverName: localhost
    sql.Mysql.driver.portNumber: 3306
    # username and password that can create and modify tables in that database
    # this user must have the following privileges for the system to function
    # properly: create/alter/drop table; insert/update/replace/delete rows.
    sql.Mysql.driver.user: root
    sql.Mysql.driver.password:
```

--------------------------------

### Compact Skin Definition Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/CustomSkins.html

Example of a .skin.json file defining a custom skin variant that inherits from a base skin.

```json
  {
      "name": "PurpleShiva",
      "baseSkin": "Shiva",
      "userSettings": {
          "name": "PurpleShiva",
          "baseSkin": "Shiva",
          "useLiveCSS": true,
          "settings": { "--isc-highlight_color": "purple" }
      }
  }
```

--------------------------------

### startQueue

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/RPCManager.html

Starts a request queue. Framework features that use queuing will automatically notice that a queue has been started and will not automatically call sendQueue().

```APIDOC
## startQueue(Boolean shouldQueue)

### Description
Starts a request queue. If queuing is already active, this method returns true, allowing you to implement logic to handle existing queues.

### Parameters
- **shouldQueue** (Boolean) - Optional - Whether queuing should be enabled, default true.

### Returns
- (Boolean) - Whether queuing was already enabled before the call.
```

--------------------------------

### CSV Quote Character Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/DataSource.html

Example of a CSV response format where a quote character is used to handle delimiters within string data.

```text
    1,ABC,"This is a text string, with a comma in the middle"
```

--------------------------------

### createProjectWithScreens

Source: https://smartclient.com/smartgwtee-15.0/javadoc/index-all.html

Creates a minimal Reify project referencing existing screens.

```APIDOC
## createProjectWithScreens(String, String[], Function)

### Description
Create a minimal Reify project that references one or more screens already stored in vbScreens.

### Parameters
- **projectName** (String) - Name of the project.
- **screenNames** (String[]) - Array of screen names.
- **callback** (Function) - Optional callback function.
```

--------------------------------

### isSystemDone(boolean options)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/AutoTest.html

Checks if the current application is fully loaded and ready for user interaction by verifying the state of various components and pending operations.

```APIDOC
### isSystemDone(boolean options)

#### Description
Returns a boolean indicating whether the application is fully loaded with no pending operations. It checks page load status, ListGrids, TileGrids, TileLayouts, DynamicForms, and Canvases.

#### Parameters
- **options** (boolean) - Determines specific outstanding actions to complete. If passed as a boolean, it determines whether to wait for pending redraws.
```
Tokens:
Raw