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

com.sas.servlet.tbeans.dataselectors.html.SelectorPanel

All Implemented Interfaces:

HttpActionProviderInterface, com.sas.beans.PropertyChangeSource, com.sas.collection.ContentsChangedListener, 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, java.util.EventListener

Direct Known Subclasses:

BaseCalculatedItemSelectorPanel, EntityAttributeValueSelectorPanel, ExceptionHighlightingChartSelectorPanel, ExceptionHighlightingSelectorPanel, ExportSelectorPanel, FilterAndRankSelectorPanel, FindSelectorPanel, MapCrossingSelectorPanel, MapPropertySelectorPanel, MemberPropertiesSelectorPanel, OLAPTimeBasedFilterSelectorPanel, PercentCalculationsSelectorPanel, SortSelectorPanel

public abstract class SelectorPanel
implements FormViewInterface

The SelectorPanel is an abstract TransformationBean™ that provides HTML form functionality for the data selector panel 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.BaseSelectorPanel

imageLocation, SELECTOR_EXPAND, SELECTOR_EXTERNAL

Constructor Summary

SelectorPanel()

Method Summary

void	close() Base implementation that does nothing.
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 SelectorPanel.
Form	getDefaultFormObject() Gets the default form object to be used by the panel
Form	getFormObject() Gets the form object to be used by the panel
java.lang.String	getIframeName() Gets the name of the remote scripting iframe name.
boolean	isFormEnabled() Determines if the SelectorPanel 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 SelectorPanel.
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 SelectorPanel.
void	setFormEnabled(boolean enable) Sets whether the SelectorPanel should render its formObject.
void	setFormObject(Form form) Sets the form object to be used by the panel
void	setIframeName(java.lang.String name) Sets the remote scripting iframe name needed for the form target value.
void	writeRemoteScriptCommands(java.io.PrintWriter out) Subclasses must implement this method to provide functionality for panels to react to remote script events.
void	writeRemoteScriptFrame(java.io.PrintWriter out) Writes out the iframe tag needed for remote javascript calls
void	writeSelectorPanelFooter(java.io.PrintWriter out) Writes out the panel form footer
void	writeSelectorPanelHeader(java.io.PrintWriter out) Writes out the panel form header and addtional parameters

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

contentsChanged, getActionProvider, getCommandId, getImageLocation, getSelector, getSelectorModel, setActionProvider, setCommandId, setImageLocation, setSelector, setSelectorModel

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, setRequest, setResponse, setStyleInfo, setTemplate, setTemplate, setTemplateDictionary, setTemplateFileName, setTemplateLocation, write, 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.actionprovider.HttpActionProviderInterface

getRequest

Constructor Detail

SelectorPanel

public SelectorPanel()

Method Detail

setFormObject

public void setFormObject(Form form)

Sets the form object to be used by the panel

Specified by:

setFormObject in interface FormViewInterface

Parameters:

form - The form object

getFormObject

public Form getFormObject()

Gets the form object to be used by the panel

Specified by:

getFormObject in interface FormViewInterface

Returns:

The form object

getDefaultFormObject

public Form getDefaultFormObject()

Gets the default form object to be used by the panel

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 SelectorPanel. 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 SelectorPanel. 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 SelectorPanel. 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 SelectorPanel 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 SelectorPanel 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

setIframeName

public void setIframeName(java.lang.String name)

Sets the remote scripting iframe name needed for the form target value. The selector (container) should write out the iframe and set the name on the panel.

Parameters:

name - The name of the iframe

getIframeName

public java.lang.String getIframeName()

Gets the name of the remote scripting iframe name.

Returns:

the name of the iframe

writeRemoteScriptCommands

public void writeRemoteScriptCommands(java.io.PrintWriter out)
                               throws java.io.IOException

Subclasses must implement this method to provide functionality for panels to react to remote script events. Data requested by a remote scripting action can be written back to the client on the output stream.

Throws:

java.io.IOException

writeRemoteScriptFrame

public void writeRemoteScriptFrame(java.io.PrintWriter out)
                            throws java.io.IOException

Writes out the iframe tag needed for remote javascript calls

Parameters:

out - the output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

writeSelectorPanelHeader

public void writeSelectorPanelHeader(java.io.PrintWriter out)
                              throws java.io.IOException

Writes out the panel form header and addtional parameters

Parameters:

out - the output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

writeSelectorPanelFooter

public void writeSelectorPanelFooter(java.io.PrintWriter out)
                              throws java.io.IOException

Writes out the panel form footer

Parameters:

out - the output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

close

public void close()

Base implementation that does nothing.

Subclasses may override this when they want to know a commit or cancel has occured on the selector.