com.sas.servlet.tbeans.dataselectors.sort.html
Class SortSelectorPanel

com.sas.servlet.tbeans.dataselectors.sort.html.SortSelectorPanel

All Implemented Interfaces:

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

public class SortSelectorPanel
implements CancelInterface, SortSelectorKeysInterface, SortSelectorStyleKeysInterface

The SortSelectorPanel is a TransformationBean™ that generates the appropriate HTML 4.0 and JavaScript to provide a user interface for specifying sorting on data items.

The SortSelectorPanel 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 SortSelectorPanel 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 SortSelectorPanel uses the following JavaScript files:

sas_sortSelector.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.4

See Also:

Serialized Form

Field Summary

static java.lang.String

DEFAULT_TEMPLATE_FILE_NAME The default file name for the template for this panel.

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

imageLocation, SELECTOR_EXPAND, SELECTOR_EXTERNAL

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.sort.html.SortSelectorKeysInterface

SORTSELECTOR, SORTSELECTOR_SORT_BY_CHOICEBOX, SORTSELECTOR_SORT_BY_LABEL, SORTSELECTOR_SORT_BY_RADIO, SORTSELECTOR_THEN_BY_CHOICEBOX, SORTSELECTOR_THEN_BY_CHOICEBOX1, SORTSELECTOR_THEN_BY_CHOICEBOX2, SORTSELECTOR_THEN_BY_LABEL, SORTSELECTOR_THEN_BY_LABEL1, SORTSELECTOR_THEN_BY_LABEL2, SORTSELECTOR_THEN_BY_RADIO, SORTSELECTOR_THEN_BY_RADIO1, SORTSELECTOR_THEN_BY_RADIO2

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.sort.html.SortSelectorStyleKeysInterface

SORTSELECTOR_CHOICE, SORTSELECTOR_DIV, SORTSELECTOR_LABEL, SORTSELECTOR_RADIO

Constructor Summary

SortSelectorPanel()
Default constructor.

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

Method Summary

protected void	addComponents() Creates the components and add them to the selector template.
void	cancel() Cancels the command.
protected void	createAdditionalComponents() Creates the additional components and add them to the selector template.
protected ChoiceBox	createSortSelectorChoiceBox() Creates the list box for the output types.
protected Label	createSortSelectorLabel() Creates the label for the sort by type.
protected Radio	createSortSelectorRadioBox() Creates the sort selector radio boxes.
protected java.lang.StringBuffer	getLayoutTemplate() Returns a default template which is dynamically built based on the number of columns in the model.
int	getMaxSortableColumns()
java.lang.Object	getSelectorModel() Returns the selector's data model
void	setActionProvider(HttpActionProvider ap) Sets the HttpActionProvider object
protected void	setLocaleDependentProperties(java.util.Locale locale) Sets the locale dependent properties.
void	setMaxSortableColumns(int value)
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, 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. "SortSelectorPanel.html"

See Also:

Constant Field Values

Constructor Detail

SortSelectorPanel

public SortSelectorPanel()

Default constructor.

SortSelectorPanel

public SortSelectorPanel(java.lang.String name)

Constructor using the given name.

Parameters:

name - String to set the name

Method Detail

setLocaleDependentProperties

protected void setLocaleDependentProperties(java.util.Locale locale)

Description copied from class: BaseTransformation

Sets the locale dependent properties. Not operational at this level.

Overrides:

setLocaleDependentProperties in class BaseTransformation

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

getLayoutTemplate

protected java.lang.StringBuffer getLayoutTemplate()

Returns a default template which is dynamically built based on the number of columns in the model.

Returns:

The default layout template

addComponents

protected void addComponents()

Creates the components and add them to the selector template.

createAdditionalComponents

protected void createAdditionalComponents()

Creates the additional components and add them to the selector template.

createSortSelectorLabel

protected Label createSortSelectorLabel()

Creates the label for the sort by type.

createSortSelectorChoiceBox

protected ChoiceBox createSortSelectorChoiceBox()

Creates the list box for the output types.

createSortSelectorRadioBox

protected Radio createSortSelectorRadioBox()

Creates the sort selector radio boxes.

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

getSelectorModel

public java.lang.Object getSelectorModel()

Description copied from class: BaseSelectorPanel

Returns the selector's data model

Overrides:

getSelectorModel in class BaseSelectorPanel

Returns:

The selector's data model

setMaxSortableColumns

public void setMaxSortableColumns(int value)

getMaxSortableColumns

public int getMaxSortableColumns()