com.helger.photon.basic.app.menu

Class AbstractMenuObject<IMPLTYPE extends AbstractMenuObject<IMPLTYPE>>

java.lang.Object

com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

com.helger.commons.collections.attrs.MapBasedAttributeContainer

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

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.collections.attrs.IAttributeContainer, com.helger.commons.collections.attrs.IGenericAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IReadonlyAttributeContainer, com.helger.commons.ICloneable<com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>>, com.helger.commons.id.IHasID<String>, com.helger.commons.state.IClearable, IMenuObject, Serializable

Direct Known Subclasses:

MenuItemExternal, MenuItemPage, MenuSeparator

@NotThreadSafe
public abstract class AbstractMenuObject<IMPLTYPE extends AbstractMenuObject<IMPLTYPE>>
extends com.helger.commons.collections.attrs.MapBasedAttributeContainer
implements IMenuObject

Implementation base class for menu items.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMenuObject(String sID)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
com.helger.commons.filter.IFilter<IMenuObject>	getDisplayFilter()
String	getID()
int	hashCode()
boolean	matchesDisplayFilter()
IMPLTYPE	setDisplayFilter(com.helger.commons.filter.IFilter<IMenuObject> aDisplayFilter) Set a new display filter for this menu object.
protected IMPLTYPE	thisAsT()
String	toString()

Methods inherited from class com.helger.commons.collections.attrs.MapBasedAttributeContainer

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer

clear, containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeNames, getAttributeObject, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

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.collections.attrs.IAttributeContainer

getAndSetAttributeFlag, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from interface com.helger.commons.collections.attrs.IGenericAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer

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

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

clear

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>

thisAsT

@Nonnull
protected final IMPLTYPE thisAsT()

setDisplayFilter

@Nonnull
public final IMPLTYPE setDisplayFilter(@Nullable
                                com.helger.commons.filter.IFilter<IMenuObject> 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 com.helger.commons.filter.IFilter<IMenuObject> 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.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

toString

public String toString()

Overrides:

toString in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>