Package com.smartgwt.client.tools

Class OverlaySettings

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.tools.OverlaySettings
All Implemented Interfaces:
HasHandlers
public class OverlaySettings extends DataClass
Optional settings for Reify.showOverlay().

  • Constructor Details

    • OverlaySettings

      public OverlaySettings()

    • OverlaySettings

      public OverlaySettings(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static OverlaySettings getOrCreateRef(JavaScriptObject jsObj)

    • setDismissKeys

      public OverlaySettings setDismissKeys(String... dismissKeys)
      Key names that dismiss the overlay when pressed.
      Parameters:
      dismissKeys - New dismissKeys value. Default value is ["Escape"]
      Returns:
      OverlaySettings instance, for chaining setter calls
      See Also:

    • getDismissKeys

      public String[] getDismissKeys()
      Key names that dismiss the overlay when pressed.
      Returns:
      Current dismissKeys value. Default value is ["Escape"]
      See Also:

    • setDismissOnOutsideClick

      public OverlaySettings setDismissOnOutsideClick(Boolean dismissOnOutsideClick)
      If true, clicking a mask tile (anywhere outside loaded screens and their action icons) dismisses the overlay.
      Parameters:
      dismissOnOutsideClick - New dismissOnOutsideClick value. Default value is true
      Returns:
      OverlaySettings instance, for chaining setter calls

    • getDismissOnOutsideClick

      public Boolean getDismissOnOutsideClick()
      If true, clicking a mask tile (anywhere outside loaded screens and their action icons) dismisses the overlay.
      Returns:
      Current dismissOnOutsideClick value. Default value is true