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

All Superinterfaces:

IWDAbstractPatternContainer, IWDUIElement, IWDViewElement

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).

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

See Also:

IWDPatternExpandFunction, IWDPatternSequenceStep

Field Summary

static int	DEFAULT_MAX_VISIBLE_STEPS Default value of property maxVisibleSteps.
static java.lang.String	DEFAULT_SELECTED_STEP Default value of property selectedStep.

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 aPatternSequenceStep) Adds the given Step at the end of the list of Steps.
void	addStep(IWDPatternSequenceStep aPatternSequenceStep, int index) Adds the given Step at the specified index in the list of Steps.
java.lang.String	bindingOfMaxVisibleSteps() Binding path of property maxVisibleSteps.
java.lang.String	bindingOfSelectedStep() Binding path of property selectedStep.
void	bindMaxVisibleSteps(IWDAttributeInfo attributeInfo) Binds property maxVisibleSteps to the context attribute specified by the given attribute info.
void	bindMaxVisibleSteps(java.lang.String path) Binds property maxVisibleSteps to the context attribute specified by path.
void	bindSelectedStep(IWDAttributeInfo attributeInfo) Binds property selectedStep to the context attribute specified by the given attribute info.
void	bindSelectedStep(java.lang.String path) Binds property selectedStep to the context attribute specified by path.
void	destroyAllSteps() Destroys all entries in the list of Steps.
void	destroyTitle() Destroys the Title instance.
int	getMaxVisibleSteps() Returns the value of the maxVisibleSteps property.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
java.lang.String	getSelectedStep() Returns the value of the selectedStep property.
IWDPatternSequenceStep	getStep(int index) Returns the Step at the given index.
IWDPatternSequenceStep[]	getSteps() Returns the list of Steps.
IWDPatternSequenceStep	getTitle() Gets the Title instance.
boolean	hasSteps() Checks if there exist Steps.
int	indexOfStep(IWDPatternSequenceStep aPatternSequenceStep) Returns the index of the given element in the list of Steps or -1 if it is not contained in the list.
java.util.Iterator	iterateSteps() Returns an iterator over the list of Steps.
IWDParameterMapping	mappingOfOnSelect() Returns the parameter mapping of event onSelect.
int	numberOfSteps() Returns the number of Steps.
void	removeAllSteps() Removes all entries from the list of Steps.
IWDPatternSequenceStep	removeStep(int index) Removes the entry at the given index from the list of Steps.
IWDPatternSequenceStep	removeStep(java.lang.String id) Removes the entry with the given ID from the list of Steps.
void	setMaxVisibleSteps(int value) Sets property maxVisibleSteps to the new value.
void	setOnSelect(IWDAction action) Maps the event onSelect to the given action.
void	setSelectedStep(java.lang.String value) Sets property selectedStep to the new value.
void	setTitle(IWDPatternSequenceStep title) Sets the Title instance.
void	swapSteps(int i, int j) 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

getId, getView, requestFocus

Field Detail

DEFAULT_MAX_VISIBLE_STEPS

public static final int DEFAULT_MAX_VISIBLE_STEPS

Default value of property maxVisibleSteps.

DEFAULT_SELECTED_STEP

public static final java.lang.String DEFAULT_SELECTED_STEP

Default value of property selectedStep.

Method Detail

getOnSelect

public IWDAction getOnSelect()

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

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSelect()

setOnSelect

public void setOnSelect(IWDAction action)

Maps the event onSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnSelect()

mappingOfOnSelect

public IWDParameterMapping mappingOfOnSelect()

Returns the parameter mapping of event onSelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• String step - The ID of the selected PatternSequenceStep.

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindMaxVisibleSteps

public void bindMaxVisibleSteps(java.lang.String path)

Binds property maxVisibleSteps to the context attribute specified by path.

Parameters:

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

bindMaxVisibleSteps

public void bindMaxVisibleSteps(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMaxVisibleSteps

public java.lang.String bindingOfMaxVisibleSteps()

Binding path of property maxVisibleSteps.

Returns:

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

getMaxVisibleSteps

public int getMaxVisibleSteps()

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)

Sets property maxVisibleSteps to the new value.

Parameters:

value - the new value of the maxVisibleSteps property

See Also:

getMaxVisibleSteps()

bindSelectedStep

public void bindSelectedStep(java.lang.String path)

Binds property selectedStep to the context attribute specified by path.

Parameters:

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

bindSelectedStep

public void bindSelectedStep(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSelectedStep

public java.lang.String bindingOfSelectedStep()

Binding path of property selectedStep.

Returns:

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

getSelectedStep

public java.lang.String getSelectedStep()

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(java.lang.String value)

Sets property selectedStep to the new value.

Parameters:

value - the new value of the selectedStep property

See Also:

getSelectedStep()

addStep

public void addStep(IWDPatternSequenceStep aPatternSequenceStep)

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

Parameters:

aPatternSequenceStep - the Step to be added into the list

See Also:

getSteps()

addStep

public void addStep(IWDPatternSequenceStep aPatternSequenceStep,
                    int index)

Adds the given Step at the specified index in the list of Steps.

Parameters:

aPatternSequenceStep - the Step to be added into the list

index - zero based index of the insertion position in the list

See Also:

getSteps()

swapSteps

public void swapSteps(int i,
                      int j)

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()

Returns the list of Steps.

Returns:

an array containing references to the current Steps

getStep

public IWDPatternSequenceStep getStep(int index)

Returns the Step at the given index.

Returns:

Step at the given index

indexOfStep

public int indexOfStep(IWDPatternSequenceStep aPatternSequenceStep)

Returns the index of the given element in the list of Steps or -1 if it is not contained in the list.

numberOfSteps

public int numberOfSteps()

Returns the number of Steps.

Returns:

the current number of Steps.

See Also:

getSteps()

hasSteps

public boolean hasSteps()

Checks if there exist Steps.

Returns:

true if there are Steps; false otherwise.

See Also:

getSteps()

iterateSteps

public java.util.Iterator iterateSteps()

Returns an iterator over the list of Steps.

Returns:

an iterator over the current Steps

See Also:

getSteps()

removeStep

public IWDPatternSequenceStep removeStep(int index)

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

Parameters:

index - zero based index of the deletion position in the list

Returns:

the removed element

See Also:

addStep(IWDPatternSequenceStep), getSteps()

removeStep

public IWDPatternSequenceStep removeStep(java.lang.String id)

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

Parameters:

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

Returns:

the removed element

See Also:

addStep(IWDPatternSequenceStep), getSteps()

removeAllSteps

public void removeAllSteps()

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

See Also:

addStep(IWDPatternSequenceStep), getSteps()

destroyAllSteps

public void destroyAllSteps()

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

getTitle

public IWDPatternSequenceStep getTitle()

Gets the Title instance.

Returns:

the current Title

See Also:

setTitle(IWDPatternSequenceStep)

setTitle

public void setTitle(IWDPatternSequenceStep title)

Sets the Title instance.

Parameters:

title - the new title

See Also:

getTitle()

destroyTitle

public void destroyTitle()

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