Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IClearer<T>

Interface for an activity that wants to register a 'Clear...' menu item

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Properties

Optional clearAll

clearAll: (widget: T) => void

Type declaration

    • (widget: T): void

    • A function to clear all of an activity.

      Parameters

      • widget: T

      Returns void

Optional clearAllLabel

clearAllLabel: (n: number) => string

Type declaration

    • (n: number): string

    • A function to create the label for the clearAllaction.

      This function receives the number of items n to be able to provided correct pluralized forms of translations.

      Parameters

      • n: number

      Returns string

Optional clearCurrent

clearCurrent: (widget: T) => void

Type declaration

    • (widget: T): void

    • A function to clear the currently portion of activity.

      Parameters

      • widget: T

      Returns void

Optional clearCurrentLabel

clearCurrentLabel: (n: number) => string

Type declaration

    • (n: number): string

    • A function to create the label for the clearCurrentaction.

      This function receives the number of items n to be able to provided correct pluralized forms of translations.

      Parameters

      • n: number

      Returns string

Optional isEnabled

isEnabled: (widget: T) => boolean

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

    • 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)

      Parameters

      • widget: T

      Returns boolean

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Generated using TypeDoc