eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'AssistantApplication':

Home

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

Class: AssistantApplication


Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--ToolApplicationModel
            |
            +--AssistantApplication

Package:
stx:libwidg2
Category:
Views-DialogBoxes
Version:
rev: 1.35 date: 2018/08/23 19:05:54
user: cg
file: AssistantApplication.st directory: libwidg2
module: stx stc-classLibrary: libwidg2
Author:
Claus Gittinger

Description:


an easy to use framework for assistant-dialog applications.
These are multipage applications, in which the user is able to navigate
along achain of pages as specified in the AssistantSpec

see stx:doc/coding:DemoAssistant for a demo example.
see ProjectBuilderAssistantApplication for a concrete example.

caveat: should have called this WizardApplication


Class protocol:

defaults
o  windowLabelTemplate

help
o  helpSpec

image specs
o  bulletIcon
This resource specification was automatically generated
by the ImageEditor of ST/X.

usage example(s):

     self bulletIcon inspect
     ImageEditor openOnClass:self andSelector:#bulletIcon
     Icon flushCachedIcons

o  leftArrowIcon
This resource specification was automatically generated
by the ImageEditor of ST/X.

usage example(s):

     self leftArrowIcon inspect
     ImageEditor openOnClass:self andSelector:#leftArrowIcon
     Icon flushCachedIcons

o  rightArrowIcon
This resource specification was automatically generated
by the ImageEditor of ST/X.

usage example(s):

     self rightArrowIcon inspect
     ImageEditor openOnClass:self andSelector:#rightArrowIcon
     Icon flushCachedIcons

interface specs
o  windowSpec
This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

     UIPainter new openOnClass:AssistantApplication andSelector:#windowSpec
     AssistantApplication new openInterface:#windowSpec
     AssistantApplication open

menu specs
o  mainMenu
This resource specification was automatically generated
by the MenuEditor of ST/X.

usage example(s):

     MenuEditor new openOnClass:AssistantApplication andSelector:#mainMenu
     (Menu new fromLiteralArrayEncoding:(AssistantApplication mainMenu)) startUp

queries
o  isAbstract

required protocol
o  assistantSpec
must return a sequenceable collection of assistantPageSpecs - one for each page

** This method raises an error - it must be redefined in concrete classes **


Instance protocol:

actions
o  canGoBackward
see if we are allowed to leave...

o  canGoForward
see if we are allowed to leave...

o  doCancel

o  doFinish

o  goBackward

o  goForward

o  gotoPage: pageIndex

aspects
o  assistantSpec

o  backButtonEnabled

o  backButtonLabelHolder

o  backButtonVisible

o  cancelButtonVisible

o  currentPageIndexHolder

o  currentPageInfoHTMLHolder

o  currentPageSpecHolder

o  finishButtonEnabled

o  finishButtonVisible

o  forwardButtonEnabled

o  forwardButtonVisible

o  infoHolder
info message at the bottom

o  nextButtonLabelHolder

o  pageInfoHolder

o  pageLabelsInList

o  pageLabelsInListWithBullet
Color grey

help
o  helpTextForKey: aKey
(comment from inherited method)
flyByHelp interface:
return some short help text for a key.
Key is the symbol associated with some widget or menu item.
(from my helpSpec);
Return a language variant (if available).
Special: with CTRL, show how it is generated (the helpKey or action block)

initialization & release
o  postBuildWith: aBuilder
(comment from inherited method)
this is sent after an interface is built from a spec,
but only iff the appModel is not the same as the topView's app
(i.e. if it is not a build for the same appModel again).
In that case, postBuildAsSubcanvasWith is invoked.
Can be redefined in subclasses for additional setup after
the view has been built, but not yet opened.

look
o  backButtonLabel

o  nextButtonLabel

o  pageLabels

private
o  canFinish

o  currentPageIndex

o  currentPageSpec

o  indexOfNextEnabledPageSpec

o  indexOfPreviousEnabledPageSpec

o  isPageEnabledAtIndex: index

o  nextEnabledPageSpec

o  nextPageSpec

o  numberOfPages

o  previousEnabledPageSpec

o  previousPageSpec

update
o  updateButtonEnableState

o  updateCanvas
update some valueHolders and especially the current canvas,
after a step in either direction

o  updateWindowLabelFor: aPageSpec



ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Tue, 31 Jan 2023 21:06:07 GMT