com.atlassian.confluence.pages.actions
Class PageVariablesAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.pages.actions.AbstractPageAwareAction
              extended by com.atlassian.confluence.pages.actions.AbstractPageAction
                  extended by com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
                      extended by com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
                          extended by com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
                              extended by com.atlassian.confluence.pages.actions.AbstractCreatePageAction
                                  extended by com.atlassian.confluence.pages.actions.CreatePageAction
                                      extended by com.atlassian.confluence.pages.actions.PageVariablesAction
All Implemented Interfaces:
Beanable, PageAware, TinyUrlAware, WebInterface, CaptchaAware, Spaced, BreadcrumbAware, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class PageVariablesAction
extends CreatePageAction

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.confluence.pages.actions.CreatePageAction
CreatePageAction.SimplePageProvider
 
Field Summary
 
Fields inherited from class com.atlassian.confluence.pages.actions.CreatePageAction
contentPermissionProvider, pageProvider
 
Fields inherited from class com.atlassian.confluence.pages.actions.AbstractCreatePageAction
attachmentManager, breadcrumbGenerator, contextProvider, INPUT_VARIABLES, originalReferrer, space, themeManager
 
Fields inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
captchaManager, CLOSE_CANCEL_RESULT, DISCARD_CANCEL_RESULT, draftManager, draftService, editPermissionsGroups, editPermissionsUsers, newSpaceKey, notificationManager, pageService, parentPageId, parentPageSpaceKey, parentPageString, parentPageTitle, sharedDraftsDarkFeatureHelper, targetId, viewPermissionsGroups, viewPermissionsUsers
 
Fields inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
pageTemplateManager, templateId
 
Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
back, bean, 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
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
PageVariablesAction()
           
 
Method Summary
 String doEnter()
           
 String execute()
           
protected  List<Label> getLabels()
           
 String getRenderedTemplateContent()
           
 List getTemplateVariables()
           
 DefaultWebInterfaceContext getWebInterfaceContext()
          Returns a context which can be passed to web items when rendering them.
 boolean isPermitted()
          This action is being used to set up the content for the CreatePageAction, so the permissions test is not needed (and doesn't work, as the final space the page will be created in hasn't been chosen yet)
 boolean isTemplateApplied()
           
 void setEditorFormatService(EditorFormatService editorFormatService)
           
 void setFormatConverter(FormatConverter formatConverter)
           
 void setRenderedTemplateContent(String renderedTemplateContent)
           
 void setTemplateApplied(boolean templateApplied)
           
 void setXhtmlContent(XhtmlContent xhtmlContent)
           
 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.CreatePageAction
createCommand, createDraft, createPage, doAdd, doDefault, doTemplateDefault, getCommandActionHelper, getInheritedViewPermissions, getLinkCreation, getPageToCreate, populateParentPageTitleField, setEncodedTitle, setLinkCreation
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractCreatePageAction
afterAdd, beforeAdd, getAttachmentSourceContent, getBreadcrumb, getCancelRedirectUrl, getCancelResult, getContentBreadcrumb, getContentType, getFromPage, getFromPageId, getNewSpace, getOriginalReferrer, getQueryString, getSpace, getSpaceKey, hasSetPagePermissionsPermission, isInvalidPageTitle, isPageRequired, setAttachmentManager, setBreadcrumbGenerator, setFromPageId, setOriginalReferrer, setQueryString, setSpaceKey, setThemeManager, setTitleWritten, transferDraftAttachments
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractCreateAndEditPageAction
createEditPermissions, createViewPermissions, getCaptchaManager, getCurrentEditPermission, getCurrentViewPermission, getDraft, getDraftId, getDraftShareId, getEditPermissionsGroups, getEditPermissionsSummary, getEditPermissionsUsers, getEntityId, getExistingDraft, getExistingDraftId, getLabelsString, getMovePageCommand, getNewSpaceKey, getNotificationManager, getParentPage, getParentPageId, getParentPageSpaceKey, getParentPageString, getParentPageTitle, getPermissionTypes, getPosition, getSharedDraftsDarkFeatureHelper, getTargetId, getTitle, getViewInheritedContentPermissionSets, getViewPermissionsGroups, getViewPermissionsSummary, getViewPermissionsUsers, hasDraftPermission, isNewAbstractPage, isRestricted, isShowDraftMessage, isUseDraft, setAutomaticWatchIfRequired, setCaptchaManager, setDraftId, setDraftManager, setDraftService, setDraftShareId, setEditPermissionsGroups, setEditPermissionsUsers, setLabelsString, setLabelsString, setNewSpaceKey, setNotificationManager, setPageService, setParentPageId, setParentPageSpaceKey, setParentPageString, setParentPageTitle, setPermissions, setPosition, setSharedDraftsDarkFeatureHelper, setShowDraftMessage, setSpaceService, setTargetId, setTitle, setUseDraft, setViewPermissionsGroups, setViewPermissionsUsers, validateDuplicatePageTitle
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractTemplatePageAction
getGlobalPageTemplates, getPageTemplate, getSpacePageTemplates, getTemplateId, isPageTemplatesAvailable, loadTemplates, setPageTemplateManager, setTemplateId
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPreviewPageAction
getBean, getContentForSaving, getConversionContext, getEditorFormattedContent, getInPreview, getRenderContext, getStorageFormat, getWysiwygContent, getxHtmlContent, setBack, setInPreview, setPreview, setWikiStyleRenderer, setWysiwygContent, updateXHtmlContent
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAction
displayDatePath, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermittedChildren, getPostingDate, getPostingDay, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setViewRenderer
 
Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction
getFriendlyDateFormatterHelper, getPage, getPageId, hasViewPagePermission, isLatestVersionRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageVariablesAction

public PageVariablesAction()
Method Detail

getTemplateVariables

public List getTemplateVariables()
                          throws XhtmlException
Throws:
XhtmlException

execute

public String execute()
               throws Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
Exception

getLabels

protected List<Label> getLabels()
Overrides:
getLabels in class AbstractPageAction

getWebInterfaceContext

public DefaultWebInterfaceContext getWebInterfaceContext()
Description copied from interface: WebInterface
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.

Specified by:
getWebInterfaceContext in interface WebInterface
Overrides:
getWebInterfaceContext in class AbstractCreateAndEditPageAction

getRenderedTemplateContent

public String getRenderedTemplateContent()

setRenderedTemplateContent

public void setRenderedTemplateContent(String renderedTemplateContent)

doEnter

public String doEnter()
               throws Exception
Throws:
Exception

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.xwork.Validateable
Overrides:
validate in class CreatePageAction

isPermitted

public boolean isPermitted()
This action is being used to set up the content for the CreatePageAction, so the permissions test is not needed (and doesn't work, as the final space the page will be created in hasn't been chosen yet)

Overrides:
isPermitted in class CreatePageAction

isTemplateApplied

public boolean isTemplateApplied()

setTemplateApplied

public void setTemplateApplied(boolean templateApplied)

setEditorFormatService

public void setEditorFormatService(EditorFormatService editorFormatService)

setXhtmlContent

public void setXhtmlContent(XhtmlContent xhtmlContent)

setFormatConverter

public void setFormatConverter(FormatConverter formatConverter)
Overrides:
setFormatConverter in class AbstractPreviewPageAction


Copyright © 2003–2015 Atlassian. All rights reserved.