org.apache.jetspeed.layout.impl
Class ChangePortletAction
java.lang.Object
org.apache.jetspeed.layout.impl.BasePortletAction
org.apache.jetspeed.layout.impl.ChangePortletAction
- All Implemented Interfaces:
- AjaxAction, AjaxBuilder, Constants
public class ChangePortletAction
- extends BasePortletAction
- implements AjaxAction, AjaxBuilder, Constants
Changes the window state or portlet mode for a given portlet window
AJAX Parameters:
id = the fragment id of the portlet to move
page = (implied in the URL)
state = the new window state
mode = the new portlet mode
- Version:
- $Id: $
- Author:
- David Sean Taylor
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 |
Method Summary |
protected boolean |
isValidPortletMode(java.lang.String portletMode)
|
protected boolean |
isValidWindowState(java.lang.String windowState)
|
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 |
log
protected static final org.apache.commons.logging.Log log
action
protected java.lang.String action
validWindowStates
protected java.util.Map validWindowStates
validPortletModes
protected java.util.Map validPortletModes
windowAccessor
protected PortletWindowAccessor windowAccessor
ChangePortletAction
public ChangePortletAction(java.lang.String template,
java.lang.String errorTemplate,
java.lang.String action,
PortletWindowAccessor windowAccessor)
throws AJAXException
- Throws:
AJAXException
ChangePortletAction
public ChangePortletAction(java.lang.String template,
java.lang.String errorTemplate,
java.lang.String action,
PageManager pageManager,
PortletWindowAccessor windowAccessor,
PortletActionSecurityBehavior securityBehavior)
throws AJAXException
- Throws:
AJAXException
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 ContextresultMap
- 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 ContextresultMap
- 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)
isValidWindowState
protected boolean isValidWindowState(java.lang.String windowState)
isValidPortletMode
protected boolean isValidPortletMode(java.lang.String portletMode)
Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.