com.sas.servlet.tbeans.dataselectors.export.html
Class ExportSelectorPanel

com.sas.servlet.tbeans.dataselectors.export.html.ExportSelectorPanel

All Implemented Interfaces:

HttpActionProviderInterface, com.sas.beans.PropertyChangeSource, com.sas.collection.ContentsChangedListener, CancelInterface, com.sas.lang.ObjectDataInterface, com.sas.servlet.tbeans.AJAXControllerURLInterface, ComplexStyleInterface, CompositeComponentInterface, ExportSelectorKeysInterface, ExportSelectorStyleKeysInterface, FormViewInterface, RenderableInterface, TemplateInterface, com.sas.servlet.tbeans.TemplateKeyInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable, java.util.EventListener

public class ExportSelectorPanel
implements CancelInterface, ExportSelectorKeysInterface, ExportSelectorStyleKeysInterface

The ExportSelectorPanel is a TransformationBean™ that generates the appropriate HTML 4.0 and JavaScript to provide a user interface for specifying options for exporting data to a spreadsheet application.

The ExportSelectorPanel is one of several TransformationBeans™ that rely on a set of style classes that are used by default when generating the resulting markup language. For more information on style sheets and the default style classes that apply to this TransformationBean™, refer to the AppDev Studio Developer Site. You'll find a useful reference document entitled Cascading Style Sheets, Images, and TransformationBeans™ as well as the TransformationBeans™ Style Sheet Reference.

The ExportSelectorPanel is one of several TransformationBeans™ that rely on JavaScript to provide some of its functionality. These JavaScript files are including automatically by the tbean. See JavaScriptIncludeHandler for more information about how these files are included and how to customize this behavior. The ExportSelectorPanel uses the following JavaScript files:

sas_exportSelector.js

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

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

protected static java.lang.String	CHECKBOX_LABEL_STYLEMAP_KEY
protected static java.lang.String	CHECKBOX_STYLEMAP_KEY
protected com.sas.servlet.tbeans.form.html.OrderedCheckBoxList	columnsCheckBoxList The CheckBoxList to allow the user to choose the columns to export.
protected Label	columnsLabel The label for the Columns radio box.
protected Radio	columnsRadio The columns radio box.
static boolean	DEFAULT_EXPORT_CSS The default value for the exportCSS flag.
static java.lang.String	DEFAULT_TEMPLATE_FILE_NAME The default file name for the template for this panel.
protected Radio	exportToRadio The 'Export to' radio button.
protected java.lang.String	isExportFromMaxValueValidErrorMessage
protected java.lang.String	isExportToMaxValueValidErrorMessage
protected java.lang.String	isNoColumnsChosenErrorMessage
protected static java.lang.String	RADIOBOX_LABEL_STYLEMAP_KEY
protected static java.lang.String	RADIOBOX_STYLEMAP_KEY
protected Label	rowsLabel The label for the Rows radio box.
protected ListBox	saveAsListBox The list box for the 'Save as' output types.
protected Radio	saveAsRadio The 'Save as' radio button.

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

imageLocation, SELECTOR_EXPAND, SELECTOR_EXTERNAL

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.export.html.ExportSelectorKeysInterface

EXPORTSELECTOR_COLUMNS_CHECK_BOX_LIST, EXPORTSELECTOR_COLUMNS_LABEL, EXPORTSELECTOR_COLUMNS_RADIO, EXPORTSELECTOR_EXPORT_TO_RADIO, EXPORTSELECTOR_FORMAT_CHECK, EXPORTSELECTOR_FORMAT_LABEL, EXPORTSELECTOR_FROM_LABEL, EXPORTSELECTOR_FROM_TEXT_ENTRY, EXPORTSELECTOR_INCLUDE_LABEL, EXPORTSELECTOR_INCLUDE_LEGEND_LABEL, EXPORTSELECTOR_INCLUDE_RADIO, EXPORTSELECTOR_LIST_BOX, EXPORTSELECTOR_OPTIONS_LABEL, EXPORTSELECTOR_OPTIONS_LEGEND_LABEL, EXPORTSELECTOR_OUTPUT_LABEL, EXPORTSELECTOR_REPEAT_ROW_LABELS_CHECK_BOX, EXPORTSELECTOR_ROWS_LABEL, EXPORTSELECTOR_SAVE_AS_LIST_BOX, EXPORTSELECTOR_SAVE_AS_RADIO, EXPORTSELECTOR_TO_LABEL, EXPORTSELECTOR_TO_TEXT_ENTRY

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.export.html.ExportSelectorStyleKeysInterface

EXPORTSELECTOR_CHECK, EXPORTSELECTOR_CHECK_LABEL, EXPORTSELECTOR_COLUMNS_DISPLAY_STYLE, EXPORTSELECTOR_LABEL, EXPORTSELECTOR_LIST, EXPORTSELECTOR_OPTIONS_DISPLAY_STYLE, EXPORTSELECTOR_RADIO, EXPORTSELECTOR_RADIO_LABEL, EXPORTSELECTOR_ROWS_DISPLAY_STYLE, EXPORTSELECTOR_TEXT, EXPORTSELECTOR_TEXT_ENTRY

Constructor Summary

ExportSelectorPanel()
Default constructor.

ExportSelectorPanel(java.lang.String name)
Constructor using the given name.

Method Summary

void	cancel() Cancels the command.
protected javax.swing.ListModel	getLocalizedColumnsRadioModel() Returns the model to be used by the EXPORTSELECTOR_COLUMNS_RADIO component.
protected Label	newLabel(java.lang.String name, com.sas.servlet.tbeans.ImmutableStyleInfo style)
protected ListBox	newListBox(java.lang.String name, com.sas.servlet.tbeans.ImmutableStyleInfo style)
protected com.sas.servlet.tbeans.form.html.OrderedCheckBoxList	newOrderedCheckBoxList(java.lang.String name, com.sas.servlet.tbeans.ImmutableStyleInfo style)
protected Radio	newRadio(java.lang.String name)
protected TextEntry	newTextEntry(java.lang.String name, int size, com.sas.servlet.tbeans.ImmutableStyleInfo style, boolean isEnabled)
void	setActionProvider(HttpActionProvider ap) Sets the HttpActionProvider object
void	setSelectorModel(java.lang.Object selectorModel) Sets the selector's data model
void	write(java.io.PrintWriter out) Writes the custom attributes of the object.

Methods inherited from class com.sas.servlet.tbeans.dataselectors.html.SelectorPanel

close, getAdditionalParameters, getDefaultFormObject, getFormObject, getIframeName, isFormEnabled, setAdditionalParameter, setAdditionalParameters, setFormEnabled, setFormObject, setIframeName, writeRemoteScriptCommands, writeRemoteScriptFrame, writeSelectorPanelFooter, writeSelectorPanelHeader

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

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

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, 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, setName, setObjectData, setObjectDataProperty, setOutputTransform, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.actionprovider.HttpActionProviderInterface

getRequest

Field Detail

DEFAULT_TEMPLATE_FILE_NAME

public static final java.lang.String DEFAULT_TEMPLATE_FILE_NAME

The default file name for the template for this panel. "ExportSelectorPanel.html"

See Also:

Constant Field Values

DEFAULT_EXPORT_CSS

public static final boolean DEFAULT_EXPORT_CSS

The default value for the exportCSS flag. true

See Also:

Constant Field Values

saveAsListBox

protected ListBox saveAsListBox

The list box for the 'Save as' output types.

exportToRadio

protected Radio exportToRadio

The 'Export to' radio button.

saveAsRadio

protected Radio saveAsRadio

The 'Save as' radio button.

columnsCheckBoxList

protected com.sas.servlet.tbeans.form.html.OrderedCheckBoxList columnsCheckBoxList

The CheckBoxList to allow the user to choose the columns to export.

rowsLabel

protected Label rowsLabel

The label for the Rows radio box.

columnsLabel

protected Label columnsLabel

The label for the Columns radio box.

columnsRadio

protected Radio columnsRadio

The columns radio box.

isExportFromMaxValueValidErrorMessage

protected java.lang.String isExportFromMaxValueValidErrorMessage

isExportToMaxValueValidErrorMessage

protected java.lang.String isExportToMaxValueValidErrorMessage

isNoColumnsChosenErrorMessage

protected java.lang.String isNoColumnsChosenErrorMessage

CHECKBOX_STYLEMAP_KEY

protected static java.lang.String CHECKBOX_STYLEMAP_KEY

CHECKBOX_LABEL_STYLEMAP_KEY

protected static java.lang.String CHECKBOX_LABEL_STYLEMAP_KEY

RADIOBOX_STYLEMAP_KEY

protected static java.lang.String RADIOBOX_STYLEMAP_KEY

RADIOBOX_LABEL_STYLEMAP_KEY

protected static java.lang.String RADIOBOX_LABEL_STYLEMAP_KEY

Constructor Detail

ExportSelectorPanel

public ExportSelectorPanel()

Default constructor.

ExportSelectorPanel

public ExportSelectorPanel(java.lang.String name)

Constructor using the given name.

Parameters:

name - String to set the name

Method Detail

write

public void write(java.io.PrintWriter out)

Description copied from class: BaseCompositeTransformation

Writes the custom attributes of the object. All transformation beans should override this method and call SUPER.

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseCompositeTransformation

Parameters:

out - The output stream

newListBox

protected ListBox newListBox(java.lang.String name,
                             com.sas.servlet.tbeans.ImmutableStyleInfo style)

newOrderedCheckBoxList

protected com.sas.servlet.tbeans.form.html.OrderedCheckBoxList newOrderedCheckBoxList(java.lang.String name,
                                                                                      com.sas.servlet.tbeans.ImmutableStyleInfo style)

newRadio

protected Radio newRadio(java.lang.String name)

newTextEntry

protected TextEntry newTextEntry(java.lang.String name,
                                 int size,
                                 com.sas.servlet.tbeans.ImmutableStyleInfo style,
                                 boolean isEnabled)

newLabel

protected Label newLabel(java.lang.String name,
                         com.sas.servlet.tbeans.ImmutableStyleInfo style)

getLocalizedColumnsRadioModel

protected javax.swing.ListModel getLocalizedColumnsRadioModel()

Returns the model to be used by the EXPORTSELECTOR_COLUMNS_RADIO component.

Returns:

the model to be used by the EXPORTSELECTOR_COLUMNS_RADIO component.

cancel

public void cancel()

Description copied from interface: CancelInterface

Cancels the command.

Common things done in this method:

• Reset the command and/or the objects that this command holds.
• Release objects for garbage collection

Specified by:

cancel in interface CancelInterface

setActionProvider

public void setActionProvider(HttpActionProvider ap)

Description copied from class: BaseSelectorPanel

Sets the HttpActionProvider object

Specified by:

setActionProvider in interface HttpActionProviderInterface

Overrides:

setActionProvider in class BaseSelectorPanel

Parameters:

ap - HttpActionProvider Object

See Also:

HttpActionProviderInterface.getActionProvider()

setSelectorModel

public void setSelectorModel(java.lang.Object selectorModel)

Description copied from class: BaseSelectorPanel

Sets the selector's data model

Overrides:

setSelectorModel in class BaseSelectorPanel

Parameters:

selectorModel - The selector's data model