Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICloseAndCleaner<T>

Interface for an activity that has some cleanup action associated with it in addition to merely closing its widget in the main area.

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Properties

action

action: string

A label to use for the cleanup action.

closeAndCleanup

closeAndCleanup: function

A function to perform the close and cleanup action.

Type declaration

    • (widget: T): Promise<void>

    • Parameters

      • widget: T

      Returns Promise<void>

Optional isEnabled

isEnabled: function

An additional function that determines whether the extender is enabled. By default it is considered enabled if the application active widget is contained in the tracker. If this is also provided, the criterion is equivalent to tracker.has(widget) && extender.isEnabled(widget)

Type declaration

    • (widget: T): boolean

    • Parameters

      • widget: T

      Returns boolean

name

name: string

A label to use for the activity that is being cleaned up.

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Generated using TypeDoc