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

All Superinterfaces:

IWDViewElement

public interface IWDRoadMapStep

extends IWDViewElement

Web Dynpro RoadMapStep API. Represents a single step in a RoadMap.

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

See Also:

IWDRoadMap

Field Summary

static java.lang.String	DEFAULT_DESCRIPTION Default value of property description.
static WDRoadMapStepDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_ENABLED Default value of property enabled.
static java.lang.String	DEFAULT_NAME Default value of property name.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.
static WDRoadMapStepType	DEFAULT_TYPE Default value of property type.
static boolean	DEFAULT_VISIBLE Default value of property visible.

Method Summary

void	bindDescription(IWDAttributeInfo attributeInfo) Binds property description to the context attribute specified by the given attribute info.
void	bindDescription(java.lang.String path) Binds property description to the context attribute specified by path.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds property design to the context attribute specified by the given attribute info.
void	bindDesign(java.lang.String path) Binds property design to the context attribute specified by path.
void	bindEnabled(IWDAttributeInfo attributeInfo) Binds property enabled to the context attribute specified by the given attribute info.
void	bindEnabled(java.lang.String path) Binds property enabled to the context attribute specified by path.
java.lang.String	bindingOfDescription() Binding path of property description.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfName() Binding path of property name.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
java.lang.String	bindingOfType() Binding path of property type.
java.lang.String	bindingOfVisible() Binding path of property visible.
void	bindName(IWDAttributeInfo attributeInfo) Binds property name to the context attribute specified by the given attribute info.
void	bindName(java.lang.String path) Binds property name to the context attribute specified by path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
void	bindTooltip(IWDAttributeInfo attributeInfo) Binds property tooltip to the context attribute specified by the given attribute info.
void	bindTooltip(java.lang.String path) Binds property tooltip to the context attribute specified by path.
void	bindType(IWDAttributeInfo attributeInfo) Binds property type to the context attribute specified by the given attribute info.
void	bindType(java.lang.String path) Binds property type to the context attribute specified by path.
void	bindVisible(IWDAttributeInfo attributeInfo) Binds property visible to the context attribute specified by the given attribute info.
void	bindVisible(java.lang.String path) Binds property visible to the context attribute specified by path.
java.lang.String	getDescription() Returns the value of the description property.
WDRoadMapStepDesign	getDesign() Returns the value of the design property.
boolean	getEnabled() Returns the value of the enabled property.
java.lang.String	getName() Returns the value of the name property.
IWDRoadMap	getRoadMap() Returns the current RoadMap.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getTooltip() Returns the value of the tooltip property.
WDRoadMapStepType	getType() Returns the value of the type property.
boolean	getVisible() Returns the value of the visible property.
void	setDescription(java.lang.String value) Sets property description to the new value.
void	setDesign(WDRoadMapStepDesign value) Sets property design to the new value.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setName(java.lang.String value) Sets property name to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new value.
void	setType(WDRoadMapStepType value) Sets property type to the new value.
void	setVisible(boolean value) Sets property visible to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_DESCRIPTION

public static final java.lang.String DEFAULT_DESCRIPTION

Default value of property description.

DEFAULT_DESIGN

public static final WDRoadMapStepDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

Default value of property name.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

DEFAULT_TYPE

public static final WDRoadMapStepType DEFAULT_TYPE

Default value of property type.

DEFAULT_VISIBLE

public static final boolean DEFAULT_VISIBLE

Default value of property visible.

Method Detail

bindDescription

public void bindDescription(java.lang.String path)

Binds property description to the context attribute specified by path.

Parameters:

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

bindDescription

public void bindDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDescription

public java.lang.String bindingOfDescription()

Binding path of property description.

Returns:

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

getDescription

public java.lang.String getDescription()

Returns the value of the description property. The initial value is "". Allows you to display a text between two RoadMap steps.

Returns:

the current value of the description property

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String value)

Sets property description to the new value.

Parameters:

value - the new value of the description property

See Also:

getDescription()

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

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

getDesign

public WDRoadMapStepDesign getDesign()

Returns the value of the design property. The initial value is WDRoadMapStepDesign.STANDARD. DEPRECATED: Please use the attribute selected on the RoadMap, the attribute enabled and the attribute type on the RoadMapStep.

Returns:

the current value of the design property

See Also:

setDesign(WDRoadMapStepDesign)

setDesign

public void setDesign(WDRoadMapStepDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindEnabled

public void bindEnabled(java.lang.String path)

Binds property enabled to the context attribute specified by path.

Parameters:

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

bindEnabled

public void bindEnabled(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfEnabled

public java.lang.String bindingOfEnabled()

Binding path of property enabled.

Returns:

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

getEnabled

public boolean getEnabled()

Returns the value of the enabled property. The initial value is true. Determines whether the Step is enabled. An enabled Step can generate events.

Returns:

the current value of the enabled property

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean value)

Sets property enabled to the new value.

Parameters:

value - the new value of the enabled property

See Also:

getEnabled()

bindName

public void bindName(java.lang.String path)

Binds property name to the context attribute specified by path.

Parameters:

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

bindName

public void bindName(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfName

public java.lang.String bindingOfName()

Binding path of property name.

Returns:

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

getName

public java.lang.String getName()

Returns the value of the name property. The initial value is "". Allows you to specify a label for the RoadMapStep element, which is displayed in the element itself.

Returns:

the current value of the name property

See Also:

setName(String)

setName

public void setName(java.lang.String value)

Sets property name to the new value.

Parameters:

value - the new value of the name property

See Also:

getName()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

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

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property. The initial value is WDTextDirection.INHERIT. Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindTooltip

public void bindTooltip(java.lang.String path)

Binds property tooltip to the context attribute specified by path.

Parameters:

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

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltip

public java.lang.String bindingOfTooltip()

Binding path of property tooltip.

Returns:

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

getTooltip

public java.lang.String getTooltip()

Returns the value of the tooltip property. The initial value is "". Describes a note for the RoadMapStep subelement. The note is displayed when the user places the cursor on the UI element.

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(java.lang.String value)

Sets property tooltip to the new value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

bindType

public void bindType(java.lang.String path)

Binds property type to the context attribute specified by path.

Parameters:

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

bindType

public void bindType(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfType

public java.lang.String bindingOfType()

Binding path of property type.

Returns:

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

getType

public WDRoadMapStepType getType()

Returns the value of the type property. The initial value is WDRoadMapStepType.STANDARD. Sets the type of a single step of the RoadMapStep control.

Returns:

the current value of the type property

See Also:

setType(WDRoadMapStepType)

setType

public void setType(WDRoadMapStepType value)

Sets property type to the new value.

Parameters:

value - the new value of the type property

See Also:

getType()

bindVisible

public void bindVisible(java.lang.String path)

Binds property visible to the context attribute specified by path.

Parameters:

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

bindVisible

public void bindVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfVisible

public java.lang.String bindingOfVisible()

Binding path of property visible.

Returns:

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

getVisible

public boolean getVisible()

Returns the value of the visible property. The initial value is true. Specifies whether the RoadMapStep is displayed.

Returns:

the current value of the visible property

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean value)

Sets property visible to the new value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

getRoadMap

public IWDRoadMap getRoadMap()

Returns the current RoadMap.

Returns:

the current RoadMap