net.jspcontrols.dialogs.actions
Class DialogMapping

java.lang.Object
  extended byorg.apache.struts.config.ActionConfig
      extended byorg.apache.struts.action.ActionMapping
          extended bynet.jspcontrols.dialogs.actions.DialogMapping
All Implemented Interfaces:
java.io.Serializable
public class DialogMapping
extends org.apache.struts.action.ActionMapping

A DialogMapping represents the information that the controller, RequestProcessor, knows about the mapping of a particular request to an instance of a particular Action class.

This class allows to employ different syntax for describing action mappings, using <component> elements instead of <action>. See struts-config_1_2_dialog.dtd for details.

Since:
1.23
Author:
Michael Jouravlev
See Also:
Serialized Form

Field Summary
protected  java.lang.String view
          Path to the default view, usually JSP page.
 
Fields inherited from class org.apache.struts.config.ActionConfig
attribute, configured, exceptions, forward, forwards, include, input, moduleConfig, multipartClass, name, parameter, path, prefix, roleNames, roles, scope, suffix, type, unknown, validate
 
Constructor Summary
DialogMapping()
          Dialogs use session scope and have automatic validation turned off, so a handler in an action form would always be called.
 
Method Summary
 org.apache.struts.config.ForwardConfig findForwardConfig(java.lang.String name)
          Return the forward configuration for the specified key, if any; otherwise return null.
 java.lang.String getForm()
          Return name of the form bean, if any, associated with this Action.
 java.lang.String getView()
          Returns the path to the default view of a corresponding dialog.
 org.apache.struts.action.ActionForward reload()
          Reloads a dialog by returning a TransferForward.DIALOG_RELOAD ActionForward object.
 void setForm(java.lang.String name)
           
 void setView(java.lang.String view)
           
 
Methods inherited from class org.apache.struts.action.ActionMapping
findForward, findForwards, getInputForward
 
Methods inherited from class org.apache.struts.config.ActionConfig
addExceptionConfig, addForwardConfig, findException, findExceptionConfig, findExceptionConfigs, findForwardConfigs, freeze, getAttribute, getForward, getInclude, getInput, getModuleConfig, getMultipartClass, getName, getParameter, getPath, getPrefix, getRoleNames, getRoles, getScope, getSuffix, getType, getUnknown, getValidate, removeExceptionConfig, removeForwardConfig, setAttribute, setForward, setInclude, setInput, setModuleConfig, setMultipartClass, setName, setParameter, setPath, setPrefix, setRoles, setScope, setSuffix, setType, setUnknown, setValidate, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

view

protected java.lang.String view
Path to the default view, usually JSP page. The 'view path = "..."' attribute of element is used instead of subelement of element.

Constructor Detail

DialogMapping

public DialogMapping()
Dialogs use session scope and have automatic validation turned off, so a handler in an action form would always be called.

Method Detail

getView

public java.lang.String getView()
Returns the path to the default view of a corresponding dialog.

setView

public void setView(java.lang.String view)
Parameters:
view - the path to the default view of a corresponding dialog.

getForm

public java.lang.String getForm()
Return name of the form bean, if any, associated with this Action.

setForm

public void setForm(java.lang.String name)
Parameters:
name - name of the form bean associated with this Action.

reload

public org.apache.struts.action.ActionForward reload()
Reloads a dialog by returning a TransferForward.DIALOG_RELOAD ActionForward object.

Returns:
TransferForward.DIALOG_RELOAD ActionForward object, which is detected by DialogAction as a signal to reload the dialog. This works only for <component> elements, does not work for <action> elements.

findForwardConfig

public org.apache.struts.config.ForwardConfig findForwardConfig(java.lang.String name)
Return the forward configuration for the specified key, if any; otherwise return null.

Parameters:
name - Name of the forward configuration to return