LoadProjectSettings (Smart GWT EE API 12.1p (2026-02-25))

java.lang.Object
- com.smartgwt.client.core.JsObject
- - com.smartgwt.client.core.DataClass
  - - com.smartgwt.client.rpc.LoadProjectSettings

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers
```
public class LoadProjectSettings
extends DataClass
```
LoadProjectSettings is the bundle of settings that can be passed to loadProject() as the "settings" argument, including optional http parameters for the request to ProjectLoaderServlet.
There is no need to instatiate an LoadProjectSettings instance. Just pass a normal JavaScript object with the desired properties.

Field Summary
- Fields inherited from class com.smartgwt.client.core.DataClass
  factoryCreated, factoryProperties
- Fields inherited from class com.smartgwt.client.core.JsObject
  jsObj

Constructor Summary

Constructors
Constructor and Description

LoadProjectSettings()

LoadProjectSettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`LoadProjectSettings()`
`LoadProjectSettings(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCurrentScreenName()` The name of the screen within the project to draw after loading.
`boolean`	`getDrawFirstScreen()` Determines whether the `currentScreenName` screen is drawn after all screens have been loaded.
`java.lang.String`	`getLocale()` The name of a locale to use for resolving i18n tags in the component XML of the screen.
`static LoadProjectSettings`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`java.lang.String`	`getOwnerId()` Use this attribute to specify a project owner.
`java.lang.String`	`getScreenNames()` A comma-separated string containing the names of screens within the project that should be loaded.
`LoadProjectSettings`	`setCurrentScreenName(java.lang.String currentScreenName)` The name of the screen within the project to draw after loading.
`LoadProjectSettings`	`setDrawFirstScreen(boolean drawFirstScreen)` Determines whether the `currentScreenName` screen is drawn after all screens have been loaded.
`LoadProjectSettings`	`setLocale(java.lang.String locale)` The name of a locale to use for resolving i18n tags in the component XML of the screen.
`LoadProjectSettings`	`setOwnerId(java.lang.String ownerId)` Use this attribute to specify a project owner.
`LoadProjectSettings`	`setScreenNames(java.lang.String screenNames)` A comma-separated string containing the names of screens within the project that should be loaded.

Methods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LoadProjectSettings
```
public LoadProjectSettings()
```
  - LoadProjectSettings
```
public LoadProjectSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static LoadProjectSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - setCurrentScreenName
```
public LoadProjectSettings setCurrentScreenName(java.lang.String currentScreenName)
```
    The name of the screen within the project to draw after loading. A null value means to use the currentScreenName as specified in the project file of the first project specified in the projectNames argument to RPCManager.loadProject().
    
    Parameters:
    
    currentScreenName - New currentScreenName value. Default value is null
    
    Returns:
    
    LoadProjectSettings instance, for chaining setter calls
  - getCurrentScreenName
```
public java.lang.String getCurrentScreenName()
```
    The name of the screen within the project to draw after loading. A null value means to use the currentScreenName as specified in the project file of the first project specified in the projectNames argument to RPCManager.loadProject().
    
    Returns:
    
    Current currentScreenName value. Default value is null
  - setDrawFirstScreen
```
public LoadProjectSettings setDrawFirstScreen(boolean drawFirstScreen)
```
    Determines whether the currentScreenName screen is drawn after all screens have been loaded.
    
    Parameters:
    
    drawFirstScreen - New drawFirstScreen value. Default value is true
    
    Returns:
    
    LoadProjectSettings instance, for chaining setter calls
  - getDrawFirstScreen
```
public boolean getDrawFirstScreen()
```
    Determines whether the currentScreenName screen is drawn after all screens have been loaded.
    
    Returns:
    
    Current drawFirstScreen value. Default value is true
  - setLocale
```
public LoadProjectSettings setLocale(java.lang.String locale)
```
    The name of a locale to use for resolving i18n tags in the component XML of the screen. The default value of null omits locale loading, which effectively means the framework default "en" locale is used.
    
    Parameters:
    
    locale - New locale value. Default value is null
    
    Returns:
    
    LoadProjectSettings instance, for chaining setter calls
  - getLocale
```
public java.lang.String getLocale()
```
    The name of a locale to use for resolving i18n tags in the component XML of the screen. The default value of null omits locale loading, which effectively means the framework default "en" locale is used.
    
    Returns:
    
    Current locale value. Default value is null
  - setOwnerId
```
public LoadProjectSettings setOwnerId(java.lang.String ownerId)
```
    Use this attribute to specify a project owner. Only applicable if project source supports owner identification.
    
    Parameters:
    
    ownerId - New ownerId value. Default value is null
    
    Returns:
    
    LoadProjectSettings instance, for chaining setter calls
  - getOwnerId
```
public java.lang.String getOwnerId()
```
    Use this attribute to specify a project owner. Only applicable if project source supports owner identification.
    
    Returns:
    
    Current ownerId value. Default value is null
  - setScreenNames
```
public LoadProjectSettings setScreenNames(java.lang.String screenNames)
```
    A comma-separated string containing the names of screens within the project that should be loaded. A null value causes all screens to be loaded.
    
    Parameters:
    
    screenNames - New screenNames value. Default value is null
    
    Returns:
    
    LoadProjectSettings instance, for chaining setter calls
  - getScreenNames
```
public java.lang.String getScreenNames()
```
    A comma-separated string containing the names of screens within the project that should be loaded. A null value causes all screens to be loaded.
    
    Returns:
    
    Current screenNames value. Default value is null

Class LoadProjectSettings

Field Summary

Fields inherited from class com.smartgwt.client.core.DataClass

Fields inherited from class com.smartgwt.client.core.JsObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.core.DataClass

Methods inherited from class com.smartgwt.client.core.JsObject

Methods inherited from class java.lang.Object

Constructor Detail

LoadProjectSettings

LoadProjectSettings

Method Detail

getOrCreateRef

setCurrentScreenName

getCurrentScreenName

setDrawFirstScreen

getDrawFirstScreen

setLocale

getLocale

setOwnerId

getOwnerId

setScreenNames

getScreenNames