ActionContextWrapper (Common Controls presentation Framework 1.7.050 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.cc.framework.adapter.struts
Class ActionContextWrapper

java.lang.Object
  com.cc.framework.adapter.struts.ActionContextWrapper

All Implemented Interfaces:: ActionContext, AjaxRequest, HttpContext, RequestContext

Direct Known Subclasses:: ConcreteControlActionContext, ConcreteFormActionContext

public abstract class ActionContextWrapper
extends java.lang.Object
implements ActionContext

Wrapper Class for the ActionContext

Since:: 1.0
Version:: $Revision: 1.2 $
Author:: Gernot Schulz

Field Summary
`private ActionContext`	`nested` The ActionContext

Constructor Summary
`ActionContextWrapper(ActionContext ctx)` Constructor

Method Summary
`void`	`addError(java.lang.String key, java.lang.Throwable t)` Serves to include an exception in the global error collection.
`void`	`addErrors(org.apache.struts.action.ActionMessages errorList)` Adds an error collection
`void`	`addGlobalError(java.lang.String key)` Saves a general error (without reference to an input field) and is used to present error messages upon returning from a sub-dialog within the calling dialog.
`void`	`addGlobalError(java.lang.String key, java.lang.Object p1)` Saves a general error (without reference to an input field)
`void`	`addGlobalError(java.lang.String key, java.lang.Object p1, java.lang.Object p2)` Saves a general error (without reference to an input field)
`void`	`addGlobalError(java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)` Saves a general error (without reference to an input field)
`void`	`addGlobalError(java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)` Saves a general error (without reference to an input field)
`void`	`addGlobalMessage(java.lang.String key)` Saves a message without reference to a Property.
`void`	`addGlobalMessage(java.lang.String key, java.lang.Object p1)` Saves a message without reference to a Property.
`void`	`addGlobalMessage(java.lang.String key, java.lang.Object p1, java.lang.Object p2)` Saves a message without reference to a Property.
`void`	`addGlobalMessage(java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)` Saves a message without reference to a Property.
`void`	`addGlobalMessage(java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)` Saves a message without reference to a Property.
`void`	`addMenu(MenuItem menu)` Adds the given Menu to the AJAX response for this action.
`void`	`addMessages(org.apache.struts.action.ActionMessages messageList)` Adds an message collection
`void`	`addPropertyError(java.lang.String property, java.lang.String key)` Saves an error to a Property in the error collection
`void`	`addPropertyError(java.lang.String property, java.lang.String key, java.lang.Object p1)` Saves an error to a Property in the error collection
`void`	`addPropertyError(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2)` Saves an error to a Property in the error collection
`void`	`addPropertyError(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)` Saves an error to a Property in the error collection
`void`	`addPropertyError(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)` Saves an error to a Property in the error collection
`void`	`addPropertyMessage(java.lang.String property, java.lang.String key)` Saves a message for a Property in the Message collection
`void`	`addPropertyMessage(java.lang.String property, java.lang.String key, java.lang.Object p1)` Saves a message for a Property in the Message collection
`void`	`addPropertyMessage(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2)` Saves a message for a Property in the Message collection
`void`	`addPropertyMessage(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)` Saves a message for a Property in the Message collection
`void`	`addPropertyMessage(java.lang.String property, java.lang.String key, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)` Saves a message for a Property in the Message collection
`void`	`cancelAjaxRequest()` Cancels the AJAX event processing of the framework.
`void`	`consumeStrutsMessages()` This method transfers all existing Struts errors and messages into the frameworks message store.
`org.apache.struts.action.ActionForm`	`form()` Returns the action form
`void`	`forward(org.apache.struts.action.ActionForward forward)` Sets the forward
`void`	`forwardByName(java.lang.String forwardName)` Forwards to the Action specified by the Name
`void`	`forwardByName(java.lang.String forwardName, java.lang.Object p1)` Forwards to the Action specified by the Name
`void`	`forwardByName(java.lang.String forwardName, java.lang.Object[] params)` Forwards to the Action specified by the Name
`void`	`forwardByName(java.lang.String forwardName, java.lang.Object p1, java.lang.Object p2)` Forwards to the Action specified by the Name
`void`	`forwardByName(java.lang.String forwardName, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)` Forwards to the Action specified by the Name
`void`	`forwardToAction(java.lang.String actionName)` Forwards to the specified Action
`void`	`forwardToAction(java.lang.String actionName, boolean redirect)` Forwards to the specified Action
`void`	`forwardToAction(java.lang.String actionName, java.util.Map params)` Forwards to the specified Action
`void`	`forwardToAction(java.lang.String actionName, java.util.Map params, boolean redirect)` Forwards to the specified Action
`void`	`forwardToInput()` Forwards the Request to the Input, which is specified for the Action in the struts configuration.
`void`	`forwardToResponse()` The next Forward should be directly directed to the Response
`java.lang.Object`	`getAjaxAttribute(Control control, java.lang.String attributeName)` Returns the attribute with the given name from the container
`java.util.Iterator`	`getAjaxAttributeNames(Control control)` Returns an Iterator that iterates all attribute names
`java.lang.Object`	`getAttribute(java.lang.String name, HttpScope scope)` Returns the attribute with the given name from the specified scope
`java.util.Iterator`	`getDirtyControls()` Returns an iterator that iterates all dirty controls that needs to be rendered after an AJAX request.
`org.apache.struts.action.ActionMessages`	`getErrors()` Gets the error collection
`org.apache.struts.action.ActionForward`	`getForward()` Gets the forward
`java.util.Locale`	`getLocale()` Returns the current Locale for this Request
`java.util.Iterator`	`getMenus()` Returns an Iterator that iterates all menus
`org.apache.struts.action.ActionMessages`	`getMessages()` Returns the message collection
`RequestContext`	`getNestedContext()` Gets the nested Action Context
`Principal`	`getPrincipal()` Returns the Principal Object in the current User session
`javax.servlet.ServletContext`	`getServletContext()` Returns the Servlet Context
`boolean`	`hasErrors()` Checks whether there are error messages.
`boolean`	`hasMessages()` Checks whether there are messages present.
`void`	`invalidDialogContext(java.lang.String messageKey)` Generates a standardized error message if no DialogContext exists.
`boolean`	`isAjaxCanceled()` Returns `true` when this AJAX request has been canceled.
`boolean`	`isAjaxRequest()` Returns `true` when this request was sent by an AJAX function call from within the clients browser.
`boolean`	`isHandeled()` If an element (control, action class) has handled the request it can set this flag, so that the request is not processed a second time by an other element.
`org.apache.struts.action.ActionMapping`	`mapping()` Returns the action mapping object
`void`	`markDirty(Control control)` Adds the given Control to the dirty list.
`javax.servlet.http.HttpServletRequest`	`request()` Returns the HTTP Request
`javax.servlet.http.HttpServletResponse`	`response()` Returns the HTTP Response
`javax.servlet.http.HttpSession`	`session()` Gets the session object
`void`	`setAjaxAttribute(Control control, java.lang.String attributeName, java.lang.Object value)` Adds a new Attribute to the container.
`void`	`setForm(org.apache.struts.action.ActionForm form)` Associates a new ActionForm with this ActionContext
`java.lang.String`	`toString()`
`void`	`validateForm()` Validates the action form and adds the error messages to the internal error collection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

nested

private ActionContext nested

The ActionContext

Constructor Detail

ActionContextWrapper

public ActionContextWrapper(ActionContext ctx)

Constructor
Parameters:: ctx - ActionContext

Method Detail

getNestedContext

public RequestContext getNestedContext()

Description copied from interface: RequestContext

Gets the nested Action Context

Specified by:: getNestedContext in interface RequestContext

Returns:: The nested Action Context
See Also:: RequestContext.getNestedContext()