com.atlassian.confluence.pages.actions

Class AbstractPaginatedListAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.pages.actions.AbstractPaginatedListAction

All Implemented Interfaces:

WebInterface, SpaceAware, Spaced, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

ListLabelsBySpaceAction, ListOrphanedPagesAction, ListPermissionPagesAction, ListUndefinedPagesAction

public abstract class AbstractPaginatedListAction
extends AbstractSpaceAction
implements SpaceAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ITEMS_PER_PAGE
protected PaginationSupport	paginationSupport

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, 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

Constructors

Constructor and Description
AbstractPaginatedListAction()
AbstractPaginatedListAction(int itemsPerPage)

Method Summary

Modifier and Type	Method and Description
String	execute()
abstract List	getItems()
PaginationSupport	getPaginationSupport()
boolean	isSpaceRequired() If the action requires that the space be set before being run, then it should return true to this method.
boolean	isViewPermissionRequired()
void	setStartIndex(int startIndex)

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

getKey, getPermissionTypes, getSpace, getSpaceKey, getSubscribableName, getThemeManager, hasSpaceIA, isAdminUser, isPermitted, isPersonalSpace, isSuperUser, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, 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, validate

Methods inherited from class java.lang.Object

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

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

setSpace

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

getSpace

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

validate

Field Detail

ITEMS_PER_PAGE

public static final int ITEMS_PER_PAGE

See Also:

Constant Field Values

paginationSupport

protected PaginationSupport paginationSupport

Constructor Detail

AbstractPaginatedListAction

public AbstractPaginatedListAction()

AbstractPaginatedListAction

public AbstractPaginatedListAction(int itemsPerPage)

Method Detail

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

getItems

public abstract List getItems()

getPaginationSupport

public PaginationSupport getPaginationSupport()

setStartIndex

public void setStartIndex(int startIndex)

isSpaceRequired

public boolean isSpaceRequired()

Description copied from interface: SpaceAware

If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isSpaceRequired in interface SpaceAware

Returns:

true if the action requires a space in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface SpaceAware

Returns:

true if the action requires view space permission