info.magnolia.module.admininterface.lists
Class VersionsList

java.lang.Object
  info.magnolia.cms.servlets.MVCServletHandlerImpl
      info.magnolia.cms.servlets.CommandBasedMVCServletHandler
          info.magnolia.module.admininterface.PageMVCHandler
              info.magnolia.module.admininterface.TemplatedMVCHandler
                  info.magnolia.module.admininterface.lists.AbstractList
                      info.magnolia.module.admininterface.lists.VersionsList

All Implemented Interfaces:

MVCServletHandler

Direct Known Subclasses:

WebsiteVersionsList

public abstract class VersionsList
extends AbstractList

Version:

$Revision$ ($Author$)

Author:

Philipp Bracher

Field Summary

protected String

path The path of the node

Fields inherited from class info.magnolia.module.admininterface.PageMVCHandler

COMMAND_PARAMETER_NAME, COMMAND_SHOW, VIEW_SHOW

Fields inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

exception, request, response, VIEW_ERROR, VIEW_SUCCESS

Fields inherited from interface info.magnolia.cms.servlets.MVCServletHandler

VIEW_NOTHING

Constructor Summary

VersionsList(String name, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

protected void	addComment(Content node, String version)
protected void	cleanComment(Content node)
protected void	configureContextMenu(ContextMenu menu) Override to configure the menu
protected void	configureFunctionBar(FunctionBar bar) Override to configure the bar
void	configureList(ListControl list)
protected javax.jcr.Node	getJCRNode()
String	getJsExecutedAfterSaving()
protected int	getMaxShowedVersions() Check the version rollover.
ListModel	getModel() Returns the model used by this list
protected Content	getNode() Deprecated. since 4.5.10 use getJCRNode() instead
String	getOnDiffFunction()
abstract String	getOnShowFunction() The script executed on a show link
String	getPath()
String	getRepository()
String	getVersionLabel()
protected boolean	isSupportsDiff()
String	onRender() Do some additional rendering in the subclass
String	restore()
String	restoreRecursive()
void	setJsExecutedAfterSaving(String jsExecutedAfterSaving)
void	setPath(String path)
void	setRepository(String repository)
void	setVersionLabel(String versionLabel)

Methods inherited from class info.magnolia.module.admininterface.lists.AbstractList

addContextMenuItem, getContextMenu, getFunctionBar, getGroupBy, getGroupByOrder, getLanguage, getList, getRenderKit, getSortBy, getSortByOrder, getTemplateName, getURI, initList, onRenderHeader, setFunctionBar, setGroupBy, setGroupByOrder, setList, setSortBy, setSortByOrder, show

Methods inherited from class info.magnolia.module.admininterface.TemplatedMVCHandler

renderHtml

Methods inherited from class info.magnolia.module.admininterface.PageMVCHandler

getForm, getI18nBasename, getMsgs, getParams, init, setForm, setI18nBasename, setMsgs, setParams

Methods inherited from class info.magnolia.cms.servlets.CommandBasedMVCServletHandler

execute, findCommand, getCatalogueName, getCommandContext, getViewNameAfterExecution, setCatalogueName

Methods inherited from class info.magnolia.cms.servlets.MVCServletHandlerImpl

getCommand, getException, getExceptionStackTrace, getName, getRequest, getResponse, populateFromRequest, setCommand, setRequest, setResponse

Methods inherited from class java.lang.Object

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

Field Detail

path

protected String path

The path of the node

Constructor Detail

VersionsList

public VersionsList(String name,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws Exception

Parameters:

name -

request -

response -

Throws:

Exception

Method Detail

getModel

public ListModel getModel()

Description copied from class: AbstractList

Returns the model used by this list

Specified by:

getModel in class AbstractList

See Also:

AbstractList.getModel()

getMaxShowedVersions

protected int getMaxShowedVersions()

Check the version rollover. The latest can not get restored therefore we don't show it.

configureList

public void configureList(ListControl list)

Specified by:

configureList in class AbstractList

getOnShowFunction

public abstract String getOnShowFunction()

The script executed on a show link

configureContextMenu

protected void configureContextMenu(ContextMenu menu)

Description copied from class: AbstractList

Override to configure the menu

Overrides:

configureContextMenu in class AbstractList

isSupportsDiff

protected boolean isSupportsDiff()

configureFunctionBar

protected void configureFunctionBar(FunctionBar bar)

Description copied from class: AbstractList

Override to configure the bar

Overrides:

configureFunctionBar in class AbstractList

See Also:

AbstractList.configureFunctionBar(info.magnolia.cms.gui.control.FunctionBar)

getNode

protected Content getNode()
                   throws javax.jcr.PathNotFoundException,
                          javax.jcr.RepositoryException,
                          AccessDeniedException

Deprecated. since 4.5.10 use getJCRNode() instead

Returns:

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

AccessDeniedException

getJCRNode

protected javax.jcr.Node getJCRNode()
                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addComment

protected void addComment(Content node,
                          String version)
                   throws AccessDeniedException,
                          javax.jcr.RepositoryException

Throws:

AccessDeniedException

javax.jcr.RepositoryException

cleanComment

protected void cleanComment(Content node)
                     throws AccessDeniedException,
                            javax.jcr.RepositoryException

Throws:

AccessDeniedException

javax.jcr.RepositoryException

restore

public String restore()

restoreRecursive

public String restoreRecursive()

getPath

public String getPath()

Returns:

Returns the path.

setPath

public void setPath(String path)

Parameters:

path - The path to set.

getRepository

public String getRepository()

Returns:

Returns the repository.

setRepository

public void setRepository(String repository)

Parameters:

repository - The repository to set.

onRender

public String onRender()

Description copied from class: AbstractList

Do some additional rendering in the subclass

Overrides:

onRender in class AbstractList

getVersionLabel

public String getVersionLabel()

Returns:

Returns the versionLabel.

setVersionLabel

public void setVersionLabel(String versionLabel)

Parameters:

versionLabel - The versionLabel to set.

getOnDiffFunction

public String getOnDiffFunction()

getJsExecutedAfterSaving

public String getJsExecutedAfterSaving()

setJsExecutedAfterSaving

public void setJsExecutedAfterSaving(String jsExecutedAfterSaving)