Class UILibraryBrowserDisplaySettings

Display settings for the UI Library Browser element.

Hierarchy (view full)

Constructors

Properties

isContentMode: boolean

Determines if the browser should work as a library content only mode and display globally all entries. If true, all other UI elements will be disabled, readOnly will be true, and the browser will display all content globally, regardless of the current path.

isDirectoriesVisible: boolean

Determines if folders should be displayed in the content.

isDragEnabled: boolean

Determines if dragging is enabled.

isLibraryWindow: boolean

Determines if the browser is part of the main library window.

isReadOnly: boolean

Determines if the browser should be read-only and not allow content editing. Dragging will also be disabled.

isShowingAffixResources: boolean

Determines if affix resources are visible.

isToolBarEnabled: boolean

Determines if the toolbar should be enabled.

isTopBarEnabled: boolean

Determines if the top bar, consisting the breadcrumb navigation, tag editor and search is be enabled.

isTreeViewEnabled: boolean

Determines if the tree view side-bar should be enabled.

resourceFilterCallback: ((resourceEntry: ResourceEntry) => boolean)

An optional filter callback to determine if a resource should be displayed.

resourceTypeFilter: Type | EnumValue<ResourceType, number>

The optional resource filter.

Accessors

  • get isGlobal(): boolean
  • Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

    Returns boolean

Methods

  • Marks the settings as dirty and invokes the onDirty event handler.

    Returns void

    This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Events

Invoked when the settings changed.

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.