info.magnolia.module.admininterface.lists
Class AbstractList

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

All Implemented Interfaces:

MVCServletHandler

Direct Known Subclasses:

AbstractSimpleSearchList, Inbox, SubPagesList, VersionsList

public abstract class AbstractList
extends TemplatedMVCHandler

Version:

$Revision$ ($Author$)

Author:

Philipp Bracher

Field Summary

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

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

Method Summary

protected void	addContextMenuItem(ContextMenu menu, String name, String label, String iconName, String methodName, String isActiveMethodName) Helper method to creat menu items for the list
protected void	configureContextMenu(ContextMenu menu) Override to configure the menu
protected void	configureFunctionBar(FunctionBar bar) Override to configure the bar
abstract void	configureList(ListControl list)
ContextMenu	getContextMenu()
FunctionBar	getFunctionBar()
String	getGroupBy()
String	getGroupByOrder()
String	getLanguage()
ListControl	getList()
abstract ListModel	getModel() Returns the model used by this list
protected RenderKit	getRenderKit() Returns the default admin interface render kit.
String	getSortBy()
String	getSortByOrder()
protected String	getTemplateName(String viewName) Don't use the class name.
String	getURI()
void	initList(ListControl list)
String	onRender() Do some additional rendering in the subclass
String	onRenderHeader() Do some additional rendering in the subclass
void	setFunctionBar(FunctionBar functionBar)
void	setGroupBy(String groupBy)
void	setGroupByOrder(String groupByOrder)
void	setList(ListControl list)
void	setSortBy(String sortBy)
void	setSortByOrder(String sortByOrder)
String	show() This is an empty implementation return the default show view.

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

Constructor Detail

AbstractList

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

Parameters:

name -

request -

response -

Method Detail

getTemplateName

protected String getTemplateName(String viewName)

Don't use the class name.

Overrides:

getTemplateName in class TemplatedMVCHandler

Parameters:

viewName - the view name to render

Returns:

the template name (including path)

show

public String show()

Description copied from class: PageMVCHandler

This is an empty implementation return the default show view.

Overrides:

show in class PageMVCHandler

Returns:

the view name

configureList

public abstract void configureList(ListControl list)

Parameters:

list -

initList

public void initList(ListControl list)

Parameters:

list -

getLanguage

public String getLanguage()

getModel

public abstract ListModel getModel()

Returns the model used by this list

setList

public void setList(ListControl list)

Parameters:

list - The list to set.

getList

public ListControl getList()

Returns:

Returns the list.

getContextMenu

public ContextMenu getContextMenu()

configureContextMenu

protected void configureContextMenu(ContextMenu menu)

Override to configure the menu

addContextMenuItem

protected void addContextMenuItem(ContextMenu menu,
                                  String name,
                                  String label,
                                  String iconName,
                                  String methodName,
                                  String isActiveMethodName)

Helper method to creat menu items for the list

getRenderKit

protected RenderKit getRenderKit()

Returns the default admin interface render kit.

getFunctionBar

public FunctionBar getFunctionBar()

Returns:

Returns the functionBar.

configureFunctionBar

protected void configureFunctionBar(FunctionBar bar)

Override to configure the bar

setFunctionBar

public void setFunctionBar(FunctionBar functionBar)

Parameters:

functionBar - The functionBar to set.

getGroupBy

public String getGroupBy()

Returns:

Returns the groupBy.

setGroupBy

public void setGroupBy(String groupBy)

Parameters:

groupBy - The groupBy to set.

getGroupByOrder

public String getGroupByOrder()

Returns:

Returns the groupByOrder.

setGroupByOrder

public void setGroupByOrder(String groupByOrder)

Parameters:

groupByOrder - The groupByOrder to set.

getSortBy

public String getSortBy()

Returns:

Returns the sortBy.

setSortBy

public void setSortBy(String sortBy)

Parameters:

sortBy - The sortBy to set.

getSortByOrder

public String getSortByOrder()

Returns:

Returns the sortByOrder.

setSortByOrder

public void setSortByOrder(String sortByOrder)

Parameters:

sortByOrder - The sortByOrder to set.

onRender

public String onRender()

Do some additional rendering in the subclass

onRenderHeader

public String onRenderHeader()

Do some additional rendering in the subclass

getURI

public String getURI()