"

 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 activeTabMarkerColor

		activeTabMarkerFGColor tabWasActiveWhenPressed removeTabIcon

		removeTabEnteredIcon removeTabDisabledIcon

		showingEnteredRemoveTabButton'

	classVariableNames:'DefaultForegroundColor DefaultBackgroundColor

		DefaultActiveForegroundColor DefaultActiveBackgroundColor

		DefaultShadowColor DefaultHalfShadowColor DefaultLightColor

		DefaultHalfLightColor DefaultEdgeStyle DisabledForegroundColor

		DefaultActiveTabMarkerColor DefaultActiveTabMarkerFgColor

		RemoveTabIcon RemoveTabEnteredIcon'

	poolDictionaries:''

	category:'Views-Layout'

!

Object subclass:#Tab

	instanceVariableNames:'label tabItem printableLabel disabledLabel lineNr

		unselectedLayout selectedLayout layout extent accessCharacter

		lastFocusViewId'

	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.

    [author:]

        Claus Atzkern

    [see also:]

        TabView

"

!

examples

"

    tabs at top & bottom

                                                                                [exBegin]                                      

    |top tab1 tab2|

    top := StandardSystemView extent:300@100.

    tab1 := NoteBookView origin:0.0 @ 0.0 corner:1.0 @ 0.5 in:top.

    tab1 direction:#top.

    tab1 list:#( 'Foo' 'Bagr' 'Baz' 'Bgar' 'Baqz'  ).

    tab2 := NoteBookView origin:0.0 @ 0.5 corner:1.0 @ 1.0 in:top.

    tab2 direction:#bottom.

    tab2 list:#( 'Foo' 'Bagr' 'Baz' 'Bgar' 'Baqz'  ).

    top open.

                                                                                [exEnd]

    tabs at left & right

                                                                                [exBegin]                                      

    |top tab1 tab2|

    top := StandardSystemView extent:100@300.

    tab1 := NoteBookView origin:0.0 @ 0.0 corner:0.5 @ 01.0 in:top.

    tab1 direction:#left.

    tab1 list:#( 'Foo' 'Bagr' 'Baz' 'Bgar' 'Baqz'  ).

    tab2 := NoteBookView origin:0.5 @ 0.0 corner:1.0 @ 1.0 in:top.

    tab2 direction:#right.

    tab2 list:#( 'Foo' 'Bagr' 'Baz' 'Bgar' 'Baqz'  ).

    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'

                       #'noteBook.showRemoveTabIcon' 

                      )>

    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.

    ].

    (StyleSheet at:#'noteBook.showRemoveTabIcon' default:true) ifTrue:[

        RemoveTabIcon := XPToolbarIconLibrary removeTab14x14Icon.

        RemoveTabEnteredIcon := XPToolbarIconLibrary removeTabEntered14x14Icon.   

    ] ifFalse:[

        RemoveTabIcon := RemoveTabEnteredIcon := nil.   

    ].

    "

     self updateStyleCache

    "

! !

!NoteBookView class methodsFor:'image specs'!

tabBackgroundVista

    "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 tabBackgroundVista inspect

     ImageEditor openOnClass:self andSelector:#tabBackgroundVista

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:#'NoteBookView class tabBackgroundVista'

        ifAbsentPut:[(Depth8Image new) width: 5; height: 25; photometric:(#palette); bitsPerSample:(#[8]); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'

B@ HB@ NC 8NC 4MCP4MCP4MCP4LC@0LC@,KB0,KB0,KB0,JB (JB (JB (JBP$IBP$GA0\GA0@@@@@@@@@@@@@@@@@@@@@@@@@@@PDA@PDA@PDA@PHB@ HB

@0LC@0LDA@PDA@TEAPTEA XFA XGA0\GA0\GA0\GA0\GA0\b') ; colorMapFromArray:#[232 232 232 233 233 233 234 234 234 235 235 235 236 236 236 237 237 237 238 238 238 240 240 240 242 242 242 245 245 245 246 246 246 247 247 247 248 248 248 249 249 249 250 250 250]; yourself]

! !

!NoteBookView methodsFor:'accepting-items'!

tabAtIndex:tabIndex put:newLabelOrTabItem

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

     be reused otherwise we must recompute the whole list

    "

    |tab tabLayout prefX prefY tabExtent|

    "/ a single items label has changed

    tab := list at:tabIndex ifAbsent:nil.

    tab notNil ifTrue:[

        tab labelOrTabItem:newLabelOrTabItem on:self.

        "/ no resizing, if the new string fits

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

        tabLayout := tab unselectedLayout.

        tabExtent := self preferredExtentForTab:tab.

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

         and:[(prefY := tabExtent y) <= tabLayout 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

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

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

            ].

        ].

        self recomputeList.

        self invalidate.

        ^ self.

    ].

    "/ can this happen ?

    "Created: / 25-02-2000 / 14:13:59 / cg"

    "Modified: / 06-09-2006 / 17:17:03 / cg"

! !

!NoteBookView methodsFor:'accessing'!

canvas

    "returns the canvas; the containter view

    "

    ^ canvas

!

canvas:newCanvas

    "change the canvas; the container view"

    |oldCanvas hadFocus focusView|

    oldCanvas := canvas.

    hadFocus  := false.

    (shown and:[newCanvas notNil and:[oldCanvas notNil]]) ifTrue:[

        windowGroup notNil ifTrue:[

            focusView := windowGroup focusView.

        ].

        (focusView notNil and:[focusView ~~ self]) ifTrue:[

            (focusView isComponentOf:oldCanvas) ifTrue:[

                hadFocus := true.

            ].

        ].

    ].

    newCanvas ~~ oldCanvas ifTrue:[

        oldCanvas notNil ifTrue:[

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

                oldCanvas beInvisible.

            ] ifFalse:[

                oldCanvas destroy.

            ].

        ].

        canvas := newCanvas.

        newCanvas notNil ifTrue:[

            tabModus := false.

            self resizeCanvas.

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

                self addSubView:newCanvas

            ].

            shown ifTrue:[

                newCanvas beVisible.

                newCanvas raise.

            ].

        ].

    ].

    (shown and:[hadFocus]) ifTrue:[

        self pushEvent:#updateFocusView

    ].

    "Modified: / 05-11-2007 / 14:23:58 / cg"

!

list

    "return the list of Tabs or Labels

    "

    ^ list collect:[:aTab| aTab label ]

!

list:newTabItemListOrNil

    "set the tab-list"

    |selectionName newList newTabItemList|

    newTabItemList := newTabItemListOrNil ? #().

    useIndex ifFalse:[

        selectionName := self selection.

    ].

    list do:[:eachTab| 

        |tabItem|

        ((tabItem := eachTab tabItem) notNil and:[(newTabItemList includesIdentical:tabItem)]) ifFalse:[

            tabItem notNil ifTrue:[tabItem view:nil].

            eachTab removeDependent:self

        ]

    ].

    newList := newTabItemList collect:

        [:eachNewItem| 

            |tab|

            (eachNewItem isNil or:[(tab := list detect:[:eachTab| eachTab tabItem == eachNewItem] ifNone:nil) isNil]) ifTrue:[

                tab := Tab labelOrTabItem:eachNewItem on:self.

                tab addDependent:self.

            ].

            tab

        ].

    list            := newList.

    preferredExtent := nil.

    numberOfLines   := nil.

    selection notNil ifTrue:[

        useIndex ifTrue:[

            selection > list size ifTrue:[

                selection := nil.

                self selectionChanged.

            ] ifFalse:[

                model notNil ifTrue:[

                    "/ force a simulated selection change (so that the canvas gets updated)

                    model changed.

                ]

            ].

        ] ifFalse:[

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

            selection == 0 ifTrue:[

                selection := nil.

                self selectionChanged.

            ] ifFalse:[

                model notNil ifTrue:[

                    "/ force a simulated selection change (so that the canvas gets updated)

                    model changed.

                ]

            ]

        ]

    ].

    self recomputeList.

    self invalidate.

    "Modified: / 06-09-2006 / 17:10:24 / cg"

!

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

!

disableDestroyButtonOfInactiveTabs

    ^ true

!

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

!