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

Interface IWDToolBar

All Superinterfaces:

IWDViewElement

public interface IWDToolBar

extends IWDViewElement

Web Dynpro ToolBar API. The ToolBar UI element represents a collection of "tools" that belong to or may be applied to the containing UI element.

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

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of the accessibilityDescription property is "".
static WDToolBarDesign	DEFAULT_DESIGN Default value of the design property is WDToolBarDesign.STANDARD.
static boolean	DEFAULT_ENABLED Default value of the enabled property is true.
static WDVisibility	DEFAULT_VISIBLE Default value of the visible property is WDVisibility.VISIBLE.
static boolean	DEFAULT_WRAPPING Default value of the wrapping property is true.

Method Summary

void	addToolBarItem(IWDToolBarItem toolBarItem) Adds the given ToolBarItem at the end of the ToolBarItems list.
void	addToolBarItem(IWDToolBarItem toolBarItem, int index) Inserts the given ToolBarItem at the specified (zero-based) index into the ToolBarItems list.
void	addToolBarRightItem(IWDToolBarItem toolBarRightItem) Adds the given ToolBarRightItem at the end of the ToolBarRightItems list.
void	addToolBarRightItem(IWDToolBarItem toolBarRightItem, int index) Inserts the given ToolBarRightItem at the specified (zero-based) index into the ToolBarRightItems list.
void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds the accessibilityDescription property to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(String path) Binds the accessibilityDescription property to the context attribute specified by the given path.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds the design property to the context attribute specified by the given attribute info.
void	bindDesign(String path) Binds the design property to the context attribute specified by the given path.
void	bindEnabled(IWDAttributeInfo attributeInfo) Binds the enabled property to the context attribute specified by the given attribute info.
void	bindEnabled(String path) Binds the enabled property to the context attribute specified by the given path.
String	bindingOfAccessibilityDescription() Returns the binding path of the accessibilityDescription property.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfEnabled() Returns the binding path of the enabled property.
String	bindingOfVisible() Returns the binding path of the visible property.
String	bindingOfWrapping() Returns the binding path of the wrapping property.
void	bindVisible(IWDAttributeInfo attributeInfo) Binds the visible property to the context attribute specified by the given attribute info.
void	bindVisible(String path) Binds the visible property to the context attribute specified by the given path.
void	bindWrapping(IWDAttributeInfo attributeInfo) Binds the wrapping property to the context attribute specified by the given attribute info.
void	bindWrapping(String path) Binds the wrapping property to the context attribute specified by the given path.
void	destroyAllToolBarItems() Destroys all elements in the ToolBarItems list.
void	destroyAllToolBarRightItems() Destroys all elements in the ToolBarRightItems list.
String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
WDToolBarDesign	getDesign() Returns the value of the design property.
boolean	getEnabled() Returns the value of the enabled property.
IWDToolBarItem	getToolBarItem(int index) Returns the ToolBarItem at the given index.
IWDToolBarItem[]	getToolBarItems() Returns the ToolBarItems list as an array.
IWDToolBarItem	getToolBarRightItem(int index) Returns the ToolBarRightItem at the given index.
IWDToolBarItem[]	getToolBarRightItems() Returns the ToolBarRightItems list as an array
WDVisibility	getVisible() Returns the value of the visible property.
boolean	getWrapping() Returns the value of the wrapping property.
boolean	hasToolBarItems() Returns true if there exists a ToolBarItem.
boolean	hasToolBarRightItems() Returns true if there exists a ToolBarRightItem.
int	indexOfToolBarItem(IWDToolBarItem toolBarItem) Returns the index of the given element in the ToolBarItems list, returns -1 if the element is not in the list.
int	indexOfToolBarRightItem(IWDToolBarItem toolBarRightItem) Returns the index of the given element in the ToolBarRightItems list, returns -1 if the element is not in the list.
Iterator	iterateToolBarItems() Returns an iterator over the ToolBarItems list.
Iterator	iterateToolBarRightItems() Returns an iterator over the ToolBarRightItems list.
int	numberOfToolBarItems() Returns the number of ToolBarItems.
int	numberOfToolBarRightItems() Returns the number of ToolBarRightItems.
void	removeAllToolBarItems() Removes all elements from the ToolBarItems list.
void	removeAllToolBarRightItems() Removes all elements from the ToolBarRightItems list.
IWDToolBarItem	removeToolBarItem(int index) Removes the ToolBarItem at the given index from the ToolBarItems list.
IWDToolBarItem	removeToolBarItem(String id) Removes the ToolBarItem with the given ID from the ToolBarItems list.
IWDToolBarItem	removeToolBarRightItem(int index) Removes the ToolBarRightItem at the given index from the ToolBarRightItems list.
IWDToolBarItem	removeToolBarRightItem(String id) Removes the ToolBarRightItem with the given ID from the ToolBarRightItems list.
void	setAccessibilityDescription(String value) Sets the accessibilityDescription property to the given value.
void	setDesign(WDToolBarDesign value) Sets the design property to the given value.
void	setEnabled(boolean value) Sets the enabled property to the given value.
void	setVisible(WDVisibility value) Sets the visible property to the given value.
void	setWrapping(boolean value) Sets the wrapping property to the given value.
void	swapToolBarItems(int i, int j) Swaps the ToolBarItems at the given indices.
void	swapToolBarRightItems(int i, int j) Swaps the ToolBarRightItems at the given indices.

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of the accessibilityDescription property is "".

See Also:

Constant Field Values

DEFAULT_DESIGN

public static final WDToolBarDesign DEFAULT_DESIGN

Default value of the design property is WDToolBarDesign.STANDARD.

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of the enabled property is true.

See Also:

Constant Field Values

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of the visible property is WDVisibility.VISIBLE.

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of the wrapping property is true.

See Also:

Constant Field Values

Method Detail

bindAccessibilityDescription

public void bindAccessibilityDescription(String path)

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

Parameters:

path - the context path of the attribute to which the accessibilityDescription property will be bound

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public String bindingOfAccessibilityDescription()

Returns the binding path of the accessibilityDescription property.

Returns:

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

getAccessibilityDescription

public String getAccessibilityDescription()

Returns the value of the accessibilityDescription property.

The initial value is "".

Short description for the Toolbar (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(String value)

Sets the accessibilityDescription property to the given value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindDesign

public void bindDesign(String path)

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

Parameters:

path - the context path of the attribute to which the design property will be bound

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public String bindingOfDesign()

Returns the binding path of the design property.

Returns:

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

getDesign

public WDToolBarDesign getDesign()

Returns the value of the design property.

The initial value is WDToolBarDesign.STANDARD.

The design of the toolbar. In some themes the design is equal but the colors of the different designs can be changed using the SAP Theme Editor.

Returns:

the current value of the design property

See Also:

setDesign(WDToolBarDesign)

setDesign

public void setDesign(WDToolBarDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindEnabled

public void bindEnabled(String path)

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

Parameters:

path - the context path of the attribute to which the enabled property will be bound

bindEnabled

public void bindEnabled(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfEnabled

public String bindingOfEnabled()

Returns the binding path of the enabled property.

Returns:

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

getEnabled

public boolean getEnabled()

Returns the value of the enabled property.

The initial value is true.

Determines if the toolbar is enabled.

Returns:

the current value of the enabled property

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean value)

Sets the enabled property to the given value.

Parameters:

value - the new value of the enabled property

See Also:

getEnabled()

bindVisible

public void bindVisible(String path)

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

Parameters:

path - the context path of the attribute to which the visible property will be bound

bindVisible

public void bindVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfVisible

public String bindingOfVisible()

Returns the binding path of the visible property.

Returns:

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

getVisible

public WDVisibility getVisible()

Returns the value of the visible property.

The initial value is WDVisibility.VISIBLE.

Determines if the toolbar is visible.

Returns:

the current value of the visible property

See Also:

setVisible(WDVisibility)

setVisible

public void setVisible(WDVisibility value)

Sets the visible property to the given value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

bindWrapping

public void bindWrapping(String path)

Binds the wrapping property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the wrapping property will be bound

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the wrapping property will be bound

bindingOfWrapping

public String bindingOfWrapping()

Returns the binding path of the wrapping property.

Returns:

the path of the context attribute to which the wrapping property is currently bound

getWrapping

public boolean getWrapping()

Returns the value of the wrapping property.

The initial value is true.

Determines if the toolBar is wrapped.

Returns:

the current value of the wrapping property

See Also:

setWrapping(boolean)

setWrapping

public void setWrapping(boolean value)

Sets the wrapping property to the given value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()

addToolBarItem

public void addToolBarItem(IWDToolBarItem toolBarItem)

Adds the given ToolBarItem at the end of the ToolBarItems list.

Parameters:

toolBarItem - the ToolBarItem to be added to the list

See Also:

getToolBarItems()

addToolBarItem

public void addToolBarItem(IWDToolBarItem toolBarItem,
                           int index)

Inserts the given ToolBarItem at the specified (zero-based) index into the ToolBarItems list.

Parameters:

toolBarItem - the ToolBarItem to be inserted into the list

index - (zero-based) insertion position in the list

See Also:

getToolBarItems()

swapToolBarItems

public void swapToolBarItems(int i,
                             int j)

Swaps the ToolBarItems at the given indices.

Parameters:

i - index of the first ToolBarItem to swap

j - index of the second ToolBarItem to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getToolBarItems

public IWDToolBarItem[] getToolBarItems()

Returns the ToolBarItems list as an array. A toolbar contains a number of toolbar items like buttons, drop-down lists or separators.

Returns:

an array containing the current ToolBarItems list

getToolBarItem

public IWDToolBarItem getToolBarItem(int index)

Returns the ToolBarItem at the given index.

Returns:

ToolBarItem at the given index

indexOfToolBarItem

public int indexOfToolBarItem(IWDToolBarItem toolBarItem)

Returns the index of the given element in the ToolBarItems list, returns -1 if the element is not in the list.

numberOfToolBarItems

public int numberOfToolBarItems()

Returns the number of ToolBarItems.

Returns:

the number of ToolBarItems

See Also:

getToolBarItems()

hasToolBarItems

public boolean hasToolBarItems()

Returns true if there exists a ToolBarItem.

Returns:

true if there exists a ToolBarItem, otherwise returns false

See Also:

getToolBarItems()

iterateToolBarItems

public Iterator iterateToolBarItems()

Returns an iterator over the ToolBarItems list.

Returns:

an iterator over the ToolBarItems list

See Also:

getToolBarItems()

removeToolBarItem

public IWDToolBarItem removeToolBarItem(int index)

Removes the ToolBarItem at the given index from the ToolBarItems list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addToolBarItem(IWDToolBarItem), getToolBarItems()

removeToolBarItem

public IWDToolBarItem removeToolBarItem(String id)

Removes the ToolBarItem with the given ID from the ToolBarItems list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be removed from the list

Returns:

the removed element

See Also:

addToolBarItem(IWDToolBarItem), getToolBarItems()

removeAllToolBarItems

public void removeAllToolBarItems()

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

See Also:

addToolBarItem(IWDToolBarItem), getToolBarItems()

destroyAllToolBarItems

public void destroyAllToolBarItems()

Destroys all elements in the ToolBarItems list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.

addToolBarRightItem

public void addToolBarRightItem(IWDToolBarItem toolBarRightItem)

Adds the given ToolBarRightItem at the end of the ToolBarRightItems list.

Parameters:

toolBarRightItem - the ToolBarRightItem to be added to the list

See Also:

getToolBarRightItems()

addToolBarRightItem

public void addToolBarRightItem(IWDToolBarItem toolBarRightItem,
                                int index)

Inserts the given ToolBarRightItem at the specified (zero-based) index into the ToolBarRightItems list.

Parameters:

toolBarRightItem - the ToolBarRightItem to be inserted into the list

index - (zero-based) insertion position in the list

See Also:

getToolBarRightItems()

swapToolBarRightItems

public void swapToolBarRightItems(int i,
                                  int j)

Swaps the ToolBarRightItems at the given indices.

Parameters:

i - index of the first ToolBarRightItem to swap

j - index of the second ToolBarRightItem to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getToolBarRightItems

public IWDToolBarItem[] getToolBarRightItems()

Returns the ToolBarRightItems list as an array.

Returns:

an array containing the current ToolBarRightItems list

getToolBarRightItem

public IWDToolBarItem getToolBarRightItem(int index)

Returns the ToolBarRightItem at the given index.

Returns:

ToolBarRightItem at the given index

indexOfToolBarRightItem

public int indexOfToolBarRightItem(IWDToolBarItem toolBarRightItem)

Returns the index of the given element in the ToolBarRightItems list, returns -1 if the element is not in the list.

numberOfToolBarRightItems

public int numberOfToolBarRightItems()

Returns the number of ToolBarRightItems.

Returns:

the number of ToolBarRightItems

See Also:

getToolBarRightItems()

hasToolBarRightItems

public boolean hasToolBarRightItems()

Returns true if there exists a ToolBarRightItem.

Returns:

true if there exists a ToolBarRightItem, otherwise returns false

See Also:

getToolBarRightItems()

iterateToolBarRightItems

public Iterator iterateToolBarRightItems()

Returns an iterator over the ToolBarRightItems list.

Returns:

an iterator over the ToolBarRightItems list

See Also:

getToolBarRightItems()

removeToolBarRightItem

public IWDToolBarItem removeToolBarRightItem(int index)

Removes the ToolBarRightItem at the given index from the ToolBarRightItems list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addToolBarRightItem(IWDToolBarItem), getToolBarRightItems()

removeToolBarRightItem

public IWDToolBarItem removeToolBarRightItem(String id)

Removes the ToolBarRightItem with the given ID from the ToolBarRightItems list. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be removed from the list

Returns:

the removed element

See Also:

addToolBarRightItem(IWDToolBarItem), getToolBarRightItems()

removeAllToolBarRightItems

public void removeAllToolBarRightItems()

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

See Also:

addToolBarRightItem(IWDToolBarItem), getToolBarRightItems()

destroyAllToolBarRightItems

public void destroyAllToolBarRightItems()

Destroys all elements in the ToolBarRightItems list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.