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

All Superinterfaces:

IWDViewElement

public interface IWDPatternSequenceStep

extends IWDViewElement

Web Dynpro PatternSequenceStep API. PatternSequenceStep represents a single step in a PatternSequence. A PatternSequenceStep contains a title that may be activated to display the content of the PatternSequenceStep. Each PatternSequenceStep can contain several PatternContentAreas. Each area contains a UIElement or a ToolBar.

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

See Also:

IWDPatternContentArea, IWDPatternSequenceStep

Field Summary

static WDPatternContainerSequenceItemDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_ENABLED Default value of property enabled.
static boolean	DEFAULT_REQUIRED Default value of property required.
static WDPatternContainerSequenceStatus	DEFAULT_STATUS Default value of property status.
static java.lang.String	DEFAULT_STEP_NUMBER Default value of property stepNumber.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_TITLE Default value of property title.
static java.lang.String	DEFAULT_TOOLTIP_OF_STATUS Default value of property tooltipOfStatus.
static java.lang.String	DEFAULT_TOOLTIP_OF_STEP_NUMBER Default value of property tooltipOfStepNumber.
static java.lang.String	DEFAULT_TOOLTIP_OF_TITLE Default value of property tooltipOfTitle.
static WDVisibility	DEFAULT_VISIBLE Default value of property visible.

Method Summary

void	addItem(IWDPatternContentArea aPatternContentArea) Adds the given Item at the end of the list of Items.
void	addItem(IWDPatternContentArea aPatternContentArea, int index) Adds the given Item at the specified index in the list of Items.
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	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfRequired() Binding path of property required.
java.lang.String	bindingOfStatus() Binding path of property status.
java.lang.String	bindingOfStepNumber() Binding path of property stepNumber.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfTitle() Binding path of property title.
java.lang.String	bindingOfTooltipOfStatus() Binding path of property tooltipOfStatus.
java.lang.String	bindingOfTooltipOfStepNumber() Binding path of property tooltipOfStepNumber.
java.lang.String	bindingOfTooltipOfTitle() Binding path of property tooltipOfTitle.
java.lang.String	bindingOfVisible() Binding path of property visible.
void	bindRequired(IWDAttributeInfo attributeInfo) Binds property required to the context attribute specified by the given attribute info.
void	bindRequired(java.lang.String path) Binds property required to the context attribute specified by path.
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	bindStepNumber(IWDAttributeInfo attributeInfo) Binds property stepNumber to the context attribute specified by the given attribute info.
void	bindStepNumber(java.lang.String path) Binds property stepNumber 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	bindTitle(IWDAttributeInfo attributeInfo) Binds property title to the context attribute specified by the given attribute info.
void	bindTitle(java.lang.String path) Binds property title to the context attribute specified by path.
void	bindTooltipOfStatus(IWDAttributeInfo attributeInfo) Binds property tooltipOfStatus to the context attribute specified by the given attribute info.
void	bindTooltipOfStatus(java.lang.String path) Binds property tooltipOfStatus to the context attribute specified by path.
void	bindTooltipOfStepNumber(IWDAttributeInfo attributeInfo) Binds property tooltipOfStepNumber to the context attribute specified by the given attribute info.
void	bindTooltipOfStepNumber(java.lang.String path) Binds property tooltipOfStepNumber to the context attribute specified by path.
void	bindTooltipOfTitle(IWDAttributeInfo attributeInfo) Binds property tooltipOfTitle to the context attribute specified by the given attribute info.
void	bindTooltipOfTitle(java.lang.String path) Binds property tooltipOfTitle 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.
void	destroyAllItems() Destroys all entries in the list of Items.
WDPatternContainerSequenceItemDesign	getDesign() Returns the value of the design property.
boolean	getEnabled() Returns the value of the enabled property.
IWDPatternContentArea	getItem(int index) Returns the Item at the given index.
IWDPatternContentArea[]	getItems() Returns the list of Items.
IWDPatternSequence	getPatternSequence() Returns the current PatternSequence.
boolean	getRequired() Returns the value of the required property.
WDPatternContainerSequenceStatus	getStatus() Returns the value of the status property.
java.lang.String	getStepNumber() Returns the value of the stepNumber property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getTitle() Returns the value of the title property.
java.lang.String	getTooltipOfStatus() Returns the value of the tooltipOfStatus property.
java.lang.String	getTooltipOfStepNumber() Returns the value of the tooltipOfStepNumber property.
java.lang.String	getTooltipOfTitle() Returns the value of the tooltipOfTitle property.
WDVisibility	getVisible() Returns the value of the visible property.
boolean	hasItems() Checks if there exist Items.
int	indexOfItem(IWDPatternContentArea aPatternContentArea) Returns the index of the given element in the list of Items or -1 if it is not contained in the list.
java.util.Iterator	iterateItems() Returns an iterator over the list of Items.
int	numberOfItems() Returns the number of Items.
void	removeAllItems() Removes all entries from the list of Items.
IWDPatternContentArea	removeItem(int index) Removes the entry at the given index from the list of Items.
IWDPatternContentArea	removeItem(java.lang.String id) Removes the entry with the given ID from the list of Items.
void	setDesign(WDPatternContainerSequenceItemDesign value) Sets property design to the new value.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setRequired(boolean value) Sets property required to the new value.
void	setStatus(WDPatternContainerSequenceStatus value) Sets property status to the new value.
void	setStepNumber(java.lang.String value) Sets property stepNumber to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.
void	setTitle(java.lang.String value) Sets property title to the new value.
void	setTooltipOfStatus(java.lang.String value) Sets property tooltipOfStatus to the new value.
void	setTooltipOfStepNumber(java.lang.String value) Sets property tooltipOfStepNumber to the new value.
void	setTooltipOfTitle(java.lang.String value) Sets property tooltipOfTitle to the new value.
void	setVisible(WDVisibility value) Sets property visible to the new value.
void	swapItems(int i, int j) Swaps the Items at the given indices.

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

getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDPatternContainerSequenceItemDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_REQUIRED

public static final boolean DEFAULT_REQUIRED

Default value of property required.

DEFAULT_STATUS

public static final WDPatternContainerSequenceStatus DEFAULT_STATUS

Default value of property status.

DEFAULT_STEP_NUMBER

public static final java.lang.String DEFAULT_STEP_NUMBER

Default value of property stepNumber.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

Default value of property title.

DEFAULT_TOOLTIP_OF_STATUS

public static final java.lang.String DEFAULT_TOOLTIP_OF_STATUS

Default value of property tooltipOfStatus.

DEFAULT_TOOLTIP_OF_STEP_NUMBER

public static final java.lang.String DEFAULT_TOOLTIP_OF_STEP_NUMBER

Default value of property tooltipOfStepNumber.

DEFAULT_TOOLTIP_OF_TITLE

public static final java.lang.String DEFAULT_TOOLTIP_OF_TITLE

Default value of property tooltipOfTitle.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

Method Detail

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

Returns the value of the design property. The initial value is WDPatternContainerSequenceItemDesign.STANDARD. Determines the design of the PatternSequenceStep control. For the parameter values see enumeration 'PatternContainerSequenceItemDesign'.

Returns:

the current value of the design property

See Also:

setDesign(WDPatternContainerSequenceItemDesign)

setDesign

public void setDesign(WDPatternContainerSequenceItemDesign 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 PatternSequenceStep 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()

bindRequired

public void bindRequired(java.lang.String path)

Binds property required to the context attribute specified by path.

Parameters:

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

bindRequired

public void bindRequired(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRequired

public java.lang.String bindingOfRequired()

Binding path of property required.

Returns:

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

getRequired

public boolean getRequired()

Returns the value of the required property. The initial value is false. Determines whether the PatternSequenceStep control is required or or not.

Returns:

the current value of the required property

See Also:

setRequired(boolean)

setRequired

public void setRequired(boolean value)

Sets property required to the new value.

Parameters:

value - the new value of the required property

See Also:

getRequired()

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

Returns the value of the status property. The initial value is WDPatternContainerSequenceStatus.NONE. Sets the status of the PatternSequenceStep control. For the parameter values see enumeration PatternContainerSequenceStatus'.

Returns:

the current value of the status property

See Also:

setStatus(WDPatternContainerSequenceStatus)

setStatus

public void setStatus(WDPatternContainerSequenceStatus value)

Sets property status to the new value.

Parameters:

value - the new value of the status property

See Also:

getStatus()

bindStepNumber

public void bindStepNumber(java.lang.String path)

Binds property stepNumber to the context attribute specified by path.

Parameters:

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

bindStepNumber

public void bindStepNumber(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfStepNumber

public java.lang.String bindingOfStepNumber()

Binding path of property stepNumber.

Returns:

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

getStepNumber

public java.lang.String getStepNumber()

Returns the value of the stepNumber property. The initial value is "". Sets the step number of the PatternSequenceStep control.

Returns:

the current value of the stepNumber property

See Also:

setStepNumber(String)

setStepNumber

public void setStepNumber(java.lang.String value)

Sets property stepNumber to the new value.

Parameters:

value - the new value of the stepNumber property

See Also:

getStepNumber()

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. The text-direction of the button 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()

bindTitle

public void bindTitle(java.lang.String path)

Binds property title to the context attribute specified by path.

Parameters:

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

bindTitle

public void bindTitle(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTitle

public java.lang.String bindingOfTitle()

Binding path of property title.

Returns:

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

getTitle

public java.lang.String getTitle()

Returns the value of the title property. The initial value is "". Determines the title of the PatternSequenceStep control.

Returns:

the current value of the title property

See Also:

setTitle(String)

setTitle

public void setTitle(java.lang.String value)

Sets property title to the new value.

Parameters:

value - the new value of the title property

See Also:

getTitle()

bindTooltipOfStatus

public void bindTooltipOfStatus(java.lang.String path)

Binds property tooltipOfStatus to the context attribute specified by path.

Parameters:

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

bindTooltipOfStatus

public void bindTooltipOfStatus(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltipOfStatus

public java.lang.String bindingOfTooltipOfStatus()

Binding path of property tooltipOfStatus.

Returns:

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

getTooltipOfStatus

public java.lang.String getTooltipOfStatus()

Returns the value of the tooltipOfStatus property. The initial value is "". Sets the tooltip status of the PatternSequenceStep control.

Returns:

the current value of the tooltipOfStatus property

See Also:

setTooltipOfStatus(String)

setTooltipOfStatus

public void setTooltipOfStatus(java.lang.String value)

Sets property tooltipOfStatus to the new value.

Parameters:

value - the new value of the tooltipOfStatus property

See Also:

getTooltipOfStatus()

bindTooltipOfStepNumber

public void bindTooltipOfStepNumber(java.lang.String path)

Binds property tooltipOfStepNumber to the context attribute specified by path.

Parameters:

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

bindTooltipOfStepNumber

public void bindTooltipOfStepNumber(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltipOfStepNumber

public java.lang.String bindingOfTooltipOfStepNumber()

Binding path of property tooltipOfStepNumber.

Returns:

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

getTooltipOfStepNumber

public java.lang.String getTooltipOfStepNumber()

Returns the value of the tooltipOfStepNumber property. The initial value is "". Sets the tooltip for the step number of the PatternSequenceStep control.

Returns:

the current value of the tooltipOfStepNumber property

See Also:

setTooltipOfStepNumber(String)

setTooltipOfStepNumber

public void setTooltipOfStepNumber(java.lang.String value)

Sets property tooltipOfStepNumber to the new value.

Parameters:

value - the new value of the tooltipOfStepNumber property

See Also:

getTooltipOfStepNumber()

bindTooltipOfTitle

public void bindTooltipOfTitle(java.lang.String path)

Binds property tooltipOfTitle to the context attribute specified by path.

Parameters:

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

bindTooltipOfTitle

public void bindTooltipOfTitle(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltipOfTitle

public java.lang.String bindingOfTooltipOfTitle()

Binding path of property tooltipOfTitle.

Returns:

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

getTooltipOfTitle

public java.lang.String getTooltipOfTitle()

Returns the value of the tooltipOfTitle property. The initial value is "". Sets the tooltip title of the PatternSequenceStep control.

Returns:

the current value of the tooltipOfTitle property

See Also:

setTooltipOfTitle(String)

setTooltipOfTitle

public void setTooltipOfTitle(java.lang.String value)

Sets property tooltipOfTitle to the new value.

Parameters:

value - the new value of the tooltipOfTitle property

See Also:

getTooltipOfTitle()

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

Returns the value of the visible property. The initial value is WDVisibility.VISIBLE. Determines whether the PatternSequenceStep is visible.

Returns:

the current value of the visible property

See Also:

setVisible(WDVisibility)

setVisible

public void setVisible(WDVisibility value)

Sets property visible to the new value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

addItem

public void addItem(IWDPatternContentArea aPatternContentArea)

Adds the given Item at the end of the list of Items.

Parameters:

aPatternContentArea - the Item to be added into the list

See Also:

getItems()

addItem

public void addItem(IWDPatternContentArea aPatternContentArea,
                    int index)

Adds the given Item at the specified index in the list of Items.

Parameters:

aPatternContentArea - the Item to be added into the list

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

See Also:

getItems()

swapItems

public void swapItems(int i,
                      int j)

Swaps the Items at the given indices.

Parameters:

i - index of the first Item to swap

j - index of the second Item to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getItems

public IWDPatternContentArea[] getItems()

Returns the list of Items.

Returns:

an array containing references to the current Items

getItem

public IWDPatternContentArea getItem(int index)

Returns the Item at the given index.

Returns:

Item at the given index

indexOfItem

public int indexOfItem(IWDPatternContentArea aPatternContentArea)

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

numberOfItems

public int numberOfItems()

Returns the number of Items.

Returns:

the current number of Items.

See Also:

getItems()

hasItems

public boolean hasItems()

Checks if there exist Items.

Returns:

true if there are Items; false otherwise.

See Also:

getItems()

iterateItems

public java.util.Iterator iterateItems()

Returns an iterator over the list of Items.

Returns:

an iterator over the current Items

See Also:

getItems()

removeItem

public IWDPatternContentArea removeItem(int index)

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

addItem(IWDPatternContentArea), getItems()

removeItem

public IWDPatternContentArea removeItem(java.lang.String id)

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

addItem(IWDPatternContentArea), getItems()

removeAllItems

public void removeAllItems()

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

See Also:

addItem(IWDPatternContentArea), getItems()

destroyAllItems

public void destroyAllItems()

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

getPatternSequence

public IWDPatternSequence getPatternSequence()

Returns the current PatternSequence.

Returns:

the current PatternSequence