de.xima.fc.gui.common.model

Class MenuEntryModel

java.lang.Object

de.xima.fc.gui.common.model.MenuEntryModel

All Implemented Interfaces:

IMenuEntryModel, Serializable

Direct Known Subclasses:

SubMenuEntryModel

public class MenuEntryModel
extends Object
implements IMenuEntryModel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MenuEntryModel.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MenuEntryModel()

Method Summary

Modifier and Type	Method and Description
IMenuEntryModel	addChild(org.apache.commons.lang3.builder.Builder<IMenuEntryModel> child)
IMenuEntryModel	addChild(IMenuEntryModel child)
boolean	equals(Object obj)
EAdminDashCategory	getAdminDashCategory()
List<IMenuEntryModel>	getChildren()
String	getDescription()
String	getHelpID()
String	getHref()
IGuiIcon	getIcon()
String	getId()
IMenuEntryModel	getParent()
String	getStyleClass()
String	getTarget()
String	getText()
int	hashCode()
boolean	isAccessable()
boolean	isExternal()
boolean	isHasRenderedChildren()
boolean	isLicensed()
boolean	isRendered()
boolean	isRenderedOnDash()
void	setAccessable(boolean accessable)
void	setAdminDashCategory(EAdminDashCategory adminDashCategory)
void	setDescription(String description)
void	setExternal(boolean external)
void	setHelpID(String helpID)
void	setHref(String href)
void	setIcon(IGuiIcon icon)
void	setId(String id)
void	setLicensed(boolean licensed)
void	setParent(MenuEntryModel parent)
void	setRendered(boolean rendered)
void	setRenderedOnDash(boolean renderedOnDash)
void	setStyleClass(String styleClass)
void	setTarget(String target)
void	setText(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuEntryModel

protected MenuEntryModel()

Method Detail

getText

public String getText()

Specified by:

getText in interface IMenuEntryModel

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface IMenuEntryModel

Returns:

A long description or explanation for this menu entry.

getChildren

public List<IMenuEntryModel> getChildren()

Specified by:

getChildren in interface IMenuEntryModel

Returns:

All children of this menu entry.

addChild

public IMenuEntryModel addChild(IMenuEntryModel child)

Specified by:

addChild in interface IMenuEntryModel

addChild

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

Specified by:

addChild in interface IMenuEntryModel

getId

public String getId()

Specified by:

getId in interface IMenuEntryModel

Returns:

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

getIcon

public IGuiIcon getIcon()

Specified by:

getIcon in interface IMenuEntryModel

Returns:

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

getHref

public String getHref()

Specified by:

getHref in interface IMenuEntryModel

Returns:

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

getHelpID

public String getHelpID()

Specified by:

getHelpID in interface IMenuEntryModel

Returns:

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

isRendered

public boolean isRendered()

Specified by:

isRendered in interface IMenuEntryModel

Returns:

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

isExternal

public boolean isExternal()

Specified by:

isExternal in interface IMenuEntryModel

Returns:

the external

isRenderedOnDash

public boolean isRenderedOnDash()

Specified by:

isRenderedOnDash in interface IMenuEntryModel

Returns:

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

isAccessable

public boolean isAccessable()

Specified by:

isAccessable in interface IMenuEntryModel

Returns:

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

getAdminDashCategory

public EAdminDashCategory getAdminDashCategory()

Specified by:

getAdminDashCategory in interface IMenuEntryModel

Returns:

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

isLicensed

public boolean isLicensed()

Specified by:

isLicensed in interface IMenuEntryModel

Returns:

true if the license allows this feature, false otherwise.

setText

public void setText(String text)

setDescription

public void setDescription(String description)

setId

public void setId(String id)

setIcon

public void setIcon(IGuiIcon icon)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

setHref

public void setHref(String href)

setHelpID

public void setHelpID(String helpID)

setRendered

public void setRendered(boolean rendered)

setRenderedOnDash

public void setRenderedOnDash(boolean renderedOnDash)

setAdminDashCategory

public void setAdminDashCategory(EAdminDashCategory adminDashCategory)

setExternal

public void setExternal(boolean external)

setAccessable

public void setAccessable(boolean accessable)

setLicensed

public void setLicensed(boolean licensed)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTarget

public String getTarget()

Specified by:

getTarget in interface IMenuEntryModel

setTarget

public void setTarget(String target)

getParent

public IMenuEntryModel getParent()

Specified by:

getParent in interface IMenuEntryModel

Returns:

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

setParent

public void setParent(MenuEntryModel parent)

Specified by:

setParent in interface IMenuEntryModel

Parameters:

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

isHasRenderedChildren

public boolean isHasRenderedChildren()

Specified by:

isHasRenderedChildren in interface IMenuEntryModel

Returns:

Whether this entry contains any child that is rendered.