eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'ToolApplicationModel':

Home

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

Class: ToolApplicationModel


Inheritance:

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

Package:
stx:libview2
Category:
Interface-Framework
Version:
rev: 1.170 date: 2019/05/14 07:46:14
user: cg
file: ToolApplicationModel.st directory: libview2
module: stx stc-classLibrary: libview2
Author:
Thomas Zwick, eXept Software AG

Description:


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


Class protocol:

accessing
o  allToolInstances

o  authorLinesForAboutBox
extracts the author(s) from the documentation method.

o  forgetInstance: anInstance

o  label
returns the label for the tool instances of this class;
extracted from the class name;
can be redefined in subclasses

o  rememberInstance: anInstance

o  settings
returns the settings dictionary

o  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

o  showingHelp: aBoolean
enable/disable active help for instances of this class

usage example(s):

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

clipboard
o  clipboard
returns the clipboard of this tool class

o  clipboard: anEditObject
sets the clipboard for this tool class

help
o  openAboutSTX
opens an about box (on ST/X)

help specs
o  helpSpec
This resource specification was automatically generated
by the UIHelpTool of ST/X.

history
o  getFileHistory
returns the file-history for this tool class

o  getHistory
returns the history for this tool class

o  historyMaxSize
returns the maximum size for the history of this tool class

image specs
o  desktopIcon
returns the icon used for the desktop

o  menuIcon
returns the icon used for the menu bar

interface specs
o  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

o  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

o  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

o  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
o  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

o  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

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

queries
o  isAbstract

startup & release
o  preSnapshot
removes the clipboard before snap shoting

o  uninitialize
resets the class instance variables

usage example(s):

     self withAllSubclasses do:[:c | c uninitialize]


Instance protocol:

aspects
o  acceptChannel
returns a valueHolder which can be set to true to force all inputFields
to accept their value.

o  canCopyHolder
returns whether can copy as value holder

o  canCutHolder
returns whether can cut as value holder

o  canPasteHolder
returns whether can paste as value holder

o  canUndoHolder
returns whether can undo as value holder

o  enablingCommitButtonsHolder
returns the enabling of the commit of this tool as value holder

o  havingDocumentationHolder
returns the enabling of having documentation for this tool as value holder

o  infoLabelHolder
returns the info label as value holder

o  infoLabelHolder: aValueHolder

o  modifiedChannel
returns a valueHolder which is set to true, whenever any of
my editfields is modified - this is hooked to
the enablingCommitButtonsHolder channel

o  timeLabelHolder
returns the time label as value holder

o  useAlienInfoLabel
answer true, if the master's infolabelHolder should be used

o  valueOfCanCopy
returns whether can copy as value holder

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

o  valueOfCanCut
returns whether can paste as value holder

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

o  valueOfCanPaste
returns whether can paste as value holder

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

o  valueOfCanUndo
returns whether can undo as value holder

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

o  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) **

o  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) **

o  valueOfInfoLabel
returns the info label as value holder

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

o  valueOfTimeLabel
returns the time label as value holder

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

clipboard
o  clipboard
returns the clipboard

o  clipboard: anEditObject
sets the clipboard and the value holder for can pasting

clock handling
o  startClock
start the time-block

o  startClockOnTimedBlock: aBlock
sets and starts the (optional) time block

o  stopClock
stop the time-block

o  updateTime
update my time-field

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

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

o  defaultInfoLabel
returns the default info label; here an empty string

o  openAbout
opens an about box (on ST/X)

o  openHTMLDocument: aHTMLFilename
opens a HTML browser on aHTMLFilename

o  showHelp: aHelpText for: view
displays aHelpText in the info label.
Only text up to '.' is shown

usage example(s):

^ masterApplication showHelp:aHelpText for:view

o  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 

o  showingHelp: aValue
toggles showing help for this application

usage example(s):

(self class showingHelp: aValue)

o  updateInfoLabel
updates the info label at the bottom of this application

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

history
o  add: aHistoryEntry toHistory: aHistory
adds aHistoryEntry (format: loadMessage -> evalString) at the top of aHistory,
and checks for maximum size of the history

o  addHistoryEntryForClass: classToAdd selector: selectorToAdd
adds aHistoryEntry (format: loadMessage -> evalString) at the top of the history,
and checks for maximum size of the history

o  addHistoryEntryForFile: fileName

o  addToFileHistory: aHistoryEntry
adds aHistoryEntry (format: loadMessage -> evalString) at the top of the file-history,
and checks for maximum size of the history

o  addToHistory: aHistoryEntry
adds aHistoryEntry (format: loadMessage -> evalString) at the top of the history,
and checks for maximum size of the history

o  emptyFileHistory
removes all history entries

o  emptyHistory
removes all history entries

o  fileHistory
returns the file-history from tool class

o  history
returns the history from tool class

o  menuHistory
returns a dynamic history submenu.
Subclasses should define #history to provide history items which
implement printStringInMenu and are passed to loadFromHistoryEntry:

o  remove: aHistoryEntry fromHistory: aHistory
removes aHistoryEntry from the history

o  removeFromHistory: aHistoryEntry
removes aHistoryEntry from the history

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

misc
o  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
o  allToolInstances
returns all instances of this tool class

o  preferredExtent
preferred extent of my window;
top/main menu and top toolbar (named by 'menuToolbarView')
will be considered

startup & release
o  closeDownViews
uninitializes and closes this tool

o  loadFromHistoryEntry: aHistoryEntry

o  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)

o  restarted
sent by my windowGroup, when restarted from an image.
restart timed block if defined.

o  uninitialize
stops active help for this tool and (if defined) removes the time block


Private classes:

    HistoryEntry
    HistoryEntryForFile
    HistoryEntryForMethod


ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Sat, 19 Sep 2020 17:40:24 GMT