public class CreateScreenSettings extends DataClass
RPCManager.createScreen().  Classes and instances can be mapped
 (constructed as) other classes, and existing widget instances can be returned for new ones.factoryCreated, factoryProperties| Constructor and Description | 
|---|
| CreateScreenSettings() | 
| CreateScreenSettings(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.lang.Boolean | getAllowPlaceholders()Should  Placeholders be rendered as placeholders? If property is not set actual components are created instead of the
 Placeholders. | 
| 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.lang.Boolean | getClobberDataSources()Should DataSources referenced by the screen clobber existing, globally-bound DataSources on the client when 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.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. | 
| DataContext | getDataContext()DataContextthat will be provided to the top-level component asdataContextin the screen. | 
| com.google.gwt.dom.client.Element | getHtmlElement()Simplifies integrating a screen with an existing JavaScript app. | 
| java.lang.String | getHtmlElementAsString()Simplifies integrating a screen with an existing JavaScript app. | 
| static CreateScreenSettings | getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| java.lang.Boolean | getSuppressAutoDraw()If true, prevents any screen from being drawn when it's created, 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. | 
| CreateScreenSettings | setAllowPlaceholders(java.lang.Boolean allowPlaceholders)Should  Placeholders be rendered as placeholders? If property is not set actual components are created instead of the
 Placeholders. | 
| 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 | setClobberDataSources(java.lang.Boolean clobberDataSources)Should DataSources referenced by the screen clobber existing, globally-bound DataSources on the client when 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. | 
| 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. | 
| CreateScreenSettings | setDataContext(DataContext dataContext)DataContextthat will be provided to the top-level component asdataContextin the screen. | 
| CreateScreenSettings | setHtmlElement(com.google.gwt.dom.client.Element htmlElement)Simplifies integrating a screen with an existing JavaScript app. | 
| CreateScreenSettings | setHtmlElement(java.lang.String htmlElement)Simplifies integrating a screen with an existing JavaScript app. | 
| CreateScreenSettings | setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw)If true, prevents any screen from being drawn when it's created, even if there's an explicit  Canvas.autoDraw:true setting on it. | 
| CreateScreenSettings | setVerifyAsError(java.lang.Boolean verifyAsError)Enable  verifyAsErrorbehavior only for requests using these
 settings. | 
| CreateScreenSettings | 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. | 
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 CreateScreenSettings()
public CreateScreenSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
public static CreateScreenSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public CreateScreenSettings setAllowPlaceholders(java.lang.Boolean allowPlaceholders)
allowPlaceholders - New allowPlaceholders value. Default value is nullCreateScreenSettings instance, for chaining setter callspublic java.lang.Boolean getAllowPlaceholders()
public CreateScreenSettings setClassSubstitutions(java.util.Map classSubstitutions)
classSubstitutions - New classSubstitutions value. Default value is nullCreateScreenSettings instance, for chaining setter callsRPCManager.createScreen(java.lang.String)public java.util.Map getClassSubstitutions()
RPCManager.createScreen(java.lang.String)public CreateScreenSettings 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 falseCreateScreenSettings 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 CreateScreenSettings setComponentSubstitutions(java.util.Map componentSubstitutions)
 Note that
 where we return an existing instance, not even its Canvas.ID will be
 changed.  An alternative is programmtic replacement using Layout.replaceMember().
componentSubstitutions - New componentSubstitutions value. Default value is nullCreateScreenSettings instance, for chaining setter callsRPCManager.createScreen(java.lang.String)public java.util.Map getComponentSubstitutions()
 Note that
 where we return an existing instance, not even its Canvas.ID will be
 changed.  An alternative is programmtic replacement using Layout.replaceMember().
RPCManager.createScreen(java.lang.String)public CreateScreenSettings setDataContext(DataContext dataContext)
DataContext that will be provided to the top-level component as dataContext in the screen.  To understand how
 dataContext is used to automatically populate  DataBoundComponents, see Canvas.autoPopulateData.
dataContext - New dataContext value. Default value is nullCreateScreenSettings instance, for chaining setter callspublic DataContext getDataContext()
DataContext that will be provided to the top-level component as dataContext in the screen.  To understand how
 dataContext is used to automatically populate  DataBoundComponents, see Canvas.autoPopulateData.
public CreateScreenSettings setHtmlElement(com.google.gwt.dom.client.Element htmlElement)
suppressAutoDraw: true
 Canvas.htmlElement of the screen's top widget to the
 DOM element
 Canvas.position:
 "relative"
  Canvas.draw() on the top widgetCanvas.htmlPosition, then instead of using this property, you
 can call
 RPCManager.createScreen() with suppressAutoDraw: true, and then
  manually configure and draw the screen:
  
      CreateScreenSettings settings = new CreateScreenSettings();
      settings.setSuppressAutoDraw(true);
      Canvas screen = RPCManager.createScreen("My Screen", settings);
      screen.setHtmlElement(element);
      screen.setHtmlPosition(DrawPosition.REPLACE);
      screen.setPosition(Positioning.RELATIVE);
      screen.draw();
  htmlElement - New htmlElement value. Default value is nullCreateScreenSettings instance, for chaining setter callspublic com.google.gwt.dom.client.Element getHtmlElement()
suppressAutoDraw: true
 Canvas.htmlElement of the screen's top widget to the
 DOM element
 Canvas.position:
 "relative"
  Canvas.draw() on the top widgetCanvas.htmlPosition, then instead of using this property, you
 can call
 RPCManager.createScreen() with suppressAutoDraw: true, and then
  manually configure and draw the screen:
  
      CreateScreenSettings settings = new CreateScreenSettings();
      settings.setSuppressAutoDraw(true);
      Canvas screen = RPCManager.createScreen("My Screen", settings);
      screen.setHtmlElement(element);
      screen.setHtmlPosition(DrawPosition.REPLACE);
      screen.setPosition(Positioning.RELATIVE);
      screen.draw();
  public CreateScreenSettings setHtmlElement(java.lang.String htmlElement)
suppressAutoDraw: true
 Canvas.htmlElement of the screen's top widget to the
 DOM element
 Canvas.position:
 "relative"
  Canvas.draw() on the top widgetCanvas.htmlPosition, then instead of using this property, you
 can call
 RPCManager.createScreen() with suppressAutoDraw: true, and then
  manually configure and draw the screen:
  
      CreateScreenSettings settings = new CreateScreenSettings();
      settings.setSuppressAutoDraw(true);
      Canvas screen = RPCManager.createScreen("My Screen", settings);
      screen.setHtmlElement(element);
      screen.setHtmlPosition(DrawPosition.REPLACE);
      screen.setPosition(Positioning.RELATIVE);
      screen.draw();
  htmlElement - New htmlElement value. Default value is nullCreateScreenSettings instance, for chaining setter callspublic java.lang.String getHtmlElementAsString()
suppressAutoDraw: true
 Canvas.htmlElement of the screen's top widget to the
 DOM element
 Canvas.position:
 "relative"
  Canvas.draw() on the top widgetCanvas.htmlPosition, then instead of using this property, you
 can call
 RPCManager.createScreen() with suppressAutoDraw: true, and then
  manually configure and draw the screen:
  
      CreateScreenSettings settings = new CreateScreenSettings();
      settings.setSuppressAutoDraw(true);
      Canvas screen = RPCManager.createScreen("My Screen", settings);
      screen.setHtmlElement(element);
      screen.setHtmlPosition(DrawPosition.REPLACE);
      screen.setPosition(Positioning.RELATIVE);
      screen.draw();
  public CreateScreenSettings setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw)
Canvas.autoDraw:true setting on it.suppressAutoDraw - New suppressAutoDraw value. Default value is falseCreateScreenSettings instance, for chaining setter callspublic java.lang.Boolean getSuppressAutoDraw()
Canvas.autoDraw:true setting on it.public CreateScreenSettings setVerifyAsError(java.lang.Boolean verifyAsError)
verifyAsError behavior only for requests using these
 settings.verifyAsError - New verifyAsError value. Default value is nullCreateScreenSettings instance, for chaining setter callssetVerifyAsError(java.lang.Boolean), 
LoadProjectSettings.setVerifyAsError(java.lang.Boolean)public java.lang.Boolean getVerifyAsError()
verifyAsError behavior only for requests using these
 settings.getVerifyAsError(), 
LoadProjectSettings.getVerifyAsError()public CreateScreenSettings 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 presence and type of Tabs, SectionStackSections, and FormItems by
  providing their names following the parent component's id in dot-separated notation.
  Example:
  
    {
      'mainTabSet.customersTab': 'ImgTab',
      'mainSectionStack.customersSection': 'SectionHeader',
      '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 nullCreateScreenSettings instance, for chaining setter callsRPCManager.createScreen(java.lang.String)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 presence and type of Tabs, SectionStackSections, and FormItems by
  providing their names following the parent component's id in dot-separated notation.
  Example:
  
    {
      'mainTabSet.customersTab': 'ImgTab',
      'mainSectionStack.customersSection': 'SectionHeader',
      '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.createScreen(java.lang.String)