PreferencesDialog¶

Overview¶

Dialog with preferences to enable or disable various features for the simulation. Groups of preferences are organized and displayed in a tab panel.

Once the dialog is created it is never destroyed so listeners and components do not need to be disposed.

@author Jesse Greenberg (PhET Interactive Simulations)

Class PreferencesDialog¶

import { PreferencesDialog } from 'scenerystack/sim';

Constructor¶

new PreferencesDialog( preferencesModel : PreferencesModel, providedOptions? : PreferencesDialogOptions )¶

Instance Methods¶

focusSelectedTab()¶

Move focus to the selected tab. Generally to be used when opening the dialog.

Static Properties¶

TAB_FONT¶

(readonly)

Font and options for the text that labels a tab in the dialog.

TAB_OPTIONS¶

(readonly)

TITLE_FONT¶

(readonly)

The font for a title of a panel in the dialog.

CONTENT_FONT¶

(readonly)

The font, max width, and options for most text content in the dialog.

CONTENT_MAX_WIDTH¶

(readonly)

PANEL_SECTION_CONTENT_OPTIONS¶

(readonly)

PANEL_SECTION_LABEL_FONT¶

(readonly)

The font, max width, and options for a label for a section of content in the dialog.

PANEL_SECTION_LABEL_MAX_WIDTH¶

(readonly)

PANEL_SECTION_LABEL_OPTIONS¶

(readonly)

CONTENT_SPACING¶

(readonly)

Default spacing between unique items in a preferences dialog

VERTICAL_CONTENT_SPACING¶

(readonly)

Default vertical spacing between grouped items (radio buttons, vertical checkboxes, ...)

CONTENT_INDENTATION_SPACING¶

(readonly)

Content or UI component intendentation under a PreferencesPanelSection title.

LABEL_CONTENT_SPACING¶

(readonly)

Default vertical spacing between a label and its collection of contents for a control in the dialog.

Source Code¶

See the source for PreferencesDialog.ts in the joist repository.