com.communote.common.menu

Class SubmenuBuilder<T extends MenuEntry>

java.lang.Object

com.communote.common.menu.SubmenuBuilder<T>

Type Parameters:

T - type of the menu entries of the sub menu

public class SubmenuBuilder<T extends MenuEntry>
extends Object

Builder for a sub-menu with entries whose positions are described declaratively by a PositionDescriptor.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
SubmenuBuilder()

Method Summary

Modifier and Type	Method and Description
void	addAll(List<T> entries, PositionDescriptor positionDescriptor) Add all of the given entries with the same position descriptor.
boolean	addEntry(T entry, PositionDescriptor positionDescriptor) Add an entry to the sub-menu.
List<T>	buildSubmenu() Build the resulting sub-menu
T	getEntry(String entryId) Return an entry by its ID.
T	removeEntry(String entryId) Remove an entry from the sub-menu.
T	removeEntry(T entry) Remove an entry from the sub-menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmenuBuilder

public SubmenuBuilder()

Method Detail

addAll

public void addAll(List<T> entries,
                   PositionDescriptor positionDescriptor)

Add all of the given entries with the same position descriptor.

Parameters:

entries - the entries to add to the sub-menu

positionDescriptor - descriptor of the position of each entry within the sub-menu

addEntry

public boolean addEntry(T entry,
                        PositionDescriptor positionDescriptor)

Add an entry to the sub-menu.

If called several times with position type TOP the entries which were added later will be positioned before those added earlier. If called several times with position type BOTTOM or AFTER (and the same menu entry ID to position after), the entries which were added later will be positioned after those added earlier. Entries with position type TOP are always before the BOTTOM positioned entries. Entries with position type AFTER will not appear in the resulting menu if the referenced menu entry does not exist. However, if that referenced entry is added later on, the entries to position after that entry will than be contained in the sub-menu.

To get the resulting sub-menu the build method needs to be called.

Parameters:

entry - the entry to add

positionDescriptor - descriptor of the position of the entry within the sub-menu, can be null for default positioning at bottom

Returns:

whether the entry was added or there was already an entry with the same ID

buildSubmenu

public List<T> buildSubmenu()

Build the resulting sub-menu

Returns:

ordered list of entries of this sub-menu

getEntry

public T getEntry(String entryId)

Return an entry by its ID.

Parameters:

entryId - the ID of the entry to return

Returns:

the entry or null if the entry does not exist

removeEntry

public T removeEntry(String entryId)

Remove an entry from the sub-menu. After successfully removing an entry the sub-menu has to be rebuild explicitly.

Parameters:

entryId - the ID of the entry to remove

Returns:

the removed entry if the entry existed, otherwise null

removeEntry

public T removeEntry(T entry)

Remove an entry from the sub-menu. After successfully removing an entry the sub-menu has to be rebuild explicitly.

Parameters:

entry - the entry to remove

Returns:

the removed entry if the entry existed, otherwise null