Package org.apache.pivot.wtk

Class Menu.Section

java.lang.Object

org.apache.pivot.wtk.Menu.Section

All Implemented Interfaces:

java.lang.Iterable<Menu.Item>, Sequence<Menu.Item>

Enclosing class:

Menu

public static class Menu.Section
extends java.lang.Object
implements Sequence<Menu.Item>, java.lang.Iterable<Menu.Item>

Class representing a menu section. A section is a grouping of menu items within a menu.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Constructors

Constructor	Description
Section()

Method Summary

Modifier and Type	Method	Description
int	add(Menu.Item item)	Adds an item to the sequence.
Menu.Item	get(int index)	Retrieves the item at the given index.
int	getLength()	Returns the length of the sequence.
Menu	getMenu()
java.lang.String	getName()
ListenerList<Menu.SectionListener>	getSectionListeners()
int	indexOf(Menu.Item item)	Returns the index of an item in the sequence.
void	insert(Menu.Item item, int index)	Inserts an item into the sequence at a specific index.
java.util.Iterator<Menu.Item>	iterator()
Sequence<Menu.Item>	remove(int index, int count)	Removes one or more items from the sequence.
int	remove(Menu.Item item)	Removes the first occurrence of the given item from the sequence.
void	setName(java.lang.String name)
Menu.Item	update(int index, Menu.Item item)	Updates the item at the given index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.pivot.collections.Sequence

addAll, addAll

Constructor Detail

Section

public Section()

Method Detail

getMenu

public Menu getMenu()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

add

public int add(Menu.Item item)

Description copied from interface: Sequence

Adds an item to the sequence.

Specified by:

add in interface Sequence<Menu.Item>

Parameters:

item - The item to be added to the sequence.

Returns:

The index at which the item was added, or -1 if the item was not added to the sequence.

insert

public void insert(Menu.Item item,
                   int index)

Description copied from interface: Sequence

Inserts an item into the sequence at a specific index.

Specified by:

insert in interface Sequence<Menu.Item>

Parameters:

item - The item to be added to the sequence.

index - The index at which the item should be inserted. Must be a value between 0 and getLength().

update

@UnsupportedOperation
public Menu.Item update(int index,
                        Menu.Item item)

Description copied from interface: Sequence

Updates the item at the given index.

Specified by:

update in interface Sequence<Menu.Item>

Parameters:

index - The index of the item to update.

item - The item that will replace any existing value at the given index.

Returns:

The item that was previously stored at the given index.

remove

public int remove(Menu.Item item)

Description copied from interface: Sequence

Removes the first occurrence of the given item from the sequence.

Specified by:

remove in interface Sequence<Menu.Item>

Parameters:

item - The item to remove.

Returns:

The index of the item that was removed, or -1 if the item could not be found.

See Also:

Sequence.remove(int, int)

remove

public Sequence<Menu.Item> remove(int index,
                                  int count)

Description copied from interface: Sequence

Removes one or more items from the sequence.

Specified by:

remove in interface Sequence<Menu.Item>

Parameters:

index - The starting index to remove.

count - The number of items to remove, beginning with index.

Returns:

A sequence containing the items that were removed.

get

public Menu.Item get(int index)

Description copied from interface: Sequence

Retrieves the item at the given index.

Specified by:

get in interface Sequence<Menu.Item>

Parameters:

index - The index of the item to retrieve.

Returns:

The item at this index in the sequence.

indexOf

public int indexOf(Menu.Item item)

Description copied from interface: Sequence

Returns the index of an item in the sequence.

Specified by:

indexOf in interface Sequence<Menu.Item>

Parameters:

item - The item to locate.

Returns:

The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

getLength

public int getLength()

Description copied from interface: Sequence

Returns the length of the sequence.

Specified by:

getLength in interface Sequence<Menu.Item>

Returns:

The number of items in the sequence.

iterator

public java.util.Iterator<Menu.Item> iterator()

Specified by:

iterator in interface java.lang.Iterable<Menu.Item>

getSectionListeners

public ListenerList<Menu.SectionListener> getSectionListeners()