com.sapportals.admin.wizardframework.components

Class MultiSelectionComponent

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.GridContainer
          com.sapportals.admin.wizardframework.components.MultiSelectionComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class MultiSelectionComponent
extends GridContainer

The class that represents the multi-selection input component.
A multi-selection component is composed of two lists:

• The available choices list
• The selected values list

Add and Remove buttons are used in the user interface to enable adding and removing values to/from the selected values list.

Field Summary

static String	VALUE Deprecated. A constant that indicates a value.
static String	VALUE_TITLES Deprecated. A constant that indicates a title value.

Fields inherited from class com.sapportals.admin.wizardframework.components.GridContainer

GRID

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

MultiSelectionComponent(String iPathOfListToChooseFrom, int iWidth)
Deprecated. A constructor that sets a path for the available choices list, and a width.

MultiSelectionComponent(String iPathOfListToChooseFrom, int iWidth, int iHeight)
Deprecated.

MultiSelectionComponent(String iPathOfListToChooseFrom, int iWidth, int iHeight, String iChoiceCaption, String iSelectionCaption)
Deprecated.

MultiSelectionComponent(String iPathOfListToChooseFrom, int iWidth, String iChoiceCaption, String iSelectionCaption)
Deprecated. A constructor that sets a path for the available choices list, a width, a caption for the choices, and a caption for the selection list.

MultiSelectionComponent(String iPathOfListToChooseFrom, String iPathOfChoiceTitles, int iWidth, int iHeight, String iChoiceCaption, String iSelectionCaption)
Deprecated.

MultiSelectionComponent(String iPathOfListToChooseFrom, String iPathOfChoiceTitles, int iWidth, String iChoiceCaption, String iSelectionCaption)
Deprecated. A constructor that sets a path for the available choices list, a path for the titles of the choices, a width, a caption for the choices, and a caption for the selection list.

Method Summary

void	clearIfInconsistent(String changedObjectKey, IWizardContext ctx) Deprecated. Clears all values from the object and its subtree when the object this object depends on was changed.
void	doAfterProcess(IWizardContext ctx) Deprecated. Performs myProcessInput(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.
com.sapportals.htmlb.Component	getDisplay(IWizardContext ctx) Deprecated. Gets the HTMLB component to display.
List	getErrorMessages(IWizardContext context) Deprecated. Validates the data for the pane.
boolean	isComplete(IWizardContext context) Deprecated. Indicates whether there is input in the component (true).
void	myProcessInput(IWizardContext ctx) Deprecated. Saves to the data model the data from any HTMLB controls created in the pane.
void	mySetupComponent(IWizardContext ctx) Deprecated. Implement this method to create your own setup for a component.
void	setCustomErrorMessage(String errorMessage) Deprecated. use of this function causes inconsistencies in the error handling of different wizards, it will be removed for MS1
void	setDefaultValue(List defaultValue) Deprecated. Sets a list of default values for the component.

Methods inherited from class com.sapportals.admin.wizardframework.components.GridContainer

addComponent, addComponent, delegateDoBeforeDisplay, delegateProcessInput, delegateSetupComponent, doAfterSubmit, doBeforeDisplay, getCell, getComponent, getControlInFocus, getGrid, getPath, init, isInitialized, myDoBeforeDisplay, processInput, setPath, setSize, setupComponent, wasChanged

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

getDescription, getProperty, getTitle, isMandatory, setMandatory, setProperty, setTempProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALUE

public static final String VALUE

Deprecated.

A constant that indicates a value.
value

See Also:

Constant Field Values

VALUE_TITLES

public static final String VALUE_TITLES

Deprecated.

A constant that indicates a title value.
valueTitles

See Also:

Constant Field Values

Constructor Detail

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               int iWidth,
                               int iHeight)

Deprecated.

A constructor that sets a path for available choices list, width and height.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iWidth - a width for the list

iHeight - a height for the list

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               int iWidth,
                               int iHeight,
                               String iChoiceCaption,
                               String iSelectionCaption)

Deprecated.

A constructor that sets a path for the available choices list, width and height, a caption for the choice, and a caption for the selection.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iWidth - a width for the list

iHeight - a height for the list

iChoiceCaption - a caption for the available choice list

iSelectionCaption - a caption for the selection list

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               String iPathOfChoiceTitles,
                               int iWidth,
                               int iHeight,
                               String iChoiceCaption,
                               String iSelectionCaption)

Deprecated.

A constructor that sets a path for the available choices list, a path for the titles of the choices, width and height, a caption for the choice, and a caption for the selection.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iPathOfChoiceTitles - path for the titles of the choices

iWidth - a width for the list

iHeight - a height for the list

iChoiceCaption - a caption for the available choice list

iSelectionCaption - a caption for the selection list

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               int iWidth)

Deprecated.

A constructor that sets a path for the available choices list, and a width.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iWidth - a width for the list

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               int iWidth,
                               String iChoiceCaption,
                               String iSelectionCaption)

Deprecated.

A constructor that sets a path for the available choices list, a width, a caption for the choices, and a caption for the selection list.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iWidth - a width for the list

iChoiceCaption - a caption for the choices

iSelectionCaption - a caption for the selection list

MultiSelectionComponent

public MultiSelectionComponent(String iPathOfListToChooseFrom,
                               String iPathOfChoiceTitles,
                               int iWidth,
                               String iChoiceCaption,
                               String iSelectionCaption)

Deprecated.

A constructor that sets a path for the available choices list, a path for the titles of the choices, a width, a caption for the choices, and a caption for the selection list.

Parameters:

iPathOfListToChooseFrom - a path for the list of available choices

iPathOfChoiceTitles - a path for the titles of the choices

iWidth - a width for the list

iChoiceCaption - a caption for the choices

iSelectionCaption - a caption for the selection list

Method Detail

mySetupComponent

public void mySetupComponent(IWizardContext ctx)

Deprecated.

Implement this method to create your own setup for a component.

Overrides:

mySetupComponent in class GridContainer

Parameters:

ctx - the current wizard context

setDefaultValue

public void setDefaultValue(List defaultValue)

Deprecated.

Sets a list of default values for the component.

Parameters:

defaultValue - a list of default values for the selection list

getDisplay

public com.sapportals.htmlb.Component getDisplay(IWizardContext ctx)

Deprecated.

Gets the HTMLB component to display. If your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent. The default implementation returns null.

Specified by:

getDisplay in interface IWizardComponent

Overrides:

getDisplay in class GridContainer

Parameters:

ctx - the current wizard context

Returns:

the component, null if the component has no display

myProcessInput

public void myProcessInput(IWizardContext ctx)

Deprecated.

Saves to the data model the data from any HTMLB controls created in the pane.

Overrides:

myProcessInput in class GridContainer

Parameters:

ctx - the current wizard context

doAfterProcess

public void doAfterProcess(IWizardContext ctx)

Deprecated.

Performs myProcessInput(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.

Parameters:

ctx - the current wizard context

isComplete

public boolean isComplete(IWizardContext context)

Deprecated.

Indicates whether there is input in the component (true). The default implementation returns true.

Overrides:

isComplete in class AbstractWizardComponent

Parameters:

context - the current wizard context

Returns:

true if there is input, false no input

getErrorMessages

public List getErrorMessages(IWizardContext context)

Deprecated.

Validates the data for the pane. If the data is valid, the method returns null. If the data is not valid, the method returns a list of error messages.

Specified by:

getErrorMessages in interface IWizardComponent

Overrides:

getErrorMessages in class GridContainer

Parameters:

context - the current wizard context

Returns:

a list of error messages

setCustomErrorMessage

public void setCustomErrorMessage(String errorMessage)

Deprecated. use of this function causes inconsistencies in the error handling of different wizards, it will be removed for MS1

Sets a custom error message.

Parameters:

errorMessage - the error message

clearIfInconsistent

public void clearIfInconsistent(String changedObjectKey,
                                IWizardContext ctx)

Deprecated.

Clears all values from the object and its subtree when the object this object depends on was changed.
The default implementation clears all values from the component's branch in the session.

Specified by:

clearIfInconsistent in interface IDependencyObject

Overrides:

clearIfInconsistent in class GridContainer

Parameters:

changedObjectKey - a changed object

ctx - the current wizard context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF