Package com.atlassian.confluence.spaces.actions

Class EditSpaceLabelAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.spaces.actions.AbstractSpaceAdminAction

com.atlassian.confluence.spaces.actions.EditSpaceLabelAction

All Implemented Interfaces:

Evented<SpaceLabelsViewEvent>, WebInterface, SpaceAware, SpaceLabelAware, Spaced, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

Direct Known Subclasses:

AddLabelToSpaceAction

public class EditSpaceLabelAction
extends AbstractSpaceAdminAction
implements SpaceLabelAware, Evented<SpaceLabelsViewEvent>

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

key, notificationManager, space, spaceManager, themeManager, wikiStyleRenderer

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
EditSpaceLabelAction()

Method Summary

Modifier and Type	Method	Description
Label	addLabel(Space space, String labelName)
List<Label>	getAvailableTeamLabels()
SpaceLabelsViewEvent	getEventToPublish(String result)	Gets the event to publish.
List<Label>	getLabelsOnThisSpace()	Returns the labels for the space (excluding team labels) for rendering in the UI
SpaceLabelManager	getSpaceLabelManager()
List<Label>	getSuggestedLabelsForSpace()
List<Label>	getTeamLabelsOnThisSpace()	Returns the teams labels for the space for rendering in the UI
void	setSpaceLabelManager(SpaceLabelManager spaceLabelManager)

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAdminAction

doDefault, getPermissionTypes, isSpaceRequired, isViewPermissionRequired

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

getActionSpaceKey, getKey, getSpace, getSpaceKey, getSpaceManager, getSubscribableName, getThemeManager, hasSpaceIA, isPermitted, isPersonalSpace, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.atlassian.confluence.core.AbstractI18nActionSupport

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Methods inherited from interface com.atlassian.confluence.spaces.actions.SpaceAware

setSpace

Methods inherited from interface com.atlassian.confluence.spaces.Spaced

getSpace

Constructor Details

EditSpaceLabelAction

public EditSpaceLabelAction()

Method Details

getSpaceLabelManager

public SpaceLabelManager getSpaceLabelManager()

setSpaceLabelManager

public void setSpaceLabelManager(SpaceLabelManager spaceLabelManager)

getTeamLabelsOnThisSpace

public List<Label> getTeamLabelsOnThisSpace()

Description copied from interface: SpaceLabelAware

Returns the teams labels for the space for rendering in the UI

Specified by:

getTeamLabelsOnThisSpace in interface SpaceLabelAware

Returns:

teams labels for the space

getLabelsOnThisSpace

public List<Label> getLabelsOnThisSpace()

Description copied from interface: SpaceLabelAware

Returns the labels for the space (excluding team labels) for rendering in the UI

Specified by:

getLabelsOnThisSpace in interface SpaceLabelAware

Returns:

teams labels for the space

getAvailableTeamLabels

public List<Label> getAvailableTeamLabels()

getSuggestedLabelsForSpace

public List<Label> getSuggestedLabelsForSpace()
                                       throws Exception

Throws:

Exception

addLabel

public Label addLabel(Space space,
 String labelName)

getEventToPublish

public SpaceLabelsViewEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<SpaceLabelsViewEvent>

Parameters:

result - the result of the action executing.

Returns:

the event. Can be null, in which case no event will be published.