com.atlassian.jira.projectconfig.tab

Class WebPanelTab

java.lang.Object

com.atlassian.jira.projectconfig.tab.WebPanelTab

All Implemented Interfaces:

ProjectConfigTab

Direct Known Subclasses:

ComponentsTab, FieldsTab, IssuePermissionsTab, IssueSecurityTab, NotificationsTab, PermissionsTab, PrioritiesTab, RolesTab, ScreensTab, SummaryTab, VersionsTab, WorkflowEditTab, WorkflowsTab

public abstract class WebPanelTab
extends Object
implements ProjectConfigTab

A tab panel on the project configuration page that is rendered using a webpanel.

It will construct the tab contents from two web panels:

• A header web-panel, assumed to be common for all inheriting tabs, located under 'tabs.admin.projectconfig.header'
• A body web-panel, specific to a given tab, located under 'tabs.admin.projectconfig.{tab ID}'

Since:

v4.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_PROJECT
static String	CURRENT_TAB_NAME
static String	EXTRA_URL_PARAM

Constructor Summary

Constructors

Constructor and Description
WebPanelTab(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, VelocityContextFactory factory, String id, String linkId)

Method Summary

Modifier and Type	Method and Description
void	addResourceForProject(ProjectConfigTabRenderContext context) Add any webresource that the tab needs to render itself.
protected Map<String,Object>	createVelocityContext(ProjectConfigTabRenderContext context)
protected com.atlassian.plugin.web.model.WebPanel	getBodyWebPanel(Map<String,Object> velocityContext)
protected com.atlassian.plugin.web.model.WebPanel	getHeaderWebPanel(Map<String,Object> velocityContext)
String	getId() Get the ID for the panel.
String	getLinkId() Return the ID of the tab link that opens this tab.
String	getTab(ProjectConfigTabRenderContext context) Return the tab content.
protected com.atlassian.plugin.web.model.WebPanel	getWebPanel(String location, Map<String,Object> velocityContext, boolean logWarns)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.projectconfig.tab.ProjectConfigTab

getTitle

Field Detail

CURRENT_PROJECT

public static final String CURRENT_PROJECT

See Also:

Constant Field Values

CURRENT_TAB_NAME

public static final String CURRENT_TAB_NAME

See Also:

Constant Field Values

EXTRA_URL_PARAM

public static final String EXTRA_URL_PARAM

See Also:

Constant Field Values

Constructor Detail

WebPanelTab

public WebPanelTab(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                   VelocityContextFactory factory,
                   String id,
                   String linkId)

Method Detail

getId

public String getId()

Description copied from interface: ProjectConfigTab

Get the ID for the panel.

Specified by:

getId in interface ProjectConfigTab

Returns:

the ID of the panel.

getLinkId

public String getLinkId()

Description copied from interface: ProjectConfigTab

Return the ID of the tab link that opens this tab.

Specified by:

getLinkId in interface ProjectConfigTab

Returns:

the ID of the tab link that opens this tab.

getTab

public String getTab(ProjectConfigTabRenderContext context)

Description copied from interface: ProjectConfigTab

Return the tab content.

Specified by:

getTab in interface ProjectConfigTab

Parameters:

context - contains information that may be useful for tab renderering.

Returns:

the HTML of the tab.

createVelocityContext

protected Map<String,Object> createVelocityContext(ProjectConfigTabRenderContext context)

addResourceForProject

public void addResourceForProject(ProjectConfigTabRenderContext context)

Description copied from interface: ProjectConfigTab

Add any webresource that the tab needs to render itself.

Specified by:

addResourceForProject in interface ProjectConfigTab

Parameters:

context - contains information that may be useful for tab renderering.

getBodyWebPanel

protected com.atlassian.plugin.web.model.WebPanel getBodyWebPanel(Map<String,Object> velocityContext)

getHeaderWebPanel

protected com.atlassian.plugin.web.model.WebPanel getHeaderWebPanel(Map<String,Object> velocityContext)

getWebPanel

protected com.atlassian.plugin.web.model.WebPanel getWebPanel(String location,
                                                              Map<String,Object> velocityContext,
                                                              boolean logWarns)