Settings (AssertJ-Swing 3.17.1 API)

java.lang.Object
- org.assertj.swing.core.Settings

```
public class Settings
extends Object
```
AssertJ-Swing configuration settings. There are two kinds of configuration entries, writable and only readable entries.

The read-only entries have hard-coded defaults which may be overwritten by assertj-swing.properties, which may be overwritten by system properties. See the javadoc of each method to find out the key which is identical in the properties file and as system property. You can identify read-only properties by the static methods in this class.

The writable entries are not static but depend on the Settings object which is created in BasicRobot and can be accessed through the robot instance. The initialisation is the same as for read-only properties, but you may change the value at runtime calling the setter methods.

Author:

Alex Ruiz

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`clickOnDisabledComponentsAllowed()`
`void`	`clickOnDisabledComponentsAllowed(boolean allow)` Default is `true`.
`ComponentLookupScope`	`componentLookupScope()`
`void`	`componentLookupScope(ComponentLookupScope scope)` Updates the scope of AWT or Swing `Component` lookups.
`int`	`delayBetweenEvents()`
`void`	`delayBetweenEvents(int ms)` Updates the value representing the millisecond count in between generated events.
`MouseButton`	`dragButton()`
`void`	`dragButton(MouseButton button)` Changes the `MouseButton` to use for drag operations.
`int`	`dragDelay()`
`void`	`dragDelay(int ms)` Updates the number of milliseconds to wait between a pressing a mouse button and moving the mouse.
`int`	`dropDelay()`
`void`	`dropDelay(int ms)` Updates the number of milliseconds between the final mouse movement and mouse release to ensure drop ends.
`int`	`eventPostingDelay()`
`void`	`eventPostingDelay(int ms)` Updates the number of milliseconds before checking for idle.
`int`	`idleTimeout()`
`void`	`idleTimeout(int ms)` Updates the time (in milliseconds) to wait for an idle AWT event queue.
`static boolean`	`shouldPreserveScreenshots()`
`boolean`	`simpleWaitForIdle()`
`void`	`simpleWaitForIdle(boolean simpleWaitForIdle)` turns on or off the simple waitForIdle implementation
`int`	`timeoutToBeVisible()`
`void`	`timeoutToBeVisible(int ms)` Updates the number of milliseconds to wait for an AWT or Swing `Component` to be visible.
`int`	`timeoutToFindPopup()`
`void`	`timeoutToFindPopup(int ms)` Updates the number of milliseconds to wait before failing to find a pop-up menu that should appear.
`int`	`timeoutToFindSubMenu()`
`void`	`timeoutToFindSubMenu(int ms)` Updates the number of milliseconds to wait for a sub-menu to appear.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - shouldPreserveScreenshots
```
public static boolean shouldPreserveScreenshots()
```
  - delayBetweenEvents
```
public int delayBetweenEvents()
```
    Returns:
    
    a value representing the millisecond count in between generated events.
    
    See Also:
    
    for default value and configuration key
  - delayBetweenEvents
```
public void delayBetweenEvents(int ms)
```
    Updates the value representing the millisecond count in between generated events. Usually just set to 100-200 if you want to slow down the playback to simulate actual user input. The default is 60 milliseconds.
    The property key for configuration file and system properties is org.assertj.swing.delay.between_events
    
    To change the speed of a GUI test, you need to change the values of both delayBetweenEvents and eventPostingDelay.
    
    Parameters:
    
    ms - the millisecond count in between generated events. It should be between -1 and 60000.
    
    See Also:
    
    eventPostingDelay(int)
  - timeoutToBeVisible
```
public int timeoutToBeVisible()
```
    Returns:
    
    the number of milliseconds to wait for an AWT or Swing Component to be visible.
    
    See Also:
    
    for default value and configuration key
  - timeoutToBeVisible
```
public void timeoutToBeVisible(int ms)
```
    Updates the number of milliseconds to wait for an AWT or Swing Component to be visible. The default value is 30,000 milliseconds.
    The property key for configuration file and system properties is org.assertj.swing.timeout.visibility
    
    Parameters:
    
    ms - the time in milliseconds. It should be between 0 and 60000.
  - timeoutToFindPopup
```
public int timeoutToFindPopup()
```
    Returns:
    
    the number of milliseconds to wait before failing to find a pop-up menu that should appear.
    
    See Also:
    
    for default value and configuration key
  - timeoutToFindPopup
```
public void timeoutToFindPopup(int ms)
```
    Updates the number of milliseconds to wait before failing to find a pop-up menu that should appear. The default value is 30000 milliseconds.
    The property key for configuration file and system properties is org.assertj.swing.timeout.popup
    
    Parameters:
    
    ms - the time in milliseconds. It should be between 0 and 60000.
  - timeoutToFindSubMenu
```
public int timeoutToFindSubMenu()
```
    Returns:
    
    the number of milliseconds to wait for a sub-menu to appear.
    
    See Also:
    
    for default value and configuration key
  - timeoutToFindSubMenu
```
public void timeoutToFindSubMenu(int ms)
```
    Updates the number of milliseconds to wait for a sub-menu to appear. The default value is 100 milliseconds.
    The property key for configuration file and system properties is org.assertj.swing.timeout.submenu
    
    Parameters:
    
    ms - the time in milliseconds. It should be between 0 and 10000.
  - dragDelay
```
public int dragDelay()
```
    Returns:
    
    the number of milliseconds to wait between a pressing a mouse button and moving the mouse.
    
    See Also:
    
    for default value and configuration key
  - dragDelay
```
public void dragDelay(int ms)
```
    Updates the number of milliseconds to wait between a pressing a mouse button and moving the mouse. The default value for Mac OS X or the X11 Windowing system is 100 milliseconds. For other platforms, the default value is 0.
    The property key for configuration file and system properties is org.assertj.swing.delay.drag
    
    Parameters:
    
    ms - the time in milliseconds. For Mac OS X or the X11 Windowing system, the minimum value is 100. For other platforms the minimum value is 0. The maximum value for all platforms is 60000.
  - eventPostingDelay
```
public int eventPostingDelay()
```
    Returns:
    
    the number of milliseconds before checking for idle.
    
    See Also:
    
    for default value and configuration key
  - eventPostingDelay
```
public void eventPostingDelay(int ms)
```
    Updates the number of milliseconds before checking for idle. This allows the system a little time to put a native event onto the AWT event queue. The default value is 100 milliseconds.
    
    The property key for configuration file and system properties is org.assertj.swing.delay.posting_events
    
    To change the speed of a GUI test, you need to change the values of both delayBetweenEvents and eventPostingDelay.
    
    Parameters:
    
    ms - the time in milliseconds. It should be between 0 and 1000.
    
    See Also:
    
    delayBetweenEvents(int)
  - dropDelay
```
public int dropDelay()
```
    Returns:
    
    the number of milliseconds between the final mouse movement and mouse release to ensure drop ends.
    
    See Also:
    
    for default value and configuration key
  - dropDelay
```
public void dropDelay(int ms)
```
    Updates the number of milliseconds between the final mouse movement and mouse release to ensure drop ends. The default value for Windows is 200. For other platforms, the default value is 0.
    The property key for configuration file and system properties is org.assertj.swing.delay.drop
    
    Parameters:
    
    ms - the time in milliseconds. For Windows, the minimum value is 200. For other platforms, the minimum value is 0. The maximum value for all platforms is 60000.
  - componentLookupScope
```
@Nonnull
public ComponentLookupScope componentLookupScope()
```
    Returns:
    
    the scope of AWT or Swing Component lookups. This setting only affects the classes in the package org.assertj.swing.fixture.
    
    See Also:
    
    for default value and configuration key
  - componentLookupScope
```
public void componentLookupScope(@Nonnull
                                 ComponentLookupScope scope)
```
    Updates the scope of AWT or Swing Component lookups. This setting only affects the classes in the package org.assertj.swing.fixture. The default value is ComponentLookupScope.DEFAULT.
    The property key for configuration file and system properties is org.assertj.swing.lookup_scope
    
    Parameters:
    
    scope - the new value for the scope.
  - idleTimeout
```
public int idleTimeout()
```
    Returns:
    
    the time (in milliseconds) to wait for an idle AWT event queue.
    
    See Also:
    
    for default value and configuration key
  - idleTimeout
```
public void idleTimeout(int ms)
```
    Updates the time (in milliseconds) to wait for an idle AWT event queue.
    The property key for configuration file and system properties is org.assertj.swing.timeout.idle
    
    Parameters:
    
    ms - the new time. The value should be equal to or greater than zero.
  - simpleWaitForIdle
```
public boolean simpleWaitForIdle()
```
    Returns:
    
    the simple waitForIdle implementation is on or off
  - simpleWaitForIdle
```
public void simpleWaitForIdle(boolean simpleWaitForIdle)
```
    turns on or off the simple waitForIdle implementation
    
    Parameters:
    
    simpleWaitForIdle - true if simple implementation should be used
  - clickOnDisabledComponentsAllowed
```
public boolean clickOnDisabledComponentsAllowed()
```
    Returns:
    
    true if clicking on disabled components should be possible.
    
    See Also:
    
    for default value and configuration key
  - clickOnDisabledComponentsAllowed
```
public void clickOnDisabledComponentsAllowed(boolean allow)
```
    Default is true.
    The property key for configuration file and system properties is org.assertj.swing.allow_click_on_disabled_component.
    
    Parameters:
    
    allow - new value for clickOnDisabledComponentsAllowed(boolean).
  - dragButton
```
public MouseButton dragButton()
```
    Returns:
    
    the MouseButton to use for drag operations.
    
    See Also:
    
    for default value and configuration key
  - dragButton
```
public void dragButton(MouseButton button)
```
    Changes the MouseButton to use for drag operations. Default is MouseButton.LEFT_BUTTON.
    The property key for configuration file and system properties is org.assertj.swing.drag.button
    
    Parameters:
    
    button - the MouseButton to use from now on

Class Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

shouldPreserveScreenshots

delayBetweenEvents

delayBetweenEvents

timeoutToBeVisible

timeoutToBeVisible

timeoutToFindPopup

timeoutToFindPopup

timeoutToFindSubMenu

timeoutToFindSubMenu

dragDelay

dragDelay

eventPostingDelay

eventPostingDelay

dropDelay

dropDelay

componentLookupScope

componentLookupScope

idleTimeout

idleTimeout

simpleWaitForIdle

simpleWaitForIdle

clickOnDisabledComponentsAllowed

clickOnDisabledComponentsAllowed

dragButton

dragButton