com.ibm.mashups.enabler.navigation
Interface NavigationElement

All Superinterfaces:

ContentProvider, com.ibm.mashups.enabler.DefaultLocalized, com.ibm.mashups.enabler.DirtyFlagProvider, com.ibm.mashups.enabler.ac.EffectiveAccess, Identifiable, Localized, MetaData, ModifiableLocalized, ModifiableMetaData, ThemeProvider, com.ibm.mashups.enabler.Transformable

public NavigationElement
extends Identifiable, ModifiableMetaData, ModifiableLocalized, com.ibm.mashups.enabler.DefaultLocalized, ThemeProvider, ContentProvider, com.ibm.mashups.enabler.ac.EffectiveAccess, com.ibm.mashups.enabler.Transformable, com.ibm.mashups.enabler.DirtyFlagProvider

Base interface for navigation elements

Since:

2.4

Method Summary

Boolean	isHidden() Returns whether this navigation element is flagged as hidden.
void	setHidden(Boolean hide) Allows to flag the navigation element as hidden or visible.
Boolean	confirmSetHidden(Boolean hide) Confirms whether setting the hidden flag is possible.
String	getNavigationElementType() Returns the type of this navigation element as defined inConstants .

Methods inherited from interface com.ibm.mashups.enabler.Identifiable

getID

Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData

setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData

Methods inherited from interface com.ibm.mashups.enabler.MetaData

getMetaDataNames, getMetaData

Methods inherited from interface com.ibm.mashups.enabler.ModifiableLocalized

setTitle, confirmSetTitle, removeTitle, confirmRemoveTitle, removeTitles, confirmRemoveTitles, setDescription, confirmSetDescription, removeDescription, confirmRemoveDescription, removeDescriptions, confirmRemoveDescriptions

Methods inherited from interface com.ibm.mashups.enabler.Localized

getLocales, getTitle, getTitles, getDescription, getDescriptions

Methods inherited from interface com.ibm.mashups.enabler.ThemeProvider

getTheme, setTheme, getThemeIdentifier, setThemeIdentifier

Methods inherited from interface com.ibm.mashups.enabler.content.ContentProvider

getContent

Method Detail

isHidden

Boolean isHidden()

Returns whether this navigation element is flagged as hidden. It is the responsibility of the UI to render the navigation correctly and honor this flag.

Returns:

true if the navigation is flagged as hidden, otherwise false.

setHidden

void setHidden(Boolean hide)

Allows to flag the navigation element as hidden or visible.

Parameters:

hide - true to hide the navigation, otherwise false.

confirmSetHidden

Boolean confirmSetHidden(Boolean hide)

Confirms whether setting the hidden flag is possible.

Parameters:

hide - true to hide the space, otherwise false.

Returns:

true if the value can be set, otherwise false.

getNavigationElementType

String getNavigationElementType()

Returns the type of this navigation element as defined inConstants .

Returns:

type of this navigation element