Package com.atlassian.confluence.pages.actions

Class EditCommentAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

com.atlassian.confluence.pages.actions.AbstractPageAction

com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

com.atlassian.confluence.pages.actions.EditCommentAction

All Implemented Interfaces:

Beanable, PageAware, TinyUrlAware, WebInterface, CaptchaAware, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class EditCommentAction
extends AbstractPreviewPageAction
implements CaptchaAware

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

back, bean, formatConverter, inPreview, preview, storageFormat, wikiStyleRenderer, wysiwygContent

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

incomingLinks, linkManager, pageManager, PREVIEW, RICHTEXT, viewRenderer, wysiwygConverter

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

contentPermissionManager, spaceManager

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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, settingsManager, spacePermissionManager, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
EditCommentAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	doEdit()
CaptchaManager	getCaptchaManager()
Comment	getComment()	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8.0.
long	getCommentId()
long	getEditCommentId()
List<Page>	getPermittedChildren()
WebInterfaceContext	getWebInterfaceContext(Comment comment)
String	getWysiwygContent()	Override since the base implementation will return the content of a page, instead of the comment.
boolean	isPermitted()
void	setCaptchaManager(CaptchaManager captchaManager)
void	setCommentId(long commentId)
void	setCommentService(CommentService commentService)
void	setNotificationManager(NotificationManager notificationManager)
void	setWatchPageAfterComment(boolean watchPageAfterComment)
void	validate()	Convert the editor content to storageFormat, catching and reporting any problems in the process.

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction

getBean, getContentForSaving, getConversionContext, getEditorFormattedContent, getInPreview, getRenderContext, getStorageFormat, getxHtmlContent, setBack, setFormatConverter, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygContent, updateXHtmlContent

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction

displayDatePath, getAttachmentSourceContent, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getLabels, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermissionTypes, getPostingDate, getPostingDay, getPostingTime, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, getWebInterfaceContext, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setPostingTime, setViewRenderer

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

getCustomPageUrl, getFriendlyDateFormatterHelper, getPage, getPageId, getPageUrl, getSpace, getSpaceKey, getTitle, isCollaborativeContent, isLatestVersionRequired, isPageRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, useSkipAccessCheck, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.security.CaptchaAware

mustValidateCaptcha

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

Methods inherited from interface com.atlassian.confluence.pages.actions.PageAware

isEditPermissionRequired

Constructor Detail

EditCommentAction

public EditCommentAction()

Method Detail

validate

public void validate()

Description copied from class: AbstractPreviewPageAction

Convert the editor content to storageFormat, catching and reporting any problems in the process. On successful validation, the storageFormat field will be populated with a storage format representation of the editor content, ready for saving.

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork2.Validateable

Overrides:

validate in class AbstractPreviewPageAction

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

Throws:

Exception

doEdit

public String doEdit()
              throws Exception

Throws:

Exception

getComment

@Deprecated(since="8.8.0",
            forRemoval=true)
public Comment getComment()

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.8.0. Hibernate objects are not supported in Struts anymore. Use action's direct method calls.

getEditCommentId

public long getEditCommentId()

getWysiwygContent

public String getWysiwygContent()
                         throws XhtmlException

Override since the base implementation will return the content of a page, instead of the comment.

Overrides:

getWysiwygContent in class AbstractPreviewPageAction

Returns:

the editor formatted content for the CEO being edited.

Throws:

XhtmlException

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class AbstractPageAwareAction

getCommentId

public long getCommentId()

setCommentId

public void setCommentId(long commentId)

getPermittedChildren

public List<Page> getPermittedChildren()

Overrides:

getPermittedChildren in class AbstractPageAction

setCommentService

public void setCommentService(CommentService commentService)

setNotificationManager

public void setNotificationManager(NotificationManager notificationManager)

setWatchPageAfterComment

public void setWatchPageAfterComment(boolean watchPageAfterComment)

getCaptchaManager

public CaptchaManager getCaptchaManager()

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

getWebInterfaceContext

public WebInterfaceContext getWebInterfaceContext(Comment comment)