com.actuate.activeportal.forms
Class TableParamListActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.TableParamListActionForm
All Implemented Interfaces:
java.io.Serializable

public class TableParamListActionForm
extends BaseActionForm

This forms is used when editing a table parameter. It provides the list of rows that are displayed in the table list page. Anything set in this form will be overridden by the action when it retrieves the content. This form is completely managed by the framework.

Author:
Actuate Corporation
See Also:
Serialized Form

Constructor Summary
TableParamListActionForm()
           
 
Method Summary
 java.util.ArrayList getColumnNames()
          Returns the names of all the columns that are available in this table parameter.
 java.lang.String getExecutableId()
          Returns the id of the executable that contains this table parmeter
 com.actuate.schemas.FieldDefinition getFieldDefinition(int index)
          Returns the definition of a column at a particular index.
 boolean getIsHidden(int index)
          This method is called to verify whether a particular column is hidden or not.
 java.util.ArrayList getRows()
          Returns all the rows in the table.
 java.lang.String getTableDisplayName()
          Returns the display name of this table parmeter
 java.lang.String getTableName()
          Returns the name of this table parameter.
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          This method is called by the struts framework.
 void setColumnNames(java.util.ArrayList names)
          Sets the names of the columns that are applicable to this table parameter
 void setExecutableId(java.lang.String string)
          Sets the id of the executable that contains this table parameter
 void setFieldDefinitions(com.actuate.schemas.FieldDefinition[] fieldDefinitions)
          Sets the definitions of all the columns that are available in this table parameter.
 void setIsHidden(boolean[] _isHidden)
          This method is called to update the state of all the columns in the form to hidden or not.
 void setRows(java.util.ArrayList list)
          Sets the rows to be displayed in the page.
 void setTableDisplayName(java.lang.String string)
          Sets the display name of this table parameter.
 void setTableName(java.lang.String string)
          Sets the table name of this table parameter.
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
fixUTF8, isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableParamListActionForm

public TableParamListActionForm()
Method Detail

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
This method is called by the struts framework. Please refer to the struts documentation for more information about this.

Overrides:
reset in class org.apache.struts.action.ActionForm
Parameters:
mapping -
request -

getRows

public java.util.ArrayList getRows()
Returns all the rows in the table. This is called when the page is displayed.

Returns:
An ArrayList containing all the rows in the specified table.

getTableName

public java.lang.String getTableName()
Returns the name of this table parameter.

Returns:
The table name

setRows

public void setRows(java.util.ArrayList list)
Sets the rows to be displayed in the page. This is called by the action so that the page can display the rows.

Parameters:
list - The list of rows to be displayed.

setTableName

public void setTableName(java.lang.String string)
Sets the table name of this table parameter. This is called by the action class.

Parameters:
string - The name of the table

getTableDisplayName

public java.lang.String getTableDisplayName()
Returns the display name of this table parmeter

Returns:
The display name

setTableDisplayName

public void setTableDisplayName(java.lang.String string)
Sets the display name of this table parameter.

Parameters:
string - The display name

getColumnNames

public java.util.ArrayList getColumnNames()
Returns the names of all the columns that are available in this table parameter.

Returns:
The list of column names

setColumnNames

public void setColumnNames(java.util.ArrayList names)
Sets the names of the columns that are applicable to this table parameter

Parameters:
names - The list of column names

setExecutableId

public void setExecutableId(java.lang.String string)
Sets the id of the executable that contains this table parameter

Parameters:
string - The executable id

getExecutableId

public java.lang.String getExecutableId()
Returns the id of the executable that contains this table parmeter

Returns:
The executable id

getIsHidden

public boolean getIsHidden(int index)
This method is called to verify whether a particular column is hidden or not.

Parameters:
index - The index of the column which is to be checked to see whether it is hidden
Returns:
true if the column is hidden; false otherwise This method will throw an ArrayIndexOutOfBoundsException if an invalid index is specified.

setIsHidden

public void setIsHidden(boolean[] _isHidden)
This method is called to update the state of all the columns in the form to hidden or not. The length of this array should be equal to the number of columns in the table

Parameters:
_isHidden - An array of booleans indicating whether a particular column is hidden or not.

setFieldDefinitions

public void setFieldDefinitions(com.actuate.schemas.FieldDefinition[] fieldDefinitions)
Sets the definitions of all the columns that are available in this table parameter.

Parameters:
fieldDefinitions - An array of field definitions that represent all the columns in this table parameter

getFieldDefinition

public final com.actuate.schemas.FieldDefinition getFieldDefinition(int index)
Returns the definition of a column at a particular index.

Parameters:
index - The index of the column whose definition is to be retrieved
Returns:
The field definition at the specified index. This method will throw an ArrayIndexOutOfBoundsException if an invalid index is specified.