public abstract class

AbstractCreateAndEditPageAction

extends AbstractTemplatePageAction
implements CaptchaAware
java.lang.Object
   ↳ com.opensymphony.xwork.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.AbstractTemplatePageAction
               ↳ com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
Known Direct Subclasses
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From class com.atlassian.confluence.pages.actions.AbstractPageAction
From class com.atlassian.confluence.core.ConfluenceActionSupport
From interface com.opensymphony.xwork.Action
Fields
protected CaptchaManager captchaManager
protected DraftManager draftManager
protected DraftService draftService
protected String editPermissionsGroups
protected String editPermissionsUsers
protected String newSpaceKey
protected NotificationManager notificationManager
protected PageService pageService
protected long parentPageId
protected String parentPageSpaceKey
protected String parentPageString
protected String parentPageTitle
protected long targetId
protected String viewPermissionsGroups
protected String viewPermissionsUsers
[Expand]
Inherited Fields
From class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
From class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
From class com.atlassian.confluence.pages.actions.AbstractPageAction
From class com.atlassian.confluence.pages.actions.AbstractPageAwareAction
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
Public Constructors
AbstractCreateAndEditPageAction()
Public Methods
String doDefault()
Default webwork action execution method.
String getCancelResult()
CaptchaManager getCaptchaManager()
abstract String getContentType()
Returns the content type being created or edited.
ContentPermission getCurrentEditPermission()
ContentPermission getCurrentViewPermission()
Draft getDraft()
Return the current draft in use if there is one or null otherwise.
long getDraftId()
Return the id of the current draft in use if there is one or 0 otherwise.
String getEditPermissionsGroups()
String getEditPermissionsSummary()
String getEditPermissionsUsers()
long getEntityId()
String getLabelsString()
String getNewSpaceKey()
NotificationManager getNotificationManager()
Page getParentPage()
long getParentPageId()
String getParentPageSpaceKey()
If the parentPageSpaceKey is set, this function will return the parentPageSpaceKey value.
String getParentPageString()
String getParentPageTitle()
String getTitle()
List getViewInheritedContentPermissionSets()
String getViewPermissionsGroups()
String getViewPermissionsSummary()
String getViewPermissionsUsers()
WebInterfaceContext getWebInterfaceContext()
Returns a context which can be passed to web items when rendering them.
boolean hasSetPagePermissionsPermission()
boolean isRestricted()
boolean isShowDraftMessage()
boolean isUseDraft()
void setAutomaticWatchIfRequired()
void setCaptchaManager(CaptchaManager captchaManager)
void setContentChanged(boolean contentChanged)
void setDiscardDraft(boolean discardDraft)
void setDraftId(long draftId)
void setDraftManager(DraftManager draftManager)
void setDraftService(DraftService draftService)
void setEditPermissionsGroups(String editPermissionsGroups)
void setEditPermissionsUsers(String editPermissionsUsers)
void setLabelsString(String labelsString)
void setLabelsString(List<Label> labels)
void setNewSpaceKey(String newSpaceKey)
void setNotificationManager(NotificationManager notificationManager)
void setPageService(PageService pageService)
void setParentPageId(long parentPageId)
void setParentPageSpaceKey(String parentPageSpaceKey)
void setParentPageString(String parentPageString)
void setParentPageTitle(String parentPageTitle)
void setPosition(String position)
void setShowDraftMessage(boolean showDraftMessage)
void setSpaceService(SpaceService spaceService)
void setTargetId(String targetId)
void setTitle(String title)
void setUseDraft(boolean useDraft)
void setViewPermissionsGroups(String viewPermissionsGroups)
void setViewPermissionsUsers(String viewPermissionsUsers)
void validate()
Convert the editor content to storageFormat, catching and reporting any problems in the process.
Protected Methods
@Deprecated List<ContentPermission> createEditPermissions()
This method is deprecated. since 3.1. Use a PagePermissionsActionHelper in your Action.
@Deprecated List<ContentPermission> createViewPermissions()
This method is deprecated. since 3.1. Use a PagePermissionsActionHelper in your Action.
MovePageCommand getMovePageCommand()
List<String> getPermissionTypes()
String getPosition()
long getTargetId()
void setPermissions(List<ContentPermission> permissions)
void validateDuplicatePageTitle()
[Expand]
Inherited Methods
From class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
From class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
From class com.atlassian.confluence.pages.actions.AbstractPageAction
From class com.atlassian.confluence.pages.actions.AbstractPageAwareAction
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
From class java.lang.Object
From interface com.atlassian.confluence.pages.actions.PageAware
From interface com.atlassian.confluence.pages.actions.TinyUrlAware
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface
From interface com.opensymphony.xwork.Action
From interface com.opensymphony.xwork.LocaleProvider
From interface com.opensymphony.xwork.TextProvider
From interface com.opensymphony.xwork.Validateable
From interface com.opensymphony.xwork.ValidationAware

Fields

protected CaptchaManager captchaManager

protected DraftManager draftManager

protected DraftService draftService

protected String editPermissionsGroups

protected String editPermissionsUsers

protected String newSpaceKey

protected NotificationManager notificationManager

protected PageService pageService

protected long parentPageId

protected String parentPageSpaceKey

protected String parentPageString

protected String parentPageTitle

protected long targetId

protected String viewPermissionsGroups

protected String viewPermissionsUsers

Public Constructors

public AbstractCreateAndEditPageAction ()

Public Methods

public String doDefault ()

Default webwork action execution method.

Returns
  • the action result
Throws
Exception

public String getCancelResult ()

public CaptchaManager getCaptchaManager ()

public abstract String getContentType ()

Returns the content type being created or edited. e.g. "page", "blogpost"

public ContentPermission getCurrentEditPermission ()

public ContentPermission getCurrentViewPermission ()

public Draft getDraft ()

Return the current draft in use if there is one or null otherwise.

public long getDraftId ()

Return the id of the current draft in use if there is one or 0 otherwise.

public String getEditPermissionsGroups ()

public String getEditPermissionsSummary ()

public String getEditPermissionsUsers ()

public long getEntityId ()

public String getLabelsString ()

public String getNewSpaceKey ()

public NotificationManager getNotificationManager ()

public Page getParentPage ()

public long getParentPageId ()

public String getParentPageSpaceKey ()

If the parentPageSpaceKey is set, this function will return the parentPageSpaceKey value. Otherwise it will return the spaceKey of the current Page.

public String getParentPageString ()

public String getParentPageTitle ()

public String getTitle ()

public List getViewInheritedContentPermissionSets ()

public String getViewPermissionsGroups ()

public String getViewPermissionsSummary ()

public String getViewPermissionsUsers ()

public WebInterfaceContext getWebInterfaceContext ()

Returns a context which can be passed to web items when rendering them.

Typically, WebWork actions will implement this to provide extra details in the context such as content objects, and so on.

public boolean hasSetPagePermissionsPermission ()

public boolean isRestricted ()

public boolean isShowDraftMessage ()

public boolean isUseDraft ()

public void setAutomaticWatchIfRequired ()

public void setCaptchaManager (CaptchaManager captchaManager)

public void setContentChanged (boolean contentChanged)

public void setDiscardDraft (boolean discardDraft)

public void setDraftId (long draftId)

public void setDraftManager (DraftManager draftManager)

public void setDraftService (DraftService draftService)

public void setEditPermissionsGroups (String editPermissionsGroups)

public void setEditPermissionsUsers (String editPermissionsUsers)

public void setLabelsString (String labelsString)

public void setLabelsString (List<Label> labels)

public void setNewSpaceKey (String newSpaceKey)

public void setNotificationManager (NotificationManager notificationManager)

public void setPageService (PageService pageService)

public void setParentPageId (long parentPageId)

public void setParentPageSpaceKey (String parentPageSpaceKey)

public void setParentPageString (String parentPageString)

public void setParentPageTitle (String parentPageTitle)

public void setPosition (String position)

public void setShowDraftMessage (boolean showDraftMessage)

public void setSpaceService (SpaceService spaceService)

public void setTargetId (String targetId)

public void setTitle (String title)

public void setUseDraft (boolean useDraft)

public void setViewPermissionsGroups (String viewPermissionsGroups)

public void setViewPermissionsUsers (String viewPermissionsUsers)

public void validate ()

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.

Protected Methods

@Deprecated protected List<ContentPermission> createEditPermissions ()

This method is deprecated.
since 3.1. Use a PagePermissionsActionHelper in your Action.

@Deprecated protected List<ContentPermission> createViewPermissions ()

This method is deprecated.
since 3.1. Use a PagePermissionsActionHelper in your Action.

protected MovePageCommand getMovePageCommand ()

protected List<String> getPermissionTypes ()

protected String getPosition ()

protected long getTargetId ()

protected void setPermissions (List<ContentPermission> permissions)

protected void validateDuplicatePageTitle ()