com.sas.servlet.tbeans.form.html
Interface FormViewInterface

All Known Implementing Classes:

AbstractSelectorContainer, BarChart, BarLineChart, BaseCalculatedItemSelectorPanel, BaseGraphSupport, DataSelector, DualListSelector, DualSelector, DualTreeSelector, EntityAttributeValueSelector, EntityAttributeValueSelectorPanel, ESRIMapComposite, ExceptionHighlightingChartSelector, ExceptionHighlightingChartSelectorPanel, ExceptionHighlightingSelector, ExceptionHighlightingSelectorPanel, ExportSelector, ExportSelectorPanel, FilterAndRankSelector, FilterAndRankSelectorPanel, FindSelector, FindSelectorPanel, GraphSupport, InformationServicesSearch, LineChart, LinePlot, MapCrossingSelector, MapCrossingSelectorPanel, MapPropertySelector, MapPropertySelectorPanel, MemberPropertiesSelector, MemberPropertiesSelectorPanel, OLAPESRIMapComposite, OLAPTableView, OLAPTimeBasedFilterSelector, OLAPTimeBasedFilterSelectorPanel, PercentCalculationsSelector, PercentCalculationsSelectorPanel, PieChart, RadarChart, RemoteFileSearch, ScatterPlot, SelectorPanel, SimpleCalculatedItemSelector, SimpleCalculatedItemSelectorPanel, SortSelector, SortSelectorPanel, TableView, TileChart, TreeListSelector, TreeView, WaterfallChart

public interface FormViewInterface

The FormViewerInterface class provides a common interface for viewers that require a form element.

Method Summary

java.util.HashMap	getAdditionalParameters() Returns a HashMap containing additional parameters that should be added to the form used to perform the various actions on the tbean.
Form	getDefaultFormObject() Gets the default form object to be used by the viewer.
Form	getFormObject() Gets the form object to be used by the viewer.
boolean	isFormEnabled() Determines if the tbean should render its formObject.
void	setAdditionalParameter(java.lang.String name, java.lang.String value) Sets an additional parameter to be added to the form used to perform the various actions on the tbean.
void	setAdditionalParameters(java.util.HashMap map) Sets a HashMap containing additional parameters that should be added to the form used to perform the various actions on the tbean.
void	setFormEnabled(boolean enabled) Sets whether the tbean should render its formObject.
void	setFormObject(Form form) Sets the form object to be used by the viewer.

Method Detail

setFormObject

void setFormObject(Form form)

Sets the form object to be used by the viewer.

Parameters:

form - The form object

getFormObject

Form getFormObject()

Gets the form object to be used by the viewer.

Returns:

The form object

getDefaultFormObject

Form getDefaultFormObject()

Gets the default form object to be used by the viewer. The getDefaultFormObject( HttpActionProviderViewInterface viewer, HttpServletRequest request, HttpServlet response ) method on the com.sas.servlet.Util class provides a generic implementation of this method for viewers that also implement the HttpActionProviderViewInterface.

Returns:

The form object

getAdditionalParameters

java.util.HashMap getAdditionalParameters()

Returns a HashMap containing additional parameters that should be added to the form used to perform the various actions on the tbean. The default value is null. Each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Returns:

a HashMap containing additional parameters that should be added to the form

See Also:

HashMap

setAdditionalParameters

void setAdditionalParameters(java.util.HashMap map)

Sets a HashMap containing additional parameters that should be added to the form used to perform the various actions on the tbean. The default value is null. Each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Parameters:

map - HashMap object

See Also:

HashMap

setAdditionalParameter

void setAdditionalParameter(java.lang.String name,
                            java.lang.String value)

Sets an additional parameter to be added to the form used to perform the various actions on the tbean. Each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Parameters:

name - name of the list item

value - value of the list item

See Also:

HashMap

isFormEnabled

boolean isFormEnabled()

Determines if the tbean should render its formObject. If true, then the tbean is responsible for rendering the formObject via the formObject's writeHeader and writeFooter methods. If false then the tbean does not render the formObject and the user is responsible for rendering the formObject.

Returns:

true if the tbean should render its formObject

setFormEnabled

void setFormEnabled(boolean enabled)

Sets whether the tbean should render its formObject. If so, then set to true. If set to false, the the user is responsible for rendering the formObject via its writeHeader and writeFooter methods.

Parameters:

value - true if the formObject should be rendered by the tbean