com.helger.photon.basic.app.menu

Class MenuItemPage

java.lang.Object

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

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<MenuItemPage>

com.helger.photon.basic.app.menu.MenuItemPage

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.id.IHasID<String>, com.helger.commons.lang.ICloneable<com.helger.commons.collection.attr.MapBasedAttributeContainer<String,Object>>, com.helger.commons.state.IClearable, com.helger.commons.text.display.IHasDisplayText, IMenuItem, IMenuItemPage, IMenuObject, Serializable

@NotThreadSafe
public class MenuItemPage
extends AbstractMenuObject<MenuItemPage>
implements IMenuItemPage

Default implementation of the IMenuItemPage interface.

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
MenuItemPage(String sItemID, IPage aPage)
MenuItemPage(String sItemID, IPage aPage, com.helger.commons.text.display.IHasDisplayText aDisplayText)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDisplayText(Locale aDisplayLocale)
EMenuObjectType	getMenuObjectType()
IPage	getPage()
String	getTarget()
int	hashCode()
boolean	hasTarget()
MenuItemPage	setTarget(com.helger.html.hc.html.HC_Target aTarget) Set the (HTML) target of the link.
MenuItemPage	setTarget(String sTarget) Set the (HTML) target of the link.
String	toString()

Methods inherited from class com.helger.photon.basic.app.menu.AbstractMenuObject

getDisplayFilter, getID, matchesDisplayFilter, setDisplayFilter, thisAsT

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

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

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, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject, getIterator

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

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.IMenuItemPage

setDisplayFilter

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

getDisplayFilter, matchesDisplayFilter

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

Constructor Detail

MenuItemPage

public MenuItemPage(@Nonnull @Nonempty
                    String sItemID,
                    @Nonnull
                    IPage aPage)

MenuItemPage

public MenuItemPage(@Nonnull @Nonempty
                    String sItemID,
                    @Nonnull
                    IPage aPage,
                    @Nonnull
                    com.helger.commons.text.display.IHasDisplayText aDisplayText)

Method Detail

getMenuObjectType

@Nonnull
public final EMenuObjectType getMenuObjectType()

Specified by:

getMenuObjectType in interface IMenuObject

getPage

@Nonnull
public IPage getPage()

Specified by:

getPage in interface IMenuItemPage

Returns:

The referenced page object.

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aDisplayLocale)

Specified by:

getDisplayText in interface com.helger.commons.text.display.IHasDisplayText

getTarget

@Nullable
public String getTarget()

Specified by:

getTarget in interface IMenuItem

Returns:

The (HTML) target of the link. May be null.

hasTarget

public boolean hasTarget()

Specified by:

hasTarget in interface IMenuItem

Returns:

true if an explicit target is defined, false otherwise.

setTarget

@Nonnull
public MenuItemPage setTarget(@Nullable
                                        com.helger.html.hc.html.HC_Target aTarget)

Description copied from interface: IMenuItem

Set the (HTML) target of the link.

Specified by:

setTarget in interface IMenuItem

Specified by:

setTarget in interface IMenuItemPage

Parameters:

aTarget - The target window. May be null.

Returns:

this

setTarget

@Nonnull
public MenuItemPage setTarget(@Nullable
                                        String sTarget)

Description copied from interface: IMenuItem

Set the (HTML) target of the link.

Specified by:

setTarget in interface IMenuItem

Specified by:

setTarget in interface IMenuItemPage

Parameters:

sTarget - The name of the target window. May be null.

Returns:

this

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractMenuObject<MenuItemPage>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMenuObject<MenuItemPage>

toString

public String toString()

Overrides:

toString in class AbstractMenuObject<MenuItemPage>