com.sas.servlet.tbeans.dataselectors.html
Class DataSelector

com.sas.servlet.tbeans.dataselectors.html.DataSelector

All Implemented Interfaces:

HttpActionProviderInterface, com.sas.beans.PropertyChangeSource, DataSelectorInterface, HttpDataSelectorInterface, com.sas.lang.ObjectDataInterface, com.sas.servlet.tbeans.AJAXControllerURLInterface, ComplexStyleInterface, CompositeComponentInterface, FormViewInterface, RenderableInterface, TemplateInterface, com.sas.servlet.tbeans.TemplateKeyInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

AbstractSelectorContainer

@SASScope(value="ALL")
public abstract class DataSelector
implements FormViewInterface

The DataSelector is an abstract TransformationBean™ that provides HTML form functionality for the data selector framework. Forms are used to submit requests for updated information during selector processing and to commit or cancel the selector changes.

For More Information:

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

Since:

3.1

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.dataselectors.BaseDataSelector

EXTERNAL_CHILD_SELECTOR, SELECTOR_EXPAND, SELECTOR_EXTERNAL

Constructor Summary

DataSelector()

Method Summary

java.util.HashMap	getAdditionalParameters() Returns an HashMap containing additional parameters that should be added to the form used to perform the various actions on the Selector.
Form	getDefaultFormObject() Gets the default form object to be used by the TableView.
Form	getFormObject() Gets the form object to be used by the TableView.
boolean	isFormEnabled() Determines if the Selector 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 Selector.
void	setAdditionalParameters(java.util.HashMap map) Sets an HashMap containing additional parameters that should be added to the form used to perform the various actions on the Selector.
void	setFormEnabled(boolean enable) Sets whether the Selector should render its formObject.
void	setFormObject(Form form) Sets the form object to be used by the TableView.

Methods inherited from class com.sas.servlet.tbeans.dataselectors.BaseDataSelector

getActionProvider, getClosingFunctionName, getCommandId, getDefaultButtonAction, getReferringURI, getSelectorId, getSelectorModel, getSelectorType, isButtonsVisible, setActionProvider, setButtonsVisible, setClosingFunctionName, setCommandId, setDefaultButtonAction, setReferringURI, setRequest, setSelectorId, setSelectorModel, setSelectorType, write

Methods inherited from class com.sas.servlet.tbeans.BaseCompositeTransformation

applyTemplate, applyTemplate, getComponent, getComponents, getDefaultTemplate, getStyleInfo, getStyleMap, getTemplate, getTemplateDictionary, getTemplateFileName, getTemplateLocation, getVisibleComponents, isFlushEnabled, propertyChange, removeComponent, setCleanUpResourcesOn, setComponent, setFlushEnabled, setId, setLocale, setResponse, setStyleInfo, setTemplate, setTemplate, setTemplateDictionary, setTemplateFileName, setTemplateLocation, writeTemplate

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCustomAttributes, setInputTransform, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.dataselectors.DataSelectorInterface

isVisible, setVisible

Methods inherited from interface com.sas.actionprovider.HttpActionProviderInterface

getRequest

Constructor Detail

DataSelector

public DataSelector()

Method Detail

setFormObject

public void setFormObject(Form form)

Sets the form object to be used by the TableView.

Specified by:

setFormObject in interface FormViewInterface

Parameters:

form - The form object

getFormObject

public Form getFormObject()

Gets the form object to be used by the TableView.

Specified by:

getFormObject in interface FormViewInterface

Returns:

The form object

getDefaultFormObject

public Form getDefaultFormObject()

Gets the default form object to be used by the TableView.

Specified by:

getDefaultFormObject in interface FormViewInterface

Returns:

the form object

getAdditionalParameters

public java.util.HashMap getAdditionalParameters()

Returns an HashMap containing additional parameters that should be added to the form used to perform the various actions on the Selector. 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.

Specified by:

getAdditionalParameters in interface FormViewInterface

Returns:

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

See Also:

HashMap

setAdditionalParameters

public void setAdditionalParameters(java.util.HashMap map)

Sets an HashMap containing additional parameters that should be added to the form used to perform the various actions on the Selector. 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.

Specified by:

setAdditionalParameters in interface FormViewInterface

Parameters:

map - HashMap object

See Also:

HashMap

setAdditionalParameter

public 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 Selector. In the html version, 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.

Specified by:

setAdditionalParameter in interface FormViewInterface

Parameters:

name - name of the list item

value - value of the list item

See Also:

HashMap

setFormEnabled

public void setFormEnabled(boolean enable)

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

Specified by:

setFormEnabled in interface FormViewInterface

Parameters:

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

isFormEnabled

public boolean isFormEnabled()

Determines if the Selector 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.

Specified by:

isFormEnabled in interface FormViewInterface

Returns:

true if the tbean should render its formObject