"

 COPYRIGHT (c) 1997 by eXept Software AG

              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' }"

Object subclass:#DataSetLabel

	instanceVariableNames:'label selector argument adjust font fgColor bgColor

	classVariableNames:''

	poolDictionaries:''

	category:'Views-DataSet'

!

!DataSetLabel class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by eXept Software AG

              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.

"

! !

!DataSetLabel methodsFor:'accessing-colors'!

backgroundColor

    "returns the background color or nil

    "

    ^ bgColor

!

backgroundColor:aColor

    "set the background color or nil

    "

    bgColor := aColor

!

foregroundColor

    "returns the foreground color or nil

    "

    ^ fgColor

!

foregroundColor:aColor

    "set the foreground color or nil

    "

    fgColor := aColor

! !

!DataSetLabel methodsFor:'accessing-dimensions'!

preferredHeight

    "returns my preferred height

    "

    ^ preferredHeight

!

preferredWidth

    "returns my preferred width

    "

    ^ preferredWidth

! !

!DataSetLabel methodsFor:'actions'!

sendClickMsgTo:aReceiver

    "inform the receiver of a button release notification

    "

    (aReceiver notNil and:[selector notNil]) ifTrue:[

        aReceiver perform:selector withOptionalArgument:argument

    ]

! !

!DataSetLabel methodsFor:'drawing'!

    "redraw the label; the background is cleared and the paint is set

    "

    |y0 x gcFont labelWidth 

     shownLabel prevClip mustUndoClip

     netWidth goodLookingVerticalSpacing|

    label isNil ifTrue:[ ^ self ].

    font notNil ifTrue:[

    ].

    y0 := (height - preferredHeight) // 2.

    y0 := y0 + goodLookingVerticalSpacing.

    netWidth := width-inset-inset.

    label do:[:aLabel|

        shownLabel := aLabel.

        mustUndoClip := false.

        labelWidth > netWidth ifTrue:[

        ].

        adjust == #left ifTrue:[

            x := xLeft + inset.

        ] ifFalse:[

            x := width - labelWidth.

            x := xLeft + x.

           "/ cg: must clip left, if string is too large

            x < xLeft ifTrue:[

                "/ must clip ...

                mustUndoClip := true.

                                    left:xLeft top:y0 

                                    width:width height:height).

            ].

        ].

        mustUndoClip == true ifTrue:[

        ].

    ].

    gcFont notNil ifTrue:[

    ].       

! !

!DataSetLabel methodsFor:'instance creation'!

description:aDescription builder:aBuilder on:aGC

    |device gcFont verticalSpace|

    label           := self resolveLabelFromDescription:aDescription withBuilder:aBuilder.

    selector        := aDescription  labelActionSelector.

    argument        := (aDescription labelActionArgument) ? label.

    adjust          := (aDescription labelAlignment) ? #left.

    device          := aGC device.

    fgColor         := aDescription labelForegroundColor.

    bgColor         := aDescription labelBackgroundColor.

    fgColor notNil ifTrue:[ fgColor := fgColor onDevice:device ].

    bgColor notNil ifTrue:[ bgColor := bgColor onDevice:device ].

    preferredHeight := preferredWidth := 0.

    (label isEmptyOrNil) ifTrue:[

        label := nil.

        ^ self

    ].

    font := aDescription labelFont.

    font notNil ifTrue:[

        font := aBuilder resolveFont:font.

        font notNil ifTrue:[

            gcFont := aGC font.

            gcFont = font ifTrue:[

                font := nil

            ] ifFalse:[

                    font := font onDevice:device.

                    aGC font:font.

            ].

        ].

    ].

    label isString ifTrue:[

        label := Array with:label.

    ] ifFalse:[

        (label isSequenceable not) ifTrue:[

            label := Array with:label.

        ]

    ].

    verticalSpace := aGC font descent. "/ goodLookingVerticalSpacing

    label := label 

                collect:[:el|

                    |lbl|

                    lbl := self label:el on:device.

                    preferredWidth  := (lbl widthOn:aGC) max:preferredWidth.

                    preferredHeight := preferredHeight + verticalSpace + (lbl heightOn:aGC) + verticalSpace.

                    lbl

                ].

    font notNil ifTrue:[aGC font:gcFont].       "/ restore font

! !

!DataSetLabel methodsFor:'private'!

label:aLabel on:aDevice

    "returns registered label on a device

    "

    |lbl img|

    aLabel isNil ifTrue:[^ ''].

    aLabel isString ifFalse:[

        aLabel isImageOrForm ifTrue:[

            aLabel device ~~ aDevice ifTrue:[

                lbl := aLabel copy onDevice:aDevice

            ] ifFalse:[

                lbl := aLabel

            ].

            lbl isImage ifTrue:[

                lbl clearMaskedPixels

            ].

            ^ lbl

        ].

        aLabel class == LabelAndIcon ifTrue:[

            lbl := aLabel onDevice:aDevice.

            (img := lbl image) isImage ifTrue:[img clearMaskedPixels].

            (img := lbl icon)  isImage ifTrue:[img clearMaskedPixels].

            ^ lbl

        ]

    ].

    ^ aLabel

!

resolveLabelFromDescription:aDescription withBuilder:aBuilder

    |rawLabel appl resources lbl|

    aBuilder isNil ifTrue:[

        rawLabel := aDescription rawLabel.

        rawLabel isString ifTrue:[

            rawLabel isEmpty ifTrue:[^ nil ].

            lbl := rawLabel asStringCollection.

            lbl size > 1 ifTrue:[^ lbl ].

        ].

        ^ rawLabel        

    ].

    rawLabel := aDescription label.

    rawLabel isNil ifTrue:[^ nil ].

    aBuilder isEditing ifFalse:[

        appl := aBuilder application.

        appl notNil ifTrue:[ resources := appl resources ].

    ].

    rawLabel isString ifTrue:[

        aDescription labelIsImage ifTrue:[

            (aBuilder isEditing or:[(rawLabel := aBuilder labelFor:(rawLabel asSymbol)) isNil]) ifTrue:[

                ^ aDescription class defaultIcon

            ]

        ] ifFalse:[

            aDescription translateLabel == true ifTrue:[

                lbl := (aBuilder aspectAt:(rawLabel asSymbol)) value.

                (lbl isNil and:[resources notNil]) ifTrue:[

                    lbl := resources string:rawLabel default:nil.

                ].

                lbl notNil ifTrue:[ rawLabel := lbl ].

            ].

        ].

    ] ifFalse:[

        rawLabel isSequenceable ifFalse:[^ rawLabel].

        rawLabel isEmptyOrNil ifTrue:[^ nil ].

        resources notNil ifTrue:[

            lbl := resources string:rawLabel default:nil.

            lbl notNil ifTrue:[

                rawLabel := lbl.

            ] ifFalse:[

                lbl := resources array:rawLabel.

                lbl notEmptyOrNil ifTrue:[

                    lbl size == 1 ifTrue:[ rawLabel := lbl first ]

                                 ifFalse:[ rawLabel := lbl ].

                ].

            ].

        ].

    ].

    rawLabel isString ifTrue:[

        rawLabel isEmpty ifTrue:[ ^ nil ].

        lbl := rawLabel asStringCollection.

        lbl size > 1 ifTrue:[^ lbl ].

    ].

    ^ rawLabel

! !

!DataSetLabel methodsFor:'queries'!

hasSeparator

    |l|

    label size == 1 ifTrue:[

"/        ^ (label at:1) ~= 'Alarm'

        ^ (label at:1) ~= 'Area'

    ].

    ^ true

!

isSelectable

    "returns true if the item is selectable; a valid selector

     to notify the receiver for a release button event exists

    "

    ^ selector notNil

! !

!DataSetLabel class methodsFor:'documentation'!

version

! !