public class LoadProjectSettings extends DataClass
ProjectLoaderServlet. There is no need to instantiate an LoadProjectSettings instance. Just pass a normal JavaScript object with the desired properties.
factoryCreated, factoryProperties| Constructor and Description | 
|---|
| LoadProjectSettings() | 
| LoadProjectSettings(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.lang.Boolean | getAllowPlaceholders()Should  Placeholders in loaded screens be rendered as placeholders? If property is not set actual components are created
 instead of the Placeholders. | 
| java.lang.Boolean | getClobberDataSources()Should DataSources referenced by the  first screenclobber existing, globally-bound DataSources on the client if the screen is created?  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 | getCurrentScreenName()The name of the screen within the project to return first when loading. | 
| DataContext | getDataContext()DataContextthat will be provided to the top-level component asdataContextin each screen cached for the project. | 
| boolean | getDrawFirstScreen()Determines whether the  currentScreenNamescreen
 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. | 
| java.lang.String[] | getOmitDataSources()DataSource IDs in the project to skip and not load when the project is loaded. | 
| boolean | getOmitLoadedDataSources()Whether to implicitly add all DataSources currently loaded on the client to  omitDataSourcesinRPCManager.loadProject(). | 
| 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 | getPassword()Overrides  passwordsetting the account password forReify.loadProject(). | 
| java.lang.String | getProjectLoaderPath()Path relative to the  server root, to target to use the
 project loader servlet, instead ofprojectLoaderPath. | 
| RPCRequest | getRequestProperties()Allows customizing the projectLoader servlet request properties. | 
| java.lang.String | getScreenNames()A comma-separated string containing the names of screens within the project that should be loaded. | 
| java.lang.String | getServerURL()URL of Reify server to use when calling  Reify.loadProject()instead
 ofserverURL. | 
| java.lang.Integer | getTimeout()Sets the timeout for the projectLoader servlet request. | 
| java.lang.String | getUserName()Overrides  userNamesetting the account name forReify.loadProject(). | 
| 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 any screen  createdon load contains a component having alocalIdequal to the given key,
  and that it is an instance (or subclass) of the key's value. | 
| java.lang.Boolean | getVerifyDataSources()Enables DataSource verification, causing warnings to be output about differences between DataSources loaded with a
 project vs those that are already present in the page (if any are present). | 
| boolean | getWillHandleError()Whether to call the provided  callback even if an error was encountered trying to load the project, so that you can run
 your own error handling. | 
| LoadProjectSettings | setAllowPlaceholders(java.lang.Boolean allowPlaceholders)Should  Placeholders in loaded screens be rendered as placeholders? If property is not set actual components are created
 instead of the Placeholders. | 
| LoadProjectSettings | setClobberDataSources(java.lang.Boolean clobberDataSources)Should DataSources referenced by the  first screenclobber existing, globally-bound DataSources on the client if the screen is created?  The default of false means that
 any DataSources defined in the screen will be discarded if they collide with existing, globally-bound DataSources. | 
| LoadProjectSettings | setCurrentScreenName(java.lang.String currentScreenName)The name of the screen within the project to return first when loading. | 
| LoadProjectSettings | setDataContext(DataContext dataContext)DataContextthat will be provided to the top-level component asdataContextin each screen cached for the project. | 
| LoadProjectSettings | setDrawFirstScreen(boolean drawFirstScreen)Determines whether the  currentScreenNamescreen
 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 | setOmitDataSources(java.lang.String... omitDataSources)DataSource IDs in the project to skip and not load when the project is loaded. | 
| LoadProjectSettings | setOmitLoadedDataSources(boolean omitLoadedDataSources)Whether to implicitly add all DataSources currently loaded on the client to  omitDataSourcesinRPCManager.loadProject(). | 
| LoadProjectSettings | setOwnerId(java.lang.String ownerId)Use this attribute to specify a project owner. | 
| LoadProjectSettings | setPassword(java.lang.String password)Overrides  passwordsetting the account password forReify.loadProject(). | 
| LoadProjectSettings | setProjectLoaderPath(java.lang.String projectLoaderPath)Path relative to the  server root, to target to use the
 project loader servlet, instead ofprojectLoaderPath. | 
| LoadProjectSettings | setRequestProperties(RPCRequest requestProperties)Allows customizing the projectLoader servlet request properties. | 
| LoadProjectSettings | setScreenNames(java.lang.String screenNames)A comma-separated string containing the names of screens within the project that should be loaded. | 
| LoadProjectSettings | setServerURL(java.lang.String serverURL)URL of Reify server to use when calling  Reify.loadProject()instead
 ofserverURL. | 
| LoadProjectSettings | setTimeout(java.lang.Integer timeout)Sets the timeout for the projectLoader servlet request. | 
| LoadProjectSettings | setUserName(java.lang.String userName)Overrides  userNamesetting the account name forReify.loadProject(). | 
| LoadProjectSettings | setVerifyAsError(java.lang.Boolean verifyAsError)Enable  verifyAsErrorbehavior only for requests using these
 settings. | 
| LoadProjectSettings | setVerifyComponents(java.util.Map<java.lang.String,java.lang.String> verifyComponents)Enables verification that any screen  createdon load contains a component having alocalIdequal to the given key,
  and that it is an instance (or subclass) of the key's value. | 
| LoadProjectSettings | setVerifyDataSources(java.lang.Boolean verifyDataSources)Enables DataSource verification, causing warnings to be output about differences between DataSources loaded with a
 project vs those that are already present in the page (if any are present). | 
| LoadProjectSettings | setWillHandleError(boolean willHandleError)Whether to call the provided  callback even if an error was encountered trying to load the project, 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 LoadProjectSettings()
public LoadProjectSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
public static LoadProjectSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public LoadProjectSettings setAllowPlaceholders(java.lang.Boolean allowPlaceholders)
allowPlaceholders - New allowPlaceholders value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.Boolean getAllowPlaceholders()
public LoadProjectSettings setClobberDataSources(java.lang.Boolean clobberDataSources)
first screen
 clobber existing, globally-bound DataSources on the client if the screen is created?  The default of false means that
 any DataSources defined in the screen will be discarded if they collide with existing, globally-bound DataSources. 
 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. 
 Note that this setting only has an impact if drawFirstScreen is true.
clobberDataSources - New clobberDataSources value. Default value is falseLoadProjectSettings instance, for chaining setter callspublic java.lang.Boolean getClobberDataSources()
first screen
 clobber existing, globally-bound DataSources on the client if the screen is created?  The default of false means that
 any DataSources defined in the screen will be discarded if they collide with existing, globally-bound DataSources. 
 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. 
 Note that this setting only has an impact if drawFirstScreen is true.
public LoadProjectSettings setCurrentScreenName(java.lang.String currentScreenName)
 This setting only affects the first project specified in the
 projectNames argument to RPCManager.loadProject().
currentScreenName - New currentScreenName value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.String getCurrentScreenName()
 This setting only affects the first project specified in the
 projectNames argument to RPCManager.loadProject().
public LoadProjectSettings setDataContext(DataContext dataContext)
DataContext that will be provided to the top-level component as dataContext in each screen cached for the project.  To understand
 how dataContext is used to automatically populate  DataBoundComponents, see Canvas.autoPopulateData.
dataContext - New dataContext value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic DataContext getDataContext()
DataContext that will be provided to the top-level component as dataContext in each screen cached for the project.  To understand
 how dataContext is used to automatically populate  DataBoundComponents, see Canvas.autoPopulateData.
public LoadProjectSettings setDrawFirstScreen(boolean drawFirstScreen)
currentScreenName screen
 is drawn after all screens have been loaded.  If not drawn, the screen will not be created.  This setting only
 affects the first project specified in the projectNames argument to RPCManager.loadProject().
drawFirstScreen - New drawFirstScreen value. Default value is falseLoadProjectSettings instance, for chaining setter callsProject.createScreen(java.lang.String), 
RPCManager.createScreen(java.lang.String)public boolean getDrawFirstScreen()
currentScreenName screen
 is drawn after all screens have been loaded.  If not drawn, the screen will not be created.  This setting only
 affects the first project specified in the projectNames argument to RPCManager.loadProject().
Project.createScreen(java.lang.String), 
RPCManager.createScreen(java.lang.String)public LoadProjectSettings setLocale(java.lang.String locale)
locale - New locale value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.String getLocale()
public LoadProjectSettings 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 variesLoadProjectSettings 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 LoadProjectSettings setOmitLoadedDataSources(boolean omitLoadedDataSources)
omitDataSources in RPCManager.loadProject().  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 trueLoadProjectSettings instance, for chaining setter callspublic boolean getOmitLoadedDataSources()
omitDataSources in RPCManager.loadProject().  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 LoadProjectSettings setOwnerId(java.lang.String ownerId)
ownerId - New ownerId value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.String getOwnerId()
public LoadProjectSettings setPassword(java.lang.String password)
password setting the account password for Reify.loadProject().  Note that this setting only applies when using
 Reify.loadProject().
password - New password value. Default value is variesLoadProjectSettings instance, for chaining setter callspublic java.lang.String getPassword()
password setting the account password for Reify.loadProject().  Note that this setting only applies when using
 Reify.loadProject().
public LoadProjectSettings setProjectLoaderPath(java.lang.String projectLoaderPath)
server root, to target to use the
 project loader servlet, instead of projectLoaderPath.  Note
 that this setting only applies when using Reify.loadProject().
projectLoaderPath - New projectLoaderPath value. Default value is variesLoadProjectSettings instance, for chaining setter callspublic java.lang.String getProjectLoaderPath()
server root, to target to use the
 project loader servlet, instead of projectLoaderPath.  Note
 that this setting only applies when using Reify.loadProject().
public LoadProjectSettings setRequestProperties(RPCRequest requestProperties)
RPCManager.loadProject().
 Note : This is an advanced setting
requestProperties - New requestProperties value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic RPCRequest getRequestProperties()
RPCManager.loadProject().public LoadProjectSettings setScreenNames(java.lang.String screenNames)
 This setting only affects the first project specified in the projectNames
 argument to RPCManager.loadProject().
screenNames - New screenNames value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.String getScreenNames()
 This setting only affects the first project specified in the projectNames
 argument to RPCManager.loadProject().
public LoadProjectSettings setServerURL(java.lang.String serverURL)
Reify.loadProject() instead
 of serverURL.  Note that this setting only applies when using
 Reify.loadProject().
serverURL - New serverURL value. Default value is variesLoadProjectSettings instance, for chaining setter callsURLpublic java.lang.String getServerURL()
Reify.loadProject() instead
 of serverURL.  Note that this setting only applies when using
 Reify.loadProject().
URLpublic LoadProjectSettings setTimeout(java.lang.Integer timeout)
requestProperties need not be set.  If unset, the
 timeout is determined by defaultTimeout.
 Note : This is an advanced setting
timeout - New timeout value. Default value is nullLoadProjectSettings instance, for chaining setter callspublic java.lang.Integer getTimeout()
requestProperties need not be set.  If unset, the
 timeout is determined by defaultTimeout.public LoadProjectSettings setUserName(java.lang.String userName)
userName setting the account name for Reify.loadProject().  Note that this setting only applies when using
 Reify.loadProject().
userName - New userName value. Default value is variesLoadProjectSettings instance, for chaining setter callspublic java.lang.String getUserName()
userName setting the account name for Reify.loadProject().  Note that this setting only applies when using
 Reify.loadProject().
public LoadProjectSettings setVerifyAsError(java.lang.Boolean verifyAsError)
verifyAsError behavior only for requests using these
 settings.verifyAsError - New verifyAsError value. Default value is nullLoadProjectSettings instance, for chaining setter callsCreateScreenSettings.setVerifyAsError(java.lang.Boolean), 
setVerifyAsError(java.lang.Boolean)public java.lang.Boolean getVerifyAsError()
verifyAsError behavior only for requests using these
 settings.CreateScreenSettings.getVerifyAsError(), 
getVerifyAsError()public LoadProjectSettings setVerifyComponents(java.util.Map<java.lang.String,java.lang.String> verifyComponents)
created
  on load contains a component having a localId equal to the given key,
  and that it is an instance (or subclass) of 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 nullLoadProjectSettings instance, for chaining setter callssetVerifyDataSources(java.lang.Boolean), 
RPCManager.loadProject(java.lang.String, com.smartgwt.client.callbacks.LoadProjectCallback, com.smartgwt.client.rpc.LoadProjectSettings)public java.util.Map<java.lang.String,java.lang.String> getVerifyComponents()
created
  on load contains a component having a localId equal to the given key,
  and that it is an instance (or subclass) of 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.getVerifyDataSources(), 
RPCManager.loadProject(java.lang.String, com.smartgwt.client.callbacks.LoadProjectCallback, com.smartgwt.client.rpc.LoadProjectSettings)public LoadProjectSettings setVerifyDataSources(java.lang.Boolean verifyDataSources)
verifyAsError.  For discussion of which issues will be
 reported and how, see DataSource.verifyDataSourcePair().  Setting this property will default omitLoadedDataSources to false, and will cause the
 special omitDataSources value of "*" to be
 ignored (but not other ID values). It's important to keep in mind when using this property that loading a project with
 all of its DataSources can be very slow, if there is a large amount of test data, for example. 
 Note that this
 behavior can be enabled globally by setting verifyDataSources
 to true.  It often makes sense to set it there during development, and turn off in production, since it slightly slows
 down DataSource loading.
verifyDataSources - New verifyDataSources value. Default value is nullLoadProjectSettings instance, for chaining setter callssetVerifyComponents(java.util.Map<java.lang.String, java.lang.String>), 
RPCManager.loadProject(java.lang.String, com.smartgwt.client.callbacks.LoadProjectCallback, com.smartgwt.client.rpc.LoadProjectSettings)public java.lang.Boolean getVerifyDataSources()
verifyAsError.  For discussion of which issues will be
 reported and how, see DataSource.verifyDataSourcePair().  Setting this property will default omitLoadedDataSources to false, and will cause the
 special omitDataSources value of "*" to be
 ignored (but not other ID values). It's important to keep in mind when using this property that loading a project with
 all of its DataSources can be very slow, if there is a large amount of test data, for example. 
 Note that this
 behavior can be enabled globally by setting verifyDataSources
 to true.  It often makes sense to set it there during development, and turn off in production, since it slightly slows
 down DataSource loading.
getVerifyComponents(), 
RPCManager.loadProject(java.lang.String, com.smartgwt.client.callbacks.LoadProjectCallback, com.smartgwt.client.rpc.LoadProjectSettings)public LoadProjectSettings setWillHandleError(boolean willHandleError)
If true, the framework won't log any messages specifically reporting the failure to load the requested projects, but depending on the situation, the browser itself may report errors from the servlet request in the console.
willHandleError - New willHandleError value. Default value is falseLoadProjectSettings instance, for chaining setter callsRPCManager.getLoadProjectErrorStatus(com.smartgwt.client.rpc.RPCResponse), 
RPCManager.getLoadProjectErrorMessage(com.smartgwt.client.rpc.RPCResponse)public boolean getWillHandleError()
If true, the framework won't log any messages specifically reporting the failure to load the requested projects, but depending on the situation, the browser itself may report errors from the servlet request in the console.
RPCManager.getLoadProjectErrorStatus(com.smartgwt.client.rpc.RPCResponse), 
RPCManager.getLoadProjectErrorMessage(com.smartgwt.client.rpc.RPCResponse)