LazyGuiSettings

java.lang.Object
- com.krab.lazy.LazyGuiSettings

```
public class LazyGuiSettings
extends java.lang.Object
```
Settings to apply once inside the main LazyGui constructor on startup before loading any saves that might overwrite them. To avoid these settings getting overwritten - disable loading the latest save in the settings. Meant to be used like this in setup():
```
      gui = new LazyGui(this, new LazyGuiSettings()
          .setLoadLatestSaveOnStartup(false)
          .setAutosaveOnExit(false)
          // ...
      );
 
```

Constructor Summary

Constructors
Constructor and Description

LazyGuiSettings()
Constructor, call this before any other function here.

Constructors
Constructor and Description
`LazyGuiSettings()` Constructor, call this before any other function here.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LazyGuiSettings`	`setAutosaveLockGuardEnabled(boolean autosaveLockGuardEnabled)` When the lock guard is enabled it checks whether the last frame took too long and does not autosave if it did.
`LazyGuiSettings`	`setAutosaveLockGuardMillisLimit(int autosaveLockGuardMillisLimit)` The millis limit for the last frame for the autosave lock guard to take effect and block autosaving.
`LazyGuiSettings`	`setAutosaveOnExit(boolean autosaveEnabled)` Should the GUI try to autosave its state before closing gracefully?
`LazyGuiSettings`	`setAutosuggestWindowWidth(boolean shouldAutosuggest)` Override the GUI trying to make window widths fit its contents snugly based on longest text in the row at window opening time.
`LazyGuiSettings`	`setCellSize(float cellSize)` This sets the cell size that all gui controls use to draw themselves.
`LazyGuiSettings`	`setCustomGuiDataFolder(java.lang.String customPath)` Set a custom data folder for the gui to use for json saves and png screenshots.
`LazyGuiSettings`	`setDefaultGradientBlendType(java.lang.String defaultGradientBlendType)` Set the default gradient blend type for all gradient control elements.
`LazyGuiSettings`	`setHideBuiltInFolders(boolean shouldHideFolders)` Should the built-in folders start hidden? That is the automatically created gui folders like "options" and "saves".
`LazyGuiSettings`	`setHideRadioValue(boolean hideRadioValue)` Hide the selected value text on the right of the radio row and replace it with a generic folder icon.
`LazyGuiSettings`	`setHotkeyMouseWheelActive(boolean shouldMouseChangePrecision)` The mouse wheel changes a slider's precision when hovering over it.
`LazyGuiSettings`	`setKeyboardDelay(int millisDelayToSet)` Set the delay in milliseconds for the keyboard buffer to be considered a new input.
`LazyGuiSettings`	`setLoadLatestSaveOnStartup(boolean loadLatestSaveOnStartup)` When this is set to false it disables the default attempt to load the latest save.
`LazyGuiSettings`	`setLoadSpecificSaveOnStartup(java.lang.String fileName)` Loads a specific save file on startup, tries to look inside the save folder for the file first before assuming the user gave the absolute path.
`LazyGuiSettings`	`setLoadSpecificSaveOnStartupOnce(java.lang.String fileName)` Loads a specific save file on startup if the gui finds its save folder empty.
`LazyGuiSettings`	`setMainFontSize(int mainFontSize)` This sets the main font size used everywhere by the gui.
`LazyGuiSettings`	`setMouseConfineToWindow(boolean mouseShouldConfineToWindow)` Should the mouse be locked inside the sketch window? You can still exit the sketch with ESC.
`LazyGuiSettings`	`setMouseHideWhenDragging(boolean mouseShouldHideWhenDragging)` Should the mouse be hidden when dragging a slider or a plot? Hiding the mouse can give the user a more immersive feeling, but it can also be disorienting.
`LazyGuiSettings`	`setOverwriteLastLoadedSave(boolean overwriteLastLoadedSave)` Sets the custom new save file name to be the same as the last loaded save file whenever a save is loaded.
`LazyGuiSettings`	`setShowSquigglyEqualsInsideSliders(boolean showSquigglyEquals)` Show the approximately equals double tilde '≈' in sliders when visually shown values are not exactly equal to the actual float values used by the program.
`LazyGuiSettings`	`setSideFontSize(int sideFontSize)` This sets the usually smaller side font size used in a few places by the gui.
`LazyGuiSettings`	`setSketchNameOverride(java.lang.String sketchNameOverride)` Overrides what the root window title displays.
`LazyGuiSettings`	`setSmooth(int smoothValue)` Override the default antialiasing level of `smooth(4)` for the GUI canvas.
`LazyGuiSettings`	`setStartGuiHidden(boolean shouldHideGui)` Should the gui start hidden? Toggle hiding with the 'H' hotkey.
`LazyGuiSettings`	`setThemeCustom(int windowBorderColor, int normalBackgroundColor, int focusBackgroundColor, int normalForegroundColor, int focusForegroundColor)` Sets a custom theme defined by individual hex colors.
`LazyGuiSettings`	`setThemePreset(java.lang.String themePreset)` Sets one theme from the preset options on startup.
`LazyGuiSettings`	`setWindowRestoreAlways()` The GUI will always load window positions, sizes and openness on startup and then always try to overwrite them when loading other saves.
`LazyGuiSettings`	`setWindowRestoreNever()` The GUI will never load window positions, sizes and openness.
`LazyGuiSettings`	`setWindowRestoreOnlyOnStartup()` The GUI will load window positions, sizes and openness on startup and then ignore any saved window states when loading other saves.

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

- Constructor Detail
  - LazyGuiSettings
```
public LazyGuiSettings()
```
    Constructor, call this before any other function here. Meant to be used like this in setup(): *
```
  *      gui = new LazyGui(this, new LazyGuiSettings()
  *          .setLoadLatestSaveOnStartup(false)
  *          .setAutosaveOnExit(false)
  *          // ...
  *      );
  * 
```
- Method Detail
  - setThemePreset
```
public LazyGuiSettings setThemePreset(java.lang.String themePreset)
```
    Sets one theme from the preset options on startup.
    
    Parameters:
    
    themePreset - selected preset, one of "dark", "light", "pink", "blue"
    
    Returns:
    
    this settings object for chaining statements easily
  - setThemeCustom
```
public LazyGuiSettings setThemeCustom(int windowBorderColor,
                                      int normalBackgroundColor,
                                      int focusBackgroundColor,
                                      int normalForegroundColor,
                                      int focusForegroundColor)
```
    Sets a custom theme defined by individual hex colors.
    
    Parameters:
    
    windowBorderColor - color of the window border
    
    normalBackgroundColor - normal background color
    
    focusBackgroundColor - focus background color
    
    normalForegroundColor - normal foreground color
    
    focusForegroundColor - focus foreground color
    
    Returns:
    
    this settings object for chaining statements easily
  - setHideBuiltInFolders
```
public LazyGuiSettings setHideBuiltInFolders(boolean shouldHideFolders)
```
    Should the built-in folders start hidden? That is the automatically created gui folders like "options" and "saves". They will still exist and will try to load their values from json (unless overriden with other constructor settings) and the gui will still use their current values, they will just hide from the user. You can reveal them again after initialization with gui.show("options") and gui.show("saves")
    
    Parameters:
    
    shouldHideFolders - whether the built-in folders should start hidden
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setLoadLatestSaveOnStartup(boolean), setAutosaveOnExit(boolean)
  - setStartGuiHidden
```
public LazyGuiSettings setStartGuiHidden(boolean shouldHideGui)
```
    Should the gui start hidden? Toggle hiding with the 'H' hotkey.
    
    Parameters:
    
    shouldHideGui - whether the gui should start hidden
    
    Returns:
    
    this settings object for chaining statements easily
  - setLoadLatestSaveOnStartup
```
public LazyGuiSettings setLoadLatestSaveOnStartup(boolean loadLatestSaveOnStartup)
```
    When this is set to false it disables the default attempt to load the latest save.
    
    Parameters:
    
    loadLatestSaveOnStartup - load the last modified save when gui starts?
    
    Returns:
    
    this settings object for chaining statements easily
  - setLoadSpecificSaveOnStartup
```
public LazyGuiSettings setLoadSpecificSaveOnStartup(java.lang.String fileName)
```
    Loads a specific save file on startup, tries to look inside the save folder for the file first before assuming the user gave the absolute path. Also disables loading the latest save on startup.
    
    Parameters:
    
    fileName - name of the save file inside the save folder to load in the format "1" or "1.json" or a full absolute path to it anywhere on disk
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setLoadLatestSaveOnStartup(boolean), setLoadSpecificSaveOnStartupOnce(String)
  - setLoadSpecificSaveOnStartupOnce
```
public LazyGuiSettings setLoadSpecificSaveOnStartupOnce(java.lang.String fileName)
```
    Loads a specific save file on startup if the gui finds its save folder empty. Can be useful for fine-tuning global initial settings for all your gui sketches. Does not disable loading latest save on startup.
    
    Parameters:
    
    fileName - name of the save file to load in the format "1" or "1.json" in the save folder or a full absolute path to it anywhere on disk
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setLoadLatestSaveOnStartup(boolean), setLoadSpecificSaveOnStartup(String)
  - setAutosaveOnExit
```
public LazyGuiSettings setAutosaveOnExit(boolean autosaveEnabled)
```
    Should the GUI try to autosave its state before closing gracefully?
    
    Parameters:
    
    autosaveEnabled - should the sketch try to save when closing
    
    Returns:
    
    this settings object for chaining statements easily
  - setAutosaveLockGuardEnabled
```
public LazyGuiSettings setAutosaveLockGuardEnabled(boolean autosaveLockGuardEnabled)
```
    When the lock guard is enabled it checks whether the last frame took too long and does not autosave if it did. Autosaving isn't always a good idea - this protects the user against cases when the sketch gets stuck in an endless loop that may have been caused by selecting some dangerous gui values.
    
    Parameters:
    
    autosaveLockGuardEnabled - should the autosave be guarded against saving bad
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setAutosaveLockGuardMillisLimit(int)
  - setAutosaveLockGuardMillisLimit
```
public LazyGuiSettings setAutosaveLockGuardMillisLimit(int autosaveLockGuardMillisLimit)
```
    The millis limit for the last frame for the autosave lock guard to take effect and block autosaving. Only has an effect when autosave lock guard is enabled.
    
    Parameters:
    
    autosaveLockGuardMillisLimit - last frame limit in millis
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setAutosaveLockGuardEnabled(boolean)
  - setMouseHideWhenDragging
```
public LazyGuiSettings setMouseHideWhenDragging(boolean mouseShouldHideWhenDragging)
```
    Should the mouse be hidden when dragging a slider or a plot? Hiding the mouse can give the user a more immersive feeling, but it can also be disorienting. The mouse can still hit the corners of your screen when hidden. On mouse released - the hidden mouse position resets to where the dragging started.
    
    Parameters:
    
    mouseShouldHideWhenDragging - should the mouse hide when dragging an element like a slider?
    
    Returns:
    
    this settings object for chaining statements easily
  - setMouseConfineToWindow
```
public LazyGuiSettings setMouseConfineToWindow(boolean mouseShouldConfineToWindow)
```
    Should the mouse be locked inside the sketch window? You can still exit the sketch with ESC.
    
    Parameters:
    
    mouseShouldConfineToWindow - confine mouse to sketch window
    
    Returns:
    
    this settings object for chaining statements easily
  - setCellSize
```
public LazyGuiSettings setCellSize(float cellSize)
```
    This sets the cell size that all gui controls use to draw themselves. Also sets the distance between guide grid dots in the background.
    
    Parameters:
    
    cellSize - global cell size
    
    Returns:
    
    this settings object for chaining statements easily
  - setMainFontSize
```
public LazyGuiSettings setMainFontSize(int mainFontSize)
```
    This sets the main font size used everywhere by the gui. If you'd like to also change the text color, use a custom theme - text falls under foreground color there.
    
    Parameters:
    
    mainFontSize - main font size
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setThemeCustom(int, int, int, int, int)
  - setSideFontSize
```
public LazyGuiSettings setSideFontSize(int sideFontSize)
```
    This sets the usually smaller side font size used in a few places by the gui. If you'd like to also change the text color, use a custom theme - text falls under foreground color there.
    
    Parameters:
    
    sideFontSize - side font size
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    setThemeCustom(int, int, int, int, int)
  - setSketchNameOverride
```
public LazyGuiSettings setSketchNameOverride(java.lang.String sketchNameOverride)
```
    Overrides what the root window title displays. It shows the name of your sketch by default, but you can set a custom value here.
    
    Parameters:
    
    sketchNameOverride - name to display in root window title
    
    Returns:
    
    this settings object for chaining statements easily
  - setAutosuggestWindowWidth
```
public LazyGuiSettings setAutosuggestWindowWidth(boolean shouldAutosuggest)
```
    Override the GUI trying to make window widths fit its contents snugly based on longest text in the row at window opening time. Setting this to false disables this behavior and sets all windows to some default size fitting for the folder type.
    
    Parameters:
    
    shouldAutosuggest - should the windows try to auto-detect optimal width?
    
    Returns:
    
    this settings object for chaining statements easily
  - setSmooth
```
public LazyGuiSettings setSmooth(int smoothValue)
```
    Override the default antialiasing level of `smooth(4)` for the GUI canvas. A value of 0 will set `noSmooth()` instead. This will not affect the smoothing level of your entire sketch - it will only affect the GUI, which will still be drawn as an image on top of your potentially differently smoothed sketch.
    
    Parameters:
    
    smoothValue - the value to be passed to `smooth()` for the gui canvas - if 0 then `noSmooth()` is used
    
    Returns:
    
    this settings object for chaining statements easily
    
    See Also:
    
    smooth(), a value of 8 breaks PGraphics on some machines
  - setHideRadioValue
```
public LazyGuiSettings setHideRadioValue(boolean hideRadioValue)
```
    Hide the selected value text on the right of the radio row and replace it with a generic folder icon. This can be useful when you want to use radio buttons with longer string values. The option strings will still be visible once you open the radio folder. This applies globally to all radio buttons and the value text is visible by default.
    
    Parameters:
    
    hideRadioValue - whether to hide the radio value text
    
    Returns:
    
    this settings object for chaining statements easily
  - setShowSquigglyEqualsInsideSliders
```
public LazyGuiSettings setShowSquigglyEqualsInsideSliders(boolean showSquigglyEquals)
```
    Show the approximately equals double tilde '≈' in sliders when visually shown values are not exactly equal to the actual float values used by the program. This happens when the display value is rounded by the currently selected slider precision (controlled by the mouse wheel). This is false by default, assuming people care more about the horizontal space that would be taken up by '≈ ' than the exact precision of the values. Even when true, this doesn't show it everywhere, (for example in plot rows where multiple slider values are combined, because the horizontal space is very limited there), for more details about the implementation see
```
SliderNode.displaySquigglyEquals
```
    and the related SliderNode constructor that sets it.
    Parameters:
    
    showSquigglyEquals - whether to show the squiggly equals '≈' in sliders where the underlying values are not exactly what is shown
    
    Returns:
    
    this settings object for chaining statements easily
  - setHotkeyMouseWheelActive
```
public LazyGuiSettings setHotkeyMouseWheelActive(boolean shouldMouseChangePrecision)
```
    The mouse wheel changes a slider's precision when hovering over it. This is true by default, but it can be useful to disable if you don't have a good mouse wheel. Alternative hotkeys to achieve a change of precision are '*' and '/'. You can also change precision by typing in a numeric value into the slider like 0.56, which the slider will detect and match by setting the precision to 0.01.
    
    Parameters:
    
    shouldMouseChangePrecision - whether the mouse wheel should change the precision of the slider
    
    Returns:
    
    this settings object for chaining statements easily
  - setKeyboardDelay
```
public LazyGuiSettings setKeyboardDelay(int millisDelayToSet)
```
    Set the delay in milliseconds for the keyboard buffer to be considered a new input.
    
    Parameters:
    
    millisDelayToSet - the delay in milliseconds
    
    Returns:
    
    this settings object for chaining statements easily
  - setCustomGuiDataFolder
```
public LazyGuiSettings setCustomGuiDataFolder(java.lang.String customPath)
```
    Set a custom data folder for the gui to use for json saves and png screenshots. Can be either absolute path or relative to the sketch data folder. It is inside the individual sketch data folder by default under /gui/. Multiple sketches can use the same path, their data will still be separated by their sketch names. The data folder will be created if it doesn't exist.
    
    Parameters:
    
    customPath - the custom path to set, "gui" by default
    
    Returns:
    
    this settings object for chaining statements easily
  - setWindowRestoreOnlyOnStartup
```
public LazyGuiSettings setWindowRestoreOnlyOnStartup()
```
    The GUI will load window positions, sizes and openness on startup and then ignore any saved window states when loading other saves.
    
    Returns:
    
    this settings object for chaining statements easily
  - setWindowRestoreAlways
```
public LazyGuiSettings setWindowRestoreAlways()
```
    The GUI will always load window positions, sizes and openness on startup and then always try to overwrite them when loading other saves.
    
    Returns:
    
    this settings object for chaining statements easily
  - setWindowRestoreNever
```
public LazyGuiSettings setWindowRestoreNever()
```
    The GUI will never load window positions, sizes and openness. You will have to manually open and position the windows every time.
    
    Returns:
    
    this settings object for chaining statements easily
  - setDefaultGradientBlendType
```
public LazyGuiSettings setDefaultGradientBlendType(java.lang.String defaultGradientBlendType)
```
    Set the default gradient blend type for all gradient control elements.
    
    Parameters:
    
    defaultGradientBlendType - one of the allowed strings in the gradient "blend" radio options - "mix", "hsv", "oklab"
    
    Returns:
    
    this settings object for chaining statements easily
  - setOverwriteLastLoadedSave
```
public LazyGuiSettings setOverwriteLastLoadedSave(boolean overwriteLastLoadedSave)
```
    Sets the custom new save file name to be the same as the last loaded save file whenever a save is loaded. This automatic custom save name replacement is not enabled by default, the default save names are incrementing integers. You can see and edit the current save name manually inside the text node at "saves/custom save name", this setting only overwrites that "custom save name" value whenever a json file is loaded. This setting can be useful for keeping a curated set of well-named saves distinct from each other, like various Magic the Gathering cards you're editing, making it easy to do work and update your save on a specific named card. LazyGui.createSave(String) ignores the custom save name, because the parameter already contains a file name. LazyGui.createSave() respects the custom save name or picks the next free integer when the custom name is empty.
    
    Parameters:
    
    overwriteLastLoadedSave - whether to overwrite the custom save name with the last loaded save name
    
    Returns:
    
    this settings object for chaining statements easily

Class LazyGuiSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LazyGuiSettings

Method Detail

setThemePreset

setThemeCustom

setHideBuiltInFolders

setStartGuiHidden

setLoadLatestSaveOnStartup

setLoadSpecificSaveOnStartup

setLoadSpecificSaveOnStartupOnce

setAutosaveOnExit

setAutosaveLockGuardEnabled

setAutosaveLockGuardMillisLimit

setMouseHideWhenDragging

setMouseConfineToWindow

setCellSize

setMainFontSize

setSideFontSize

setSketchNameOverride

setAutosuggestWindowWidth

setSmooth

setHideRadioValue

setShowSquigglyEqualsInsideSliders

setHotkeyMouseWheelActive

setKeyboardDelay

setCustomGuiDataFolder

setWindowRestoreOnlyOnStartup

setWindowRestoreAlways

setWindowRestoreNever

setDefaultGradientBlendType

setOverwriteLastLoadedSave