Class DialogPlugin

Plugin base class for temporary UI dialogs such as confirmations, settings panels, and wizards.

Hierarchy (View Summary)

IPlugin
- DialogPlugin

Index

Constructors

Properties

id pluginSystem

Methods

deinit getTypeName isOfType isSame show

Constructors

constructor

new DialogPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): DialogPlugin
Constructs a new DialogPlugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns DialogPlugin
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The PluginSystem instance that owns and manages this plugin.

Methods

deinit

deinit(): void
Tears down the plugin and releases its resources.

Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

show

show(parent: Widget): Dialog
Creates and displays the dialog as a child of the given parent widget, returning the resulting Dialog instance.
Parameters
- parent: Widget
Returns Dialog