com.helger.photon.basic.app.menu

Interface IMenuObject

All Superinterfaces:

com.helger.commons.collection.attr.IAttributeContainer<String,Object>, com.helger.commons.state.IClearable, com.helger.commons.id.IHasID<String>, com.helger.commons.collection.attr.IMutableAttributeContainer<String,Object>, com.helger.commons.collection.attr.IMutableAttributeContainerAny<String>, Serializable

All Known Subinterfaces:

IMenuItem, IMenuItemExternal, IMenuItemPage, IMenuSeparator

All Known Implementing Classes:

AbstractMenuObject, MenuItemExternal, MenuItemPage, MenuSeparator

public interface IMenuObject
extends com.helger.commons.id.IHasID<String>, com.helger.commons.collection.attr.IMutableAttributeContainerAny<String>

Base interface for menu items and menu separators.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
IMenuObjectFilter	getDisplayFilter()
EMenuObjectType	getMenuObjectType()
boolean	matchesDisplayFilter()
IMenuObject	setDisplayFilter(IMenuObjectFilter aDisplayFilter) Set a new display filter for this menu object.

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainerAny

getAndSetAttributeFlag, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getIterator, getTypedAttribute, getTypedAttribute

Methods inherited from interface com.helger.commons.state.IClearable

clear

Method Detail

getMenuObjectType

@Nonnull
EMenuObjectType getMenuObjectType()

getDisplayFilter

@Nullable
IMenuObjectFilter getDisplayFilter()

Returns:

An optional filter that toggles visibility.

setDisplayFilter

@Nonnull
IMenuObject setDisplayFilter(@Nullable
                                       IMenuObjectFilter aDisplayFilter)

Set a new display filter for this menu object.

Parameters:

aDisplayFilter - The new display filter to set. Maybe null to indicate that no filter is required.

Returns:

this

matchesDisplayFilter

boolean matchesDisplayFilter()

Returns:

true if either no display filter is installed, or if the installed filter matches, false otherwise.