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

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

public class ColumnDataBean
extends DynamicDataBeanImpl

See Also:
Serialized Form

Field Summary
protected  java.util.Vector column
           
static java.lang.String COPYRIGHT
           
protected  java.lang.String formElementName
           
protected  java.lang.String undoURL
           
 
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
ColumnDataBean()
          ColumnDataBean constructor.
 
Method Summary
 void addElement(DsData data)
          Add an element to the column.
 void copy(DynamicDataBean ds)
          Copies a databean into this databean.
 java.util.Vector getColumn()
          Gets the collection of data objects making up the column.
 java.lang.String getCommandInterfaceName()
          Retrieve the interface name of the command which can be used to populate this databean.
 DsData getDataElementAt(int x)
          This method returns one element in a column.
 ElementDataBean getElementAt(int x)
          This method returns one element in a column as an ElementDataBean.
 java.lang.String getFormElementName()
          Get the form element name assigned to this object.
 int getSize()
          This method returns the number of elements in the column
 java.lang.String getUndoURL()
          Get the url string to use for any "undo" images to be associated with this column.
 void insertElementAt(DsData data, int index)
          Add a data object to the column at the index supplied.
 boolean isNull()
          This method will return true if all its data elements are null.
 void setColumn(java.util.Vector newValue)
          Sets the collection of data in the column in one call.
 void setFormElementName(java.lang.String newValue)
          Set the form element name to associate with this column.
 void setUndoURL(java.lang.String newValue)
          Set the url string for the undo image to associate with this column.
 
Methods inherited from class com.ibm.commerce.pa.beans.DynamicDataBeanImpl
addConstraint, 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

column

protected java.util.Vector column

COPYRIGHT

public static final java.lang.String COPYRIGHT

formElementName

protected java.lang.String formElementName

undoURL

protected java.lang.String undoURL
Constructor Detail

ColumnDataBean

public ColumnDataBean()
ColumnDataBean constructor.
Method Detail

addElement

public void addElement(DsData data)
Add an element to the column.
Parameters:
ds - The data object to add to the column.

copy

public void copy(DynamicDataBean ds)
Copies a databean into this databean. The databean being copied must be a ColumnDataBean.
Overrides:
copy in class DynamicDataBeanImpl
Parameters:
ds - The databean to copy.

getColumn

public java.util.Vector getColumn()
Gets the collection of data objects making up the column.
Returns:
The collection of data objects in the column.

getCommandInterfaceName

public java.lang.String getCommandInterfaceName()
Retrieve the interface name of the command which can be used to populate this databean.
Overrides:
getCommandInterfaceName in class DynamicDataBeanImpl
Returns:
The interface name.

getDataElementAt

public DsData getDataElementAt(int x)
This method returns one element in a column.
Parameters:
x - The index of the element to retrieve.
Returns:
The data object at index x.

getElementAt

public ElementDataBean getElementAt(int x)
This method returns one element in a column as an ElementDataBean.
Parameters:
x - The index of the element to retrieve.
Returns:
The element databean at index x.

getFormElementName

public java.lang.String getFormElementName()
Get the form element name assigned to this object.
Returns:
The form element name assigned to this object.

getSize

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

getUndoURL

public java.lang.String getUndoURL()
Get the url string to use for any "undo" images to be associated with this column.
Returns:
The url of the undo image.

insertElementAt

public void insertElementAt(DsData data,
                            int index)
Add a data object to the column at the index supplied.
Parameters:
ds - The data object to add to the column.
index - The position in the column to insert the data into.

isNull

public boolean isNull()
This method will return true if all its data elements are null.
Returns:
true if all the data in the DsData objects are null; false otherwise.

setColumn

public void setColumn(java.util.Vector newValue)
Sets the collection of data in the column in one call.
Parameters:
newValue - The collection of data objects in the column.

setFormElementName

public void setFormElementName(java.lang.String newValue)
Set the form element name to associate with this column.
Parameters:
newValue - The form element name to use.

setUndoURL

public void setUndoURL(java.lang.String newValue)
Set the url string for the undo image to associate with this column.
Parameters:
newValue - The url for the undo image.