org.apache.jetspeed.layout.impl
Class RemovePortletAction

java.lang.Object
  extended by org.apache.jetspeed.layout.impl.BasePortletAction
      extended by org.apache.jetspeed.layout.impl.RemovePortletAction
All Implemented Interfaces:
AjaxAction, AjaxBuilder, Constants

public class RemovePortletAction
extends BasePortletAction
implements AjaxAction, AjaxBuilder, Constants

Remove Portlet portlet placement action AJAX Parameters: id = the fragment id of the portlet to remove page = (implied in the URL)

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

Field Summary
protected static org.apache.commons.logging.Log log
           
 
Fields inherited from class org.apache.jetspeed.layout.impl.BasePortletAction
errorTemplate, pageManager, securityBehavior, 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
RemovePortletAction(java.lang.String template, java.lang.String errorTemplate, PortletRegistry registry)
           
RemovePortletAction(java.lang.String template, java.lang.String errorTemplate, PortletRegistry registry, PageManager pageManager, PortletActionSecurityBehavior securityBehavior)
           
 
Method Summary
protected  PortletRegistry getPortletRegistry()
           
 boolean run(RequestContext requestContext, java.util.Map resultMap)
          The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.
 boolean runAction(RequestContext requestContext, java.util.Map resultMap, boolean batch)
           
 boolean runBatch(RequestContext requestContext, java.util.Map resultMap)
          Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage
 
Methods inherited from class org.apache.jetspeed.layout.impl.BasePortletAction
buildContext, buildErrorContext, checkAccess, createNewPageOnEdit, getActionParameter, getErrorTemplate, getFragmentIdFromLocation, getFragmentIdFromLocation, getNonNullActionParameter, getParentFragmentById, getTemplate, isCreateNewPageOnEditEnabled, isPageQualifiedForCreateNewPageOnEdit
 
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
checkAccess
 
Methods inherited from interface org.apache.jetspeed.ajax.AjaxBuilder
buildContext, buildErrorContext, getErrorTemplate, getTemplate
 

Field Detail

log

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

RemovePortletAction

public RemovePortletAction(java.lang.String template,
                           java.lang.String errorTemplate,
                           PortletRegistry registry)
                    throws PipelineException
Throws:
PipelineException

RemovePortletAction

public RemovePortletAction(java.lang.String template,
                           java.lang.String errorTemplate,
                           PortletRegistry registry,
                           PageManager pageManager,
                           PortletActionSecurityBehavior securityBehavior)
                    throws PipelineException
Throws:
PipelineException
Method Detail

runBatch

public boolean runBatch(RequestContext requestContext,
                        java.util.Map resultMap)
                 throws AJAXException
Description copied from interface: AjaxAction
Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage

Specified by:
runBatch in interface AjaxAction
Overrides:
runBatch in class BasePortletAction
Parameters:
requestContext - The Jetspeed Request Context
resultMap - map of action parameters passed to the builder context
Returns:
success is true, failure is false
Throws:
AJAXException

run

public boolean run(RequestContext requestContext,
                   java.util.Map resultMap)
            throws AJAXException
Description copied from interface: AjaxAction
The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.

Specified by:
run in interface AjaxAction
Parameters:
requestContext - The Jetspeed Request Context
resultMap - map of action parameters passed to the builder context
Returns:
success is true, failure is false
Throws:
AJAXException

runAction

public boolean runAction(RequestContext requestContext,
                         java.util.Map resultMap,
                         boolean batch)

getPortletRegistry

protected PortletRegistry getPortletRegistry()


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