Smalltalk/X Webserver

Documentation of class 'ToolApplicationModel':

Class: ToolApplicationModel

Inheritance
Description
Class protocol
Instance protocol
Private classes

Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--ToolApplicationModel
            |
            +--AbstractLauncherApplication
            |
            +--AssistantApplication
            |
            +--MultiViewToolApplication
            |
            +--ResourceSpecEditor
            |
            +--Tools::ChangeSetBrowser2

Package:: stx:libview2

Category:: Interface-Framework

Version:: rev: 1.188 date: 2023/11/28 07:39:05; user: stefan; file: ToolApplicationModel.st directory: libview2; module: stx stc-classLibrary: libview2

Description:

Framework class for tool applications (UIPainter, MenuEditor etc.).
Provides hooks for modifiedChannels, history management,
showing help texts, about menu, help menu etc.

copyrightCOPYRIGHT (c) 1997 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice. This software may not
be provided or otherwise made available to, or used by, any
other person. No title to or ownership of the software is
hereby transferred.

Class protocol:

accessing

allToolInstances

authorLinesForAboutBox

extracts the author(s) from the documentation method.

forgetInstance: anInstance

label

returns the label for the tool instances of this class;
extracted from the class name (inserts spaces before UC chars);
can be redefined in subclasses

rememberInstance: anInstance

settings

returns the settings dictionary

showingHelp

returns true if active help is turned on for instances of this class

Usage example(s):

     self withAllSubclassesDo:[:cls | cls showingHelp:false]
     WorkspaceApplication showingHelp

showingHelp: aBoolean

enable/disable active help for instances of this class

Usage example(s):

     self withAllSubclassesDo:[:cls | cls showingHelp:false]

clipboard

clipboard: returns the clipboard of this tool class
clipboard: anEditObject: sets the clipboard for this tool class

help

openAboutSTX: opens an about box (on ST/X)
openHTMLDocument: anHTMLFilename: opens a HTML browser on aHTMLFilename, which can be an absolute filename,
or a filename relative to the doc folder

help specs

helpSpec: This resource specification was automatically generated
by the UIHelpTool of ST/X.

history

getFileHistory: returns the file-history for this tool class
getHistory: returns the history for this tool class
historyMaxSize: returns the maximum size for the history of this tool class

image specs

desktopIcon: returns the icon used for the desktop
menuIcon: returns the icon used for the menu bar

interface specs

windowSpecForCommit

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

     UIPainter new openOnClass:ToolApplicationModel andSelector:#windowSpecForCommit
     ToolApplicationModel new openInterface:#windowSpecForCommit

windowSpecForCommitWithoutChannels

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

     UIPainter new openOnClass:ToolApplicationModel andSelector:#windowSpecForCommitWithoutChannels
     ToolApplicationModel new openInterface:#windowSpecForCommitWithoutChannels

windowSpecForInfoBar

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

     UIPainter new openOnClass:ToolApplicationModel andSelector:#windowSpecForInfoBar
     ToolApplicationModel new openInterface:#windowSpecForInfoBar

windowSpecForInfoBarWithClock

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

     UIPainter new openOnClass:ToolApplicationModel andSelector:#windowSpecForInfoBarWithClock
     ToolApplicationModel new openInterface:#windowSpecForInfoBarWithClock

menu specs

menuAbout

This resource specification was automatically generated
by the MenuEditor of ST/X.

Usage example(s):

     MenuEditor new openOnClass:ToolApplicationModel andSelector:#menuAbout
     (Menu new fromLiteralArrayEncoding:(ToolApplicationModel menuAbout)) startUp

menuHelp

This resource specification was automatically generated
by the MenuEditor of ST/X.

Usage example(s):

     MenuEditor new openOnClass:ToolApplicationModel andSelector:#menuHelp
     (Menu new fromLiteralArrayEncoding:(ToolApplicationModel menuHelp)) startUp

xxxmenuFont

This resource specification was automatically generated
by the MenuEditor of ST/X.

Usage example(s):

     MenuEditor new openOnClass:ToolApplicationModel andSelector:#xxxmenuFont
     (Menu new fromLiteralArrayEncoding:(ToolApplicationModel xxxmenuFont)) startUp

queries

isAbstract: (comment from inherited method)
self isAbstract

startup & release

preSnapshot

removes the clipboard before snap shoting

uninitialize

resets the class instance variables

Usage example(s):

     self withAllSubclasses do:[:c | c uninitialize]

Instance protocol:

aspects

acceptChannel: returns a valueHolder which can be set to true to force all inputFields
to accept their value.
canCopyHolder: returns whether can copy as value holder
canCutHolder: returns whether can cut as value holder
canPasteHolder: returns whether can paste as value holder
canUndoHolder: returns whether can undo as value holder
enablingCommitButtonsHolder: returns the enabling of the commit of this tool as value holder
havingDocumentationHolder: returns the enabling of having documentation for this tool as value holder
infoLabelHolder: returns the info label as value holder
infoLabelHolder: aValueHolder
modifiedChannel: returns a valueHolder which is set to true, whenever any of
my editfields is modified - this is hooked to
the enablingCommitButtonsHolder channel
timeLabelHolder: returns the time label as value holder
useAlienInfoLabel: answer true, if the master's infolabelHolder should be used
valueOfCanCopy: returns whether can copy as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfCanCut: returns whether can paste as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfCanPaste: returns whether can paste as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfCanUndo: returns whether can undo as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfEnablingCommitButtons: returns the enabling of the commit of this tool as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfHavingDocumentation: returns the enabling of having documentation for this tool as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfInfoLabel: returns the info label as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **
valueOfTimeLabel: returns the time label as value holder

** This is an obsolete interface - do not use it (it may vanish in future versions) **

clipboard

clipboard: returns a shared clipboard
clipboard: anEditObject: sets the clipboard and the value holder for can pasting

clock handling

startClock: start the time-block
startClockOnTimedBlock: aBlock: sets and starts the (optional) time block
stopClock: stop the time-block
updateTime: update my time-field (only hours and minutes are shown)

defaults

aboutImage: the image to be displayed in my about-box;
If nil is returned, the ST/X default image is used.

help

aboutThisApplicationText

text for an about box for this application.
Extracts some common info (i.e. class revision, author etc.) from
the classes documentation.

defaultInfoLabel

returns the default info label; here an empty string

openAbout

opens an about box (on ST/X)

openHTMLDocument: anHTMLFilename

opens a HTML browser on aHTMLFilename

showHelp: aHelpText for: view

displays aHelpText in the info label.
Only the first line is shown

showingHelp

returns true, if automatic display of help (in my infoLine - not the tooltips)
is enabled for this application

Usage example(s):

^ self class showingHelp

showingHelp: aValue

toggles showing help for this application

Usage example(s):

(self class showingHelp: aValue)

updateInfoLabel

updates the info label at the bottom of this application

history

add: aHistoryEntry toHistory: aHistory: adds aHistoryEntry (format: loadMessage -> evalString) at the top of aHistory,
and checks for maximum size of the history
addHistoryEntryForClass: classToAdd selector: selectorToAdd: adds aHistoryEntry (format: loadMessage -> evalString) at the top of the history,
and checks for maximum size of the history
addHistoryEntryForFile: fileName
addToFileHistory: aHistoryEntry: adds aHistoryEntry (format: loadMessage -> evalString) at the top of the file-history,
and checks for maximum size of the history
addToHistory: aHistoryEntry: adds aHistoryEntry (format: loadMessage -> evalString) at the top of the history,
and checks for maximum size of the history
emptyFileHistory: removes all history entries
emptyHistory: removes all history entries
fileHistory: returns the file-history from tool class
history: returns the history from tool class
menuHistory: returns a dynamic history submenu.
Subclasses should define #history to provide history items which
implement printStringInMenu and are passed to loadFromHistoryEntry:
remove: aHistoryEntry fromHistory: aHistory: removes aHistoryEntry from the history
removeFromHistory: aHistoryEntry: removes aHistoryEntry from the history

initialization

initialize: (comment from inherited method)
nothing done here;
but can be redefined in concrete applications

misc

clearModifiedFlag: clear the modifiedChannel.
That one is hooked to components in the right noteBook,
and will be set, when any value is modified.
(to enable OK and cancel buttons)

queries

allToolInstances: returns all instances of this tool class
preferredExtent: preferred extent of my window;
top/main menu and top toolbar (named by 'menuToolbarView')
will be considered

startup & release

closeDownViews: uninitializes and closes this tool
hideInfoBarIfAlienInfoLabelIsUsed: common code for apps which have an infoBar at the bottom,
and want to hide this, if embedded into another app, which
already shows tzhe infoBar.
For example, the imageEditor embedded inside a NewSystemBrowser
is such an app
loadFromHistoryEntry: aHistoryEntry
postOpenWith: aBuilder: starts the active help for this tool (if turned on in the settings)
and updates the info label and the font's (from the settings)
restarted: sent by my windowGroup, when restarted from an image.
restart timed block if defined.
uninitialize: stops active help for this tool and (if defined) removes the time block

Private classes:

    HistoryEntry
    HistoryEntryForFile
    HistoryEntryForMethod

ST/X 7.7.0.0; WebServer 1.702 at 20f6060372b9.unknown:8081; Sat, 27 Jul 2024 01:06:19 GMT