com.sas.servlet.tbeans.dataselectors.memberproperties.html
Class MemberPropertiesSelectorPanel

com.sas.servlet.tbeans.dataselectors.memberproperties.html.MemberPropertiesSelectorPanel

All Implemented Interfaces:

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

public class MemberPropertiesSelectorPanel
implements CancelInterface, MemberPropertiesSelectorKeysInterface, MemberPropertiesSelectorStyleKeysInterface

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

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

sas_percentCalculationsSelector.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.
static java.lang.String	DUAL_TREE_SELECTOR_TEMPLATE_FILE_NAME The default file name for the template for this panel.
protected static java.lang.String	JAVASCRIPT_ADD_FUNCTION The name of the JavaScript function which adds items to the summary box.
protected static java.lang.String	JAVASCRIPT_PANEL_CLASS The root portion of any JavaScript function names for this selector panel.
protected static java.lang.String	JAVASCRIPT_POST_SOURCE_TRIGGER_FUNCTION
protected static java.lang.String	JAVASCRIPT_POST_TARGET_TRIGGER_FUNCTION
protected static java.lang.String	JAVASCRIPT_SELECT_NODE_FUNCTION
protected static java.lang.String	JAVASCRIPT_SELECT_TARGET_NODE_FUNCTION
static java.lang.String	RB_KEY

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

imageLocation, SELECTOR_EXPAND, SELECTOR_EXTERNAL

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.memberproperties.html.MemberPropertiesSelectorKeysInterface

MPS_CAPTIONS_CHECKBOX, MPS_DUAL_SELECTOR, MPS_LABELS_CHECKBOX, MPS_OPTIONS_LABEL

Fields inherited from interface com.sas.servlet.tbeans.dataselectors.memberproperties.html.MemberPropertiesSelectorStyleKeysInterface

MPS_CAPTION_TD_STYLE, MPS_CAPTIONS_CHECKBOX_LABEL_STYLE, MPS_CAPTIONS_CHECKBOX_STYLE, MPS_DUALSELECTOR_CONTAINER, MPS_LABEL_TD_STYLE, MPS_LABELS_CHECKBOX_LABEL_STYLE, MPS_LABELS_CHECKBOX_STYLE, MPS_OPTIONS_LABEL_STYLE, MPS_SOURCE_TITLE_STYLE, MPS_TARGET_TITLE_STYLE

Constructor Summary

MemberPropertiesSelectorPanel()
Default constructor.

MemberPropertiesSelectorPanel(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.
void	cleanUpResources() This method releases all of the necessary resources that were needed by the transformation bean to render itself.
java.lang.String	getDefaultTemplate() Returns the default template to be used for this composite.
protected CheckBox	newCaptionsCheckBoxInstance()
protected DualTreeSelector	newDualTreeSelectorInstance() Returns a new default DualTreeSelector
protected CheckBox	newLabelsCheckBoxInstance()
protected Label	newOptionsLabelInstance()
protected void	populateDualTreeSelector() Sets write-time properties for the summary listbox including its model
protected void	setComponentValues()
protected void	setLocaleDependentProperties(java.util.Locale locale) Sets the locale dependent properties.
void	setSelectorModel(java.lang.Object selectormodel) Sets the selector's data model
protected void	setupTemplateDictionary()
void	write(java.io.PrintWriter out) Writes the custom attributes of the object.
protected void	writeActionProviderFields(java.io.PrintWriter out)

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, setActionProvider, setCommandId, setImageLocation, setSelector

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

applyTemplate, applyTemplate, getComponent, getComponents, 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, 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

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

DEFAULT_TEMPLATE_FILE_NAME

public static final java.lang.String DEFAULT_TEMPLATE_FILE_NAME

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

See Also:

Constant Field Values

DUAL_TREE_SELECTOR_TEMPLATE_FILE_NAME

public static final java.lang.String DUAL_TREE_SELECTOR_TEMPLATE_FILE_NAME

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

See Also:

Constant Field Values

JAVASCRIPT_PANEL_CLASS

protected static final java.lang.String JAVASCRIPT_PANEL_CLASS

The root portion of any JavaScript function names for this selector panel.

See Also:

Constant Field Values

JAVASCRIPT_ADD_FUNCTION

protected static final java.lang.String JAVASCRIPT_ADD_FUNCTION

The name of the JavaScript function which adds items to the summary box.

See Also:

Constant Field Values

JAVASCRIPT_SELECT_NODE_FUNCTION

protected static final java.lang.String JAVASCRIPT_SELECT_NODE_FUNCTION

See Also:

Constant Field Values

JAVASCRIPT_SELECT_TARGET_NODE_FUNCTION

protected static final java.lang.String JAVASCRIPT_SELECT_TARGET_NODE_FUNCTION

See Also:

Constant Field Values

JAVASCRIPT_POST_SOURCE_TRIGGER_FUNCTION

protected static final java.lang.String JAVASCRIPT_POST_SOURCE_TRIGGER_FUNCTION

See Also:

Constant Field Values

JAVASCRIPT_POST_TARGET_TRIGGER_FUNCTION

protected static final java.lang.String JAVASCRIPT_POST_TARGET_TRIGGER_FUNCTION

See Also:

Constant Field Values

Constructor Detail

MemberPropertiesSelectorPanel

public MemberPropertiesSelectorPanel()

Default constructor.

MemberPropertiesSelectorPanel

public MemberPropertiesSelectorPanel(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

setSelectorModel

public void setSelectorModel(java.lang.Object selectormodel)

Sets the selector's data model

Overrides:

setSelectorModel in class BaseSelectorPanel

Parameters:

selectormodel - The selector's data model

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

writeActionProviderFields

protected void writeActionProviderFields(java.io.PrintWriter out)

setupTemplateDictionary

protected void setupTemplateDictionary()

addComponents

protected void addComponents()

Creates the components and add them to the selector template.

newOptionsLabelInstance

protected Label newOptionsLabelInstance()

newLabelsCheckBoxInstance

protected CheckBox newLabelsCheckBoxInstance()

newCaptionsCheckBoxInstance

protected CheckBox newCaptionsCheckBoxInstance()

newDualTreeSelectorInstance

protected DualTreeSelector newDualTreeSelectorInstance()

Returns a new default DualTreeSelector

setComponentValues

protected void setComponentValues()

populateDualTreeSelector

protected void populateDualTreeSelector()

Sets write-time properties for the summary listbox including its model

Throws:

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

getDefaultTemplate

public java.lang.String getDefaultTemplate()

Returns the default template to be used for this composite. If no customized template has been applied and the template file cannot be found or read, this template is used to provide at least a minimum amount of functionality and may or may not have styling or formatting applied to it.

Specified by:

getDefaultTemplate in interface TemplateInterface

Overrides:

getDefaultTemplate in class BaseCompositeTransformation

Returns:

String the default template

cleanUpResources

public void cleanUpResources()

Description copied from class: BaseTransformation

This method releases all of the necessary resources that were needed by the transformation bean to render itself. These resources include fields such as request and response. This method calls the setRequest and setResponse methods with a null value.

Overrides:

cleanUpResources in class BaseTransformation

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