info.magnolia.module.workflow.inbox
Class Inbox

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
                      extended by info.magnolia.module.workflow.inbox.Inbox
All Implemented Interfaces:
MVCServletHandler

public class Inbox
extends AbstractList

The AbstractList responsible for displaying a user's inbox, i.e current work items.

Version:
$Revision:3416 $ ($Author:philipp $)
Author:
Philipp Bracher

Field Summary
protected  Messages msgs
           
 
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
Inbox(java.lang.String name, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 java.lang.String cancel()
          Stop the workflow.
 void configureContextMenu(ContextMenu menu)
          Override to configure the menu
 void configureFunctionBar(FunctionBar bar)
          Same as the context menu.
 void configureList(ListControl list)
          Sets the select js code and defines the columns.
 java.lang.String getComment()
           
 java.lang.String getFlowItemId()
           
protected  java.lang.String getIcon(java.lang.String path, java.lang.String repository)
           
 ListModel getModel()
          Returns the model used by this list
protected  java.lang.String getShowJSFunction(java.lang.String repository, java.lang.String path)
           
 java.lang.String getSortBy()
           
 boolean isDebug()
           
 java.lang.String onRender()
          Add some inbox specific stuff: mainly hidden fields.
 java.lang.String proceed()
          Proceed the item.
 java.lang.String reject()
          Reject the item (adds a comment).
 void setComment(java.lang.String comment)
           
 void setDebug(boolean debug)
           
 void setFlowItemId(java.lang.String flowItemId)
           
 
Methods inherited from class info.magnolia.module.admininterface.lists.AbstractList
addContextMenuItem, getContextMenu, getFunctionBar, getGroupBy, getGroupByOrder, getLanguage, getList, getRenderKit, 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

msgs

protected Messages msgs
Constructor Detail

Inbox

public Inbox(java.lang.String name,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
Method Detail

getModel

public ListModel getModel()
Description copied from class: AbstractList
Returns the model used by this list

Specified by:
getModel in class AbstractList

getSortBy

public java.lang.String getSortBy()
Overrides:
getSortBy in class AbstractList
Returns:
Returns the sortBy.

configureList

public void configureList(ListControl list)
Sets the select js code and defines the columns.

Specified by:
configureList in class AbstractList

getIcon

protected java.lang.String getIcon(java.lang.String path,
                                   java.lang.String repository)

getShowJSFunction

protected java.lang.String getShowJSFunction(java.lang.String repository,
                                             java.lang.String path)

configureContextMenu

public void configureContextMenu(ContextMenu menu)
Description copied from class: AbstractList
Override to configure the menu

Overrides:
configureContextMenu in class AbstractList

configureFunctionBar

public void configureFunctionBar(FunctionBar bar)
Same as the context menu.

Overrides:
configureFunctionBar in class AbstractList

onRender

public java.lang.String onRender()
Add some inbox specific stuff: mainly hidden fields.

Overrides:
onRender in class AbstractList

proceed

public java.lang.String proceed()
Proceed the item.


reject

public java.lang.String reject()
Reject the item (adds a comment).


cancel

public java.lang.String cancel()
Stop the workflow.


getFlowItemId

public java.lang.String getFlowItemId()

setFlowItemId

public void setFlowItemId(java.lang.String flowItemId)

getComment

public java.lang.String getComment()

setComment

public void setComment(java.lang.String comment)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)


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