"

 Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague

 Copyright (c) 2009-2010 eXept Software AG

 Copyright (c) 2021 LabWare

 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.

"

"{ Package: 'stx:libtool' }"

"{ NameSpace: Tools }"

ApplicationModel subclass:#InlineMessageDialog

	instanceVariableNames:'messageHolder progressHolder backgroundColorHolder

		backgroundColorOrDefaultHolder progressView panelView

		panelViewComponents specHolder panelShownHolder panelHiddenHolder

		worker layout changeLayoutUponShowHide

		progressIndicatorForegroundHolder'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Tools'

!

!InlineMessageDialog class methodsFor:'documentation'!

copyright

"

 Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague

 Copyright (c) 2009-2010 eXept Software AG

 Copyright (c) 2021 LabWare

 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.

"

!

documentation

"

    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.

    [author:]

        Jan Vrany <jan.vrany@fit.cvut.cz>

    [instance variables:]

    [class variables:]

    [see also:]

"

!

examples

"

  Starting the application:

                                                                [exBegin]

    Tools::InlineMessageDialog new

        open;

        message: 'Hello World';

        show: #messageInfoSpec.

                                                                [exEnd]

  more examples to be added:

                                                                [exBegin]

    ... add code fragment for 

    ... executable example here ...

                                                                [exEnd]

"

! !

!InlineMessageDialog class methodsFor:'interface specs'!

messageInfoSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#messageInfoSpec

     Tools::InlineMessageDialog new openInterface:#messageInfoSpec

    "

    <resource: #canvas>

    ^ 

     #(FullSpec

        name: messageInfoSpec

        window: 

       (WindowSpec

          label: 'MessageInfo'

          name: 'MessageInfo'

          min: (Point 10 10)

          bounds: (Rectangle 0 0 800 40)

        )

        component: 

       (SpecCollection

          collection: (

           (LabelSpec

              label: 'Label'

              name: 'Message'

              layout: (LayoutFrame 0 0 0 0 0 1 0 1)

              backgroundChannel: backgroundColorOrDefaultHolder

              translateLabel: true

              labelChannel: messageHolder

              adjust: left

            )

           )

        )

      )

!

progressInfoSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#progressInfoSpec

     Tools::InlineMessageDialog new openInterface:#progressInfoSpec

    "

    <resource: #canvas>

    ^ 

    #(FullSpec

       name: progressInfoSpec

       window: 

      (WindowSpec

         label: 'ProgressInfo'

         name: 'ProgressInfo'

         min: (Point 10 10)

         bounds: (Rectangle 0 0 800 40)

         forceRecursiveBackgroundOfDefaultBackground: true

       )

       component: 

      (SpecCollection

         collection: (

          (ViewSpec

             name: 'Box1'

             layout: (LayoutFrame 0 0 0 0 0 1 0 1)

             level: 0

             backgroundChannel: backgroundColorOrDefaultHolder

             component: 

            (SpecCollection

               collection: (

                (LabelSpec

                   label: 'Label'

                   name: 'Message'

                   layout: (LayoutFrame 0 0 0 0 -20 1 20 0)

                   backgroundChannel: backgroundColorOrDefaultHolder

                   translateLabel: true

                   labelChannel: messageHolder

                   adjust: left

                 )

                (ProgressIndicatorSpec

                   name: 'ProgressIndicator'

                   layout: (LayoutFrame 0 0 -20 1 -20 1 -3 1)

                   level: 0

                   backgroundChannel: backgroundColorOrDefaultHolder

                   foregroundChannel: progressIndicatorForegroundHolder

                   model: progressHolder

                   postBuildCallback: postBuildProgressView:

                 )

                )

             )

           )

          )

       )

     )

!

warningInfoSpec

     <resource: #canvas>

    ^self messageInfoSpec

    "Modified: / 10-04-2012 / 19:40:35 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

windowSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:Tools::InlineMessageDialog andSelector:#windowSpec

     Tools::InlineMessageDialog new openInterface:#windowSpec

     Tools::InlineMessageDialog open

    "

    <resource: #canvas>

    ^ 

     #(FullSpec

        name: windowSpec

        window: 

       (WindowSpec

          label: 'Tools::InlineMessageDialog'

          name: 'Tools::InlineMessageDialog'

          min: (Point 10 10)

          bounds: (Rectangle 0 0 800 40)

        )

        component: 

       (SpecCollection

          collection: (

           (ViewSpec

              name: 'Layout'

              layout: (LayoutFrame 0 0 0 0 0 1 0 1)

              backgroundChannel: backgroundColorOrDefaultHolder

              component: 

             (SpecCollection

                collection: (

                 (HorizontalPanelViewSpec

                    name: 'ComponentPanel'

                    layout: (LayoutFrame 12 0 0 0 -10 1 0 1)

                    backgroundChannel: backgroundColorOrDefaultHolder

                    horizontalLayout: rightSpaceFit

                    verticalLayout: fit

                    horizontalSpace: 0

                    verticalSpace: 3

                    elementsChangeSize: true

                    component: 

                   (SpecCollection

                      collection: (

                       (SubCanvasSpec

                          name: 'InfoSpec'

                          level: 0

                          hasHorizontalScrollBar: false

                          hasVerticalScrollBar: false

                          miniScrollerHorizontal: false

                          specHolder: specHolder

                          createNewBuilder: false

                          usePreferredHeight: true

                          useDynamicPreferredWidth: true

                          useDynamicPreferredHeight: true

                          useDefaultExtent: true

                          usePreferredWidth: true

                        )

                       )

                    )

                    postBuildCallback: postBuildPanelView:

                  )

                 )

              )

            )

           )

        )

      )

! !

!InlineMessageDialog methodsFor:'accessing'!

backgroundColor: aColor

    "Sets the background color, but only iff backgroundColorHolder is

     not set"

    backgroundColorHolder isNil ifTrue:[

        self backgroundColorOrDefaultHolder value: aColor.

        self progressIndicatorForegroundHolder value:(aColor darkened).

    ]

    "Created: / 10-04-2012 / 19:38:31 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

buttons

    panelView isNil ifTrue:[ ^ #() ].

    ^ OrderedCollection streamContents:[ :s |

        panelView allSubViewsDo:[:v |

            (v class == Button or:[ v class == LinkButton ]) ifTrue:[ 

                s nextPut: v

            ].

        ]

    ]

    "Created: / 03-03-2015 / 10:10:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

message

    ^ self messageHolder value

    "Created: / 03-03-2015 / 10:06:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

message: aString

    self messageHolder value: aString

    "Created: / 28-10-2010 / 18:23:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

progress: aNumberOrNil

    aNumberOrNil isNumber ifTrue:[

        progressView notNil ifTrue:[

            progressView showBusyIndication: false.

        ].

        self progressHolder value: aNumberOrNil

    ] ifFalse:[

        progressView notNil ifTrue:[

            progressView showBusyIndication: true.

        ]

    ]

    "Created: / 28-10-2010 / 18:24:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!InlineMessageDialog methodsFor:'accessing-look'!

infoBackgroundColor

    <resource: #style (#'inlineMessageDialog.info.backgroundColor')>  

    ^ self styleSheet 

        colorAt: #'inlineMessageDialog.info.backgroundColor'

        default: [ Color blue lighter ]

    "Created: / 17-09-2021 / 21:08:04 / Jan Vrany <jan.vrany@labware.com>"

!

warnBackgroundColor

    <resource: #style (#'inlineMessageDialog.warning.backgroundColor')>

    ^ self styleSheet 

        colorAt: #'inlineMessageDialog.warning.backgroundColor'

        default: [ Color red:76 green:43 blue:43 ]

    "Created: / 17-09-2021 / 21:09:19 / Jan Vrany <jan.vrany@labware.com>"

! !

!InlineMessageDialog methodsFor:'accessing-presentation'!

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

     changeLayoutUponShowHide := aBoolean

    "Modified (comment): / 17-05-2012 / 13:56:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!InlineMessageDialog methodsFor:'actions'!

doAbort

    worker isNil ifTrue:[ self hide. ^ self ].

    worker interruptWith:[

        NoHandlerError handle:[:ex |

            ex exception creator == AbortOperationRequest ifTrue:[

                ex return.

            ].

            ex reject.

        ] do:[

            AbortOperationRequest raise.

        ].

    ].

    (worker notNil and:[worker isDead not]) ifTrue:[

        worker terminate.

        "/ raise its prio to make it terminate quickly

        worker priority:(Processor userSchedulingPriority + 1).

        worker := nil.

    ].

    "Modified: / 11-04-2012 / 16:24:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

doAbortIfWorking

    worker notNil ifTrue:[ self doAbort ].

    "Created: / 04-10-2012 / 19:20:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

doOK

    <resource: #uiCallback>

    (worker notNil and:[worker isDead not]) ifTrue:[

        worker terminate.

        "/ raise its prio to make it terminate quickly

        worker priority:(Processor userSchedulingPriority + 1).

        worker := nil.

    ].

    self hide.

    "Modified: / 31-03-2013 / 18:02:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!InlineMessageDialog methodsFor:'adding & removing components'!

addButton: aButton

    | layoutView |

    aButton preferredExtent: ((aButton width + 20) max: 70"px") @ 24.

    layoutView := View new.

    layoutView backgroundChannel: self backgroundColorOrDefaultHolder.

    layoutView addComponent: aButton.

    aButton layout:

        ( LayoutFrame fractions:(0 @ 0.5 corner:1.0 @ 0.5) offsets:(3 @ -12 corner:-3 @ 12) ).

    layoutView preferredExtent: (aButton preferredExtent x + 12) @ 24.

    ^self addComponent: layoutView

    "Created: / 10-04-2012 / 20:49:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

addButtonAbort

    ^self addButtonWithLabel: (self resources string:'Abort') action: [ self doAbort ]

    "Created: / 10-04-2012 / 21:45:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

addButtonOK

    ^self addButtonWithLabel: (self resources string:'OK') action: [ self doOK ]

    "Created: / 10-04-2012 / 21:44:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

addButtonWithLabel: label action: action

    ^self addButton: (Button label: label action: action)

    "Created: / 10-04-2012 / 20:50:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

addComponent: aView

    panelView isNil ifTrue:[

        panelViewComponents isNil ifTrue:[

            panelViewComponents := OrderedCollection new

        ].

        panelViewComponents add: aView

    ] ifFalse:[

        panelView addSubView: aView.

        aView isVisible: true.

    ].

    ^aView.

    "Created: / 10-04-2012 / 20:50:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

beInformation

    self backgroundColor: self infoBackgroundColor.

    self specHolder value: #messageInfoSpec

    "Created: / 11-04-2012 / 11:39:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"