public class LoadScreenSettings extends DataClass
RPCManager.loadScreen() as the "settings" argument.  Some settings can also be passed as separate arguments; if these
 are present both as separate arguments and in settings, loadScreen() will use the value from the settings.  There is
 no need to instantiate a LoadScreenSettings instance.  Just pass a normal JavaScript object with the
 desired properties.
factoryCreated, factoryProperties| Constructor and Description | 
|---|
| LoadScreenSettings() | 
| LoadScreenSettings(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.lang.Boolean | getCacheScreen()Caches screen much like  RPCManager.cacheScreens(), soRPCManager.isScreenCached()reports true. | 
| java.lang.Boolean | getClobberDataSources()Should DataSources referenced by the screen clobber existing, globally-bound DataSources on the client when the screen
 is loaded?  The default of false means that any DataSources defined in the screen will be discarded if they collide with
 existing, globally-bound DataSources. | 
| java.lang.String | getLocale()The name of a locale to use for resolving i18n tags in the component XML of the screen. | 
| java.lang.Boolean | getMissingDSIsNotFatal()If true, server logic does not crash out if it cannot load a DataSource specified in the screen definition. | 
| java.lang.String[] | getOmitDataSources()DataSource IDs in the screen to skip and not load when the screen is loaded. | 
| boolean | getOmitLoadedDataSources()Whether to implicitly add all DataSources currently loaded on the client to  omitDataSourcesinRPCManager.loadScreen(). | 
| static LoadScreenSettings | getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| RPCRequest | getRequestProperties()Specifies optional  RPCRequestproperties for the request. | 
| java.lang.Boolean | getSuppressAutoDraw()If true, prevents any screen from being drawn when it's loaded, even if there's an explicit  Canvas.autoDraw:true setting on it. | 
| java.lang.Boolean | getVerifyAsError()Enable  verifyAsErrorbehavior only for requests using these
 settings. | 
| java.util.Map<java.lang.String,java.lang.String> | getVerifyComponents()Enables verification that the created screen contains a component having a
   localIdequal to the given key, and that it is an instance (or subclass)
  if the key's value. | 
| java.lang.Boolean | getWillHandleError()Whether to call the provided  callback even if an error was encountered trying to load the screen (or it was simply not
 found), so that you can run your own error handling. | 
| LoadScreenSettings | setCacheScreen(java.lang.Boolean cacheScreen)Caches screen much like  RPCManager.cacheScreens(), soRPCManager.isScreenCached()reports true. | 
| LoadScreenSettings | setClobberDataSources(java.lang.Boolean clobberDataSources)Should DataSources referenced by the screen clobber existing, globally-bound DataSources on the client when the screen
 is loaded?  The default of false means that any DataSources defined in the screen will be discarded if they collide with
 existing, globally-bound DataSources. | 
| LoadScreenSettings | setLocale(java.lang.String locale)The name of a locale to use for resolving i18n tags in the component XML of the screen. | 
| LoadScreenSettings | setMissingDSIsNotFatal(java.lang.Boolean missingDSIsNotFatal)If true, server logic does not crash out if it cannot load a DataSource specified in the screen definition. | 
| LoadScreenSettings | setOmitDataSources(java.lang.String... omitDataSources)DataSource IDs in the screen to skip and not load when the screen is loaded. | 
| LoadScreenSettings | setOmitLoadedDataSources(boolean omitLoadedDataSources)Whether to implicitly add all DataSources currently loaded on the client to  omitDataSourcesinRPCManager.loadScreen(). | 
| LoadScreenSettings | setRequestProperties(RPCRequest requestProperties)Specifies optional  RPCRequestproperties for the request. | 
| LoadScreenSettings | setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw)If true, prevents any screen from being drawn when it's loaded, even if there's an explicit  Canvas.autoDraw:true setting on it. | 
| LoadScreenSettings | setVerifyAsError(java.lang.Boolean verifyAsError)Enable  verifyAsErrorbehavior only for requests using these
 settings. | 
| LoadScreenSettings | setVerifyComponents(java.util.Map<java.lang.String,java.lang.String> verifyComponents)Enables verification that the created screen contains a component having a
   localIdequal to the given key, and that it is an instance (or subclass)
  if the key's value. | 
| LoadScreenSettings | setWillHandleError(java.lang.Boolean willHandleError)Whether to call the provided  callback even if an error was encountered trying to load the screen (or it was simply not
 found), so that you can run your own error handling. | 
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, 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, setFactoryCreatedpublic LoadScreenSettings()
public LoadScreenSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
public static LoadScreenSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public LoadScreenSettings setCacheScreen(java.lang.Boolean cacheScreen)
RPCManager.cacheScreens(), so RPCManager.isScreenCached() reports true.cacheScreen - New cacheScreen value. Default value is falseLoadScreenSettings instance, for chaining setter callspublic java.lang.Boolean getCacheScreen()
RPCManager.cacheScreens(), so RPCManager.isScreenCached() reports true.public LoadScreenSettings setClobberDataSources(java.lang.Boolean clobberDataSources)
 Note that here we consider a DataSource to be "globally bound" if it can be
 retrieved by ID using the method DataSource.get(), regardless of whether
 it's actually bound to the browser window object.
clobberDataSources - New clobberDataSources value. Default value is falseLoadScreenSettings instance, for chaining setter callspublic java.lang.Boolean getClobberDataSources()
 Note that here we consider a DataSource to be "globally bound" if it can be
 retrieved by ID using the method DataSource.get(), regardless of whether
 it's actually bound to the browser window object.
public LoadScreenSettings setLocale(java.lang.String locale)
locale - New locale value. Default value is nullLoadScreenSettings instance, for chaining setter callspublic java.lang.String getLocale()
public LoadScreenSettings setMissingDSIsNotFatal(java.lang.Boolean missingDSIsNotFatal)
unableToLoad flag, which
 client-side code can use to determine that the DataSource could not be loaded on the server.  Optional, defaults to
 false (ie, a missing DataSource causes a crash by default)missingDSIsNotFatal - New missingDSIsNotFatal value. Default value is nullLoadScreenSettings instance, for chaining setter callspublic java.lang.Boolean getMissingDSIsNotFatal()
unableToLoad flag, which
 client-side code can use to determine that the DataSource could not be loaded on the server.  Optional, defaults to
 false (ie, a missing DataSource causes a crash by default)public LoadScreenSettings setOmitDataSources(java.lang.String... omitDataSources)
The special value of "*" can be specified for this property to indicate that all DataSources should be omitted.
 Note that, unless omitLoadedDataSources is false, all loaded
 DataSources will by default be added to whatever value you provide (making that also the default for this property).
omitDataSources - New omitDataSources value. Default value is variesLoadScreenSettings instance, for chaining setter callsIdentifierpublic java.lang.String[] getOmitDataSources()
The special value of "*" can be specified for this property to indicate that all DataSources should be omitted.
 Note that, unless omitLoadedDataSources is false, all loaded
 DataSources will by default be added to whatever value you provide (making that also the default for this property).
Identifierpublic LoadScreenSettings setOmitLoadedDataSources(boolean omitLoadedDataSources)
omitDataSources in RPCManager.loadScreen().  Setting this false would only make sense in
 connection with setting clobberDataSources
 true, and would create more potential work for the server since many more DataSources could be output.  Note that
 here we consider the "loaded DataSources" to be those that are registered with the DataSource module (i.e. available by
 ID via DataSource.get()), regardless of whether they're actually bound
 to the browser window object.
omitLoadedDataSources - New omitLoadedDataSources value. Default value is trueLoadScreenSettings instance, for chaining setter callspublic boolean getOmitLoadedDataSources()
omitDataSources in RPCManager.loadScreen().  Setting this false would only make sense in
 connection with setting clobberDataSources
 true, and would create more potential work for the server since many more DataSources could be output.  Note that
 here we consider the "loaded DataSources" to be those that are registered with the DataSource module (i.e. available by
 ID via DataSource.get()), regardless of whether they're actually bound
 to the browser window object.
public LoadScreenSettings setRequestProperties(RPCRequest requestProperties)
RPCRequest properties for the request.requestProperties - New requestProperties value. Default value is nullLoadScreenSettings instance, for chaining setter callspublic RPCRequest getRequestProperties()
RPCRequest properties for the request.public LoadScreenSettings setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw)
Canvas.autoDraw:true setting on it.suppressAutoDraw - New suppressAutoDraw value. Default value is trueLoadScreenSettings instance, for chaining setter callspublic java.lang.Boolean getSuppressAutoDraw()
Canvas.autoDraw:true setting on it.public LoadScreenSettings setVerifyAsError(java.lang.Boolean verifyAsError)
verifyAsError behavior only for requests using these
 settings.verifyAsError - New verifyAsError value. Default value is nullLoadScreenSettings instance, for chaining setter callsCreateScreenSettings.setVerifyAsError(java.lang.Boolean), 
LoadProjectSettings.setVerifyAsError(java.lang.Boolean)public java.lang.Boolean getVerifyAsError()
verifyAsError behavior only for requests using these
 settings.CreateScreenSettings.getVerifyAsError(), 
LoadProjectSettings.getVerifyAsError()public LoadScreenSettings setVerifyComponents(java.util.Map<java.lang.String,java.lang.String> verifyComponents)
localId equal to the given key, and that it is an instance (or subclass)
  if the key's value.  Example:
  
    {customerListGrid: 'ListGrid'}
  
  You may verify the presence of Tabs, SectionStackSections, and FormItems by
  providing their names following the parent component's id in dot-separated notation.
  Example:
  
    {
      'mainTabSet.customersTab': 'ImgTab',
      'mainSectionStack.customerStackSection': 'SectionStackSection',
      'customerDetailsForm.customerNameItem': 'TextItem'
    }
  
  Findings are always reported to the console, and may also be presented to the user
  with a warning dialog by setting verifyAsError or
  verifyAsError.verifyComponents - New verifyComponents value. Default value is nullLoadScreenSettings instance, for chaining setter callsRPCManager.loadScreen(java.lang.String, com.smartgwt.client.rpc.LoadScreenCallback)public java.util.Map<java.lang.String,java.lang.String> getVerifyComponents()
localId equal to the given key, and that it is an instance (or subclass)
  if the key's value.  Example:
  
    {customerListGrid: 'ListGrid'}
  
  You may verify the presence of Tabs, SectionStackSections, and FormItems by
  providing their names following the parent component's id in dot-separated notation.
  Example:
  
    {
      'mainTabSet.customersTab': 'ImgTab',
      'mainSectionStack.customerStackSection': 'SectionStackSection',
      'customerDetailsForm.customerNameItem': 'TextItem'
    }
  
  Findings are always reported to the console, and may also be presented to the user
  with a warning dialog by setting verifyAsError or
  verifyAsError.RPCManager.loadScreen(java.lang.String, com.smartgwt.client.rpc.LoadScreenCallback)public LoadScreenSettings setWillHandleError(java.lang.Boolean willHandleError)
Note that for backward compatibility, the default of null means that the callback will still happen if the screen is not found, but not for a response with a server error. To have all such cases handled automatically, set this property explicitly false.
willHandleError - New willHandleError value. Default value is nullLoadScreenSettings instance, for chaining setter callspublic java.lang.Boolean getWillHandleError()
Note that for backward compatibility, the default of null means that the callback will still happen if the screen is not found, but not for a response with a server error. To have all such cases handled automatically, set this property explicitly false.