Class ConfigurePortalPages
java.lang.Object
webwork.action.ActionSupport
com.atlassian.jira.web.action.JiraWebActionSupport
com.atlassian.jira.web.action.user.ConfigurePortalPages
- All Implemented Interfaces:
ErrorCollection
,I18nHelper
,SharedEntitySearchAction
,HttpServletVariables
,DropDownModelProvider<PortalPageDisplayBean>
,AuthorizationSupport
,Serializable
,webwork.action.Action
,webwork.action.CommandDriven
,webwork.action.IllegalArgumentAware
- Direct Known Subclasses:
ViewSharedDashboards
public class ConfigurePortalPages
extends JiraWebActionSupport
implements SharedEntitySearchAction, DropDownModelProvider<PortalPageDisplayBean>
This action is the place we manage Portal Pages, aka Dashboard pages from
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
Class to help executing and displaying the results of PortalPage searches.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
Nested classes/interfaces inherited from interface com.atlassian.jira.web.action.util.sharing.SharedEntitySearchAction
SharedEntitySearchAction.FieldNameMapper, SharedEntitySearchAction.QueryValidator
-
Field Summary
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
ConstructorsConstructorDescriptionConfigurePortalPages
(PortalPageService portalPageService, JiraAuthenticationContext authenticationContext, FavouritesService favouritesService, GlobalPermissionManager permissionManager, ShareTypeFactory shareTypeFactory, UserFormats userFormats, com.atlassian.webresource.api.WebResourceManager webResourceManager, UserHistoryManager userHistoryManager, ShareManager shareManager, FeatureManager featureManager, UserManager userManager) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Can we display the favourite column? Determined by if there is a user in the current session.protected String
Default method runs when displaying portal pages.doMoveUp()
getDropDownModel
(PortalPageDisplayBean displayBean, int listIndex) int
getPageName
(PortalPage portalPage) getPages()
int
int
int
getView()
boolean
boolean
boolean
boolean
boolean
boolean
void
setContentOnly
(boolean contentOnly) void
setCopyPageId
(Long copyPageId) void
setDescription
(String description) void
setGroupShare
(String groupShare) void
protected void
setPages
(List<PortalPageDisplayBean> pages) void
setPagingOffset
(Long pagingOffset) void
setPortalPageName
(String portalPageName) void
setPosition
(int position) void
setProjectShare
(String projectShare) void
setRoleShare
(String roleShare) void
setSearchName
(String searchName) void
setSearchOwnerUserName
(String searchOwnerUserName) protected void
setSearchResults
(SharedEntitySearchViewHelper.SearchResult<PortalPage> searchResults) void
setSearchShareType
(String searchShareType) void
setSortAscending
(boolean sortAscending) void
setSortColumn
(String sortColumn) void
setUserShare
(String userShare) void
boolean
protected String
toUrl
(PortalPageDisplayBean pageDisplayBean, String page, String idUrlVariable, boolean includeReturnUrl) protected List<PortalPageDisplayBean>
transformToDisplayBeans
(Collection<PortalPage> portalPages) 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, 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
-
Constructor Details
-
Method Details
-
doDefault
- Overrides:
doDefault
in classwebwork.action.ActionSupport
- Throws:
Exception
-
getSearchName
- Specified by:
getSearchName
in interfaceSharedEntitySearchAction
-
setSearchName
- Specified by:
setSearchName
in interfaceSharedEntitySearchAction
-
getSearchOwnerUserName
- Specified by:
getSearchOwnerUserName
in interfaceSharedEntitySearchAction
-
setSearchOwnerUserName
- Specified by:
setSearchOwnerUserName
in interfaceSharedEntitySearchAction
-
getPagingOffset
- Specified by:
getPagingOffset
in interfaceSharedEntitySearchAction
-
setPagingOffset
- Specified by:
setPagingOffset
in interfaceSharedEntitySearchAction
-
getSortColumn
- Specified by:
getSortColumn
in interfaceSharedEntitySearchAction
-
setSortColumn
- Specified by:
setSortColumn
in interfaceSharedEntitySearchAction
-
isSortAscending
public boolean isSortAscending()- Specified by:
isSortAscending
in interfaceSharedEntitySearchAction
-
setSortAscending
public void setSortAscending(boolean sortAscending) - Specified by:
setSortAscending
in interfaceSharedEntitySearchAction
-
setPageId
-
getPortalPageName
-
setPortalPageName
-
getCopyPageId
-
setCopyPageId
-
getPageId
-
getDescription
-
setDescription
-
getView
-
setView
-
getPosition
public int getPosition() -
setPosition
public void setPosition(int position) -
getPageName
-
isContentOnly
public boolean isContentOnly() -
setContentOnly
public void setContentOnly(boolean contentOnly) -
getSearchUnsuccessfulMessage
-
isErrorMessage
public boolean isErrorMessage() -
getPortalPageViewHelper
-
isSearchRequested
public boolean isSearchRequested() -
getCurrentPortalPage
-
getPages
-
setPages
-
getNextUrl
-
getPreviousUrl
-
getStartPosition
public int getStartPosition() -
getEndPosition
public int getEndPosition() -
getTotalResultCount
public int getTotalResultCount() -
isUserLoggedIn
public boolean isUserLoggedIn() -
hasBrowseUsersPermission
public boolean hasBrowseUsersPermission() -
shouldShowOwnerColumn
public boolean shouldShowOwnerColumn() -
canShowFavourite
public boolean canShowFavourite()Can we display the favourite column? Determined by if there is a user in the current session.- Returns:
- true if there is a logged-in user, else false
-
doExecute
Default method runs when displaying portal pages.- Overrides:
doExecute
in classwebwork.action.ActionSupport
- Returns:
- the view to display
-
doMoveUp
-
doMoveDown
-
doMoveToStart
-
doMoveToEnd
-
transformToDisplayBeans
-
getDropDownModel
- Specified by:
getDropDownModel
in interfaceDropDownModelProvider<PortalPageDisplayBean>
- Parameters:
displayBean
- some domain objectlistIndex
- this parameter indicates the position in of the domain object in a list of domain objects. Often generated markup uses position in the list to generate ids and the like- Returns:
- a drop down model based on the values in domainObject
-
toUrl
protected String toUrl(PortalPageDisplayBean pageDisplayBean, String page, String idUrlVariable, boolean includeReturnUrl)
-