"

 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.

"

View subclass:#TopView

	instanceVariableNames:'type iconified'

	classVariableNames:'TakeFocusWhenMapped'

	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		<Symbol>	one of #normal, #master, #slave or #partner

					for modeless views

					(#master, #slave or #partner link multiple views 

					into a windowManagers windowGroup -> de-iconification) 

					#dialog for modal views; #popup for popup views.

    [see also:]

        StandardSystemView PopUpView DialogBox 

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

    [author:]

        Claus Gittinger

"

! !

!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 width // 3 * 2) @ (display height // 3 * 2)

    "Modified: 22.4.1996 / 23:39:13 / cg"

! !

!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-behavior'!

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 := nil

!

beMaster

    "make this a master-view. All slave views within the same

     windowGroup will be closed if any master is closed."

    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 := #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"

!

beSlave

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

     whenever any master of the windowgroup is closed.

     See also: #bePartner"

    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"

!

focusSequence:aCollectionOfSubcomponents

    "define the sequence for stepping through my components."

    windowGroup isNil ifTrue:[

        windowGroup := WindowGroup 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'!

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:'initialize / release'!

assignKeyboardFocusToFirstInputField

    "assign the keyboard focus to the first input field,

     or else to the first keyboardConsumer.

     This prefers inputFields over editTextViews 

     (which may change in the future)"

    |firstConsumer|

    self allSubViewsDo:[:v |

        v isInputField ifTrue:[

            v requestFocus. "/ self windowGroup focusView:v.

            ^ self

        ].

        (firstConsumer isNil and:[v isKeyboardConsumer]) ifTrue:[

            firstConsumer := v

        ].

    ].

    firstConsumer notNil ifTrue:[

        firstConsumer requestFocus.

        "/ firstConsumer requestFocus. - could be denied; but we force it here

        windowGroup focusView:firstConsumer byTab:false.

    ].

    "Modified: / 20.5.1999 / 18:14:16 / cg"

!

destroy

    "the receiver is to be destroyed - look for partners and slaves"

    |wg dev|

    wg := windowGroup.                  "/ have to fetch windowGroup before;

    dev := device.                      "/ and device ...

    super destroy.                      "/ ... since destroy nils em

"/    dev notNil ifTrue:[

"/        dev flush

"/    ].

    "/

    "/ destroy slaves and partners

    "/

    self masterSlaveMessage:#destroy inGroup:wg

    "Modified: 20.3.1997 / 22:14:16 / cg"

!

initialize

    "initialize the topViews position for the screens center"

    |screenCenter|

    super initialize.

    device initializeTopViewHookFor:self.

    screenCenter := device center.

    left := screenCenter x - (width // 2).

    top := screenCenter y - (height // 2).

    type := #normal

!

postRealize

    super postRealize.

    device realizedTopViewHookFor:self

! !

!TopView methodsFor:'misc'!

raiseDeiconified

    "deiconify & bring to front"

    self isCollapsed ifTrue:[

        self unmap.

        self realize.

    ].

    self raise

    "

     Transcript topView raiseDeiconified

    "

    "Modified: 3.5.1996 / 23:49:36 / stefan"

!

waitUntilClosed

    "wait until the receiver has been closed.

     Can be used to synchronize multiple-window applications,

     and (especially) to wait until an application session is finished

     when invoking commands with the rDoit mechanism"

    [drawableId isNil] whileFalse:[

        Delay waitForSeconds:0.1.

    ].

    "asynchronous:

     EditTextView open

    "

    "synchronous:

     EditTextView open topView waitUntilClosed

    "

    "Modified: / 20.5.1998 / 18:03:37 / cg"

!

withCursor:aCursor do:aBlock

    "evaluate aBlock while showing aCursor in all my views.

     Return the value as returned by aBlock."

    windowGroup notNil ifTrue:[

        ^ windowGroup withCursor:aCursor do:aBlock

    ].

    ^ super withCursor:aCursor do:aBlock

! !

!TopView methodsFor:'queries'!

heightIncludingBorder

    "return the views overall-height"

    ^ height

!

isCollapsed

    "ST80 compatibility: return true if the view is not shown (i.e. iconified)"

    "/ ^ device windowIsIconified:drawableId

    ^ shown not

    "Modified: 4.4.1997 / 14:44:39 / cg"

!

isPopUpView

    "return true, since I want to come up without decoration 

     and popUp to top immediately."

    ^ type == #popup

    "Created: 28.2.1997 / 22:12:30 / cg"

    "Modified: 28.2.1997 / 22:37:01 / cg"

!

isTopView

    "return true, since I am a topView"

    ^ true

    "Created: 22.3.1997 / 14:45:55 / cg"

!

preferredExtent

    "return my preferred extent - this is the minimum size I would like to have.

     The default here is the classes default extent,

     however many subclasses redefine this to compute the actual value

     depending on the sizes of the contents or subcomponents."

    "/ If I have an explicit preferredExtent ..

    preferredExtent notNil ifTrue:[

        ^ preferredExtent

    ].

    ^ self class defaultExtent

    "Modified: 19.7.1996 / 20:45:41 / cg"

!

type

    "return the views type. This is one of #normal,

     #master, #slave or #partner."

    ^ type

!

widthIncludingBorder

    "return the views overall-width"

    ^ width

!

window

    "for compatibility with applicationModels ... return the receiver"

    ^ self

! !

!TopView methodsFor:'show / hide'!

fixPosition:aPoint

    "set origin to aPoint, but make sure, that the box is fully visible 

     by shifting it into the visible screen area if nescessary.

     This prevents invisible modalBoxes (which you could never close)."

    self origin:aPoint.

    self makeFullyVisible

    "Created: 28.2.1997 / 16:39:31 / cg"

!

mapIconified

    "make the view visible but iconified.

     In contrast to map, which does it non-iconified"

    realized ifFalse:[

        "

         now, make the view visible

        "

        realized := true.

        device

            mapView:self id:drawableId iconified:true

            atX:left y:top width:width height:height

            minExtent:(self minExtent) maxExtent:(self maxExtent)

    ]

    "Modified: 25.2.1997 / 22:44:33 / cg"

    "Created: 24.7.1997 / 12:48:21 / cg"

!

positionOffset

    "return the delta, by which the box should be

     displaced from the mouse pointer.

     Here, the boxes center is returned as a default.

     Usually redefined in subclasses to have the most convenient

     ok-button appear under the pointer."

    ^ self extent // 2

    "Created: 28.2.1997 / 22:56:34 / cg"

! !

!TopView methodsFor:'startup'!

openAt:aPosition transientFor:anotherView

    "force the view to be opened at some position on the screen

     AND tell the windowManager to NOT let the user choose a position

     (i.e. suppress any ghostframe).

     The view is marked as being a transient (i.e. pop-up) view for

     anotherView - it will deiconify with it and (on some windowManagers)

     have no iconify button of its own.

     Notice, that its up to the windowManager to care for any borders -

     it seems not deterministic, where the view actually ends up being positioned.

     Not all windowManagers (olwm) honor this - some insist on it ..."

    |otherId|

    drawableId isNil ifTrue:[self create].