Object subclass:#Menu

	instanceVariableNames:'items groupSizes receiver'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Support'

!

!Menu class methodsFor:'documentation'!

documentation

"

    not yet finished Menu class - this will eventually replace

    most of the MenuView and PopUpMenu stuff.

    (and hopefully be ST-80 compatible ...)

    For now, only a subset of the full protocol is implemented.

    [author:]

    [see also:]

"

! !

!Menu class methodsFor:'instance creation'!

labelArray: arrayOfString lines: linesArray values: valueArrayOrNil

    "return a menu with menu items built with labels from arrayOfString (not Symbols).  

     The linesArray describes which menu items are the last menu item in their group. 

     The valueArray contains value objects for each menu item 

     (or is nil if no value objects are specified)."

    | nLabel valueArray menuItems groupLengths |

    nLabel := arrayOfString size.

    valueArrayOrNil isNil ifTrue:[

    ] ifFalse:[

    ].

    nLabel ~~ valueArray size ifTrue: [

    ].

    menuItems := Array new:nLabel.

    1 to:nLabel do:[:i |

    ].

    (linesArray == nil or:[linesArray isEmpty]) ifTrue:[

    ] ifFalse:[

    ].

    ^ self new 

    "Modified: / 31.10.1997 / 03:19:14 / cg"

!

labelList:arrayOfGroupStrings values:valueArrayOrNil

    |labels lines|

    lines := arrayOfGroupStrings collect:[:each | each size].

    labels := OrderedCollection new.

    arrayOfGroupStrings do:[:group | labels addAll:group].

    ^ self labelArray:labels lines:lines values:valueArrayOrNil

    "Modified: 20.6.1997 / 10:46:45 / cg"

    "Created: 13.9.1997 / 10:35:46 / cg"

!

labels:aString lines:linesArray values:valueArrayOrNil

    ^ self 

    "Created: / 31.10.1997 / 03:12:20 / cg"

    "Modified: / 31.10.1997 / 03:23:42 / cg"

! !

!Menu methodsFor:'ST-80 compatibility'!

indexOfMenuItem:anItem

    ^ items indexOf:anItem

    "Created: / 27.10.1997 / 16:34:19 / cg"

!

menuButtons

    "ST-80 seems to use a special menuButton class here.

     Here, kludge a collection of menuItems."

    ^ items

    "Created: / 27.10.1997 / 16:33:35 / cg"

! !

!Menu methodsFor:'accessing'!

addItem:aMenuItem

    items isNil ifTrue:[

    ].

    items add:aMenuItem.

!

addItem:aMenuItem value:aValue

    aMenuItem value:aValue.

    self addItem:aMenuItem.

!

addItemGroup:aCollectionOfItems

    groupSizes isNil ifTrue:[

    ].

    groupSizes add:aCollectionOfItems size.

    aCollectionOfItems do:[:item |

    ].

    "Created: / 27.10.1997 / 15:02:15 / cg"

!

addItemGroup:aGroup values:values

    groupSizes isNil ifTrue:[

    ].

    groupSizes add:items size.

    aGroup with:values do:[:item :value |

    ].

!

addItemGroupLabels:labels values:values

    |items|

    items := labels with:values

    self addItemGroup:items

    "Created: / 27.10.1997 / 19:49:27 / cg"

!

addItemLabel:label value:value

    |item|

    item := MenuItem new.

    item label:label.

    item value:value.

    self addItem:item

    "Created: / 27.10.1997 / 19:47:12 / cg"

!

atNameKey:aNameKey

    "return the menuItem for the given nameKey; nil if no such item is in the menu.

     Searches in allItems (i.e. also in subMenus)"

    self allItemsDo:[:anItem|

    ].

    ^ nil

    "Modified: / 27.10.1997 / 15:12:00 / cg"

!

groupSizes

    "return the value of the instance variable 'groupSizes' (automatically generated)"

    ^ groupSizes!

groupSizes:something

    "set the value of the instance variable 'groupSizes' (automatically generated)"

    groupSizes := something.!

labelAt:anIndex

    "gets the label of the menu item at the given index or nil

    "

    |item|

    (item := self menuItemAt:anIndex) notNil ifTrue:[

    ].

  ^ nil

!

labelAtValue:aValue

    "gets the label of the menu item assigned to value

    "

    |item|

    item := self menuAndSubmenusDetectItem:[:anItem| anItem value == aValue ].

    item notNil ifTrue:[

    ].

  ^ nil

!

labels

    "return a collection of labels from my items"

    ^ items collect:[:anItem | anItem label]

    "Created: 25.2.1997 / 19:47:53 / cg"

!

lines

    "return the indexes of the menu items that are the last menu item in their group (except the very last)."

    | lines |

    groupSizes size <= 1 ifTrue: [^Array new].

    lines := Array new: groupSizes size - 1.

    lines at: 1 put: groupSizes first.

    2 to: groupSizes size -1 do: 

    ^lines

    "Modified: / 31.10.1997 / 03:19:51 / cg"

!

menuItemAt:index

    "gets the menu item at the given index. When the index is out of bounds

     nil is returned

    "

    (index > 0 and:[index <= items size]) ifTrue:[

    ].

  ^ nil

!

menuItemLabeled:anItemLabel

    "return the menuItem for the given nameKey; nil if no such item is in the menu.

     Searches all items (i.e. also submenu items)"

    self allItemsDo:[:anItem|

    ^ nil

    "Created: / 13.9.1997 / 10:25:16 / cg"

    "Modified: / 27.10.1997 / 15:23:33 / cg"

!

menuItems

    ^ items

!

menuItems:aCollectionOfMenuItems menuItemGroups:sizes values:values

    items := aCollectionOfMenuItems.

    groupSizes := sizes.

    values notNil ifTrue:[

    ].

    "Modified: 20.6.1997 / 10:45:30 / cg"

!

numberOfItems

    ^ items size

    "Created: 6.3.1997 / 15:15:53 / cg"

!

receiver

    "return the value of the instance variable 'receiver' (automatically generated)"

    ^ receiver!

receiver:something

    "set the value of the instance variable 'receiver' (automatically generated)"

    receiver := something.!

removeItem:aMenuItem

    |idx|

    items notNil ifTrue:[

    ].

    "Created: 13.9.1997 / 10:27:31 / cg"

!

valueAt:index

    "return a collection of values from my items"

    ^ (items at:index) value

    "Created: 25.2.1997 / 19:49:41 / cg"

!

valueAt:anIndex put:aValue

    "put value an an index"

    (items at:anIndex) value:aValue

    "Created: 6.3.1997 / 15:15:48 / cg"

!

values

    "return a collection of values from my items"

    ^ items collect:[:anItem | anItem value]

    "Created: 25.2.1997 / 19:49:29 / cg"

!

values:aCollectionOfValues

    "return a collection of values from my items"

    |s|

    s := aCollectionOfValues readStream.

    self itemsDo:[:item |

    ].

    s atEnd ifFalse:[self halt]

    "Created: / 27.10.1997 / 15:15:47 / cg"

!

visibleMenuItemGroups

    "Created: / 27.10.1997 / 15:07:50 / cg"

! !

!Menu methodsFor:'accessing resource'!

findGuiResourcesIn:aResourceContainerOrApplication

    "setup a resource owner

    "

    aResourceContainerOrApplication notNil ifTrue:[

    ]

! !

!Menu methodsFor:'converting'!

fromLiteralArrayEncoding:aLiteralEncodedArray

    "read my contents from a aLiteralEncodedArray"

    |items groups values|

    items := (aLiteralEncodedArray at:2) collect:[:item | item decodeAsLiteralArray].

    groups := aLiteralEncodedArray at:3.

    values := aLiteralEncodedArray at:4.

    self menuItems:items menuItemGroups:groups values:values.

    "extract from PD folder.st:

     #(#Menu #(

       ) decodeAsLiteralArray

    "

    "

     #(#Menu #(

       ) decodeAsLiteralArray startUp  

    "

    "extract from iconicBrowser.st:

     #(#Menu #(

       ) decodeAsLiteralArray startUp  

    "

    "extract from refactory213.st:

     #(#Menu #(