hg/stx-libtool2: comparison UIHelpTool.st

equal deleted inserted replaced

-:325eba9f37b7
+:a1bb632b1e00
 ^
 #(#FullSpec
 #window:
 #(#WindowSpec
-#name: 'HelpTool'
+#name: 'unnamed canvas'
-#layout: #(#LayoutFrame 90 0 295 0 375 0 565 0)
+#layout: #(#LayoutFrame 118 0 430 0 403 0 700 0)
 #label: 'unnamed canvas'
 #min: #(#Point 10 10)
 #max: #(#Point 1160 870)
-#bounds: #(#Rectangle 90 295 376 566)
+#bounds: #(#Rectangle 118 430 404 701)
 #usePreferredExtent: false
 )
 #component:
 #(#SpecCollection
 #collection:
 #(
 #(#ActionButtonSpec
 #name: 'AddButton'
 #activeHelpKey: #addHelpTextKey
 #label: 'Add'
-#model: #accept
+#model: #add
 #extent: #(#Point 44 24)
 )
 #(#ActionButtonSpec
 #name: 'RemoveButton'
 #activeHelpKey: #removeHelpTextKey
 #(#InputFieldSpec
 #name: 'helpKeyInputField'
 #layout: #(#LayoutFrame 1 0.5 29 0 -3 1 51 0)
 #activeHelpKey: #currentHelpTexts
 #model: #listModel
+#immediateAccept: false
 )
 #(#SequenceViewSpec
 #name: 'listOfHelpSpecClassesView'
 #layout: #(#LayoutFrame 1 0.5 53 0 -3 1 -1 0.5)
 #activeHelpKey: #listOfHelpSpecClasses
 #(#MenuItem
 #label: '-'
 )
 #(#MenuItem
 #label: 'Save'
-#value: #doInstallHelpSpec
+#value: #doSave
 )
 #(#MenuItem
 #label: '-'
 )
 #(#MenuItem
 ! !
 !UIHelpTool methodsFor:'accessing'!
 dictionaries
-"return dictionaries"
+"get the dictionary of the help dictionaries of the classes having help specs
+"
 ^dictionaries
 !
 dictionaries:aDictionaryOfDictionaries
-"set dictionaries"
+"set a dictionary of the help dictionaries of the classes having help specs
+"
 (dictionaries := aDictionaryOfDictionaries) isNil ifTrue:[
 dictionaries := Dictionary new.
 ].
 self updateList.
 !
 dictionary
-"return dictionary"
+"get the dictionary of the selected class
+"
-^ dictionary
+^dictionary
 !
 dictionary:aDictionary
-"set dictionary"
+"set dictionary of the selected class
+"
 (dictionary := aDictionary) isNil ifTrue:[
 dictionary := Dictionary new.
 ].
 self updateList
 !
 helpKey
+"get the help key of selected help text
+"
 listSelection size ~~ 0 ifTrue:[
 ^ listSelection asSymbol
 ].
 ^ nil
 !
 helpKey:aKey
+"set the help key into the selection channel in order to show the help text
+"
 |key|
 aKey size ~~ 0 ifTrue:[
 key := aKey asString
 ].
 self listModel value:key
 !
 helpSpecFrom:aClass
-"read help text from an application associated with the class
+"read the help dictionary from aClass and find remaining classes
+'between' aClass and ApplicationModel
 "
 |help|
 isModified := false.
 specClass notNil
 self updateList
 !
 isModified
-^ isModified
+"answer whether the help tool was modified
+"
+^isModified
 !
 isModified: aBoolean
+"set the help tool as modified
+"
 isModified := aBoolean
 !
 modifiedHolder:aValueHolder
 "set the value holder set to true in case of modifying attributes
 !
 specClass
+"get the class on which the help tool works
+"
 ^specClass
 ! !
 !UIHelpTool methodsFor:'actions'!
-accept
-"accept the text
-"
-|view key txt list listChgd|
-(listSelection size == 0 or:[(view := self editTextView) isNil]) ifFalse:[
-txt    := view contents asString.
-key    := listSelection asSymbol.
-list   := self listChannel value.
-(listChgd := (dictionary at:key ifAbsent:nil) isNil) ifTrue:[
-list add:key.
-].
-dictionary at:key put:txt.
-listChgd ifTrue:[
-self updateList.
-(builder componentAt: #listOfHelpKeysView) selection: (list indexOf: key).
-].
-isModified := true.
-modifiedHolder notNil ifTrue: [modifiedHolder value:true]
-]
-!
-delete
-"delete selected help key
-"
-listSelection notNil
-ifTrue:
-[
-dictionary removeKey: listSelection asSymbol ifAbsent: nil.
-self remove.
-self updateList.
-isModified := true.
-modifiedHolder notNil ifTrue: [modifiedHolder value:true]
-]
-!
 helpSpecClassSelected
+"extract the help dictionary from the selected class and make it current
+"
 |clsName|
 clsName := self selectionOfHelpSpecClass value.
 (dictionary := dictionaries at: clsName ifAbsent: nil) isNil
 ]
 !
-installHelpSpecInto:aClass
+installHelpSpecOnClass:aClass
-"install help text
+"save the help dicts in aClass which is subclass of ApplicationModel"
-"
 |cls src helpSpec|
 cls := self applicationClassAssociatedWith:aClass.
 cls isNil ifTrue:[
-^ self information:'No application class defined!!'.
+self information:'No application class defined!!'.
-].
+^nil
+].
-aClass = cls name asString
-ifTrue: [self listOfHelpSpecClasses value do: [:c| c ~~ cls name ifTrue: [self installHelpSpecInto: (Smalltalk at: c). isModified := true]]].
+(cls isSubclassOf: ApplicationModel) ifFalse:[
+self information: 'Cannot save help spec into class ', cls name asBoldText, ',\because it is not a subclass of ApplicationModel!!' withCRs.
-isModified not ifTrue:[
 ^nil
 ].
 helpSpec := dictionaries at: cls name
 ifAbsent: [aClass = cls name asString ifTrue: [dictionary] ifFalse: [Dictionary new]].
 ifFalse: [helpSpec at: h key put: h value]].
 ]
 ].
 helpSpec isEmpty ifTrue:[
-(cls superclass respondsTo: #helpSpec) ifTrue: [cls class removeSelector: #helpSpec].
+^(cls superclass respondsTo: #helpSpec) ifTrue: [cls class removeSelector: #helpSpec].
-^nil
 ].
 src  := '' writeStream.
 src nextPutAll:
 ].
 src nextPutLine:t storeString; cr.
 ].
 src nextPutLine:')'.
-Compiler compile:(src contents)
+Compiler
-forClass:cls class
+compile:(src contents)
-inCategory:'help specs'.
+forClass:cls class
+inCategory:'help specs'.
+!
+installHelpSpecsOnClass:aClass
+"save the help dicts on aClass and its superclasses which are subclasses of ApplicationModel
+"
+|cls helpSpecClasses|
+isModified ifFalse:[
+^nil
+].
+cls := aClass isClass ifTrue: [aClass name] ifFalse: [aClass].
+(helpSpecClasses := self listOfHelpSpecClasses value) notNil
+ifTrue:
+[
+(helpSpecClasses includes: cls) ifFalse: [helpSpecClasses add: cls].
+helpSpecClasses do: [:clsName| (self installHelpSpecOnClass: clsName) isNil ifTrue: [^isModified := false]].
+]
+ifFalse:
+[
+self installHelpSpecOnClass: cls
+].
 isModified := false.
-!
-remove
-"remove selected help key
-"
-self listModel value: nil.
-self updateList.
-modifiedHolder notNil ifTrue: [modifiedHolder value:true]
 ! !
 !UIHelpTool methodsFor:'aspects'!
 listChannel
+"get the value holder of the help texts
+"
 |holder|
 (holder := builder bindingAt:#listChannel) isNil ifTrue:[
 builder aspectAt:#listChannel put:(holder :=  OrderedCollection new asValue).
 ].
 ^ holder
 !
 listModel
+"get the value holder of the help key
+"
 |holder|
 (holder := builder bindingAt:#listModel) isNil ifTrue:[
 holder := AspectAdaptor new subject:self; forAspect:#listSelection.
 builder aspectAt:#listModel put:holder.
 ].
 ^ holder
 !
 listOfHelpSpecClasses
+"get the value holder of the specClass and its superclasses
+which are subclasses of ApplicationModel
+"
 |holder|
 (holder := builder bindingAt:#listOfHelpSpecClasses) isNil ifTrue:[
 builder aspectAt:#listOfHelpSpecClasses put: (holder := List new)
 ].
 ^ holder
 !
 selectionOfHelpSpecClass
+"get the value holder of the selected help spec class
+"
 |holder|
 (holder := builder bindingAt:#selectionOfHelpSpecClass) isNil ifTrue:[
 builder aspectAt:#selectionOfHelpSpecClass put: (holder := ValueHolder new)
 ].
 ^ holder
 ! !
 !UIHelpTool methodsFor:'initialization'!
 initialize
-"setup instance attributes
+"initialize instance variables
 "
 super initialize.
 dictionary   := Dictionary new.
 dictionaries := Dictionary new.
-isModified := false.
+isModified   := false.
 ! !
 !UIHelpTool methodsFor:'private'!
 ].
 ^ view
 !
 extractHelpSpecForClass: aClass
+"extract the help dictionary of aClass, it current and return it
+"
 |helpSpecSuperClass superHelpSpecKeys helpSpec|
 ((aClass class implements: #helpSpec)
 and: [(helpSpecSuperClass := aClass allSuperclasses detect: [:cls| cls class implements: #helpSpec] ifNone: nil) notNil])
 ifTrue:
 ].
 ^dictionary := Dictionary new
 !
 findHelpSpecForKey: aHelpKey
-"update list from dictionary
+"find the help spec class including aHelpKey in its help dictionary and make it current
 "
 |dictTemp helpSpecClass superHelpSpecKeys helpSpec|
 aHelpKey isNil ifTrue: [^nil].
 dictTemp := dictionary.
 !
 updateList
-"update list from dictionary
+"update the list channel from dictionary
 "
 self listChannel value: dictionary keys asSortedCollection
 ! !
 !UIHelpTool methodsFor:'queries'!
 applicationClassAssociatedWith:aClass
 "get application class keeping the associated help text or nil
 "
 |cls|
-cls := self resolveName:aClass.
+((cls := self resolveName:aClass) notNil and:[cls includesBehavior:UISpecification]) ifTrue:[
+^UISpecificationTool
-(cls notNil and:[cls includesBehavior:UISpecification]) ifTrue:[
+].
-^ UISpecificationTool
+^cls
-].
-^ cls
 ! !
 !UIHelpTool methodsFor:'selection'!
 listSelection:aSelection
 "current selection changed
 "
 |txt view sel|
-aSelection isNil ifTrue: [(builder componentAt: #listOfHelpKeysView) selection: nil].
+aSelection isNil
-self findHelpSpecForKey: aSelection.
+ifTrue: [(builder componentAt: #listOfHelpKeysView) selection: nil]
+ifFalse: [(dictionary includesKey: aSelection asSymbol) ifFalse: [self findHelpSpecForKey: aSelection]].
 aSelection isNumber ifTrue:[
 aSelection ~~ 0 ifTrue:[
 sel := self listChannel value at:aSelection
 ]
 ! !
 !UIHelpTool methodsFor:'startup / release'!
 closeRequest
+"before closing the help tool, ask for permission
+"
 (isModified and:[self masterApplication isNil]) ifTrue:[
 (self confirm:'Exit without saving your modifications?') ifFalse:[
 ^ self
 ]
 ].
 "
 super openInterface: #windowSpecForStandAlone
 ! !
 !UIHelpTool methodsFor:'user interactions'!
+accept
+"accept the help text
+"
+|view key txt list listChgd|
+(listSelection size == 0 or:[(view := self editTextView) isNil]) ifFalse:[
+txt    := view contents asString.
+key    := listSelection asSymbol.
+list   := self listChannel value.
+(listChgd := (dictionary at:key ifAbsent:nil) isNil) ifTrue:[
+list add:key.
+].
+dictionary at:key put:txt.
+listChgd ifTrue:[
+self updateList.
+(builder componentAt: #listOfHelpKeysView) selection: (list indexOf: key).
+].
+isModified := true.
+modifiedHolder notNil ifTrue: [modifiedHolder value:true]
+]
+!
+add
+"add help key
+"
+self listModel value: (builder componentAt: #helpKeyInputField asSymbol) contents.
+self accept
+!
+delete
+"delete selected help key
+"
+listSelection notNil
+ifTrue:
+[
+dictionary removeKey: listSelection asSymbol ifAbsent: nil.
+self remove.
+self updateList.
+isModified := true.
+modifiedHolder notNil ifTrue: [modifiedHolder value:true]
+]
+!
 doFromClass
 "setup new specification from a class accessed through to a dialog
 "
 |cls cls2 accepted|
 ].
 self warn:'No help spec found in class ', cls value asBoldText, '!!'.
 ]
 !
-doInstallHelpSpec
-"install help spec
-"
-self installHelpSpecInto:specClass
-!
 doReload
-"reload specification
+"reload the help dictionaries
 "
 |oldSel model|
 model  := self listModel.
 oldSel := model value.
 model value:nil.
 self helpSpecFrom:specClass.
 model value:oldSel.
 isModified := false.
+!
+doSave
+"save the help dictionaries
+"
+self installHelpSpecsOnClass:specClass
+!
+remove
+"remove selected help key
+"
+self listModel value: nil.
+self updateList.
+modifiedHolder notNil ifTrue: [modifiedHolder value:true]
 ! !
 !UIHelpTool class methodsFor:'documentation'!
 version

changeset 722	a1bb632b1e00
parent 717	fb90f37268be
child 740	e7362f3ab5e5