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

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDPatternSequence, IWDPatternTabStrip, IWDPatternTray

public interface IWDAbstractPatternContainer

extends IWDUIElement

Web Dynpro AbstractPatternContainer API. Abstract base class of all PatternContainers.

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 WDPatternContainerDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_HAS_CONTENT_CONNECTOR Default value of property hasContentConnector.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addExpandFunction(IWDPatternExpandFunction aPatternExpandFunction) Adds the given ExpandFunction at the end of the list of ExpandFunctions.
void	addExpandFunction(IWDPatternExpandFunction aPatternExpandFunction, int index) Adds the given ExpandFunction at the specified index in the list of ExpandFunctions.
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	bindHasContentConnector(IWDAttributeInfo attributeInfo) Binds property hasContentConnector to the context attribute specified by the given attribute info.
void	bindHasContentConnector(java.lang.String path) Binds property hasContentConnector 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	bindingOfHasContentConnector() Binding path of property hasContentConnector.
void	destroyAllExpandFunctions() Destroys all entries in the list of ExpandFunctions.
void	destroyPopupMenu() Destroys the PopupMenu instance.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
WDPatternContainerDesign	getDesign() Returns the value of the design property.
IWDPatternExpandFunction	getExpandFunction(int index) Returns the ExpandFunction at the given index.
IWDPatternExpandFunction[]	getExpandFunctions() Returns the list of ExpandFunctions.
boolean	getHasContentConnector() Returns the value of the hasContentConnector property.
IWDMenu	getPopupMenu() Gets the PopupMenu instance.
boolean	hasExpandFunctions() Checks if there exist ExpandFunctions.
int	indexOfExpandFunction(IWDPatternExpandFunction aPatternExpandFunction) Returns the index of the given element in the list of ExpandFunctions or -1 if it is not contained in the list.
java.util.Iterator	iterateExpandFunctions() Returns an iterator over the list of ExpandFunctions.
int	numberOfExpandFunctions() Returns the number of ExpandFunctions.
void	removeAllExpandFunctions() Removes all entries from the list of ExpandFunctions.
IWDPatternExpandFunction	removeExpandFunction(int index) Removes the entry at the given index from the list of ExpandFunctions.
IWDPatternExpandFunction	removeExpandFunction(java.lang.String id) Removes the entry with the given ID from the list of ExpandFunctions.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setDesign(WDPatternContainerDesign value) Sets property design to the new value.
void	setHasContentConnector(boolean value) Sets property hasContentConnector to the new value.
void	setPopupMenu(IWDMenu popupMenu) Sets the PopupMenu instance.
void	swapExpandFunctions(int i, int j) Swaps the ExpandFunctions at the given indices.

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

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

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 WDPatternContainerDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_HAS_CONTENT_CONNECTOR

public static final boolean DEFAULT_HAS_CONTENT_CONNECTOR

Default value of property hasContentConnector.

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 PatternContainer (it's like a title) in the accessibility mode. Should be used if no title is available. 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 WDPatternContainerDesign getDesign()

Returns the value of the design property. The initial value is WDPatternContainerDesign.PLAIN. Determines the design of this PatternContainer. For the parameter values see enumeration 'PatternContainerDesign'. Default is 'PLAIN'.

Returns:

the current value of the design property

See Also:

setDesign(WDPatternContainerDesign)

setDesign

public void setDesign(WDPatternContainerDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindHasContentConnector

public void bindHasContentConnector(java.lang.String path)

Binds property hasContentConnector to the context attribute specified by path.

Parameters:

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

bindHasContentConnector

public void bindHasContentConnector(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentConnector

public java.lang.String bindingOfHasContentConnector()

Binding path of property hasContentConnector.

Returns:

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

getHasContentConnector

public boolean getHasContentConnector()

Returns the value of the hasContentConnector property. The initial value is false. Determines whether the PatternContainer control has a content connector or not. It is a visualisation between two PatternContainer to show that their content is connected to each other.

Returns:

the current value of the hasContentConnector property

See Also:

setHasContentConnector(boolean)

setHasContentConnector

public void setHasContentConnector(boolean value)

Sets property hasContentConnector to the new value.

Parameters:

value - the new value of the hasContentConnector property

See Also:

getHasContentConnector()

addExpandFunction

public void addExpandFunction(IWDPatternExpandFunction aPatternExpandFunction)

Adds the given ExpandFunction at the end of the list of ExpandFunctions.

Parameters:

aPatternExpandFunction - the ExpandFunction to be added into the list

See Also:

getExpandFunctions()

addExpandFunction

public void addExpandFunction(IWDPatternExpandFunction aPatternExpandFunction,
                              int index)

Adds the given ExpandFunction at the specified index in the list of ExpandFunctions.

Parameters:

aPatternExpandFunction - the ExpandFunction to be added into the list

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

See Also:

getExpandFunctions()

swapExpandFunctions

public void swapExpandFunctions(int i,
                                int j)

Swaps the ExpandFunctions at the given indices.

Parameters:

i - index of the first ExpandFunction to swap

j - index of the second ExpandFunction to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getExpandFunctions

public IWDPatternExpandFunction[] getExpandFunctions()

Returns the list of ExpandFunctions.

Returns:

an array containing references to the current ExpandFunctions

getExpandFunction

public IWDPatternExpandFunction getExpandFunction(int index)

Returns the ExpandFunction at the given index.

Returns:

ExpandFunction at the given index

indexOfExpandFunction

public int indexOfExpandFunction(IWDPatternExpandFunction aPatternExpandFunction)

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

numberOfExpandFunctions

public int numberOfExpandFunctions()

Returns the number of ExpandFunctions.

Returns:

the current number of ExpandFunctions.

See Also:

getExpandFunctions()

hasExpandFunctions

public boolean hasExpandFunctions()

Checks if there exist ExpandFunctions.

Returns:

true if there are ExpandFunctions; false otherwise.

See Also:

getExpandFunctions()

iterateExpandFunctions

public java.util.Iterator iterateExpandFunctions()

Returns an iterator over the list of ExpandFunctions.

Returns:

an iterator over the current ExpandFunctions

See Also:

getExpandFunctions()

removeExpandFunction

public IWDPatternExpandFunction removeExpandFunction(int index)

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

addExpandFunction(IWDPatternExpandFunction), getExpandFunctions()

removeExpandFunction

public IWDPatternExpandFunction removeExpandFunction(java.lang.String id)

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

addExpandFunction(IWDPatternExpandFunction), getExpandFunctions()

removeAllExpandFunctions

public void removeAllExpandFunctions()

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

See Also:

addExpandFunction(IWDPatternExpandFunction), getExpandFunctions()

destroyAllExpandFunctions

public void destroyAllExpandFunctions()

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

getPopupMenu

public IWDMenu getPopupMenu()

Gets the PopupMenu instance.

Returns:

the current PopupMenu

See Also:

setPopupMenu(IWDMenu)

setPopupMenu

public void setPopupMenu(IWDMenu popupMenu)

Sets the PopupMenu instance.

Parameters:

popupMenu - the new popupMenu

See Also:

getPopupMenu()

destroyPopupMenu

public void destroyPopupMenu()

Destroys the PopupMenu instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.