com.helger.photon.basic.app.menu

Interface IMenuItemExternal

All Superinterfaces:

com.helger.commons.text.display.IHasDisplayText, com.helger.commons.id.IHasID<String>, IMenuItem, IMenuObject, Serializable

All Known Implementing Classes:

MenuItemExternal

public interface IMenuItemExternal
extends IMenuItem

Base interface for a single menu item referencing an arbitrary URL.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default com.helger.commons.url.ISimpleURL	getURL()
com.helger.commons.url.IHasSimpleURL	getURLProvider()
IMenuItemExternal	setDisplayFilter(IMenuObjectFilter aDisplayFilter) Set a new display filter for this menu object.
IMenuItemExternal	setTarget(String sTarget) Set the (HTML) target of the link.

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

getTarget, hasTarget

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

attrs, getDisplayFilter, getMenuObjectType, matchesDisplayFilter

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

getComparatorID, getID

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getAsHasText, getComparatorCollating, getDisplayText

Method Detail

setDisplayFilter

@Nonnull
IMenuItemExternal setDisplayFilter(@Nullable
                                             IMenuObjectFilter aDisplayFilter)

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

getURLProvider

@Nonnull
com.helger.commons.url.IHasSimpleURL getURLProvider()

Returns:

The URL provider used internally. Never null.

getURL

@Nonnull
default com.helger.commons.url.ISimpleURL getURL()

Returns:

The referenced external URL. Never null.

setTarget

@Nonnull
IMenuItemExternal setTarget(@Nullable
                                      String sTarget)

Description copied from interface: IMenuItem

Set the (HTML) target of the link.

Specified by:

setTarget in interface IMenuItem

Parameters:

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

Returns:

this