com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDRoadMap

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDRoadMap

extends IWDUIElement

Web Dynpro RoadMap API. Visualizes the steps in a wizard.

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

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static WDRoadMapEdgeDesign	DEFAULT_END_POINT_DESIGN Default value of property endPointDesign.
static java.lang.String	DEFAULT_SELECTED_STEP Default value of property selectedStep.
static WDRoadMapEdgeDesign	DEFAULT_START_POINT_DESIGN Default value of property startPointDesign.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addStep(IWDRoadMapStep aRoadMapStep) Adds the given Step at the end of the list of Steps.
void	addStep(IWDRoadMapStep aRoadMapStep, int index) Adds the given Step at the specified index in the list of Steps.
void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindEndPointDesign(IWDAttributeInfo attributeInfo) Binds property endPointDesign to the context attribute specified by the given attribute info.
void	bindEndPointDesign(java.lang.String path) Binds property endPointDesign to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfEndPointDesign() Binding path of property endPointDesign.
java.lang.String	bindingOfSelectedStep() Binding path of property selectedStep.
java.lang.String	bindingOfStartPointDesign() Binding path of property startPointDesign.
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	bindStartPointDesign(IWDAttributeInfo attributeInfo) Binds property startPointDesign to the context attribute specified by the given attribute info.
void	bindStartPointDesign(java.lang.String path) Binds property startPointDesign to the context attribute specified by path.
void	destroyAllSteps() Destroys all entries in the list of Steps.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
WDRoadMapEdgeDesign	getEndPointDesign() Returns the value of the endPointDesign property.
IWDAction	getOnLoadSteps() Returns the action to which the event onLoadSteps is mapped.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
java.lang.String	getSelectedStep() Returns the value of the selectedStep property.
WDRoadMapEdgeDesign	getStartPointDesign() Returns the value of the startPointDesign property.
IWDRoadMapStep	getStep(int index) Returns the Step at the given index.
IWDRoadMapStep[]	getSteps() Returns the list of Steps.
boolean	hasSteps() Checks if there exist Steps.
int	indexOfStep(IWDRoadMapStep aRoadMapStep) 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	mappingOfOnLoadSteps() Returns the parameter mapping of event onLoadSteps.
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.
IWDRoadMapStep	removeStep(int index) Removes the entry at the given index from the list of Steps.
IWDRoadMapStep	removeStep(java.lang.String id) Removes the entry with the given ID from the list of Steps.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setEndPointDesign(WDRoadMapEdgeDesign value) Sets property endPointDesign to the new value.
void	setOnLoadSteps(IWDAction action) Maps the event onLoadSteps to the given action.
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	setStartPointDesign(WDRoadMapEdgeDesign value) Sets property startPointDesign to the new value.
void	swapSteps(int i, int j) Swaps the Steps at the given indices.

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_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_END_POINT_DESIGN

public static final WDRoadMapEdgeDesign DEFAULT_END_POINT_DESIGN

Default value of property endPointDesign.

DEFAULT_SELECTED_STEP

public static final java.lang.String DEFAULT_SELECTED_STEP

Default value of property selectedStep.

DEFAULT_START_POINT_DESIGN

public static final WDRoadMapEdgeDesign DEFAULT_START_POINT_DESIGN

Default value of property startPointDesign.

Method Detail

getOnLoadSteps

public IWDAction getOnLoadSteps()

Returns the action to which the event onLoadSteps is mapped. The action performed when the RoadMap has more steps as currently displayed (startPointDesign-->more or endPointDesign-->more) and the users clicks an the more-steps icon. Event parameter is a boolean and defines if more steps are at the end (true) or the further steps are at the beginning of the RoadMap (false).

Returns:

the action to which the event is mapped

See Also:

mappingOfOnLoadSteps()

setOnLoadSteps

public void setOnLoadSteps(IWDAction action)

Maps the event onLoadSteps to the given action.

Parameters:

action - the action for the event

See Also:

getOnLoadSteps()

mappingOfOnLoadSteps

public IWDParameterMapping mappingOfOnLoadSteps()

Returns the parameter mapping of event onLoadSteps.

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:

• boolean atEnd - Event parameter is a boolean and defines if more steps are at the end (true) or the further steps are at the beginning of the RoadMap (false).

Returns:

parameter mapping list.

See Also:

getOnLoadSteps()

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

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

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

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the RoadMap (it's like a title) in the accessibility mode. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindEndPointDesign

public void bindEndPointDesign(java.lang.String path)

Binds property endPointDesign to the context attribute specified by path.

Parameters:

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

bindEndPointDesign

public void bindEndPointDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfEndPointDesign

public java.lang.String bindingOfEndPointDesign()

Binding path of property endPointDesign.

Returns:

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

getEndPointDesign

public WDRoadMapEdgeDesign getEndPointDesign()

Returns the value of the endPointDesign property. The initial value is WDRoadMapEdgeDesign.STANDARD. The visual design of the road map's end point.

Returns:

the current value of the endPointDesign property

See Also:

setEndPointDesign(WDRoadMapEdgeDesign)

setEndPointDesign

public void setEndPointDesign(WDRoadMapEdgeDesign value)

Sets property endPointDesign to the new value.

Parameters:

value - the new value of the endPointDesign property

See Also:

getEndPointDesign()

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 selected Step.

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

bindStartPointDesign

public void bindStartPointDesign(java.lang.String path)

Binds property startPointDesign to the context attribute specified by path.

Parameters:

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

bindStartPointDesign

public void bindStartPointDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfStartPointDesign

public java.lang.String bindingOfStartPointDesign()

Binding path of property startPointDesign.

Returns:

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

getStartPointDesign

public WDRoadMapEdgeDesign getStartPointDesign()

Returns the value of the startPointDesign property. The initial value is WDRoadMapEdgeDesign.STANDARD. The visual design of the road map's start point.

Returns:

the current value of the startPointDesign property

See Also:

setStartPointDesign(WDRoadMapEdgeDesign)

setStartPointDesign

public void setStartPointDesign(WDRoadMapEdgeDesign value)

Sets property startPointDesign to the new value.

Parameters:

value - the new value of the startPointDesign property

See Also:

getStartPointDesign()

addStep

public void addStep(IWDRoadMapStep aRoadMapStep)

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

Parameters:

aRoadMapStep - the Step to be added into the list

See Also:

getSteps()

addStep

public void addStep(IWDRoadMapStep aRoadMapStep,
                    int index)

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

Parameters:

aRoadMapStep - 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 IWDRoadMapStep[] getSteps()

Returns the list of Steps.

Returns:

an array containing references to the current Steps

getStep

public IWDRoadMapStep getStep(int index)

Returns the Step at the given index.

Returns:

Step at the given index

indexOfStep

public int indexOfStep(IWDRoadMapStep aRoadMapStep)

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 IWDRoadMapStep 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(IWDRoadMapStep), getSteps()

removeStep

public IWDRoadMapStep 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(IWDRoadMapStep), 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(IWDRoadMapStep), 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.