"

 COPYRIGHT (c) 1995 by Claus Gittinger

              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.

"

"{ Package: 'stx:libview' }"

View subclass:#TopView

	instanceVariableNames:'type iconified keyboardProcessor'

	classVariableNames:'TakeFocusWhenMapped ForceModalBoxesToOpenAtCenter

		ForceModalBoxesToOpenAtPointer MasterSlaveMask WindowTypeMask

		TypeMaster TypeSlave TypePartner TypeDialog TypePopUp

		TypeUndecorated'

	poolDictionaries:''

	category:'Views-Basic'

!

!TopView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1995 by Claus Gittinger

              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.

"

!

documentation

"

    I am an abstract superclass of StandardSystemView and PopUpView;

    i.e. views which have no superview.

    Do not get confused by the name TopView - your applications

    topViews are typically instances of StandardSystemView.

    [instance variables:]

        type            <Integer>       encodes master/slave relationship:

                                            #normal, #master, #slave or #partner

                                        for modeless views

                                        (the #master-, #slave- or #partner-type links multiple views 

                                         into a windowManagers windowGroup -> for de-iconification)

                                        encodes window type:

                                            #normal, #dialog, #popup, #undecorated 

    [see also:]

        StandardSystemView PopUpView DialogBox 

        ( introduction to view programming :html: programming/viewintro.html )

    [author:]

        Claus Gittinger

"

!

examples

"

  Notice, the following examples only demonstrate the windos style (not its modal behavior).

  the style is controlled by the systems windowManager, and might even be ignored by some.

  (for example, the dialog- and normal styles often look the same).

  The bahavior is controlled by ST/X, and controlled by the open vs. openModeless vs. openModal message.

  Modeless:

    regular style:

                                                            [exBegin]

        |v|

        v := TopView new.

        v extent:200@200.

        v open

                                                            [exEnd]

    dialog:

                                                            [exBegin]

        |v|

        v := TopView new.

        v beDialogView.

        v extent:200@200.

        v open

                                                            [exEnd]

    popUp (always on top):

                                                            [exBegin]

        |v|

        v := TopView new.

        v bePopUpView.

        v extent:200@200.

        v open

                                                            [exEnd]

    undecorated (looks loke popUp, but is not always on top):

                                                            [exBegin]

        |v|

        v := TopView new.

        v beUndecorated.

        v extent:200@200.

        v open

                                                            [exEnd]

  Modal:

    regular style:

                                                            [exBegin]

        |v|

        v := TopView new.

        v extent:200@200.

        v openModal

                                                            [exEnd]

    dialog:

                                                            [exBegin]

        |v|

        v := TopView new.

        v beDialogView.

        v extent:200@200.

        v openModal

                                                            [exEnd]

    popUp (always on top):

                                                            [exBegin]

        |v|

        v := TopView new.

        v bePopUpView.

        v extent:200@200.

        v openModal

                                                            [exEnd]

    undecorated (looks loke popUp, but is not always on top):

                                                            [exBegin]

        |v|

        v := TopView new.

        v beUndecorated.

        v extent:200@200.

        v openModal

                                                            [exEnd]

"

! !

!TopView class methodsFor:'class initialization'!

initialize

    MasterSlaveMask := 16r0F.

    TypeMaster      := 16r01.

    TypeSlave       := 16r02.

    TypePartner     := 16r03.

    WindowTypeMask  := 16rF0.

    TypeDialog      := 16r10.

    TypePopUp       := 16r20.

    TypeUndecorated := 16r30.

    "

     self initialize

    "

! !

!TopView class methodsFor:'defaults'!

defaultExtent

    "return the default extent of my instances.

     Topviews extents is 2/3 of screen by default"

    |display|

    display := Screen current.

    display isNil ifTrue:[

        ^ 600 @ 400

    ].

    ^ display defaultExtentForTopViews

!

forceModalBoxesToOpenAtCenter

    "return the flag which forces all modal views to be opened 

     at the screens center"

    ^ ForceModalBoxesToOpenAtCenter ? false

!

forceModalBoxesToOpenAtCenter:aBoolean

    "set/clear a flag which forces all modal views to be opened

     at the screens center"

    ForceModalBoxesToOpenAtCenter := aBoolean

    "

     TopView forceModalBoxesToOpenAtCenter:true

     TopView forceModalBoxesToOpenAtCenter:false

    "

!

forceModalBoxesToOpenAtPointer

    "return the flag which forces all modal views to be opened 

     at the current pointer position"

    ^ ForceModalBoxesToOpenAtPointer ? false

!

forceModalBoxesToOpenAtPointer:aBoolean

    "set/clear the flag which forces all modal views to be opened 

     at the current pointer position"

    ForceModalBoxesToOpenAtPointer := aBoolean

!

takeFocusWhenMapped:aBoolean

    "if turned on, topViews will grab the keyboard when mapped.

     This is useful on systems like openView or Win32, where a view needs a click

     otherwise"

    TakeFocusWhenMapped := aBoolean

    "

     StandardSystemView takeFocusWhenMapped:true

    "

! !

!TopView methodsFor:'Compatibility-ST80'!

displayBox

    ^ self bounds

    "Created: 3.3.1997 / 16:31:33 / cg"

!

displayBox:aRectangle

    self origin:aRectangle origin corner:aRectangle corner

    "Created: 3.3.1997 / 16:34:38 / cg"

! !

!TopView methodsFor:'accessing'!

keyboardProcessor

    "return my keyboard processor"

    ^ keyboardProcessor

    "Created: / 18.6.1998 / 18:52:42 / cg"

    "Modified: / 18.6.1998 / 20:00:18 / cg"

!

keyboardProcessor:something

    "set my keyboard processor"

    keyboardProcessor := something.

    "Created: / 18.6.1998 / 18:52:42 / cg"

    "Modified: / 18.6.1998 / 20:00:30 / cg"

!

label:labelString iconLabel:iconLabelString

    "/ ignored here - for compat. with StdSysViews

! !

!TopView methodsFor:'accessing-behavior'!

beDialogView

    type isInteger ifTrue:[

        type := (type bitClear:WindowTypeMask) bitOr:TypeDialog.

        ^ self.

    ].

    type := #dialog 

!

beIndependent

    "make this an independent view; i.e. remove any master/slave or partner

     attribute (this is the default).

     However, the view remains in the current windowGroup"

    type isInteger ifTrue:[

        type := type bitClear:MasterSlaveMask.

        ^ self.

    ].

    type := nil

!

beMaster

    "make this a master-view. 

     All slave views within the same windowGroup will be closed if any master is closed

     and also de/iconify together with their master(s).

     (i.e. they follow their master(s))."

    type isInteger ifTrue:[

        type := (type bitClear:MasterSlaveMask) bitOr:TypeMaster.

        ^ self.

    ].

    type := #master

    "

     see example in TopView>>beSlave

    "

    "Created: 10.12.1995 / 13:30:50 / cg"

!

bePartner

    "make this a partner-view. Each partner-view will automatically 

     close other partner views (within the same windowGroup) when closed."

    type isInteger ifTrue:[

        type := (type bitClear:MasterSlaveMask) bitOr:TypePartner.

        ^ self.

    ].

    type := #partner 

    "

     create two topViews within the same group:

     if any of them is iconified/deiconified/closed, the other one is also

     |top1 top2|

     top1 := StandardSystemView new label:'partner'; extent:300@300.

     top2 := StandardSystemView new label:'partner'; extent:200@200.

     top1 bePartner.

     top2 bePartner.

     top1 open.

     top2 openInGroup:(top1 windowGroup)

    "

    "Created: 10.12.1995 / 13:29:59 / cg"

    "Modified: 25.5.1996 / 11:44:48 / cg"

!

bePopUpView

    type isInteger ifTrue:[

        type := (type bitClear:WindowTypeMask) bitOr:TypePopUp.

        ^ self.

    ].

    type := #popup 

!

beSlave

    "make this a slave-view. It will be closed automatically,

     whenever any master of the windowgroup is closed.

     See also: #bePartner"

    type isInteger ifTrue:[

        type := (type bitClear:MasterSlaveMask) bitOr:TypeSlave.

        ^ self.

    ].

    type := #slave 

    "

     create two topViews within the same group:

     the slave is allowed to be iconified/close independ of the master;

     but if the master is iconified, the slave is also.

     |top1 top2|

     top1 := StandardSystemView new label:'master'; extent:300@300.

     top2 := StandardSystemView new label:'slave'; extent:200@200.

     top1 beMaster.

     top2 beSlave.

     top1 open.

     top2 openInGroup:(top1 windowGroup)

    "

    "Created: 10.12.1995 / 13:29:10 / cg"

    "Modified: 25.5.1996 / 11:45:30 / cg"

!

beUndecorated

    type isInteger ifTrue:[

        type := (type bitClear:WindowTypeMask) bitOr:TypeUndecorated.

        ^ self.

    ].

    type := nil

!

focusSequence:aCollectionOfSubcomponents

    "define the sequence for stepping through my components."

    windowGroup isNil ifTrue:[

	windowGroup := self windowGroupClass new.

    ].

    windowGroup focusSequence:aCollectionOfSubcomponents.

    "Created: 6.3.1996 / 15:37:11 / cg"

    "Modified: 30.4.1996 / 15:41:40 / cg"

! !

!TopView methodsFor:'event handling'!

keyPress:key x:x y:y

    "notice: this is going to be moved into the upcoming 

     StandardSystemViewController."

    <resource: #keyboard ( #Tab 

                           #FocusNext #FocusPrevious 

                           #CursorDown #CursorUp ) >

    windowGroup notNil ifTrue:[

        key == #Tab ifTrue:[

            self sensor shiftDown ifTrue:[

                windowGroup focusPrevious

            ] ifFalse:[

                windowGroup focusNext

            ].

            ^ self.

        ].

        (key == #FocusNext or:[key == #CursorDown]) ifTrue:[

            windowGroup focusNext.

            ^ self.

        ].

        (key == #FocusPrevious or:[key == #CursorUp])  ifTrue:[

            windowGroup focusPrevious.

            ^ self.

        ].

    ].

    super keyPress:key x:x y:y

    "Created: 1.2.1996 / 22:08:30 / cg"

    "Modified: 9.1.1997 / 12:17:38 / cg"

!

showActivity:someMessage

    "some activityNotification shalt be communicated to

     the user. 

     Default for activity notifications here: ignore them"

    ^ self

    "Created: 16.12.1995 / 18:40:13 / cg"

    "Modified: 23.4.1996 / 21:38:27 / cg"

! !

!TopView methodsFor:'help stubs'!

flyByHelpTextFor:aSubView

    "this will vanish - its temporarily here to allow for stdSysViews to be

     used as a masterApp for dialogs"

    ^ nil

!

helpTextFor:aSubView

    "this will vanish - its temporarily here to allow for stdSysViews to be

     used as a masterApp for dialogs"

    ^ nil

!

showHelp:aHelpText for:aView

    "dummy - added in case a regular topView is installed

     as a dialogs masterApplication.

     Concrete application subclasses may redefine this to

     display a help text in one of its message areas"

! !

!TopView methodsFor:'initialization & release'!

assignInitialKeyboardFocus

    "assign the initial keyboard focus to a 'useful' component."

    |componentWithInitialFocus|

"/    |keyboardProcessor componentWithInitialFocus|

"/

"/    keyboardProcessor := self keyboardProcessor.

"/    keyboardProcessor notNil ifTrue:[

"/        componentWithInitialFocus := keyboardProcessor componentWithInitialFocus.

"/        componentWithInitialFocus notNil ifTrue:[

"/            self windowGroup focusView:componentWithInitialFocus byTab:true.

"/            "/ componentWithInitialFocus requestFocus.                    

"/            ^ self.

"/        ]

"/    ].