de.xima.fc.gui.common.interfaces

Interface IMenuEntryModel

All Superinterfaces:

Serializable

All Known Implementing Classes:

MenuEntryModel, SubMenuEntryModel

public interface IMenuEntryModel
extends Serializable

Method Summary

Modifier and Type	Method and Description
IMenuEntryModel	addChild(org.apache.commons.lang3.builder.Builder<IMenuEntryModel> child)
IMenuEntryModel	addChild(IMenuEntryModel child)
EAdminDashCategory	getAdminDashCategory()
List<IMenuEntryModel>	getChildren()
String	getDescription()
String	getHelpID()
String	getHref()
IGuiIcon	getIcon()
String	getId()
IMenuEntryModel	getParent()
String	getTarget()
String	getText()
boolean	isAccessable()
boolean	isExternal()
boolean	isHasRenderedChildren()
boolean	isLicensed()
boolean	isRendered()
boolean	isRenderedOnDash()
void	setParent(MenuEntryModel parent)

Method Detail

addChild

IMenuEntryModel addChild(org.apache.commons.lang3.builder.Builder<IMenuEntryModel> child)

addChild

IMenuEntryModel addChild(IMenuEntryModel child)

getChildren

List<IMenuEntryModel> getChildren()

Returns:

All children of this menu entry.

getDescription

String getDescription()

Returns:

A long description or explanation for this menu entry.

getHelpID

String getHelpID()

Returns:

The ID for the help page for this menu entry. The help pages are currently located at http://help.formcycle.eu

getHref

String getHref()

Returns:

The link to this menu entry. For internal pages, this is the relative link.

getIcon

IGuiIcon getIcon()

Returns:

Icon this menu entry if it has one, or null.

getId

String getId()

Returns:

The unique ID of this menu entry. Can be used as an HTML id.

getText

String getText()

Returns:

The name of this menu entry, as shown in the menu.

getTarget

String getTarget()

Parameters:

get - target for menu entry link f.e. _self, _blank, _top, framename

isAccessable

boolean isAccessable()

Returns:

Whether the current user is allowed to access this menu entry.

isExternal

boolean isExternal()

Returns:

the external

isRendered

boolean isRendered()

Returns:

Whether this menu entry is displayed. Note that a menu entry may not be displayed on a particular page, but still be isAccessable() by that user.

isRenderedOnDash

boolean isRenderedOnDash()

Returns:

Whether this item is available on the client (normal) dashboard.

getAdminDashCategory

EAdminDashCategory getAdminDashCategory()

Returns:

If null, this item is not available on the sadmin dashboard. Otherwise, it is available under that category.

isLicensed

boolean isLicensed()

Returns:

true if the license allows this feature, false otherwise.

getParent

IMenuEntryModel getParent()

Returns:

The parent of this entry, or null if it is a root entry.

setParent

void setParent(MenuEntryModel parent)

Parameters:

parent - The parent of this entry, or null if it is a root entry.

isHasRenderedChildren

boolean isHasRenderedChildren()

Returns:

Whether this entry contains any child that is rendered.