"

 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.

"

HorizontalPanelView subclass:#CheckBox

	instanceVariableNames:'toggleView labelView labelForegroundColor

		disabledLabelForegroundColor foregroundChannel backgroundChannel'

	classVariableNames:'DefaultLabelForegroundColor DefaultDisabledLabelForegroundColor

		CheckToggleLeft'

	poolDictionaries:''

	category:'Views-Interactors'

!

!CheckBox 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

"

    CheckBoxes consist of a checkToggle and a label;

    if used without a model, its action block is evaluated

    when toggled (see Toggle for more information).

    Otherwise, a valueHolder on a boolean is the preferred model

    (other models are possible - this may required different aspect

     and/or changeMessage settings; make certain to set those before

     a model is assigned, since the toggle fetches the value when

     a new model is assigned.)

    [author:]

        Claus Gittinger

    [see also:]

        Button CheckToggle

        DialogBox

        ValueHolder

"

!

examples

"

  no-op checkBox without a label:

                                                                        [exBegin]

     |b|

     b := CheckBox new.

     b open

                                                                        [exEnd]

  no-op checkBox:

                                                                        [exBegin]

     |b|

     b := CheckBox new.

     b label:'foo'.

     b open

                                                                        [exEnd]

  combined instance creation & label setup:

                                                                        [exBegin]

     |b|

     b := CheckBox label:'foo'.

     b open

                                                                        [exEnd]

  no-op checkBox, disabled:

                                                                        [exBegin]

     |b|

     b := CheckBox label:'foo'.

     b disable.

     b open

                                                                        [exEnd]

  changing colors 

  (a demo only: it is no good style to fight the styleSheet):

                                                                        [exBegin]

     |panel b|

     panel := VerticalPanelView new.

     b := CheckBox label:'foo' in:panel.

     b := CheckBox label:'bar' in:panel.

     b labelView foregroundColor:Color red.

     b := CheckBox label:'baz' in:panel.

     b toggleView activeForegroundColor:Color blue.

     panel open

                                                                        [exEnd]

  using action-blocks:

                                                                        [exBegin]

     |b|

     b := CheckBox label:'check'.

     b action:[:value | Transcript show:'set to: '; showCR:value].

     b open.

                                                                        [exEnd]

  with a model (default ST-80 behavior, sending #value: to the model):

  (see changing value in the inspector)

                                                                        [exBegin]

     |b model|

     model := ValueHolder newBoolean.

     b := CheckBox label:'check'.

     b model:model.

     b open.

     model inspect.

                                                                        [exEnd]

  combined instance creation & model setup:

                                                                        [exBegin]

     |b model|

     model := ValueHolder newBoolean.

     b := CheckBox label:'check' model:model .

     b open.

     model inspect.

                                                                        [exEnd]

  with a model and different aspect & changeSelector

  setting the aspect to nil suppresses fetching the value from the model.

  (using a plug here, for demonstration only):

                                                                        [exBegin]

     |b model|

     model := Plug new.

     model respondTo:#changeCheck: with:[:arg | Transcript showCR:'change to ' , arg printString].

     model respondTo:#value with:[false].

     b := CheckBox label:'check'.

     b aspectMessage:nil; model:model; changeMessage:#changeCheck:.

     b open.

                                                                        [exEnd]

  with an enableChannel

                                                                        [exBegin]

     |b enaToggle enaHolder|

     enaHolder := true asValue.

     enaToggle := Toggle label:'enable'.

     enaToggle model:enaHolder.

     enaToggle open.

     b := CheckBox label:'check'.

     b action:[:value | Transcript show:'set to: '; showCR:value].

     b enableChannel:enaHolder.

     b open.

                                                                        [exEnd]

  with models, one checkBox disabling the others:

                                                                        [exBegin]

     |dialog translator enableChannel val1 val2 val3 eBox box1 box2 box3|

     translator := Plug new.

     translator respondTo:#enableDisable 

                with:[

                        enableChannel value

                            ifTrue:[

                                box1 enable.

                                box2 enable.

                                box3 enable.

                            ]

                            ifFalse:[

                                box1 disable.

                                box2 disable.

                                box3 disable.

                            ]

                     ].

     enableChannel := true asValue.

     enableChannel onChangeSend:#enableDisable to:translator.

     val1 := true asValue.

     val2 := false asValue.

     val3 := true asValue.

     dialog := Dialog new.

     dialog addCheckBox:'enable' on:enableChannel.

     dialog addVerticalSpace.

     dialog leftIndent:30.

     box1 := dialog addCheckBox:'value1' on:val1.

     dialog addVerticalSpace.

     box2 := dialog addCheckBox:'value2' on:val2.

     dialog addVerticalSpace.

     box3 := dialog addCheckBox:'value3' on:val3.

     dialog addVerticalSpace.

     dialog addOkButton.

     dialog open.

                                                                        [exEnd]

  multiple checkBoxes on a single model (using different aspects)

                                                                        [exBegin]

     |top panel b model value1 value2|

     value1 := true.

     value2 := false.

     model := Plug new.

     model respondTo:#value1 with:[value1].

     model respondTo:#value1: with:[:val | value1 := val].

     model respondTo:#value2 with:[value2].

     model respondTo:#value2: with:[:val | value2 := val].

     top := DialogBox new.

     top extent:200@300.

     panel := VerticalPanelView new.

     b := CheckBox in:panel.

     b label:'check1'.

     b aspect:#value1; model:model; changeMessage:#value1:.

     b := CheckBox in:panel.

     b label:'check2'.

     b aspect:#value2; model:model; changeMessage:#value2:.

     top addComponent:panel.

     top addAbortButton; addOkButton.

     top openModal.

     top accepted ifTrue:[

         Transcript show:'value1: '; showCR:model value1.

         Transcript show:'value2: '; showCR:model value2.

     ]

                                                                        [exEnd]

"

! !

!CheckBox class methodsFor:'instance creation'!

label:aStringOrImage model:aModel

    "create & return a new checkBox, on aModel (typically a ValueHolder),

     with aStringOrImage as label."

    ^ (self model:aModel) label:aStringOrImage

    "Created: 17.9.1995 / 14:20:58 / claus"

    "Modified: 28.2.1997 / 19:23:59 / cg"

! !

!CheckBox class methodsFor:'defaults'!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style (#'checkBox.labelForegroundColor' 

                       #'checkBox.disabledLabelForegroundColor'

                       #'checkBox.toggleLeft')>

    DefaultFont                         := StyleSheet fontAt:'label.font'.                   

    DefaultLabelForegroundColor         := StyleSheet colorAt:'checkBox.labelForegroundColor'.

    DefaultDisabledLabelForegroundColor := StyleSheet colorAt:'checkBox.disabledLabelForegroundColor'.

    CheckToggleLeft                     := StyleSheet at:'checkBox.toggleLeft' default:true

    "

     self updateStyleCache

    "

    "Created: 14.12.1995 / 14:47:22 / cg"

    "Modified: 20.10.1997 / 13:51:30 / cg"

! !

!CheckBox methodsFor:'accessing-behavior'!

action:aBlock

    "set the actionBlock; forwarded to the toggle"

    toggleView action:aBlock

    "Modified: 25.4.1996 / 16:31:19 / cg"

!

disable

    "disable the checkBox; forwarded to toggle & change labels color"

    |clr|

    toggleView disable.

    clr := disabledLabelForegroundColor.

    clr isNil ifTrue:[ clr := toggleView disabledForegroundColor ].

    labelView foregroundColor:clr.

    "Modified: 25.4.1996 / 16:31:31 / cg"

!

enable

    "enable the checkBox; forwarded to toggle & change labels color"

    |clr|

    toggleView enable.

    clr := labelForegroundColor.

    clr isNil ifTrue:[ clr := labelView foregroundColor ].

    labelView foregroundColor:clr. 

    "Modified: 25.4.1996 / 16:31:40 / cg"

!

enabled

    "return true, if the checkBox is enabled.

     forwarded to toggle"

    ^ toggleView enabled.

!

pressAction:aBlock

    "set the pressAction; forwarded to the toggle"

    toggleView pressAction:aBlock.

    "Created: 22.9.1995 / 15:54:04 / claus"

    "Modified: 25.4.1996 / 16:31:52 / cg"

!

releaseAction:aBlock

    "set the releaseAction; forwarded to the toggle"

    toggleView releaseAction:aBlock.

    "Created: 22.9.1995 / 15:54:11 / claus"

    "Modified: 25.4.1996 / 16:32:00 / cg"

! !

!CheckBox methodsFor:'accessing-channels'!

backgroundChannel

    ^labelView backgroundChannel

!

backgroundChannel:aChannel

    labelView backgroundChannel: (backgroundChannel := aChannel).

    aChannel onChangeSend:#value to: [self enableStateChanged]

!

enableChannel

    "return a valueHolder for enable/disable"

    ^ toggleView enableChannel

    "Created: 30.4.1996 / 15:11:13 / cg"

!

enableChannel:aChannel

    "set the enableChannel"

    |wasEnabled|

    wasEnabled := toggleView enabled.

    toggleView enableChannel:aChannel.

    aChannel onChangeSend:#value to: [self enableStateChanged].

    aChannel value ~~ wasEnabled ifTrue:[

        self enableStateChanged

    ]

!

foregroundChannel

    ^labelView foregroundChannel

!

foregroundChannel:aChannel

    labelView foregroundChannel: (foregroundChannel := aChannel).

    aChannel onChangeSend:#value to: [self enableStateChanged]

!

labelChannel

    ^labelView labelChannel

!

labelChannel:aChannel

    labelView labelChannel: aChannel

! !

!CheckBox methodsFor:'accessing-colors'!

backgroundColor

    "get backgroundColor of the label view"

    ^labelView backgroundColor

!

backgroundColor: backgroundColor

    "set backgroundColor only for the label view"

    labelView backgroundColor: backgroundColor.

!

foregroundColor

    "get foregroundColor of the label view"

    ^labelView foregroundColor

!

foregroundColor: foregroundColor

    "set foregroundColor only for the label view"

    labelView foregroundColor: (labelForegroundColor := foregroundColor).

    foregroundChannel notNil ifTrue: [foregroundChannel value: foregroundColor]

!

viewBackground: backgroundColor

    "set backgroundColor"

    labelView backgroundColor: backgroundColor.

    super viewBackground: backgroundColor

! !

!CheckBox methodsFor:'accessing-components'!

labelView

    "return the labelView; allows manipulation of the

     labels attributes (colors etc.)"

    ^ labelView

!

toggleView

    "return the toggleView; allows manipulation of the

     toggles attributes (colors etc.)"

    ^ toggleView

! !

!CheckBox methodsFor:'accessing-look'!

activeLogo:anImageOrString

    "set the activeLogo; forwarded to the toggle"

    toggleView activeLogo:anImageOrString

    "Created: 22.9.1995 / 15:44:08 / claus"

    "Modified: 25.4.1996 / 16:32:50 / cg"

!

disabledLabelForegroundColor

    "set the disabledLabelForegroundColor; forwarded to the toggle"

    disabledLabelForegroundColor isNil ifTrue:[ ^ toggleView disabledForegroundColor ].