org.docgene.model.globals

Class DefaultMenuItem

java.lang.Object

org.docgene.model.globals.AbstractMenuItem

org.docgene.model.globals.DefaultMenuItem

public class DefaultMenuItem
extends AbstractMenuItem

Represent a default Menu Item.

Since:

1.6.2

Field Summary

Fields

Modifier and Type	Field and Description
static short	CATEGORIES The type for the CATEGORIES menu item.
static short	DICTIONARY The type for the DICTIONARY menu item.
static short	GLOSSARY The type for the GLOSSARY menu item.
static short	HOME The type for the HOME menu item.
static short	LINKS_FROM The type for the LINKS_FROM menu item.

Constructor Summary

Constructors

Constructor and Description
DefaultMenuItem(short type) Constructor.
DefaultMenuItem(java.lang.String desc, short type) Constructor.

Method Summary

Modifier and Type	Method and Description
short	getType() Return the menu item type.
static boolean	supportType(short type) Return true if a item type is supported.

Methods inherited from class org.docgene.model.globals.AbstractMenuItem

getDescription

Methods inherited from class java.lang.Object

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

Field Detail

HOME

public static final short HOME

The type for the HOME menu item.

See Also:

Constant Field Values

DICTIONARY

public static final short DICTIONARY

The type for the DICTIONARY menu item.

See Also:

Constant Field Values

CATEGORIES

public static final short CATEGORIES

The type for the CATEGORIES menu item.

See Also:

Constant Field Values

GLOSSARY

public static final short GLOSSARY

The type for the GLOSSARY menu item.

See Also:

Constant Field Values

LINKS_FROM

public static final short LINKS_FROM

The type for the LINKS_FROM menu item.

See Also:

Constant Field Values

Constructor Detail

DefaultMenuItem

public DefaultMenuItem(short type)

Constructor.

Parameters:

type - the menu item type.

DefaultMenuItem

public DefaultMenuItem(java.lang.String desc,
                       short type)

Constructor.

Parameters:

desc - the menu description

type - the menu item type.

Method Detail

supportType

public static boolean supportType(short type)

Return true if a item type is supported.

Parameters:

type - the default item type

Returns:

true if the item type is supported

getType

public short getType()

Return the menu item type.

Returns:

the menu item type