editor › Globals › FakeProgressBar

Class: FakeProgressBar

This class makes use of a NotificationDisplayController combined with FakeProgress to create the illusion of a realistic progressbar, exponentially slowering the progress for a given perios of time. It will converge to a given maximum but never reach it. This class is useful for eg. server requests, since the are no single callbacks of the progress.

Hierarchy

• FakeProgressBar

Index

Constructors

• constructor

Properties

• fakeProgress
• initialTimeout
• notificationController
• operationFinished
• operationId
• progressShown
• waitingMessage

Methods

• _update
• cancelOperation
• finishOperation
• startOperation

Constructors

constructor

+ new FakeProgressBar(notificationController: any, operationId: string, waitingMessage: string, expectedOperationDuration: number): FakeProgressBar

Defined in src/util/FakeProgressBar.ts:17

Parameters:

Name	Type	Description
notificationController	any	-
operationId	string	-
waitingMessage	string	What should be displayed as the controller message while the progress bar runs through
expectedOperationDuration	number	-

Returns: FakeProgressBar

Properties

Private fakeProgress

• fakeProgress: FakeProgress

Defined in src/util/FakeProgressBar.ts:11

---

Private initialTimeout

• initialTimeout: number = Config.get("interaction.waitTimeUntilUserFeedback")

Defined in src/util/FakeProgressBar.ts:13

---

Private Readonly notificationController

• notificationController: any

Defined in src/util/FakeProgressBar.ts:23

---

Private operationFinished

• operationFinished: boolean = false

Defined in src/util/FakeProgressBar.ts:15

---

Private Readonly operationId

• operationId: string

Defined in src/util/FakeProgressBar.ts:24

---

Private progressShown

• progressShown: boolean = false

Defined in src/util/FakeProgressBar.ts:17

---

Private Readonly waitingMessage

• waitingMessage: string

Defined in src/util/FakeProgressBar.ts:25

What should be displayed as the controller message while the progress bar runs through

Methods

Private _update

▸ _update(): void

Defined in src/util/FakeProgressBar.ts:66

Returns: void

---

cancelOperation

▸ cancelOperation(): void

Defined in src/util/FakeProgressBar.ts:61

Returns: void

---

finishOperation

▸ finishOperation(): void

Defined in src/util/FakeProgressBar.ts:56

Returns: void

---

startOperation

▸ startOperation(): void

Defined in src/util/FakeProgressBar.ts:32

Returns: void