com.ibm.commerce.pa.widget.beans
Class FormDataBean

java.lang.Object
  |
  +--com.ibm.commerce.pa.beans.DynamicDataBeanImpl
        |
        +--com.ibm.commerce.pa.widget.beans.FormDataBean
All Implemented Interfaces:
CommandDataBean, DataBean, DynamicDataBean, InputDataBean, java.io.Serializable
Direct Known Subclasses:
ProductExploreDataBean

public class FormDataBean
extends DynamicDataBeanImpl

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
protected  java.util.Vector formElements
           
protected  java.lang.Boolean removeIrrelevant
           
 
Fields inherited from class com.ibm.commerce.pa.beans.DynamicDataBeanImpl
constraintList, defaultWidget, errorCode, errorMessage, interfaceName, metaData, pageName, parent, parentName, requestProperties, scriptName
 
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
 
Constructor Summary
FormDataBean()
          A form object constructor.
 
Method Summary
 void addElement(ColumnDataBean ds)
          Add a column to the form.
 void copy(DynamicDataBean ds)
          Copy the elements from a form object into this object.
 ColumnDataBean getElement(java.lang.String itemName)
          This method will return a column given the name associated with it.
 ColumnDataBean getElementAt(int n)
          This method returns the ColumnDataBean at element n
 java.util.Vector getFormElements()
          This method will return the internal Vector of ColumnDataBeans which make up the collection of form elements
 boolean getRemoveIrrelevant()
          If a column is empty it is considered irrelevant.
 int getSize()
          This method returns the number of columns in the form.
 void insertElementAt(ColumnDataBean ds, int index)
          Insert a column at the index supplied.
 int removeIrrelevantColumns()
          Check for empty columns and remove them from the form.
 void setFormElements(java.util.Vector newValue)
          This method will set the internal collection of ColumnDataBeans which represent the form elements
 void setRemoveIrrelevant(java.lang.Boolean newValue)
          Set the flag indicating whether empty columns should be removed from the form.
 
Methods inherited from class com.ibm.commerce.pa.beans.DynamicDataBeanImpl
addConstraint, getCommandInterfaceName, getConstraintList, getDefaultWidget, getErrorCode, getErrorMessage, getMetaData, getPageName, getParent, getParentName, getRequestProperties, getScriptName, setCommandInterfaceName, setConstraintList, setDefaultWidget, setErrorCode, setErrorMessage, setMetaData, setPageName, setParent, setParentName, setRequestProperties, setScriptName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

formElements

protected java.util.Vector formElements

removeIrrelevant

protected java.lang.Boolean removeIrrelevant
Constructor Detail

FormDataBean

public FormDataBean()
A form object constructor.
Method Detail

addElement

public void addElement(ColumnDataBean ds)
Add a column to the form.
Parameters:
ds - The column databean to add to the form.

copy

public void copy(DynamicDataBean ds)
Copy the elements from a form object into this object.
Overrides:
copy in class DynamicDataBeanImpl
Parameters:
ds - The FormDataBean object to copy from.

getElement

public ColumnDataBean getElement(java.lang.String itemName)
This method will return a column given the name associated with it. The meta data for the column databean contains the name.
Parameters:
itemName - String name of the column to retrieve.
Returns:
The column databean with the name supplied.

getElementAt

public ColumnDataBean getElementAt(int n)
This method returns the ColumnDataBean at element n
Parameters:
n - The index of the column to retrieve.
Returns:
The column databean.

getFormElements

public java.util.Vector getFormElements()
This method will return the internal Vector of ColumnDataBeans which make up the collection of form elements
Returns:
A collection of ColumnDataBeans

getRemoveIrrelevant

public boolean getRemoveIrrelevant()
If a column is empty it is considered irrelevant. Retrieve the setting for removing irrelevant columns from the form.
Returns:
true if irrelevant columns will be removed; false otherwise.

getSize

public int getSize()
This method returns the number of columns in the form.
Returns:
The number of columns.

insertElementAt

public void insertElementAt(ColumnDataBean ds,
                            int index)
Insert a column at the index supplied.
Parameters:
ds - The column databean to insert.
index - The place in the form where the column is to be inserted.

removeIrrelevantColumns

public int removeIrrelevantColumns()
Check for empty columns and remove them from the form.
Returns:
int The number of columns removed.

setFormElements

public void setFormElements(java.util.Vector newValue)
This method will set the internal collection of ColumnDataBeans which represent the form elements
Parameters:
newValue - The collection of ColumnDataBeans to use.

setRemoveIrrelevant

public void setRemoveIrrelevant(java.lang.Boolean newValue)
Set the flag indicating whether empty columns should be removed from the form.
Parameters:
newValue - true to remove empty columns; false otherwise.