jetbrains.buildServer.web.openapi
Interface CustomTab

All Superinterfaces:
PageExtension
All Known Implementing Classes:
AdminPage, AgentDetailsTab, BuildTab, BuildTypeTab, ProjectTab, SimpleCustomTab, ViewBuildTab, ViewLogTab

@UserImplemented(adapterClass=SimpleCustomTab.class)
public interface CustomTab
extends PageExtension

Represents custom tab, see SimpleCustomTab Use SimpleCustomTab as base class


Method Summary
 void fillModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request)
          This method is called if this tab is selected.
 java.lang.String getTabId()
          Returns tab identifier
 java.lang.String getTabTitle()
          Returns title to use as custom tab name
 java.lang.String getTabTitle(javax.servlet.http.HttpServletRequest request)
          Returns title to use as custom tab name
 boolean isAvailable(javax.servlet.http.HttpServletRequest request)
          Return true if tab should be shown and false otherwise
 boolean isVisible()
          Return false if the tab should be active (i.e.
 
Methods inherited from interface jetbrains.buildServer.web.openapi.PageExtension
getCssPaths, getIncludeUrl, getJsPaths, getPluginName
 

Method Detail

getTabId

@NotNull
java.lang.String getTabId()
Returns tab identifier

Returns:
tab identifier

getTabTitle

@NotNull
java.lang.String getTabTitle()
Returns title to use as custom tab name

Returns:
tab title

getTabTitle

@NotNull
java.lang.String getTabTitle(@NotNull
                                     javax.servlet.http.HttpServletRequest request)
Returns title to use as custom tab name

Parameters:
request - to get information from. Can be used to customize title
Returns:
tab title for given request
Since:
8.0

isAvailable

boolean isAvailable(@NotNull
                    javax.servlet.http.HttpServletRequest request)
Return true if tab should be shown and false otherwise

Specified by:
isAvailable in interface PageExtension
Parameters:
request - HTTP request
Returns:
see above

isVisible

boolean isVisible()
Return false if the tab should be active (i.e. handle requests) but not visible for some reason

Returns:
see above

fillModel

void fillModel(@NotNull
               java.util.Map<java.lang.String,java.lang.Object> model,
               @NotNull
               javax.servlet.http.HttpServletRequest request)
This method is called if this tab is selected. See also PageExtension.fillModel(java.util.Map, javax.servlet.http.HttpServletRequest)

Specified by:
fillModel in interface PageExtension
Parameters:
model - model to modify
request - HTTP request