"

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

View subclass:#NoteBookView

	instanceVariableNames:'list listHolder foregroundColor backgroundColor selection enabled

		action useIndex direction numberOfLines selectConditionBlock

		accessTabMenuAction canvas canvasInset canvasHolder

		halfLightColor halfShadowColor fitLastRow tabModus

		lastComputedExtent keepCanvas activeForegroundColor

		activeBackgroundColor drawLightColor edgeStyle tabInset

		tabLabelInset disabledForegroundColor tabLevel tabTopMargin

		tabBottomMargin selectionInsetX selectionInsetY translateLabel

		buttonPrev buttonNext tabRightMargin tabLeftMargin

		showDestroyTabButton destroyTabAction'

	classVariableNames:'DefaultForegroundColor DefaultBackgroundColor

		DefaultActiveForegroundColor DefaultActiveBackgroundColor

		DefaultShadowColor DefaultHalfShadowColor DefaultLightColor

		DefaultHalfLightColor DefaultEdgeStyle DisabledForegroundColor

		DefaultActiveTabMarkerColor DefaultActiveTabMarkerFgColor'

	poolDictionaries:''

	category:'Views-Layout'

!

Object subclass:#Tab

	instanceVariableNames:'label model printableLabel disabledLabel lineNr layout extent

		accessCharacter'

	classVariableNames:''

	poolDictionaries:''

	privateIn:NoteBookView

!

!NoteBookView 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.

"

!

documentation

"

    implements the noteBook.

    May also be used on its own (without a surrounding noteBook).

    [author:]

        Claus Atzkern

    [see also:]

        TabView

"

!

examples

"

    tabs at top ( default )

                                                                                [exBegin]                                      

    |top tab|

    top  := StandardSystemView extent:250@100.

    tab := NoteBookView origin:0.0 @ 0.0 corner:1.0 @ 1.0 in:top.

    tab list:#( 'Foo' 'Bar' 'Baz' ).

    tab action:[:index| Transcript showCR:index].

    top open.

                                                                                [exEnd]

    tabs at bottom

                                                                                [exBegin]                                      

    |top tab|

    top  := StandardSystemView extent:250@100.

    tab := NoteBookView origin:0.0 @ 0.0 corner:1.0 @ 1.0 in:top.

    tab direction:#bottom.

    tab list:#( 'Foo' 'Bar' 'Baz' ).

    tab action:[:index| Transcript showCR:index].

    top open.

                                                                                [exEnd]

    tabs at left

                                                                                [exBegin]                                      

    |top tab|

    top  := StandardSystemView extent:100@200.

    tab := NoteBookView origin:0.0 @ 0.0 corner:1.0 @ 1.0 in:top.

    tab direction:#left.

    tab list:#( 'Foo' 'Bar' 'Baz' ).

    tab action:[:index| Transcript showCR:index].

    top open.

                                                                                [exEnd]

    tabs at right

                                                                                [exBegin]                                      

    |top tab|

    top  := StandardSystemView extent:100@200.

    tab := NoteBookView origin:0.0 @ 0.0 corner:1.0 @ 1.0 in:top.

    tab direction:#right.

    tab list:#( 'Foo' 'Bar' 'Baz' ).

    tab action:[:index| Transcript showCR:index].

    top open.

                                                                                [exEnd]

"

! !

!NoteBookView class methodsFor:'defaults'!

defaultFont

    ^ MenuView defaultFont

!

updateStyleCache

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

    <resource: #style (#'noteBook.foregroundColor' #'noteBook.backgroundColor'

                       #'noteBook.activeForegroundColor' #'noteBook.activeBackgroundColor'

                       #'noteBook.lightColor' #'noteBook.halfLightColor' #'noteBook.shadowColor'

                       #'noteBook.halfShadowColor' #'noteBook.edgeStyle'

                       #'noteBook.activeTabMarkerColor'

                      )>

    DefaultForegroundColor := StyleSheet colorAt:#'noteBook.foregroundColor'.

    DefaultForegroundColor isNil ifTrue:[

        DefaultForegroundColor := StyleSheet colorAt:#'button.foregroundColor'.

    ].

    DefaultBackgroundColor := StyleSheet colorAt:#'noteBook.backgroundColor'.

    DefaultActiveForegroundColor := StyleSheet colorAt:#'noteBook.activeForegroundColor'.

    DefaultActiveForegroundColor isNil ifTrue:[

        DefaultActiveForegroundColor := StyleSheet colorAt:#'button.activeForegroundColor'

    ].

    DefaultActiveBackgroundColor := StyleSheet colorAt:#'noteBook.activeBackgroundColor'.

    DefaultLightColor := StyleSheet colorAt:#'noteBook.lightColor'.

    DefaultLightColor isNil ifTrue:[

        DefaultLightColor := StyleSheet colorAt:'button.lightColor'

    ].

    DefaultHalfLightColor := StyleSheet colorAt:#'noteBook.halfLightColor'.

    DefaultHalfLightColor isNil ifTrue:[

        DefaultHalfLightColor := StyleSheet colorAt:#'button.halfLightColor'

    ].    

    DefaultShadowColor := StyleSheet colorAt:#'noteBook.shadowColor'.

    DefaultShadowColor isNil ifTrue:[

        DefaultShadowColor := StyleSheet colorAt:'button.shadowColor'

    ].

    DefaultHalfShadowColor := StyleSheet colorAt:#'noteBook.halfShadowColor'.

    DefaultHalfShadowColor isNil ifTrue:[

        DefaultHalfShadowColor := StyleSheet colorAt:#'button.halfShadowColor'

    ].

    DefaultEdgeStyle := StyleSheet at:#'noteBook.edgeStyle'.

    DefaultEdgeStyle isNil ifTrue:[

        DefaultEdgeStyle := StyleSheet at:#'button.edgeStyle'

    ].

    DefaultEdgeStyle == #softWin95 ifFalse:[

        DefaultEdgeStyle := nil

    ].

    DefaultActiveTabMarkerColor := StyleSheet colorAt:#'noteBook.activeTabMarkerColor'.

    DefaultActiveTabMarkerColor isNil ifTrue:[

        DefaultActiveTabMarkerFgColor := nil.

    ] ifFalse:[

        DefaultActiveTabMarkerFgColor :=  Color redByte:255 greenByte:138 blueByte:41.

    ].

    "

     self updateStyleCache

    "

! !

!NoteBookView methodsFor:'accepting-items'!

tabAtIndex:tabIndex put:newLabel

    "called if the contents of a tab changed; test whether the old layout can

     be reused otherwise we must recompute the whole list

    "

    |tab layout prefX prefY tabExtent|

    "/ a single items label has changed

    tab := list at:tabIndex ifAbsent:nil.

    tab notNil ifTrue:[

        tab label:newLabel on:self.

        "/ no resizing, if the new string fits

        "/ and is not too small for current tab-layout

        layout := tab layout.

        tabExtent := self preferredExtentForTab:tab.

        (     (prefX := tabExtent x) <= layout width

         and:[(prefY := tabExtent y) <= layout height]

        ) ifTrue:[

            "/ the new string fits into current tab-layout

            numberOfLines == 1 ifTrue:[         "/ do not change the layout

                ^ self invalidateTab:tab

            ].

            "/ check whether the string is not too small for current tab-layout

            ((layout width <= (prefX * 1.5)) and:[layout height <= (prefY * 1.5)]) ifTrue:[

                ^ self invalidateTab:tab.      "/ do not change the layout

            ].

        ].

        self recomputeList.

        self invalidate.

        ^ self.

    ].

    "/ can this happen ?

    "Created: / 25.2.2000 / 14:13:59 / cg"

! !

!NoteBookView methodsFor:'accessing'!

canvas

    "returns the canvas; the containter view

    "

    ^ canvas

!

canvas:newCanvas

    "change the canvas; the containter view

    "

    |oldCanvas|

    oldCanvas := canvas.

    newCanvas ~~ oldCanvas ifTrue:[

        oldCanvas notNil ifTrue:[

            (keepCanvas or:[(oldCanvas objectAttributeAt:#isTabItem) == true]) ifTrue:[

                oldCanvas unmap.

            ] ifFalse:[

                oldCanvas destroy.

            ].

        ].

        canvas := newCanvas.

        newCanvas notNil ifTrue:[

            tabModus := false.

            self resizeCanvas.

            (subViews size == 0 or:[(subViews includesIdentical:newCanvas) not]) ifTrue:[

                self addSubView:newCanvas

            ].

            realized ifTrue:[

                newCanvas realize.

                newCanvas raise.

            ].

        ]

    ].

!

list

    "return the list of Tabs or Labels

    "

    ^ list collect:[:aTab| aTab label ]

!

list:aList

    "set the list

    "

    |name newList|

    name    := self selection.

    newList := OrderedCollection new.

    aList size == 0 ifTrue:[

        list do:[:aTab| aTab removeDependent:self].

    ] ifFalse:[

        list do:[:aTab| |m|

            (     (m := aTab model) notNil

             and:[(aList includesIdentical:m)]

            ) ifFalse:[

                aTab removeDependent:self

            ]

        ].

        aList do:[:el| |i tab|

            (    el isNil

             or:[(tab := list detect:[:t| t model == el] ifNone:nil) isNil]

            ) ifTrue:[

                tab := Tab label:el on:self.

                tab addDependent:self.

            ].

            newList add:tab

        ]

    ].

    list            := newList.

    preferredExtent := nil.

    numberOfLines   := nil.

    selection notNil ifTrue:[

        useIndex ifTrue:[

            selection > list size ifTrue:[

                selection := nil.

                self selectionChanged.

            ]

        ] ifFalse:[

            selection := list findFirst:[:el| el label = name ].

            selection == 0 ifTrue:[

                selection := nil.

                self selectionChanged.

            ]

        ]

    ].

    self recomputeList.

    self invalidate.

!

listIndexOf:something

    "convert something to an index into the list;

     returns the index or nil if not found

    "

    |index|

    something isNil ifTrue:[^ nil ].

    something isNumber ifTrue:[

        index := something

    ] ifFalse:[

        index := list findFirst:[:aTab|aTab label = something].

        index == 0 ifTrue:[

            index := list findFirst:[:aTab|aTab printableLabel = something]

        ]

    ].

    ^ (index between:1 and:list size) ifTrue:[index] ifFalse:[nil]

!

useIndex

    "use index instead of tab name

    "

    ^ useIndex

!

useIndex:aBoolean

    "set/clear the useIndex flag. If set, both actionBlock and change-messages

     are passed the index(indices) of the selection as argument. 

     If clear, the value(s) (i.e. the selected string) is passed.

     Default is false."

    useIndex := aBoolean

! !

!NoteBookView methodsFor:'accessing-actions'!

accessTabMenuAction

    "callback to retrieve the menu for a specific tab.

     the argument to the block is the index of the tab

    "

    ^ accessTabMenuAction

!

accessTabMenuAction:aOneArgAction

    "callback to retrieve the menu for a specific tab.

     the argument to the block is the index of the tab

    "

    accessTabMenuAction := aOneArgAction.

!

action

    "get the action block to be performed on select; the argument to

     the block is the selected index or nil in case of no selection.

    "

    ^ action

!

action:oneArgBlock

    "set the action block to be performed on select; the argument to

     the block is the selected index or nil in case of no selection.

    "

    action := oneArgBlock.

! !

!NoteBookView methodsFor:'accessing-behavior'!

destroyTabAction

    ^ destroyTabAction

!

destroyTabAction:aOneArgBlock

    destroyTabAction := aOneArgBlock

!

enabled

    "returns true if tabs are enabled"

    ^ enabled

!

enabled:aState

    "set the enabled state of tabs"

    |state|

    state := aState ? true.

    enabled ~~ state ifTrue:[

        enabled := state.

        self invalidate.

    ]

!

isEnabled

    "returns the enabled state"

    ^ enabled

!

keepCanvas:aBoolean

    "if false (the default), the previous canvas is destroyed, whenever

     a new canvas is set.

     if true, it is unmapped and kept.

     Set this flag, if the application changes the canvas but wants

     them to be kept for fast switching."

    keepCanvas := aBoolean.

!

selectConditionBlock

    "get the conditionBlock; this block is evaluated before a selection

     change is performed; the change will not be done, if the evaluation

     returns false. The argument to the block is the selection index."

    ^ selectConditionBlock

!

selectConditionBlock:aOneArgBlock

    "get the conditionBlock; this block is evaluated before a selection

     change is performed; the change will not be done, if the evaluation

     returns false. The argument to the block is the selection index."

    selectConditionBlock := aOneArgBlock

!

translateLabel

    "true if labels are translated"

    ^ translateLabel    

!

translateLabel:aBoolean

    "set to true if labels should be translated"

    translateLabel := aBoolean.

!

translateToDisplayLabel:aString

    "translate the label"

    |application builder string|

    translateLabel ifFalse:[ ^ aString ].

    aString isEmptyOrNil ifTrue:[ ^ aString ].

    application := self application.