eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'Tools::InlineMessageDialog':

Home

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

Class: InlineMessageDialog (in Tools)


Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--Tools::InlineMessageDialog

Package:
stx:libtool
Category:
Interface-Tools
Version:
rev: 1.23 date: 2017/11/28 18:22:08
user: cg
file: Tools__InlineMessageDialog.st directory: libtool
module: stx stc-classLibrary: libtool
Author:
Jan Vrany <jan.vrany@fit.cvut.cz>

Description:


A simple info/warning dialog to embed into application window -
much like information panel in Firefox or other applications.
Use it when a modal dialog might be too disturbing.



[instance variables:]

[class variables:]


Related information:



Class protocol:

accessing-colors
o  defaultInformationBackground

o  defaultWarningBackground

interface specs
o  messageInfoSpec
This resource specification was automatically generated
by the UIPainter of ST/X.
usage example(s):
     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#messageInfoSpec
     Tools::InlineMessageDialog new openInterface:#messageInfoSpec

o  progressInfoSpec
This resource specification was automatically generated
by the UIPainter of ST/X.
usage example(s):
     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#progressInfoSpec
     Tools::InlineMessageDialog new openInterface:#progressInfoSpec

o  warningInfoSpec

o  windowSpec
This resource specification was automatically generated
by the UIPainter of ST/X.
usage example(s):
     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#windowSpec
     Tools::InlineMessageDialog new openInterface:#windowSpec
     Tools::InlineMessageDialog open


Instance protocol:

accessing
o  buttons

o  message

o  message: aString

o  progress: aNumberOrNil

accessing-color & font
o  backgroundColor: aColor
Sets the background color, but only iff backgroundColorHolder is
not set

accessing-presentation
o  changeLayoutUponShowHide: aBoolean
If set to false, no changes to compokent layout is done
when panel is shown/hidden. This effectively means, that
that panel is shown over the normal content.

Default value is true (i.e., relayout components)

actions
o  doAbort
raise its prio to make it terminate quickly

o  doAbortIfWorking

o  doOK
raise its prio to make it terminate quickly

adding & removing components
o  addButton: aButton
px

o  addButtonAbort

o  addButtonOK

o  addButtonWithLabel: label action: action

o  addComponent: aView

o  beInformation

o  beProgress
never, ever use explicit colors.

o  beWarning
never, ever use explicit colors.

o  removeComponent: aView

o  removeComponents
Removes all components except subcanvas

aspects
o  backgroundColorHolder
return/create the 'backgroundColorHolder' value holder (automatically generated)

o  backgroundColorHolder: something
set the 'backgroundColorHolder' value holder (automatically generated)

o  backgroundColorOrDefaultHolder
return/create the 'backgroundColorOrDefaultHolder' value holder (automatically generated)

o  messageHolder
Modified (comment): / 15-05-2012 / 11:08:35 / cg

o  panelHiddenHolder
return/create the 'panelHiddenHolder' value holder (automatically generated)

o  panelHiddenHolder: aValueModel
set the 'panelHiddenHolder' value holder (automatically generated)

o  panelShownHolder
return/create the 'panelShownHolder' value holder (automatically generated)

o  panelShownHolder: aValueModel
set the 'panelShownHolder' value holder (automatically generated)

o  progressHolder
automatically generated by UIPainter ...

o  progressIndicatorForegroundHolder

o  specHolder
return/create the 'specHolder' value holder (automatically generated)

change & update
o  update: aspect with: parameter from: changedObject
Invoked when an object that I depend upon sends a change notification.

hooks
o  commonPostBuild
"/Correction view, dunno why the layout is bad without it...

o  postBuildPanelView: aPanelView

o  postBuildProgressView: aProgressIndicator

private
o  getMyView

o  getOtherView

o  hide
already hidden"

o  show

o  show: spec

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

testing
o  isMessageOrWarning

o  isProgress

o  isVisible

utilities
o  reset
Resets the dialog to initial state, removes all
user supplied components.

o  showMessage: aString
Shows given message and OK button (which closes the dialog
when clicked

o  showMessage: aString closeAfter: aTimeDurationOrIntegerOrNil
Shows given message and OK button (which closes the dialog
when clicked). The dialog closes automaticaly after
aTimeDurationOrIntegerOrNil (integer value means secons, nil
means do not close automatically)

o  showProgressLabeled: aString while: aBlock
During an execution of aBlock, show a label with given
string, a progressbar showing the progress and an 'Abort' button.

If the block raises a ProgressNotification, then the percentage
progress is updated accordingly. If it raises an ActivityNotification,
then the label is updated and progress bar is changed to be an
activity notificator.

When an 'Abort' button is pressed, the block is interrupted by AbortOperationRequest.

When aBlock terminates (either normally or abruptly, the inline-dialog is closed).

utilities-obsolete
o  information: message
(comment from inherited method)
like Object's information, but translates the string via the
resourcePack, thus giving a translated string automatically

o  information: message timeout: timeoutOrNil

o  progress: label while: block

o  warning: message action: block labeled: label


Examples:


Starting the application:
  Tools::InlineMessageDialog new
      open;
      message: 'Hello World';
      show: #messageInfoSpec.


more examples to be added:
  ... add code fragment for 
  ... executable example here ...


ST/X 7.1.0.0; WebServer 1.663 at exept.de:8081; Wed, 20 Mar 2019 23:51:20 GMT