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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDPhaseIndicator

extends IWDUIElement

Web Dynpro PhaseIndicator 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 WDPhaseIndicatorBackgroundDesign	DEFAULT_BACKGROUND_DESIGN Default value of property backgroundDesign.
static java.lang.String	DEFAULT_FIRST_VISIBLE_PHASE Default value of property firstVisiblePhase.
static java.lang.String	DEFAULT_SELECTED_PHASE Default value of property selectedPhase.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addPhase(IWDPhase aPhase) Adds the given Phase at the end of the list of Phases.
void	addPhase(IWDPhase aPhase, int index) Adds the given Phase at the specified index in the list of Phases.
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	bindBackgroundDesign(IWDAttributeInfo attributeInfo) Binds property backgroundDesign to the context attribute specified by the given attribute info.
void	bindBackgroundDesign(java.lang.String path) Binds property backgroundDesign to the context attribute specified by path.
void	bindFirstVisiblePhase(IWDAttributeInfo attributeInfo) Binds property firstVisiblePhase to the context attribute specified by the given attribute info.
void	bindFirstVisiblePhase(java.lang.String path) Binds property firstVisiblePhase to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfBackgroundDesign() Binding path of property backgroundDesign.
java.lang.String	bindingOfFirstVisiblePhase() Binding path of property firstVisiblePhase.
java.lang.String	bindingOfSelectedPhase() Binding path of property selectedPhase.
void	bindSelectedPhase(IWDAttributeInfo attributeInfo) Binds property selectedPhase to the context attribute specified by the given attribute info.
void	bindSelectedPhase(java.lang.String path) Binds property selectedPhase to the context attribute specified by path.
void	destroyAllPhases() Destroys all entries in the list of Phases.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
WDPhaseIndicatorBackgroundDesign	getBackgroundDesign() Returns the value of the backgroundDesign property.
java.lang.String	getFirstVisiblePhase() Returns the value of the firstVisiblePhase property.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
IWDPhase	getPhase(int index) Returns the Phase at the given index.
IWDPhase[]	getPhases() Returns the list of Phases.
java.lang.String	getSelectedPhase() Returns the value of the selectedPhase property.
boolean	hasPhases() Checks if there exist Phases.
int	indexOfPhase(IWDPhase aPhase) Returns the index of the given element in the list of Phases or -1 if it is not contained in the list.
java.util.Iterator	iteratePhases() Returns an iterator over the list of Phases.
IWDParameterMapping	mappingOfOnSelect() Returns the parameter mapping of event onSelect.
int	numberOfPhases() Returns the number of Phases.
void	removeAllPhases() Removes all entries from the list of Phases.
IWDPhase	removePhase(int index) Removes the entry at the given index from the list of Phases.
IWDPhase	removePhase(java.lang.String id) Removes the entry with the given ID from the list of Phases.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setBackgroundDesign(WDPhaseIndicatorBackgroundDesign value) Sets property backgroundDesign to the new value.
void	setFirstVisiblePhase(java.lang.String value) Sets property firstVisiblePhase to the new value.
void	setOnSelect(IWDAction action) Maps the event onSelect to the given action.
void	setSelectedPhase(java.lang.String value) Sets property selectedPhase to the new value.
void	swapPhases(int i, int j) Swaps the Phases 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_BACKGROUND_DESIGN

public static final WDPhaseIndicatorBackgroundDesign DEFAULT_BACKGROUND_DESIGN

Default value of property backgroundDesign.

DEFAULT_FIRST_VISIBLE_PHASE

public static final java.lang.String DEFAULT_FIRST_VISIBLE_PHASE

Default value of property firstVisiblePhase.

DEFAULT_SELECTED_PHASE

public static final java.lang.String DEFAULT_SELECTED_PHASE

Default value of property selectedPhase.

Method Detail

getOnSelect

public IWDAction getOnSelect()

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

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 phase - The ID of the selected phase.

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

bindBackgroundDesign

public void bindBackgroundDesign(java.lang.String path)

Binds property backgroundDesign to the context attribute specified by path.

Parameters:

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

bindBackgroundDesign

public void bindBackgroundDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBackgroundDesign

public java.lang.String bindingOfBackgroundDesign()

Binding path of property backgroundDesign.

Returns:

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

getBackgroundDesign

public WDPhaseIndicatorBackgroundDesign getBackgroundDesign()

Returns the value of the backgroundDesign property. The initial value is WDPhaseIndicatorBackgroundDesign.EMPHASIZED. Defines the background color of a PhaseIndicator.

Returns:

the current value of the backgroundDesign property

See Also:

setBackgroundDesign(WDPhaseIndicatorBackgroundDesign)

setBackgroundDesign

public void setBackgroundDesign(WDPhaseIndicatorBackgroundDesign value)

Sets property backgroundDesign to the new value.

Parameters:

value - the new value of the backgroundDesign property

See Also:

getBackgroundDesign()

bindFirstVisiblePhase

public void bindFirstVisiblePhase(java.lang.String path)

Binds property firstVisiblePhase to the context attribute specified by path.

Parameters:

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

bindFirstVisiblePhase

public void bindFirstVisiblePhase(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfFirstVisiblePhase

public java.lang.String bindingOfFirstVisiblePhase()

Binding path of property firstVisiblePhase.

Returns:

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

getFirstVisiblePhase

public java.lang.String getFirstVisiblePhase()

Returns the value of the firstVisiblePhase property. The initial value is "". Contains the ID of the first visible Phase.

Returns:

the current value of the firstVisiblePhase property

See Also:

setFirstVisiblePhase(String)

setFirstVisiblePhase

public void setFirstVisiblePhase(java.lang.String value)

Sets property firstVisiblePhase to the new value.

Parameters:

value - the new value of the firstVisiblePhase property

See Also:

getFirstVisiblePhase()

bindSelectedPhase

public void bindSelectedPhase(java.lang.String path)

Binds property selectedPhase to the context attribute specified by path.

Parameters:

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

bindSelectedPhase

public void bindSelectedPhase(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSelectedPhase

public java.lang.String bindingOfSelectedPhase()

Binding path of property selectedPhase.

Returns:

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

getSelectedPhase

public java.lang.String getSelectedPhase()

Returns the value of the selectedPhase property. The initial value is "". Contains the ID of the selected Phase.

Returns:

the current value of the selectedPhase property

See Also:

setSelectedPhase(String)

setSelectedPhase

public void setSelectedPhase(java.lang.String value)

Sets property selectedPhase to the new value.

Parameters:

value - the new value of the selectedPhase property

See Also:

getSelectedPhase()

addPhase

public void addPhase(IWDPhase aPhase)

Adds the given Phase at the end of the list of Phases.

Parameters:

aPhase - the Phase to be added into the list

See Also:

getPhases()

addPhase

public void addPhase(IWDPhase aPhase,
                     int index)

Adds the given Phase at the specified index in the list of Phases.

Parameters:

aPhase - the Phase to be added into the list

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

See Also:

getPhases()

swapPhases

public void swapPhases(int i,
                       int j)

Swaps the Phases at the given indices.

Parameters:

i - index of the first Phase to swap

j - index of the second Phase to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getPhases

public IWDPhase[] getPhases()

Returns the list of Phases.

Returns:

an array containing references to the current Phases

getPhase

public IWDPhase getPhase(int index)

Returns the Phase at the given index.

Returns:

Phase at the given index

indexOfPhase

public int indexOfPhase(IWDPhase aPhase)

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

numberOfPhases

public int numberOfPhases()

Returns the number of Phases.

Returns:

the current number of Phases.

See Also:

getPhases()

hasPhases

public boolean hasPhases()

Checks if there exist Phases.

Returns:

true if there are Phases; false otherwise.

See Also:

getPhases()

iteratePhases

public java.util.Iterator iteratePhases()

Returns an iterator over the list of Phases.

Returns:

an iterator over the current Phases

See Also:

getPhases()

removePhase

public IWDPhase removePhase(int index)

Removes the entry at the given index from the list of Phases. 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:

addPhase(IWDPhase), getPhases()

removePhase

public IWDPhase removePhase(java.lang.String id)

Removes the entry with the given ID from the list of Phases. 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:

addPhase(IWDPhase), getPhases()

removeAllPhases

public void removeAllPhases()

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

See Also:

addPhase(IWDPhase), getPhases()

destroyAllPhases

public void destroyAllPhases()

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