com.helger.photon.basic.app.menu

Class AbstractMenuObject<IMPLTYPE extends AbstractMenuObject<IMPLTYPE>>

java.lang.Object

com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedAttributeContainer<KEYTYPE,Object>

com.helger.commons.collection.attr.MapBasedAttributeContainerAny<String>

com.helger.photon.basic.app.menu.AbstractMenuObject<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.collection.attr.IAttributeContainer<String,Object>, com.helger.commons.collection.attr.IMutableAttributeContainer<String,Object>, com.helger.commons.collection.attr.IMutableAttributeContainerAny<String>, com.helger.commons.collection.ext.ICommonsIterable<Map.Entry<String,Object>>, com.helger.commons.id.IHasID<String>, com.helger.commons.lang.ICloneable<com.helger.commons.collection.attr.MapBasedAttributeContainer<String,Object>>, com.helger.commons.state.IClearable, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IMenuObject, Serializable, Iterable<Map.Entry<String,Object>>

Direct Known Subclasses:

MenuItemExternal, MenuItemPage, MenuSeparator

@NotThreadSafe
public abstract class AbstractMenuObject<IMPLTYPE extends AbstractMenuObject<IMPLTYPE>>
extends com.helger.commons.collection.attr.MapBasedAttributeContainerAny<String>
implements IMenuObject, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Implementation base class for menu items.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

m_aAttrs

Constructor Summary

Constructors

Constructor and Description
AbstractMenuObject(String sID)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
IMenuObjectFilter	getDisplayFilter()
String	getID()
int	hashCode()
boolean	matchesDisplayFilter()
IMPLTYPE	setDisplayFilter(IMenuObjectFilter aDisplayFilter) Set a new display filter for this menu object.
String	toString()

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainerAny

getClone

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainer

clear, onBeforeRemoveAllAttributes, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

containsAttribute, forAllAttributes, forAllAttributeValues, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject, isEmpty, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.app.menu.IMenuObject

getMenuObjectType

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

getComparatorID

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

computeIfAbsent, removeAttribute, setAttribute, setAttributes, setAttributes

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

containsAttribute, forAllAttributes, forAllAttributeValues, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute, isEmpty, isNotEmpty, iterator

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEach, forEachBreakable, getIteratorCount, getIteratorCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

clear

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Constructor Detail

AbstractMenuObject

public AbstractMenuObject(@Nonnull @Nonempty
                          String sID)

Method Detail

getID

@Nonnull
 @Nonempty
public final String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

setDisplayFilter

@Nonnull
public final IMPLTYPE setDisplayFilter(@Nullable
                                                 IMenuObjectFilter aDisplayFilter)

Description copied from interface: IMenuObject

Set a new display filter for this menu object.

Specified by:

setDisplayFilter in interface IMenuObject

Parameters:

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

Returns:

this

getDisplayFilter

@Nullable
public final IMenuObjectFilter getDisplayFilter()

Specified by:

getDisplayFilter in interface IMenuObject

Returns:

An optional filter that toggles visibility.

matchesDisplayFilter

public final boolean matchesDisplayFilter()

Specified by:

matchesDisplayFilter in interface IMenuObject

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.commons.collection.attr.MapBasedAttributeContainer<String,Object>

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.commons.collection.attr.MapBasedAttributeContainer<String,Object>

toString

public String toString()

Overrides:

toString in class com.helger.commons.collection.attr.MapBasedAttributeContainer<String,Object>