ActivityNotification.st
author Claus Gittinger <cg@exept.de>
Wed, 13 Feb 2019 22:10:53 +0100
changeset 23735 77363fc65861
parent 23222 5bcfeacda179
permissions -rw-r--r--
#FEATURE by cg class: OrderedDictionary changed: #copyValuesFrom:to: class: OrderedDictionary class changed: #version_CVS
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
23222
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
     1
"{ Encoding: utf8 }"
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
     2
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     3
"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     4
 COPYRIGHT (c) 2003 by eXept Software AG
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     5
              All Rights Reserved
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     6
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     7
 This software is furnished under a license and may be used
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     8
 only in accordance with the terms of that license and with the
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
     9
 inclusion of the above copyright notice.   This software may not
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    10
 be provided or otherwise made available to, or used by, any
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    11
 other person.  No title to or ownership of the software is
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    12
 hereby transferred.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    13
"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    14
"{ Package: 'stx:libbasic' }"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    15
23222
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    16
"{ NameSpace: Smalltalk }"
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    17
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    18
UserNotification subclass:#ActivityNotification
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    19
	instanceVariableNames:''
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    20
	classVariableNames:''
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    21
	poolDictionaries:''
11194
0525f26f3b14 category
Claus Gittinger <cg@exept.de>
parents: 10515
diff changeset
    22
	category:'Kernel-Exceptions-Notifications'
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    23
!
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    24
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    25
!ActivityNotification class methodsFor:'documentation'!
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    26
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    27
copyright
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    28
"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    29
 COPYRIGHT (c) 2003 by eXept Software AG
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    30
              All Rights Reserved
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    31
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    32
 This software is furnished under a license and may be used
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    33
 only in accordance with the terms of that license and with the
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    34
 inclusion of the above copyright notice.   This software may not
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    35
 be provided or otherwise made available to, or used by, any
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    36
 other person.  No title to or ownership of the software is
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    37
 hereby transferred.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    38
"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    39
!
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    40
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    41
documentation
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    42
"    
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    43
    ActivityNotification can be raised from deeply nested methods, which are going to perform
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    44
    some long-time activity.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    45
8371
4493f5ac7405 *** empty log message ***
ca
parents: 8329
diff changeset
    46
    If there is a handler for the ActivityNotification, that one is called,
23222
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    47
    passing the argument. The handler should show this message wherever it likes,
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    48
    and proceed. 
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    49
    If there is no handler, ActivityNotification is simply ignored.
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    50
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    51
    This is very useful to pass busy messages up to some higher level (typically a view)
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    52
    which likes to display that message in its label or a busy-box.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    53
    It could also be put into some logfile or printed on the standard output/error.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    54
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    55
    [see also:]
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    56
        Signal
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    57
"
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    58
! !
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    59
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    60
!ActivityNotification class methodsFor:'initialization'!
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    61
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    62
initialize
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    63
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    64
    NotifierString := 'activity'.
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    65
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    66
    "
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    67
     self initialize
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    68
    "
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    69
! !
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    70
10515
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    71
!ActivityNotification methodsFor:'default actions'!
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    72
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    73
defaultAction
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    74
    "the default action is to do nothing"
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    75
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    76
    self proceed.
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    77
! !
af20fca71049 Do nothing, if not handled
Stefan Vogel <sv@exept.de>
parents: 8371
diff changeset
    78
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    79
!ActivityNotification class methodsFor:'documentation'!
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    80
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    81
version
23222
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    82
    ^ '$Header$'
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    83
! !
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    84
23222
5bcfeacda179 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 11194
diff changeset
    85
8329
1828c8969866 initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    86
ActivityNotification initialize!