Skip navigation links

Package com.smartgwt.client.docs.serverds

This package is reference for all properties that may be specified in DataSource descriptor (.ds.xml file), for use with Smart GWT Pro Edition and above.

See: Description

Package com.smartgwt.client.docs.serverds Description

This package is reference for all properties that may be specified in DataSource descriptor (.ds.xml file), for use with Smart GWT Pro Edition and above. Do not import this package in your Java code - it is informational only.

Each Java Class here represents an XML element, and each field is a setting that can be specified as either an attribute or a subelement.

For example, DataSource.canMultiSort can be set like this:


<DataSource canMultiSort="true"/>
Or like this:

<DataSource>
    <canMultiSort>true</canMultiSort>
</DataSource>
When a class in this package has a field that is an Array of another class, it means there is a containing XML tag named after the field, then several tags named after the class. For example, DataSource.operationBindings is an Array of OperationBinding. The XML for this is:

<DataSource>
    <operationBindings>
        <operationBinding operationType="fetch">
            ... various operationBinding settings ...
        </operationBinding>
    </operationBindings>
</DataSource>
If the field is not an Array, it means there should be a singular tag. For example, OperationBinding.mail:

<DataSource>
    <operationBindings>
        <operationBinding operationType="add">
            <mail to="admin@company.com" templateFile="messageTemplate.txt"/>
        </operationBinding>
    </operationBindings>
</DataSource>

DataSource files and other Component XML files can be localized using resource bundles - see this overview for details.

NOTE: the settings described in the special "serverds" JavaDoc package are only usable with Smart GWT Pro Edition and above, however, the "serverds" documentation is included with Smart GWT LGPL since some parts of the documentation cover concepts and approaches that are also applicable in Smart GWT LGPL.

Skip navigation links