Package jetbrains.buildServer.controllers.admin.projects

Class EditProjectTab

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.web.openapi.SimpleCustomTab

jetbrains.buildServer.controllers.admin.projects.EditProjectTab

All Implemented Interfaces:

CustomTab, ExtensionAvailability, PageExtension

Direct Known Subclasses:

AdminEditProjectController.EditProjectGeneralTab, ArtifactsStorageSettingsTab, AttachBuildHistoryTab, BuildsScheduleTab, EditDeploymentDashboardsTab, EditProjectParametersTab, IssueTrackerProjectPage, OAuthConnectionsTab, ProjectCleanupRulesTab, ProjectExportTab, ProjectReportTabsTab, ProjectSuggestionsTab, ProjectVcsRootsTab, SslCertificatesProjectTab, UntrustedBuildsProjectPage, UsagesReportTab, VersionedSettingsProjectPage

public abstract class EditProjectTab
extends SimpleCustomTab

Base class for project tabs in project administration UI.

Since:

8.0.3

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_PROJECT_ATTRIBUTE

Fields inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension

myCssPaths, myJsPaths, myPagePlaces

Constructor Summary

Constructors

Constructor	Description
EditProjectTab(PagePlaces pagePlaces, String pluginName, String includeUrl, String title)

Method Summary

Modifier and Type	Method	Description
SProject	getProject(javax.servlet.http.HttpServletRequest request)
String	getTabTitle(javax.servlet.http.HttpServletRequest request)	Returns title to use as custom tab name
boolean	hasOwnSettings(SProject project)
boolean	isAvailable(javax.servlet.http.HttpServletRequest request)	Returns true if this extension is available (should be included on the page) for the specified request.

Methods inherited from class jetbrains.buildServer.web.openapi.SimpleCustomTab

getTabId, getTabTitle, isVisible, setTabTitle

Methods inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension

addCssFile, addJsFile, fillModel, getCssPaths, getIncludeUrl, getJsPaths, getPlaceId, getPluginName, isGet, isPost, register, setIncludeUrl, setPlaceId, setPluginName, setPosition, toString, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.web.openapi.CustomTab

fillModel

Methods inherited from interface jetbrains.buildServer.web.openapi.PageExtension

getCssPaths, getDisplayName, getIncludeUrl, getJsPaths, getPluginName

Field Detail

CURRENT_PROJECT_ATTRIBUTE

public static final String CURRENT_PROJECT_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

EditProjectTab

public EditProjectTab(PagePlaces pagePlaces,
                      String pluginName,
                      String includeUrl,
                      String title)

Method Detail

getProject

@Nullable
public SProject getProject(@NotNull
                           javax.servlet.http.HttpServletRequest request)

isAvailable

public boolean isAvailable(@NotNull
                           javax.servlet.http.HttpServletRequest request)

Description copied from interface: PageExtension

Returns true if this extension is available (should be included on the page) for the specified request. If extension needs to be shown for some pages only, it can obtain original page URL via request attribute called "pageUrl":

String pageUrl = (String)request.getAttribute("pageUrl");

Specified by:

isAvailable in interface ExtensionAvailability

Specified by:

isAvailable in interface PageExtension

Overrides:

isAvailable in class SimplePageExtension

Parameters:

request - HTTP request

Returns:

true if extension should be included in the page place

hasOwnSettings

public boolean hasOwnSettings(@NotNull
                              SProject project)

Parameters:

project - current project

Returns:

true if tab has own settings associated with the given project (tabs without own settings are not shown by default)

Since:

2018.1

getTabTitle

@NotNull
public String getTabTitle(@NotNull
                          javax.servlet.http.HttpServletRequest request)

Description copied from interface: CustomTab

Returns title to use as custom tab name

Specified by:

getTabTitle in interface CustomTab

Overrides:

getTabTitle in class SimpleCustomTab

Parameters:

request - to get information from. Can be used to customize title

Returns:

tab title for given request