DebugUI

ClubCrawler.DOMUserInterface. DebugUI

Presents an expandable menu for the user to change debug messaging settings, which appear in the the DebugMessageBox. Creates a new instance of DebugUI for each nested object inside the object which it models.

Constructor

new DebugUI(element)

Source:
Parameters:
Name Type Description
element HTMLElement

The container element.

Members

children :Array

Source:

The DebugUIs and InputComponents which were created by the DebugUI.

Type:
  • Array
Source:

The drop down button with the title. When clicked, it will toggle showing of DebugUI.inputContainer.

Type:
  • HTMLElement

element :HTMLElement

Source:

The container element.

Type:
  • HTMLElement

inputContainer :HTMLElement

Source:

The element containing the options. Will be hidden or shown when DebugUI.dropDownElement is clicked

Type:
  • HTMLElement

settingsObject :ClubCrawler.Types.DebugConfig

Source:

The object whose properties to make configurable, which is the top-level DebugConfig for the first DebugUI created, then nested objects for the subsequent ones.

Type:

uiManager :ClubCrawler.UserInterface.DOMUIManager

Source:

The ui manager.

Type:
  • ClubCrawler.UserInterface.DOMUIManager

Methods

addDropDownListener()

Source:

Adds a click listener to DebugUI.dropDownElement.

loadDebugObject(settingsObject, name)

Source:

Creates a check box for each boolean property in the settings object. Creates a new DebugUI for each nested object in the settings object.

Parameters:
Name Type Default Description
settingsObject Object

The object to load and create buttons for.
name string debug

The name for the drop down button to be displayed in DebugUI.dropDownElement.
Fires:

loadManager(uiManager)

Source:

load the UI manager into this and all children objects

Parameters:
Name Type Description
uiManager ClubCrawler.DOMUserInterface.DOMUIManager

The manager