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!

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static WDToolBarDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_ENABLED Default value of property enabled.
static WDVisibility	DEFAULT_VISIBLE Default value of property visible.
static boolean	DEFAULT_WRAPPING Default value of property wrapping.

Method Summary

void	addToolBarItem(IWDToolBarItem aToolBarItem) Adds the given ToolBarItem at the end of the list of ToolBarItems.
void	addToolBarItem(IWDToolBarItem aToolBarItem, int index) Adds the given ToolBarItem at the specified index in the list of ToolBarItems.
void	addToolBarRightItem(IWDToolBarItem aToolBarItem) Adds the given ToolBarRightItem at the end of the list of ToolBarRightItems.
void	addToolBarRightItem(IWDToolBarItem aToolBarItem, int index) Adds the given ToolBarRightItem at the specified index in the list of ToolBarRightItems.
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	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	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfVisible() Binding path of property visible.
java.lang.String	bindingOfWrapping() Binding path of property wrapping.
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	bindWrapping(IWDAttributeInfo attributeInfo) Binds property wrapping to the context attribute specified by the given attribute info.
void	bindWrapping(java.lang.String path) Binds property wrapping to the context attribute specified by path.
void	destroyAllToolBarItems() Destroys all entries in the list of ToolBarItems.
void	destroyAllToolBarRightItems() Destroys all entries in the list of ToolBarRightItems.
java.lang.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 list of ToolBarItems.
IWDToolBarItem	getToolBarRightItem(int index) Returns the ToolBarRightItem at the given index.
IWDToolBarItem[]	getToolBarRightItems() Returns the list of ToolBarRightItems.
WDVisibility	getVisible() Returns the value of the visible property.
boolean	getWrapping() Returns the value of the wrapping property.
boolean	hasToolBarItems() Checks if there exist ToolBarItems.
boolean	hasToolBarRightItems() Checks if there exist ToolBarRightItems.
int	indexOfToolBarItem(IWDToolBarItem aToolBarItem) Returns the index of the given element in the list of ToolBarItems or -1 if it is not contained in the list.
int	indexOfToolBarRightItem(IWDToolBarItem aToolBarItem) Returns the index of the given element in the list of ToolBarRightItems or -1 if it is not contained in the list.
java.util.Iterator	iterateToolBarItems() Returns an iterator over the list of ToolBarItems.
java.util.Iterator	iterateToolBarRightItems() Returns an iterator over the list of ToolBarRightItems.
int	numberOfToolBarItems() Returns the number of ToolBarItems.
int	numberOfToolBarRightItems() Returns the number of ToolBarRightItems.
void	removeAllToolBarItems() Removes all entries from the list of ToolBarItems.
void	removeAllToolBarRightItems() Removes all entries from the list of ToolBarRightItems.
IWDToolBarItem	removeToolBarItem(int index) Removes the entry at the given index from the list of ToolBarItems.
IWDToolBarItem	removeToolBarItem(java.lang.String id) Removes the entry with the given ID from the list of ToolBarItems.
IWDToolBarItem	removeToolBarRightItem(int index) Removes the entry at the given index from the list of ToolBarRightItems.
IWDToolBarItem	removeToolBarRightItem(java.lang.String id) Removes the entry with the given ID from the list of ToolBarRightItems.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setDesign(WDToolBarDesign value) Sets property design to the new value.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setVisible(WDVisibility value) Sets property visible to the new value.
void	setWrapping(boolean value) Sets property wrapping to the new 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

getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_DESIGN

public static final WDToolBarDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of property wrapping.

Method Detail

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 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(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

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

Returns the value of the design property. The initial value is WDToolBarDesign.STANDARD. The design of the toolbar.

Returns:

the current value of the design property

See Also:

setDesign(WDToolBarDesign)

setDesign

public void setDesign(WDToolBarDesign 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 if the toolbar 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()

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 if the toolbar 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()

bindWrapping

public void bindWrapping(java.lang.String path)

Binds property wrapping to the context attribute specified by path.

Parameters:

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

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWrapping

public java.lang.String bindingOfWrapping()

Binding path of property wrapping.

Returns:

the path of the context attribute to which the wrapping 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 property wrapping to the new value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()

addToolBarItem

public void addToolBarItem(IWDToolBarItem aToolBarItem)

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

Parameters:

aToolBarItem - the ToolBarItem to be added into the list

See Also:

getToolBarItems()

addToolBarItem

public void addToolBarItem(IWDToolBarItem aToolBarItem,
                           int index)

Adds the given ToolBarItem at the specified index in the list of ToolBarItems.

Parameters:

aToolBarItem - the ToolBarItem to be added into the list

index - zero based index of the 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 list of ToolBarItems. A toolbar contains a number of toolbar items like buttons, drop-down lists or separators.

Returns:

an array containing references to the current ToolBarItems

getToolBarItem

public IWDToolBarItem getToolBarItem(int index)

Returns the ToolBarItem at the given index.

Returns:

ToolBarItem at the given index

indexOfToolBarItem

public int indexOfToolBarItem(IWDToolBarItem aToolBarItem)

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

numberOfToolBarItems

public int numberOfToolBarItems()

Returns the number of ToolBarItems.

Returns:

the current number of ToolBarItems.

See Also:

getToolBarItems()

hasToolBarItems

public boolean hasToolBarItems()

Checks if there exist ToolBarItems.

Returns:

true if there are ToolBarItems; false otherwise.

See Also:

getToolBarItems()

iterateToolBarItems

public java.util.Iterator iterateToolBarItems()

Returns an iterator over the list of ToolBarItems.

Returns:

an iterator over the current ToolBarItems

See Also:

getToolBarItems()

removeToolBarItem

public IWDToolBarItem removeToolBarItem(int index)

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

addToolBarItem(IWDToolBarItem), getToolBarItems()

removeToolBarItem

public IWDToolBarItem removeToolBarItem(java.lang.String id)

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

addToolBarItem(IWDToolBarItem), getToolBarItems()

removeAllToolBarItems

public void removeAllToolBarItems()

Removes all entries from the list of ToolBarItems. 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 entries in the list of ToolBarItems. Destroyed elements do not exist any longer, i.e. new elements may be created with the same IDs.

addToolBarRightItem

public void addToolBarRightItem(IWDToolBarItem aToolBarItem)

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

Parameters:

aToolBarItem - the ToolBarRightItem to be added into the list

See Also:

getToolBarRightItems()

addToolBarRightItem

public void addToolBarRightItem(IWDToolBarItem aToolBarItem,
                                int index)

Adds the given ToolBarRightItem at the specified index in the list of ToolBarRightItems.

Parameters:

aToolBarItem - the ToolBarRightItem to be added into the list

index - zero based index of the 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 list of ToolBarRightItems.

Returns:

an array containing references to the current ToolBarRightItems

getToolBarRightItem

public IWDToolBarItem getToolBarRightItem(int index)

Returns the ToolBarRightItem at the given index.

Returns:

ToolBarRightItem at the given index

indexOfToolBarRightItem

public int indexOfToolBarRightItem(IWDToolBarItem aToolBarItem)

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

numberOfToolBarRightItems

public int numberOfToolBarRightItems()

Returns the number of ToolBarRightItems.

Returns:

the current number of ToolBarRightItems.

See Also:

getToolBarRightItems()

hasToolBarRightItems

public boolean hasToolBarRightItems()

Checks if there exist ToolBarRightItems.

Returns:

true if there are ToolBarRightItems; false otherwise.

See Also:

getToolBarRightItems()

iterateToolBarRightItems

public java.util.Iterator iterateToolBarRightItems()

Returns an iterator over the list of ToolBarRightItems.

Returns:

an iterator over the current ToolBarRightItems

See Also:

getToolBarRightItems()

removeToolBarRightItem

public IWDToolBarItem removeToolBarRightItem(int index)

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

addToolBarRightItem(IWDToolBarItem), getToolBarRightItems()

removeToolBarRightItem

public IWDToolBarItem removeToolBarRightItem(java.lang.String id)

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

addToolBarRightItem(IWDToolBarItem), getToolBarRightItems()

removeAllToolBarRightItems

public void removeAllToolBarRightItems()

Removes all entries from the list of ToolBarRightItems. 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 entries in the list of ToolBarRightItems. Destroyed elements do not exist any longer, i.e. new elements may be created with the same IDs.