com.sap.tc.webdynpro.clientserver.uielib.pattern.api

Interface IWDPatternSequence

All Superinterfaces:

IWDAbstractPatternContainer, IWDUIElement, IWDViewElement

Deprecated. This UI element may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unsupported UIElement. Use the Guided Procedure Pattern instead (with RoadMap).

public interface IWDPatternSequence

extends IWDAbstractPatternContainer

Web Dynpro PatternSequence API. PatternSequence is used to display a sequence of data organized in steps. Use it, for example, for creating a wizard. One step at a time may be selected and its content by displayed. A step is selected by clicking its title. If not all steps can be displayed scrolling between the tabs is possible. The PatternSequence can contains a Menu and several PatternExpandFunction (for open/close buttons).

Note: To be used only by the Portal Platform group. Other usages by applications and customers WILL NOT BE SUPPORTED!

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

See Also:

IWDPatternExpandFunction, IWDPatternSequenceStep

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Nested Class Summary

static interface

IWDPatternSequence.IWDOnSelect Deprecated. Interface defining the parameter names for event onSelect.

Field Summary

static int	DEFAULT_MAX_VISIBLE_STEPS Deprecated. Default value of the maxVisibleSteps property is 7.
static String	DEFAULT_SELECTED_STEP Deprecated. Default value of the selectedStep property is "".

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.pattern.api.IWDAbstractPatternContainer

DEFAULT_ACCESSIBILITY_DESCRIPTION, DEFAULT_DESIGN, DEFAULT_HAS_CONTENT_CONNECTOR

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addStep(IWDPatternSequenceStep step) Deprecated. Adds the given Step at the end of the Steps list.
void	addStep(IWDPatternSequenceStep step, int index) Deprecated. Inserts the given Step at the specified (zero-based) index into the Steps list.
String	bindingOfMaxVisibleSteps() Deprecated. Returns the binding path of the maxVisibleSteps property.
String	bindingOfSelectedStep() Deprecated. Returns the binding path of the selectedStep property.
void	bindMaxVisibleSteps(IWDAttributeInfo attributeInfo) Deprecated. Binds the maxVisibleSteps property to the context attribute specified by the given attribute info.
void	bindMaxVisibleSteps(String path) Deprecated. Binds the maxVisibleSteps property to the context attribute specified by the given path.
void	bindSelectedStep(IWDAttributeInfo attributeInfo) Deprecated. Binds the selectedStep property to the context attribute specified by the given attribute info.
void	bindSelectedStep(String path) Deprecated. Binds the selectedStep property to the context attribute specified by the given path.
void	destroyAllSteps() Deprecated. Destroys all elements in the Steps list.
void	destroyTitle() Deprecated. Destroys the aggregated Title element.
int	getMaxVisibleSteps() Deprecated. Returns the value of the maxVisibleSteps property.
IWDAction	getOnSelect() Deprecated. Returns the action assigned to event onSelect.
String	getSelectedStep() Deprecated. Returns the value of the selectedStep property.
IWDPatternSequenceStep	getStep(int index) Deprecated. Returns the Step at the given index.
IWDPatternSequenceStep[]	getSteps() Deprecated. Returns the Steps list as an array
IWDPatternSequenceStep	getTitle() Deprecated. Returns the aggregated Title element
boolean	hasSteps() Deprecated. Returns true if there exists a Step.
int	indexOfStep(IWDPatternSequenceStep step) Deprecated. Returns the index of the given element in the Steps list, returns -1 if the element is not in the list.
Iterator	iterateSteps() Deprecated. Returns an iterator over the Steps list.
IWDParameterMapping	mappingOfOnSelect() Deprecated. Returns the parameter mapping for event onSelect.
int	numberOfSteps() Deprecated. Returns the number of Steps.
void	removeAllSteps() Deprecated. Removes all elements from the Steps list.
IWDPatternSequenceStep	removeStep(int index) Deprecated. Removes the Step at the given index from the Steps list.
IWDPatternSequenceStep	removeStep(String id) Deprecated. Removes the Step with the given ID from the Steps list.
void	setMaxVisibleSteps(int value) Deprecated. Sets the maxVisibleSteps property to the given value.
void	setOnSelect(IWDAction action) Deprecated. Assigns the given action to event onSelect.
void	setSelectedStep(String value) Deprecated. Sets the selectedStep property to the given value.
void	setTitle(IWDPatternSequenceStep title) Deprecated. Sets the aggregated Title element.
void	swapSteps(int i, int j) Deprecated. Swaps the Steps at the given indices.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.pattern.api.IWDAbstractPatternContainer

addExpandFunction, addExpandFunction, bindAccessibilityDescription, bindAccessibilityDescription, bindDesign, bindDesign, bindHasContentConnector, bindHasContentConnector, bindingOfAccessibilityDescription, bindingOfDesign, bindingOfHasContentConnector, destroyAllExpandFunctions, destroyPopupMenu, getAccessibilityDescription, getDesign, getExpandFunction, getExpandFunctions, getHasContentConnector, getPopupMenu, hasExpandFunctions, indexOfExpandFunction, iterateExpandFunctions, numberOfExpandFunctions, removeAllExpandFunctions, removeExpandFunction, removeExpandFunction, setAccessibilityDescription, setDesign, setHasContentConnector, setPopupMenu, swapExpandFunctions

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_MAX_VISIBLE_STEPS

public static final int DEFAULT_MAX_VISIBLE_STEPS

Deprecated.

Default value of the maxVisibleSteps property is 7.

See Also:

Constant Field Values

DEFAULT_SELECTED_STEP

public static final String DEFAULT_SELECTED_STEP

Deprecated.

Default value of the selectedStep property is "".

See Also:

Constant Field Values

Method Detail

getOnSelect

public IWDAction getOnSelect()

Deprecated.

Returns the action assigned to event onSelect. The action performed when a step is selected. Event parameter is the ID of the selected step.

Returns:

the action assigned to event onSelect

See Also:

mappingOfOnSelect()

setOnSelect

public void setOnSelect(IWDAction action)

Deprecated.

Assigns the given action to event onSelect.

Parameters:

action - the action assigned to the event

See Also:

getOnSelect()

mappingOfOnSelect

public IWDParameterMapping mappingOfOnSelect()

Deprecated.

Returns the parameter mapping for event onSelect.

To pass UI element event parameter values into action handler parameters, a parameter mapping has to be defined. Add code like the following inside method wdDoModifyView() of the view controller:

 if (firstTime)
 {
   IWDPatternSequence myPatternSequence = (IWDPatternSequence) view.getElement("ID-of-PatternSequence");
   myPatternSequence.mappingOfOnSelect().addSourceMapping
   (
     IWDPatternSequence.IWDOnSelect.STEP, // event parameter name
     "name-of-action-parameter" // (type String)
   ); 
 }

 

Event onSelect has the following parameters:

• String step
  The ID of the selected PatternSequenceStep.

Returns:

the parameter mapping for event onSelect

See Also:

getOnSelect()

bindMaxVisibleSteps

public void bindMaxVisibleSteps(String path)

Deprecated.

Binds the maxVisibleSteps property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the maxVisibleSteps property will be bound

bindMaxVisibleSteps

public void bindMaxVisibleSteps(IWDAttributeInfo attributeInfo)

Deprecated.

Binds the maxVisibleSteps property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the maxVisibleSteps property will be bound

bindingOfMaxVisibleSteps

public String bindingOfMaxVisibleSteps()

Deprecated.

Returns the binding path of the maxVisibleSteps property.

Returns:

the path of the context attribute to which the maxVisibleSteps property is currently bound

getMaxVisibleSteps

public int getMaxVisibleSteps()

Deprecated.

Returns the value of the maxVisibleSteps property.

The initial value is 7.

Sets the maximum number of visible items for the PatternSequenceStep control. If the PatternSequence contains more Steps scrolling between Steps is enabled.

Returns:

the current value of the maxVisibleSteps property

See Also:

setMaxVisibleSteps(int)

setMaxVisibleSteps

public void setMaxVisibleSteps(int value)

Deprecated.

Sets the maxVisibleSteps property to the given value.

Parameters:

value - the new value of the maxVisibleSteps property

See Also:

getMaxVisibleSteps()

bindSelectedStep

public void bindSelectedStep(String path)

Deprecated.

Binds the selectedStep property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the selectedStep property will be bound

bindSelectedStep

public void bindSelectedStep(IWDAttributeInfo attributeInfo)

Deprecated.

Binds the selectedStep property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the selectedStep property will be bound

bindingOfSelectedStep

public String bindingOfSelectedStep()

Deprecated.

Returns the binding path of the selectedStep property.

Returns:

the path of the context attribute to which the selectedStep property is currently bound

getSelectedStep

public String getSelectedStep()

Deprecated.

Returns the value of the selectedStep property.

The initial value is "".

Contains the ID of the currently selected PatternSequenceStep.

Returns:

the current value of the selectedStep property

See Also:

setSelectedStep(String)

setSelectedStep

public void setSelectedStep(String value)

Deprecated.

Sets the selectedStep property to the given value.

Parameters:

value - the new value of the selectedStep property

See Also:

getSelectedStep()

addStep

public void addStep(IWDPatternSequenceStep step)

Deprecated.

Adds the given Step at the end of the Steps list.

Parameters:

step - the Step to be added to the list

See Also:

getSteps()

addStep

public void addStep(IWDPatternSequenceStep step,
                    int index)

Deprecated.

Inserts the given Step at the specified (zero-based) index into the Steps list.

Parameters:

step - the Step to be inserted into the list

index - (zero-based) insertion position in the list

See Also:

getSteps()

swapSteps

public void swapSteps(int i,
                      int j)

Deprecated.

Swaps the Steps at the given indices.

Parameters:

i - index of the first Step to swap

j - index of the second Step to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getSteps

public IWDPatternSequenceStep[] getSteps()

Deprecated.

Returns the Steps list as an array.

Returns:

an array containing the current Steps list

getStep

public IWDPatternSequenceStep getStep(int index)

Deprecated.

Returns the Step at the given index.

Returns:

Step at the given index

indexOfStep

public int indexOfStep(IWDPatternSequenceStep step)

Deprecated.

Returns the index of the given element in the Steps list, returns -1 if the element is not in the list.

numberOfSteps

public int numberOfSteps()

Deprecated.

Returns the number of Steps.

Returns:

the number of Steps

See Also:

getSteps()

hasSteps

public boolean hasSteps()

Deprecated.

Returns true if there exists a Step.

Returns:

true if there exists a Step, otherwise returns false

See Also:

getSteps()

iterateSteps

public Iterator iterateSteps()

Deprecated.

Returns an iterator over the Steps list.

Returns:

an iterator over the Steps list

See Also:

getSteps()

removeStep

public IWDPatternSequenceStep removeStep(int index)

Deprecated.

Removes the Step at the given index from the Steps list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addStep(IWDPatternSequenceStep), getSteps()

removeStep

public IWDPatternSequenceStep removeStep(String id)

Deprecated.

Removes the Step with the given ID from the Steps list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be removed from the list

Returns:

the removed element

See Also:

addStep(IWDPatternSequenceStep), getSteps()

removeAllSteps

public void removeAllSteps()

Deprecated.

Removes all elements from the Steps list. This does not destroy the removed elements, i.e. they may be added again!

See Also:

addStep(IWDPatternSequenceStep), getSteps()

destroyAllSteps

public void destroyAllSteps()

Deprecated.

Destroys all elements in the Steps list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.

getTitle

public IWDPatternSequenceStep getTitle()

Deprecated.

Returns the aggregated Title element.

Returns:

the aggregated Title element

See Also:

setTitle(IWDPatternSequenceStep)

setTitle

public void setTitle(IWDPatternSequenceStep title)

Deprecated.

Sets the aggregated Title element.

Parameters:

title - the new title

See Also:

getTitle()

destroyTitle

public void destroyTitle()

Deprecated.

Destroys the aggregated Title element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.