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

All Superinterfaces:

IWDViewElement

public interface IWDPhase

extends IWDViewElement

Web Dynpro Phase API. Represents a single phase in a PhaseIndicator.

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

See Also:

IWDPhaseIndicator

Field Summary

static java.lang.String	DEFAULT_DESCRIPTION Default value of property description.
static boolean	DEFAULT_ENABLED Default value of property enabled.
static WDPhaseStatus	DEFAULT_STATUS Default value of property status.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.
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	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	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfStatus() Binding path of property status.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
java.lang.String	bindingOfVisible() Binding path of property visible.
void	bindStatus(IWDAttributeInfo attributeInfo) Binds property status to the context attribute specified by the given attribute info.
void	bindStatus(java.lang.String path) Binds property status 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	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.
boolean	getEnabled() Returns the value of the enabled property.
IWDPhaseIndicator	getPhaseIndicator() Returns the current PhaseIndicator.
WDPhaseStatus	getStatus() Returns the value of the status property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getTooltip() Returns the value of the tooltip property.
boolean	getVisible() Returns the value of the visible property.
void	setDescription(java.lang.String value) Sets property description to the new value.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setStatus(WDPhaseStatus value) Sets property status 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	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_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_STATUS

public static final WDPhaseStatus DEFAULT_STATUS

Default value of property status.

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_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 on a Phase.

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

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 Phase is enabled.

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

bindStatus

public void bindStatus(java.lang.String path)

Binds property status to the context attribute specified by path.

Parameters:

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

bindStatus

public void bindStatus(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfStatus

public java.lang.String bindingOfStatus()

Binding path of property status.

Returns:

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

getStatus

public WDPhaseStatus getStatus()

Returns the value of the status property. The initial value is WDPhaseStatus.NORMAL. Determines the status of the Phase.

Returns:

the current value of the status property

See Also:

setStatus(WDPhaseStatus)

setStatus

public void setStatus(WDPhaseStatus value)

Sets property status to the new value.

Parameters:

value - the new value of the status property

See Also:

getStatus()

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 "". The text that is displayed when the mouse cursor is moved onto the Phase.

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

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

getPhaseIndicator

public IWDPhaseIndicator getPhaseIndicator()

Returns the current PhaseIndicator.

Returns:

the current PhaseIndicator