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

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers
```
public class CreateScreenSettings
extends DataClass
```
Controls what class and instance substitutions, if any, are applied during a call to RPCManager.createScreen(). Classes and instances can be mapped (constructed as) other classes, and existing widget instances can be returned for new ones.

See Also:

getClassSubstitutions(), getComponentSubstitutions()

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

CreateScreenSettings()

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map`	`getClassSubstitutions()` Maps class names of widgets in the screen to new class names, so that if a widget would normally be constructed as an instance of a class, and that class is in the map, it's instead constructed as an instance of the new class.
`java.util.Map`	`getComponentSubstitutions()` Defines the map of new widget ids to existing class instances, or to new instances that will be of a different class.
`static CreateScreenSettings`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`CreateScreenSettings`	`setClassSubstitutions(java.util.Map classSubstitutions)` Maps class names of widgets in the screen to new class names, so that if a widget would normally be constructed as an instance of a class, and that class is in the map, it's instead constructed as an instance of the new class.
`CreateScreenSettings`	`setComponentSubstitutions(java.util.Map componentSubstitutions)` Defines the map of new widget ids to existing class instances, or to new instances that will be of a different class.

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
  - CreateScreenSettings
```
public CreateScreenSettings()
```
  - CreateScreenSettings
```
public CreateScreenSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static CreateScreenSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - setClassSubstitutions
```
public CreateScreenSettings setClassSubstitutions(java.util.Map classSubstitutions)
```
    Maps class names of widgets in the screen to new class names, so that if a widget would normally be constructed as an instance of a class, and that class is in the map, it's instead constructed as an instance of the new class.
    
    Parameters:
    
    classSubstitutions - New classSubstitutions value. Default value is null
    
    Returns:
    
    CreateScreenSettings instance, for chaining setter calls
    
    See Also:
    
    RPCManager.createScreen(java.lang.String)
  - getClassSubstitutions
```
public java.util.Map getClassSubstitutions()
```
    Maps class names of widgets in the screen to new class names, so that if a widget would normally be constructed as an instance of a class, and that class is in the map, it's instead constructed as an instance of the new class.
    
    Returns:
    
    Current classSubstitutions value. Default value is null
    
    See Also:
    
    RPCManager.createScreen(java.lang.String)
  - setComponentSubstitutions
```
public CreateScreenSettings setComponentSubstitutions(java.util.Map componentSubstitutions)
```
    Defines the map of new widget ids to existing class instances, or to new instances that will be of a different class. A substituted class instance is returned immediately from Class.create() without modification. Otherwise, the constructor for the new instance is run, but targeting the substituted class rather than the original.
    Note that where we return an existing instance, not even its Canvas.ID will be changed. An alternative is programmtic replacement using Layout.replaceMember().
    
    Parameters:
    
    componentSubstitutions - New componentSubstitutions value. Default value is null
    
    Returns:
    
    CreateScreenSettings instance, for chaining setter calls
    
    See Also:
    
    RPCManager.createScreen(java.lang.String)
  - getComponentSubstitutions
```
public java.util.Map getComponentSubstitutions()
```
    Defines the map of new widget ids to existing class instances, or to new instances that will be of a different class. A substituted class instance is returned immediately from Class.create() without modification. Otherwise, the constructor for the new instance is run, but targeting the substituted class rather than the original.
    Note that where we return an existing instance, not even its Canvas.ID will be changed. An alternative is programmtic replacement using Layout.replaceMember().
    
    Returns:
    
    Current componentSubstitutions value. Default value is null
    
    See Also:
    
    RPCManager.createScreen(java.lang.String)

Class CreateScreenSettings

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

CreateScreenSettings

CreateScreenSettings

Method Detail

getOrCreateRef

setClassSubstitutions

getClassSubstitutions

setComponentSubstitutions

getComponentSubstitutions