info.magnolia.module.admininterface.lists
Class AbstractList

java.lang.Object
  extended by info.magnolia.cms.servlets.MVCServletHandlerImpl
      extended by info.magnolia.cms.servlets.CommandBasedMVCServletHandler
          extended by info.magnolia.module.admininterface.PageMVCHandler
              extended by info.magnolia.module.admininterface.TemplatedMVCHandler
                  extended by 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: 41137 $ ($Author: gjoseph $)
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(java.lang.String name, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
protected  void addContextMenuItem(ContextMenu menu, java.lang.String name, java.lang.String label, java.lang.String iconName, java.lang.String methodName, java.lang.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()
           
 java.lang.String getGroupBy()
           
 java.lang.String getGroupByOrder()
           
 java.lang.String getLanguage()
           
 ListControl getList()
           
abstract  ListModel getModel()
          Returns the model used by this list
protected  RenderKit getRenderKit()
          Returns the default admin interface render kit.
 java.lang.String getSortBy()
           
 java.lang.String getSortByOrder()
           
protected  java.lang.String getTemplateName(java.lang.String viewName)
          Don't use the class name.
 java.lang.String getURI()
           
 void initList(ListControl list)
           
 java.lang.String onRender()
          Do some additional rendering in the subclass
 java.lang.String onRenderHeader()
          Do some additional rendering in the subclass
 void setFunctionBar(FunctionBar functionBar)
           
 void setGroupBy(java.lang.String groupBy)
           
 void setGroupByOrder(java.lang.String groupByOrder)
           
 void setList(ListControl list)
           
 void setSortBy(java.lang.String sortBy)
           
 void setSortByOrder(java.lang.String sortByOrder)
           
 java.lang.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(java.lang.String name,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
Parameters:
name -
request -
response -
Method Detail

getTemplateName

protected java.lang.String getTemplateName(java.lang.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 java.lang.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 java.lang.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,
                                  java.lang.String name,
                                  java.lang.String label,
                                  java.lang.String iconName,
                                  java.lang.String methodName,
                                  java.lang.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 java.lang.String getGroupBy()
Returns:
Returns the groupBy.

setGroupBy

public void setGroupBy(java.lang.String groupBy)
Parameters:
groupBy - The groupBy to set.

getGroupByOrder

public java.lang.String getGroupByOrder()
Returns:
Returns the groupByOrder.

setGroupByOrder

public void setGroupByOrder(java.lang.String groupByOrder)
Parameters:
groupByOrder - The groupByOrder to set.

getSortBy

public java.lang.String getSortBy()
Returns:
Returns the sortBy.

setSortBy

public void setSortBy(java.lang.String sortBy)
Parameters:
sortBy - The sortBy to set.

getSortByOrder

public java.lang.String getSortByOrder()
Returns:
Returns the sortByOrder.

setSortByOrder

public void setSortByOrder(java.lang.String sortByOrder)
Parameters:
sortByOrder - The sortByOrder to set.

onRender

public java.lang.String onRender()
Do some additional rendering in the subclass


onRenderHeader

public java.lang.String onRenderHeader()
Do some additional rendering in the subclass


getURI

public java.lang.String getURI()


Copyright © 2003-2011 Magnolia International Ltd.. All Rights Reserved.