"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1996 by eXept Software AG / 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:libwidg2' }"

"{ NameSpace: Smalltalk }"

View subclass:#ComboView

	instanceVariableNames:'field pullDownButton list listHolder listMsg action resizableMenu

		currentIndex comboMenuHolder comboMenuMessage'

	classVariableNames:'DefaultButtonForm ComboButtonForms'

	poolDictionaries:''

	category:'Views-Interactors'

!

!ComboView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996 by eXept Software AG / 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

"

    A ComboView combines some field (typically an enterField or Label)

    with a drop down list of default inputs;

    ComboView is abstract, providing protocol common to ComboBoxView and

    ComboListView. See documentation & examples there.

    [author:]

        Claus Gittinger

    [instance variables:]

        currentIndex    Integer     index into the list, that is currently selected

    [see also:]

        PopUpList

        ComboListView ComboBoxView ExtendedComboBox

        PullDownMenu Label EntryField

"

!

examples

"

  see examples in ComboListView and ComboBoxView

"

! !

!ComboView class methodsFor:'defaults'!

buttonForm

    "return the pull-buttons image"

    <resource: #style (#'comboView.downForm' 

                       #'comboView.downFormFile')>

    |fileName form|

    DefaultButtonForm notNil ifTrue:[

        ^ DefaultButtonForm

    ].

    form := StyleSheet at:#'comboView.downForm'.

    form isNil ifTrue:[

        fileName := StyleSheet at:#'comboView.downFormFile' "default:'ComboDn.14.xbm'".

        fileName notNil ifTrue:[

            form := Smalltalk imageFromFileNamed:fileName forClass:self.

            form isNil ifTrue:[

                form := Smalltalk imageFromFileNamed:fileName inPackage:'stx:libwidg'.

            ]

        ].

    ].

    form isNil ifTrue:[

        form  := self defaultButtonForm.

    ].

    form notNil ifTrue:[

        form := DefaultButtonForm := form onDevice:Display.

        ^ form

    ].

    ^ nil

    "Modified: / 28.4.1999 / 12:49:42 / cg"

!

comboButtonFor:aComboView

    <resource: #style (#'comboView.disabledDownForm' 

                       #'comboView.disabledDownFormFile'

                       #'comboView.activeDownFormFile'

                       #'comboView.button.activeForegroundColor'

                       #'comboView.button.activeBackgroundColor'

                       #'comboView.button.activeLevel'

                       #'comboView.button.passiveLevel'  )>

    |pullDownButton fn logo disabledLogo activeLogo enteredLogo lvl clr|

    pullDownButton := ComboBoxButton in:aComboView.

    pullDownButton controller beTriggerOnDown.

    pullDownButton label:(logo := self buttonForm).

    ComboButtonForms isNil ifTrue:[

        ComboButtonForms := IdentityDictionary new.

    ].

    disabledLogo := ComboButtonForms at:disabledLogo ifAbsentPut:[|logo|

        logo := StyleSheet at:#'comboView.disabledDownForm'.

        logo isNil ifTrue:[

            fn := StyleSheet at:#'comboView.disabledDownFormFile'.

            fn notNil ifTrue:[

                logo := Smalltalk imageFromFileNamed:fn forClass:self.

                logo isNil ifTrue:[

                    logo := Smalltalk imageFromFileNamed:fn inPackage:'stx:libwidg'.

                ]

            ]

        ].

        logo

    ].    

    activeLogo := ComboButtonForms at:#activeLogo ifAbsentPut:[|logo|

        logo := StyleSheet at:#'comboView.activeDownForm'.

        logo isNil ifTrue:[

            fn := StyleSheet at:#'comboView.activeDownFormFile'.

            fn notNil ifTrue:[

                logo := Smalltalk imageFromFileNamed:fn forClass:self.

                logo isNil ifTrue:[

                    logo := Smalltalk imageFromFileNamed:fn inPackage:'stx:libwidg'.

                ]

            ]

        ].

        logo

    ].    

    enteredLogo := ComboButtonForms at:#enteredLogo ifAbsentPut:[|logo|

        logo := StyleSheet at:#'comboView.enteredDownForm'.

        logo isNil ifTrue:[

            fn := StyleSheet at:#'comboView.enteredDownFormFile'.

            fn notNil ifTrue:[

                logo := Smalltalk imageFromFileNamed:fn forClass:self.

                logo isNil ifTrue:[

                    logo := Smalltalk imageFromFileNamed:fn inPackage:'stx:libwidg'.

                ]

            ]

        ].    

        logo

    ].

    disabledLogo notNil ifTrue:[

        pullDownButton passiveLogo:logo.

        pullDownButton activeLogo:logo.

        pullDownButton disabledLogo:disabledLogo.

    ].

    pullDownButton showLamp:false.

    activeLogo notNil ifTrue:[

        pullDownButton activeLogo:activeLogo.

        pullDownButton passiveLogo:logo.

        pullDownButton label:logo.

    ].

    enteredLogo notNil ifTrue:[

        pullDownButton enteredLogo:enteredLogo.

    ].

    (lvl := StyleSheet at:#'comboView.button.activeLevel') notNil ifTrue:[

        pullDownButton activeLevel:lvl

    ].

    (lvl := StyleSheet at:#'comboView.button.passiveLevel') notNil ifTrue:[

        pullDownButton passiveLevel:lvl

    ].

    (clr := StyleSheet colorAt:#'comboView.button.activeForegroundColor') notNil ifTrue:[

        pullDownButton activeForegroundColor:clr

    ].

    (clr := StyleSheet colorAt:#'comboView.button.activeBackgroundColor') notNil ifTrue:[

        pullDownButton activeBackgroundColor:clr

    ].

    pullDownButton activeLevel == pullDownButton passiveLevel ifTrue:[

        pullDownButton activeLevel:0.

    ].

    ^ pullDownButton.

!

defaultFont

    "/ for now - should come from the styleSheet

    ^ EditField defaultFont.

    "/ ^ SelectionInListView defaultFont.

    "Created: 4.6.1997 / 15:44:17 / cg"

!

defaultListMessage

    ^ #list

    "Created: 26.2.1997 / 19:34:50 / cg"

!

updateStyleCache

    "flush the forms cache"

    DefaultButtonForm := ComboButtonForms := nil.

    "Created: / 3.11.1997 / 15:28:48 / cg"

! !

!ComboView class methodsFor:'image specs'!

defaultButtonForm

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

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

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

    "

     self defaultButtonForm inspect

     ImageEditor openOnClass:self andSelector:#defaultButtonForm

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'ComboView class defaultButtonForm'

        ifAbsentPut:[(Depth1Image width:12 height:12) bits:(ByteArray fromPackedString:'@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@')

            colorMapFromArray:#[0 0 0]

            mask:((ImageMask width:12 height:12) bits:(ByteArray fromPackedString:'@@<OC0<OC0=?;3?OG8<OC0XO@@=?;0@O'); yourself); yourself]

! !

!ComboView class methodsFor:'queries'!

isAbstract

    "Return if this class is an abstract class.

     True is returned here for myself only; false for subclasses.

     Abstract subclasses must redefine this again."

    ^ self == ComboView.

! !

!ComboView methodsFor:'accessing-behavior'!

action:aBlock

    "specify, a block, which is evaluated when the lists selection changes.

     This is an additional hook - normally, you would communicate with the model

     alone"

    action := aBlock.

    "Created: 26.7.1996 / 17:44:18 / cg"

    "Modified: 26.2.1997 / 19:37:18 / cg"

!

enabled

    "return true, if it is enabled"

    enableChannel isNil ifTrue:[^ true].

    ^ enableChannel value ? true

!

enabled:aBoolean

    "enable/disable components"

    self enableChannel value:aBoolean.

    "Modified: / 30.3.1999 / 14:56:18 / stefan"

!

resizableMenu

    "return true, if the menu is to be resizable.

     This feature is as yet unimplemented."

    ^ resizableMenu ? false

!

resizableMenu:aBoolean

    "enable/disable, if the menu is to be resizable.

     This feature is as yet unimplemented."

    resizableMenu := aBoolean

! !

!ComboView methodsFor:'accessing-channels'!

enableChannel 

    "return a valueHolder for enable/disable"

    enableChannel isNil ifTrue:[

        self enableChannel:(true asValue).

    ].

    ^ enableChannel

    "Modified: / 30.3.1999 / 16:20:25 / stefan"

! !

!ComboView methodsFor:'accessing-components'!

field

    "return the field (input or label) component.

     For knowledgable users only."

    ^ field

    "Created: / 26.9.1999 / 13:33:15 / cg"

!

menuButton

    "return the menuButton component"

    ^ pullDownButton

    "Created: 28.2.1996 / 15:03:14 / cg"

! !

!ComboView methodsFor:'accessing-contents'!

contents

    "get the contents of my field"

    |m|

    (m := field model) isNil ifTrue:[

        ^ field contents

    ].

    ^ m value

    "Created: / 14-05-1996 / 13:05:16 / cg"

    "Modified: / 21-03-2012 / 12:06:42 / cg"

!

contents:something

    "set the contents of my field; questionable"

    |m|

    (m := field model) notNil ifTrue:[

        m value:something

    ]

    "Created: 14.5.1996 / 13:05:33 / cg"

    "Modified: 26.2.1997 / 16:56:08 / cg"

!

list

    "return the list"

    ^ list

    "Created: / 18.5.1998 / 18:58:08 / cg"

!

list:aList

    "set the list explicitely; used internally or 

     to be send from the outside if no model/listHolder is used."

    list ~~ aList ifTrue:[

        self assert:(aList isNil or:[aList isSequenceable]).

        currentIndex := 1.

        list := aList.

    ].

    "maybe some values have been added to / removed from list"

    self enableStateChanged.

    "Modified: / 30.3.1999 / 14:17:38 / stefan"

! !

!ComboView methodsFor:'accessing-look'!

backgroundColor

    ^field backgroundColor

!

backgroundColor:aColor

    field backgroundColor:aColor

!

font:aFont

    super font:aFont.

    self setFieldsFont:aFont.

!

foregroundColor

    ^field foregroundColor

!

foregroundColor:aColor

    field foregroundColor:aColor

! !

!ComboView methodsFor:'accessing-mvc'!

comboMenuHolder

    ^ comboMenuHolder

!

comboMenuHolder:aMenuHolder

    "allows for arbitrary menus to be opened via the combo button"

    comboMenuHolder := aMenuHolder.

!

comboMenuHolder:aMenuHolder comboMenuMessage:aSelectorToTheHolder

    "allows for arbitrary menus to be opened via the combo button"

    comboMenuHolder := aMenuHolder.

    comboMenuMessage := aSelectorToTheHolder.

!

comboMenuMessage

    ^ comboMenuMessage

!

comboMenuMessage:aSelectorToTheHolder

    "allows for arbitrary menus to be opened via the combo button"

    comboMenuMessage := aSelectorToTheHolder.

!

currentIndex

    ^ currentIndex

!

listHolder:aValueHolder

    "set the listHolder.

     If not set, the list is supposed to be set explicitely"

    listHolder notNil ifTrue:[

        listHolder removeDependent:self.

    ].

    listHolder := aValueHolder.

    listHolder notNil ifTrue:[

        aValueHolder addDependent:self.

    ].

    "/ cg: either fetch it here or when realized;

    "/ (otherwise we'd never fetch the list if it won't change later)

"/    realized ifTrue:[

        self getListFromModel.

"/    ]

    "Modified: / 09-11-2007 / 15:59:18 / cg"

!

listMessage:aSymbol

    "define the message selector sent to the model, to fetch

     the list. If not defined, #list is used"

    listMsg := aSymbol

    "Created: 14.2.1997 / 19:16:52 / cg"

    "Modified: 26.2.1997 / 19:33:09 / cg"

!

model:aModel

    "set the model, which is supposed to provide the boxes value.

     If a listMessage was defined, it is also responsible for providing

     the list"

    super model:aModel.