com.sap.tc.webdynpro.progmodel.api
Interface IWDUIElementContainer

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDGroup, IWDScrollContainer, IWDTransparentContainer, IWDTray

public interface IWDUIElementContainer

extends IWDUIElement

Web Dynpro UIElementContainer API. UIElementContainer is the abstract base class of all UI elements that may contain a number of arbitrary UI elements called its children.

A container manages its children using an instance of Layout. The layout defines how the children are arranged in their container. A UI element that is managed by a layout may provide layout data carrying individual layout information.

The size of the container is specified using the attributes width and height. Width and height may be specified by CSS (cascading-style-sheet) size values. This is a percentage value like "50%", a pixel value like "100px" or a relative font size value like "1.5em" or "1ex".

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

See Also:

IWDLayout, IWDLayoutData

Field Summary

static java.lang.String	DEFAULT_HEIGHT Default value of property height.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addChild(IWDUIElement aUIElement) Adds the given Child at the end of the list of Children.
void	addChild(IWDUIElement aUIElement, int index) Adds the given Child at the specified index in the list of Children.
void	bindHeight(IWDAttributeInfo attributeInfo) Binds property height to the context attribute specified by the given attribute info.
void	bindHeight(java.lang.String path) Binds property height to the context attribute specified by path.
java.lang.String	bindingOfHeight() Binding path of property height.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
IWDLayout	createLayout(java.lang.Class layoutInterface) Creates and sets a layout of the given type.
void	destroyAllChildren() Destroys all entries in the list of Children.
IWDUIElement	getChild(int index) Returns the Child at the given index.
IWDUIElement[]	getChildren() Returns the list of Children.
java.lang.String	getHeight() Returns the value of the height property.
IWDLayout	getLayout() Gets the Layout instance.
java.lang.String	getWidth() Returns the value of the width property.
boolean	hasChildren() Checks if there exist Children.
int	indexOfChild(IWDUIElement aUIElement) Returns the index of the given element in the list of Children or -1 if it is not contained in the list.
java.util.Iterator	iterateChildren() Returns an iterator over the list of Children.
int	numberOfChildren() Returns the number of Children.
void	removeAllChildren() Removes all entries from the list of Children.
IWDUIElement	removeChild(int index) Removes the entry at the given index from the list of Children.
IWDUIElement	removeChild(java.lang.String id) Removes the entry with the given ID from the list of Children.
void	setHeight(java.lang.String value) Sets property height to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.
void	swapChildren(int i, int j) Swaps the Children 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_HEIGHT

public static final java.lang.String DEFAULT_HEIGHT

Default value of property height.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

bindHeight

public void bindHeight(java.lang.String path)

Binds property height to the context attribute specified by path.

Parameters:

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

bindHeight

public void bindHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHeight

public java.lang.String bindingOfHeight()

Binding path of property height.

Returns:

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

getHeight

public java.lang.String getHeight()

Returns the value of the height property. The initial value is "". Determines the height (CSS size ) of this container.

Returns:

the current value of the height property

See Also:

setHeight(String)

setHeight

public void setHeight(java.lang.String value)

Sets property height to the new value.

Parameters:

value - the new value of the height property

See Also:

getHeight()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

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

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

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

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". Determines the width (CSS size ) of this container.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addChild

public void addChild(IWDUIElement aUIElement)

Adds the given Child at the end of the list of Children.

Parameters:

aUIElement - the Child to be added into the list

See Also:

getChildren()

addChild

public void addChild(IWDUIElement aUIElement,
                     int index)

Adds the given Child at the specified index in the list of Children.

Parameters:

aUIElement - the Child to be added into the list

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

See Also:

getChildren()

swapChildren

public void swapChildren(int i,
                         int j)

Swaps the Children at the given indices.

Parameters:

i - index of the first Child to swap

j - index of the second Child to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getChildren

public IWDUIElement[] getChildren()

Returns the list of Children. A container may contain a number of arbitrary UI elements called its children. The parent-child relation is used to construct the UI tree.

Returns:

an array containing references to the current Children

getChild

public IWDUIElement getChild(int index)

Returns the Child at the given index.

Returns:

Child at the given index

indexOfChild

public int indexOfChild(IWDUIElement aUIElement)

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

numberOfChildren

public int numberOfChildren()

Returns the number of Children.

Returns:

the current number of Children.

See Also:

getChildren()

hasChildren

public boolean hasChildren()

Checks if there exist Children.

Returns:

true if there are Children; false otherwise.

See Also:

getChildren()

iterateChildren

public java.util.Iterator iterateChildren()

Returns an iterator over the list of Children.

Returns:

an iterator over the current Children

See Also:

getChildren()

removeChild

public IWDUIElement removeChild(int index)

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

addChild(IWDUIElement), getChildren()

removeChild

public IWDUIElement removeChild(java.lang.String id)

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

addChild(IWDUIElement), getChildren()

removeAllChildren

public void removeAllChildren()

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

See Also:

addChild(IWDUIElement), getChildren()

destroyAllChildren

public void destroyAllChildren()

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

getLayout

public IWDLayout getLayout()

Gets the Layout instance. A container manages the layout of its children using an associated layout manager.

Returns:

the current Layout

See Also:

createLayout(Class)

createLayout

public IWDLayout createLayout(java.lang.Class layoutInterface)

Creates and sets a layout of the given type.

Parameters:

layoutInterface - the type of layout to be created

Returns:

the layout created