com.ivata.mask.web.struts
Class ListForm

java.lang.Object
  org.apache.struts.action.ActionForm
      com.ivata.mask.web.struts.DialogForm
          com.ivata.mask.web.struts.MaskForm
              com.ivata.mask.web.struts.ListForm

All Implemented Interfaces:

java.io.Serializable

public class ListForm

extends MaskForm

This form references a list of value objects to be displayed.

Since:

ivata masks 0.1 (2004-05-09)

Version:

$Revision: 1.5 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

static java.lang.String

REQUEST_ATTRIBUTE Request attribute under which name this form is stored.

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

ListForm(java.util.List valueObjectsParam, com.ivata.mask.Mask maskParam, java.lang.Class baseClassParam)
Create a new mask form for the given value object list and base class.

Method Summary

protected void	clear() Clear all bean properties to their default state.The difference between this and reset is that all properties are changed, regardless of current request state.
java.util.List	getValueObjects() Contains all value objects to be displayed.
void	setValueObjects(java.util.List valueObjectsParam) Contains all value objects to be displayed.

Methods inherited from class com.ivata.mask.web.struts.MaskForm

getBaseClass, getMask, validate

Methods inherited from class com.ivata.mask.web.struts.DialogForm

getApply, getBundle, getClear, getDefaultForwardApply, getDefaultForwardDelete, getDefaultForwardOk, getDeleteConfirm, getDeleteKey, getDeleteWarn, getHelpKey, getOk, reset, setApply, setBundle, setClear, setDefaultForwardApply, setDefaultForwardDelete, setDefaultForwardOk, setDeleteConfirm, setDeleteKey, setDeleteWarn, setHelpKey, setOk, validate

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_ATTRIBUTE

public static final java.lang.String REQUEST_ATTRIBUTE

Request attribute under which name this form is stored.

See Also:

Constant Field Values

Constructor Detail

ListForm

public ListForm(java.util.List valueObjectsParam,
                com.ivata.mask.Mask maskParam,
                java.lang.Class baseClassParam)

Create a new mask form for the given value object list and base class.

Parameters:

valueObjectsParam - all value objects to be displayed.

maskParam - Refer to MaskForm.MaskForm(com.ivata.mask.Mask, java.lang.Class).

baseClassParam - Refer to MaskForm.MaskForm(com.ivata.mask.Mask, java.lang.Class).

Method Detail

clear

protected void clear()

Clear all bean properties to their default state.The difference between this and reset is that all properties are changed, regardless of current request state.

Overrides:

clear in class MaskForm

See Also:

MaskForm.clear()

getValueObjects

public final java.util.List getValueObjects()

Contains all value objects to be displayed.

Returns:

all value objects to be displayed.

setValueObjects

public final void setValueObjects(java.util.List valueObjectsParam)

Contains all value objects to be displayed.

Parameters:

valueObjectsParam - all value objects to be displayed.