Class: InlineMessageDialog (in Tools)

• Inheritance
• Description
• Class protocol
  • accessing-colors
  • interface specs
• Instance protocol
  • accessing
  • accessing-color & font
  • accessing-presentation
  • actions
  • adding & removing components
  • aspects
  • change & update
  • hooks
  • private
  • testing
  • utilities
  • utilities-obsolete
• Examples

Inheritance:

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

Package:

stx:libtool

Category:

Interface-Tools

Version:

rev: 1.34 date: 2023/06/13 18:11:23

user: cg

file: Tools__InlineMessageDialog.st directory: libtool

module: stx stc-classLibrary: libtool

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:]

copyright
Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague
Copyright (c) 2009-2010 eXept Software AG

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the 'Software'), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Class protocol:

 defaultInformationBackground

 defaultWarningBackground

 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

 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

 warningInfoSpec

 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:

 buttons

 message

 message: aString

 progress: aNumberOrNil

 backgroundColor: aColor

Sets the background color, but only iff backgroundColorHolder is
not set

 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)

 doAbort

raise its prio to make it terminate quickly

 doAbortIfWorking

 doOK

raise its prio to make it terminate quickly

 addButton: aButton

px

 addButtonAbort

 addButtonOK

 addButtonWithLabel: label action: action

 addComponent: aView

 beInformation

 beProgress

never, ever use explicit colors.

 beWarning

never, ever use explicit colors.

 removeComponent: aView

 removeComponents

Removes all components except subcanvas

 backgroundColorHolder

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

 backgroundColorHolder: something

set the 'backgroundColorHolder' value holder (automatically generated)

 backgroundColorOrDefaultHolder

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

 messageHolder

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

 panelHiddenHolder

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

 panelHiddenHolder: aValueModel

set the 'panelHiddenHolder' value holder (automatically generated)

 panelShownHolder

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

 panelShownHolder: aValueModel

set the 'panelShownHolder' value holder (automatically generated)

 progressHolder

automatically generated by UIPainter ...

 progressIndicatorForegroundHolder

 specHolder

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

 update: aspect with: parameter from: changedObject

Invoked when an object that I depend upon sends a change notification.

 commonPostBuild

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

 postBuildPanelView: aPanelView

 postBuildProgressView: aProgressIndicator

 getMyView

 getOtherView

 hide

already hidden"

 show

 show: spec

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

 isMessageOrWarning

 isProgress

 isVisible

 reset

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

 showMessage: aString

Shows given message and OK button (which closes the dialog
when clicked

 showMessage: aString closeAfter: aTimeDurationOrIntegerOrNil

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

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

 information: message

(comment from inherited method)
like Object's information, but translates the string via the
resourcePack, thus giving a translated string automatically

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

 information: message timeout: timeoutOrNil

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

Examples:

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

  ... add code fragment for 
  ... executable example here ...