eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'ProgressNotification':

Home

Documentation
www.exept.de
Everywhere
for:
[back]

Class: ProgressNotification


Inheritance:

   Object
   |
   +--GenericException
      |
      +--Notification
         |
         +--UserNotification
            |
            +--ActivityNotification
               |
               +--ProgressNotification

Package:
stx:libwidg2
Category:
Kernel-Exceptions-Notifications
Version:
rev: 1.10 date: 2018/03/06 18:41:48
user: cg
file: ProgressNotification.st directory: libwidg2
module: stx stc-classLibrary: libwidg2

Description:


This should be used in long-going activities to tell the caller about any
progress (percentage).
Being a notification, it will be ignored if no one is interested.
If someone is interested, the caller may present this information as a progress-bar,
percentage display or whatever is useful in the UI.
Examples are:
    http-requests, ftp requests, long lint checks etc.

See examples (look for references to this class) on how this is used.

 ProgressNotification handle:[:ex |
    Transcript showCR:(ex progressValue rounded).
    ex proceed.
 ] do:[
     #(0 1 2 3 4 5 6 6 7 8 9)
         do:[:i| Delay waitForMilliseconds: 50]
         displayingProgress: 'Progress'
 ].


Class protocol:

notification
o  notify: message progress: aPercentageNumber

o  progressPercentage: aPercentageNumber

o  progressPercentage: aPercentageNumber statusInfo: statusInfo


Instance protocol:

accessing
o  progressValue
answer the parameter that was passed to the notification requrest
as percentage parameter

o  statusInfo
any additional info (opaque to me)

o  statusInfo: something
any additional info (opaque to me)



ST/X 7.1.0.0; WebServer 1.663 at exept.de:8081; Wed, 19 Sep 2018 07:40:55 GMT