com.communote.common.menu

Class PositionDescriptor

java.lang.Object

com.communote.common.menu.PositionDescriptor

public class PositionDescriptor
extends Object

Describes the position of the entry in the menu.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PositionDescriptor.PositionType Possible types of positioning a menu entry

Constructor Summary

Constructors

Constructor and Description
PositionDescriptor() Create a new entry descriptor with BOTTOM positioning
PositionDescriptor(PositionDescriptor.PositionType positionType, String entryId) Create a new descriptor

Method Summary

Modifier and Type	Method and Description
String	getMenuEntryId()
PositionDescriptor.PositionType	getPositionType()

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionDescriptor

public PositionDescriptor()

Create a new entry descriptor with BOTTOM positioning

PositionDescriptor

public PositionDescriptor(PositionDescriptor.PositionType positionType,
                          String entryId)

Create a new descriptor

Parameters:

positionType - how to position the entry

entryId - the ID of another menu entry to position this item after if position type is AFTER

Method Detail

getMenuEntryId

public String getMenuEntryId()

Returns:

the ID of the menu entry to position this entry after if position type is AFTER. Should be null otherwise.

getPositionType

public PositionDescriptor.PositionType getPositionType()

Returns:

the type of the position