com.atlassian.jira.web.action.browser
Class BrowseComponent

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport
              com.atlassian.jira.web.action.ProjectActionSupport
                  com.atlassian.jira.web.action.IssueActionSupport
                      com.atlassian.jira.web.action.AbstractPluggableTabPanelAction<ComponentTabPanelModuleDescriptor>
                          com.atlassian.jira.web.action.browser.BrowseComponent

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class BrowseComponent
extends AbstractPluggableTabPanelAction<ComponentTabPanelModuleDescriptor>

Version browser that is similar to project browser (BrowseProject) but also take version into account.

Since:

3.10

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.AbstractPluggableTabPanelAction

pluginAccessor

Fields inherited from class com.atlassian.jira.web.action.IssueActionSupport

attachmentManager

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

BrowseComponent(ProjectComponentManager projectComponentManager, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.plugin.webresource.WebResourceManager webResourceManager, PopularIssueTypesUtil popularIssueTypesUtil, SearchService searchService, ProjectManager projectManager, PermissionManager permissionManager)

Method Summary

protected String	doExecute()
ProjectComponent	getComponent()
List<ComponentTabPanelModuleDescriptor>	getComponentTabPanels()
String	getFullName(String username) Returns full name of the user with given username.
Long	getId()
Collection<IssueType>	getOtherIssueTypes()
protected String	getPageHeaderHtml()
Collection<IssueType>	getPopularIssueTypes()
Project	getProject()
protected com.atlassian.soy.renderer.SoyTemplateRenderer	getSoyRenderer()
String	getTabHtml()
String	getTabHtmlForJSON()
String	getTabLabel()
protected List<ComponentTabPanelModuleDescriptor>	getTabPanelModuleDescriptors() Retrieves the tab panels for this page via the plugin accessor.
boolean	hasCreateIssuePermissionForProject()
boolean	isContentOnly()
boolean	isHasProjectAdminPermission()
boolean	isNoTitle()
boolean	isStateUpdateOnly()
protected boolean	isTabPanelHidden(ComponentTabPanelModuleDescriptor descriptor) Returns true if the tab panel of the given descriptor should be hidden from the current view
void	setComponentId(Long id)
void	setContentOnly(boolean contentOnly)
void	setId(Long id)
void	setNoTitle(boolean noTitle)
void	setStateUpdateOnly(boolean stateUpdateOnly)

Methods inherited from class com.atlassian.jira.web.action.AbstractPluggableTabPanelAction

canSeeTab, getSelected, getSelectedTab, getSelectedTabPanel, getTabPanels, initTabPanels, setPersistenceKey, setSelectedTab

Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport

addIssueToHistory, clearSelectedIssue, getAttachmentManager, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getHoursPerDay, getIssueManager, getLastFailedLogin, getLastLogin, getLoginCount, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getPreviousLogin, getSearchRequest, getSelectedIssueId, getSessionPagerFilterManager, getSessionSearchRequestManager, getSessionSearchRequestManagerFactory, getSessionSelectedIssueManager, getTotalFailedLoginCount, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isElevatedSecurityCheckRequired, isFieldHidden, isFieldHidden, isTimeTrackingEnabled, setSearchRequest, setSelectedIssueId, updateSearchRequest

Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport

getBrowsableProjects, getBrowseableProjects, getSelectedProjectId, setSelectedProject, setSelectedProject

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasIssuePermission, hasPermission, hasProjectPermission, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

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.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

BrowseComponent

public BrowseComponent(ProjectComponentManager projectComponentManager,
                       com.atlassian.plugin.PluginAccessor pluginAccessor,
                       com.atlassian.plugin.webresource.WebResourceManager webResourceManager,
                       PopularIssueTypesUtil popularIssueTypesUtil,
                       SearchService searchService,
                       ProjectManager projectManager,
                       PermissionManager permissionManager)

Method Detail

doExecute

protected String doExecute()

Overrides:

doExecute in class webwork.action.ActionSupport

hasCreateIssuePermissionForProject

public boolean hasCreateIssuePermissionForProject()

setComponentId

public void setComponentId(Long id)

getComponent

public ProjectComponent getComponent()

getComponentTabPanels

public List<ComponentTabPanelModuleDescriptor> getComponentTabPanels()

getTabHtmlForJSON

public String getTabHtmlForJSON()
                         throws IOException

Throws:

IOException

getTabHtml

public String getTabHtml()
                  throws IOException

Throws:

IOException

getTabLabel

public String getTabLabel()

getId

public Long getId()
           throws PermissionException

Throws:

PermissionException

setId

public void setId(Long id)

getFullName

public String getFullName(String username)

Returns full name of the user with given username.

Parameters:

username - username

Returns:

full name of the user if found, given username if user not found, empty string if username was null

getProject

public Project getProject()

isHasProjectAdminPermission

public boolean isHasProjectAdminPermission()

getTabPanelModuleDescriptors

protected List<ComponentTabPanelModuleDescriptor> getTabPanelModuleDescriptors()

Description copied from class: AbstractPluggableTabPanelAction

Retrieves the tab panels for this page via the plugin accessor. Used by initialisation method to collect the list of tab panels for this page

Specified by:

getTabPanelModuleDescriptors in class AbstractPluggableTabPanelAction<ComponentTabPanelModuleDescriptor>

isTabPanelHidden

protected boolean isTabPanelHidden(ComponentTabPanelModuleDescriptor descriptor)
                            throws PermissionException

Description copied from class: AbstractPluggableTabPanelAction

Returns true if the tab panel of the given descriptor should be hidden from the current view

Specified by:

isTabPanelHidden in class AbstractPluggableTabPanelAction<ComponentTabPanelModuleDescriptor>

Parameters:

descriptor - module descriptor

Returns:

true if hidden, false otherwise

Throws:

PermissionException - if project is invalid or not visible to the current user

getPopularIssueTypes

public Collection<IssueType> getPopularIssueTypes()

getOtherIssueTypes

public Collection<IssueType> getOtherIssueTypes()

isContentOnly

public boolean isContentOnly()

setContentOnly

public void setContentOnly(boolean contentOnly)

isStateUpdateOnly

public boolean isStateUpdateOnly()

setStateUpdateOnly

public void setStateUpdateOnly(boolean stateUpdateOnly)

isNoTitle

public boolean isNoTitle()

setNoTitle

public void setNoTitle(boolean noTitle)

getSoyRenderer

protected com.atlassian.soy.renderer.SoyTemplateRenderer getSoyRenderer()

getPageHeaderHtml

protected String getPageHeaderHtml()