org.apache.jetspeed.layout.impl
Class BasePortletAction

java.lang.Object
  extended by org.apache.jetspeed.layout.impl.BasePortletAction
All Implemented Interfaces:
org.apache.jetspeed.ajax.AjaxAction, org.apache.jetspeed.ajax.AjaxBuilder, Constants
Direct Known Subclasses:
BaseGetResourceAction, BaseSiteUpdateAction, ChangePortletAction, GetMenuAction, GetMenusAction, GetPagesAction, GetPortletActionsAction, GetPortletsAction, GetThemesAction, MovePortletAction, MultipleAction, RemovePortletAction, SecurityConstraintsAction, SecurityPermissionAction

public abstract class BasePortletAction
extends Object
implements org.apache.jetspeed.ajax.AjaxAction, org.apache.jetspeed.ajax.AjaxBuilder, Constants

Abstract portlet placement action

Version:
$Id: $
Author:
David Gurney, David Sean Taylor

Field Summary
protected  String errorTemplate
           
protected static org.apache.commons.logging.Log log
           
protected  org.apache.jetspeed.page.PageManager pageManager
           
protected  org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior
           
protected  String template
           
 
Fields inherited from interface org.apache.jetspeed.layout.impl.Constants
ABS, ACTION, CARTESIAN, COL, CUSTOM_MENUS, DEFAULT_LAYOUT, DESKTOP_EXTENDED, DESKTOP_PAGE_DECORATIONS, DESKTOP_PORTLET_DECORATIONS, DESTINATION, DOWN, FILTER, FOLDER, FOLDERS, FORMAT, FRAGMENTID, FRAGMENTS, GUESTUSERS, HEIGHT, INCLUDE_MENU_DEFS, IPADDRESS, LAYOUT, LAYOUTID, LAYOUTS, LEFT, LINK, LINKS, MENU, MENU_CONTEXT, MENU_DEFINITIONS, MENU_LOCALE, MENU_NAME, METADATA, NEWCOL, NEWROW, OFFLINE, OLD_DESKTOP_EXTENDED, OLD_HEIGHT, OLD_PORTLET_MODE, OLD_WIDTH, OLD_WINDOW_STATE, OLD_X, OLD_Y, OLD_Z, OLDCOL, OLDROW, ONLINE, PAGE, PAGE_DECORATIONS, PAGE_QUALIFIED_CREATE_ON_EDIT, PAGES, PORTLET_DECORATIONS, PORTLET_MODE, PORTLETENTITY, PORTLETID, PORTLETS, PROFILED_PATH, REASON, RESOURCE_NAME, RIGHT, ROLES, ROW, SECURITY_DEFS, SECURITY_OWNER, SECURITY_REFS, SESSIONS, SHORT_TITLE, SIZES, SOURCE, STANDARD_MENUS, STATUS, TITLE, TYPE, UP, USER_IS_ANONYMOUS, USERINFO, USERNAME, USERS, WIDTH, WINDOW_STATE, X, Y, Z
 
Constructor Summary
BasePortletAction(String template, String errorTemplate, org.apache.jetspeed.page.PageManager pageManager)
           
BasePortletAction(String template, String errorTemplate, org.apache.jetspeed.page.PageManager pageManager, org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)
           
BasePortletAction(String template, String errorTemplate, org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)
           
 
Method Summary
 boolean buildContext(org.apache.jetspeed.request.RequestContext requestContext, Map responseContext)
           
 boolean buildErrorContext(org.apache.jetspeed.request.RequestContext requestContext, Map responseContext)
           
 boolean checkAccess(org.apache.jetspeed.request.RequestContext context, String action)
           
 boolean createNewPageOnEdit(org.apache.jetspeed.request.RequestContext context)
           
 String getActionParameter(org.apache.jetspeed.request.RequestContext requestContext, String name)
           
 String getErrorTemplate()
           
 org.apache.jetspeed.om.page.Fragment getFragmentIdFromLocation(int row, int column, org.apache.jetspeed.om.page.Fragment parentFragment)
           
 org.apache.jetspeed.om.page.Fragment getFragmentIdFromLocation(int row, int column, org.apache.jetspeed.om.page.Page page)
           
 String getNonNullActionParameter(org.apache.jetspeed.request.RequestContext requestContext, String name)
           
 org.apache.jetspeed.om.page.Fragment getParentFragmentById(String id, org.apache.jetspeed.om.page.Fragment root)
           
 String getTemplate()
           
 boolean isCreateNewPageOnEditEnabled()
           
 boolean isPageQualifiedForCreateNewPageOnEdit(org.apache.jetspeed.request.RequestContext context)
           
 boolean runBatch(org.apache.jetspeed.request.RequestContext requestContext, Map resultMap)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.ajax.AjaxAction
run
 

Field Detail

log

protected static final org.apache.commons.logging.Log log

template

protected String template

pageManager

protected org.apache.jetspeed.page.PageManager pageManager

errorTemplate

protected String errorTemplate

securityBehavior

protected org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior
Constructor Detail

BasePortletAction

public BasePortletAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)

BasePortletAction

public BasePortletAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.page.PageManager pageManager)

BasePortletAction

public BasePortletAction(String template,
                         String errorTemplate,
                         org.apache.jetspeed.page.PageManager pageManager,
                         org.apache.jetspeed.layout.PortletActionSecurityBehavior securityBehavior)
Method Detail

buildContext

public boolean buildContext(org.apache.jetspeed.request.RequestContext requestContext,
                            Map responseContext)
Specified by:
buildContext in interface org.apache.jetspeed.ajax.AjaxBuilder

buildErrorContext

public boolean buildErrorContext(org.apache.jetspeed.request.RequestContext requestContext,
                                 Map responseContext)
Specified by:
buildErrorContext in interface org.apache.jetspeed.ajax.AjaxBuilder

getErrorTemplate

public String getErrorTemplate()
Specified by:
getErrorTemplate in interface org.apache.jetspeed.ajax.AjaxBuilder

getTemplate

public String getTemplate()
Specified by:
getTemplate in interface org.apache.jetspeed.ajax.AjaxBuilder

checkAccess

public boolean checkAccess(org.apache.jetspeed.request.RequestContext context,
                           String action)
Specified by:
checkAccess in interface org.apache.jetspeed.ajax.AjaxAction

isCreateNewPageOnEditEnabled

public boolean isCreateNewPageOnEditEnabled()

isPageQualifiedForCreateNewPageOnEdit

public boolean isPageQualifiedForCreateNewPageOnEdit(org.apache.jetspeed.request.RequestContext context)

createNewPageOnEdit

public boolean createNewPageOnEdit(org.apache.jetspeed.request.RequestContext context)

getFragmentIdFromLocation

public org.apache.jetspeed.om.page.Fragment getFragmentIdFromLocation(int row,
                                                                      int column,
                                                                      org.apache.jetspeed.om.page.Page page)

getFragmentIdFromLocation

public org.apache.jetspeed.om.page.Fragment getFragmentIdFromLocation(int row,
                                                                      int column,
                                                                      org.apache.jetspeed.om.page.Fragment parentFragment)

runBatch

public boolean runBatch(org.apache.jetspeed.request.RequestContext requestContext,
                        Map resultMap)
                 throws org.apache.jetspeed.ajax.AJAXException
Specified by:
runBatch in interface org.apache.jetspeed.ajax.AjaxAction
Throws:
org.apache.jetspeed.ajax.AJAXException

getActionParameter

public String getActionParameter(org.apache.jetspeed.request.RequestContext requestContext,
                                 String name)

getNonNullActionParameter

public String getNonNullActionParameter(org.apache.jetspeed.request.RequestContext requestContext,
                                        String name)

getParentFragmentById

public org.apache.jetspeed.om.page.Fragment getParentFragmentById(String id,
                                                                  org.apache.jetspeed.om.page.Fragment root)


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.