com.atlassian.jira.plugin.projectpanel.fragment
Interface MenuFragment

All Known Implementing Classes:

FiltersMenuComponentFragment, FiltersMenuFragment, FiltersMenuVersionFragment, ReleaseNotesMenuFragment, ReportsMenuFragment

public interface MenuFragment

A fragment displayed on a BrowseProject/Component/Version in the appropriate section for menus.

Since:

v4.0

Method Summary

java.lang.String	getHtml(BrowseContext ctx) The Html representation of this menu.
java.lang.String	getId() The id of the fragment div
boolean	showFragment(BrowseContext ctx) Whether or not to show this menu fragment.

Method Detail

getId

java.lang.String getId()

The id of the fragment div

Returns:

a valid html id string that represents this menu item/frag.

getHtml

java.lang.String getHtml(BrowseContext ctx)

The Html representation of this menu. Typically an anchor followed by an unordered list.

Parameters:

ctx - The context under which this menu is being used. Project, component, version...

Returns:

valid html for this menu fragment

showFragment

boolean showFragment(BrowseContext ctx)

Whether or not to show this menu fragment.

Parameters:

ctx - The context under which this menu is being used. Project, component, version...

Returns:

true is the menu should be shown, false otherwise.