Package com.atlassian.jira.web.action
Class AbstractPluggableTabPanelAction<TabPanelClass extends PluggableTabPanelModuleDescriptor>
java.lang.Object
webwork.action.ActionSupport
com.atlassian.jira.web.action.JiraWebActionSupport
com.atlassian.jira.web.action.ProjectActionSupport
com.atlassian.jira.web.action.IssueActionSupport
com.atlassian.jira.web.action.AbstractPluggableTabPanelAction<TabPanelClass>
- All Implemented Interfaces:
ErrorCollection
,I18nHelper
,HttpServletVariables
,AuthorizationSupport
,Serializable
,webwork.action.Action
,webwork.action.CommandDriven
,webwork.action.IllegalArgumentAware
- Direct Known Subclasses:
ViewProfile
public abstract class AbstractPluggableTabPanelAction<TabPanelClass extends PluggableTabPanelModuleDescriptor>
extends IssueActionSupport
Manages the setting, retrieval, checking and activating of a "selected tab"
for any page that wishes to provide navigation to "tab panels".
- Since:
- v6.1
- See Also:
-
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
FieldsModifier and TypeFieldDescriptionprotected final com.atlassian.plugin.PluginAccessor
Fields inherited from class com.atlassian.jira.web.action.IssueActionSupport
attachmentManager
Fields inherited from class com.atlassian.jira.web.action.ProjectActionSupport
projectManager
Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractPluggableTabPanelAction
(com.atlassian.plugin.PluginAccessor pluginAccessor) Deprecated.AbstractPluggableTabPanelAction
(com.atlassian.plugin.PluginAccessor pluginAccessor, UserPreferencesManager userPreferencesManager) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
protected String
Retrieve the name of the tab panel that is selected.protected abstract List<TabPanelClass>
Retrieves the tab panels for this page via the plugin accessor.protected List<TabPanelClass>
Retrieves and initialises the tab panels via the plugin accessorprotected abstract boolean
isTabPanelHidden
(TabPanelClass descriptor) Returns true if the tab panel of the given descriptor should be hidden from the current viewvoid
setSelectedTab
(String selectedTab) Set the name of the selected tab.Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport
addIssueToHistory, getAttachmentManager, getCurrentDateTimeInUsersTimezone, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getFormToken, 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, setFormToken, setSearchRequest, setSelectedIssueId, updateSearchRequest
Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport
getBrowsableProjects, getSelectedProjectId, setSelectedProject, setSelectedProject
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doExecute, 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 webwork.action.CommandDriven
getCommandName, setCommand
Methods inherited from interface com.atlassian.jira.util.ErrorCollection
addError, addErrorMessage, setErrorMessages
-
Field Details
-
pluginAccessor
protected final com.atlassian.plugin.PluginAccessor pluginAccessor
-
-
Constructor Details
-
AbstractPluggableTabPanelAction
@Deprecated public AbstractPluggableTabPanelAction(com.atlassian.plugin.PluginAccessor pluginAccessor) Deprecated.UseAbstractPluggableTabPanelAction(PluginAccessor, UserPreferencesManager)
}, which enables the user preferences manager to be injected. -
AbstractPluggableTabPanelAction
public AbstractPluggableTabPanelAction(com.atlassian.plugin.PluginAccessor pluginAccessor, UserPreferencesManager userPreferencesManager)
-
-
Method Details
-
getTabPanels
- Returns:
- A list of
AbstractPluggableTabPanelAction
objects, never null
-
initTabPanels
Retrieves and initialises the tab panels via the plugin accessor- Returns:
- list of
AbstractPluggableTabPanelAction
objects, never null - Since:
- v3.10
-
getTabPanelModuleDescriptors
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
-
isTabPanelHidden
Returns true if the tab panel of the given descriptor should be hidden from the current view- Parameters:
descriptor
- module descriptor- Returns:
- true if hidden, false otherwise
- Throws:
PermissionException
- if project is invalid or not visible to the current user- Since:
- v3.10
-
canSeeTab
-
getSelectedTabPanel
-
getSelected
-
getSelectedTab
Retrieve the name of the tab panel that is selected.Protected because it's used in some error log messages.
- Returns:
- The complete module key of the selected tab. If no tab is currently selected, it will return the first available tab on the page. If there are no tabs to select, returns null.
-
setSelectedTab
Set the name of the selected tab.Used by
JiraSafeActionParameterSetter.setActionProperty(java.lang.reflect.Method, webwork.action.Action, String[])
.- Parameters:
selectedTab
- a complete module descriptor key for theAbstractPluggableTabPanelAction
to set as the selected tab.
-
AbstractPluggableTabPanelAction(PluginAccessor, UserPreferencesManager)
}, which enables the user preferences manager to be injected.