Class: AssistantApplication

• Inheritance
• Description
• Class protocol
  • defaults
  • help
  • image specs
  • interface specs
  • menu specs
  • queries
  • required protocol
• Instance protocol
  • actions
  • aspects
  • help
  • initialization & release
  • look
  • private
  • update

Inheritance:

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

Package:

stx:libwidg2

Category:

Views-DialogBoxes

Version:

rev: 1.43 date: 2022/02/09 18:08:27

user: cg

file: AssistantApplication.st directory: libwidg2

module: stx stc-classLibrary: libwidg2

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

copyright
COPYRIGHT (c) 2018 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:

 windowLabelTemplate

 helpSpec

(comment from inherited method)
This resource specification was automatically generated
by the UIHelpTool of ST/X.

 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

 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

 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

 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

 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

 isAbstract

 assistantSpec

must return a sequenceable collection of assistantPageSpecs - one for each page

** This method must be redefined in concrete classes (subclassResponsibility) **

Instance protocol:

 canGoBackward

see if we are allowed to leave...

 canGoForward

see if we are allowed to leave...

 doCancel

(comment from inherited method)
this is invoked by the Escape-Key (if escapeIsCancel) or
the cancel-button (if any), IFF the application has been
opened modal (i.e. as a dialog).

 doFinish

 goBackward

 goForward

 gotoPage: pageIndex

 assistantSpec

 backButtonEnabled

 backButtonLabelHolder

 backButtonVisible

 cancelButtonVisible

 currentPageIndexHolder

 currentPageInfoHTMLHolder

 currentPageSpecHolder

 finishButtonEnabled

 finishButtonVisible

 forwardButtonEnabled

 forwardButtonVisible

 infoHolder

info message at the bottom

 nextButtonLabelHolder

 pageInfoHolder

 pageLabelsInList

 pageLabelsInListWithBullet

Color grey

 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)

 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 the other case, postBuildAsSubcanvasWith is invoked.
Can be redefined in subclasses for additional setup after
the view has been built, but not yet opened.

 backButtonLabel

 nextButtonLabel

 pageLabels

 canFinish

 currentPageIndex

 currentPageSpec

 indexOfNextEnabledPageSpec

 indexOfPreviousEnabledPageSpec

 isPageEnabledAtIndex: index

 nextEnabledPageSpec

 nextPageSpec

 numberOfPages

 previousEnabledPageSpec

 previousPageSpec

 updateButtonEnableState

 updateCanvas

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

 updateWindowLabelFor: aPageSpec