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

Interface IWDGroup

All Superinterfaces:

IWDScrollContainer, IWDUIElement, IWDUIElementContainer, IWDViewElement

public interface IWDGroup

extends IWDScrollContainer

Web Dynpro Group API. Group is used to group a number of UI elements under a common header.

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

See Also:

IWDCaption

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 WDGroupDesign	DEFAULT_DESIGN Default value of the design property is WDGroupDesign.PRIMARYCOLOR.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of the hasContentPadding property is true.

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDScrollContainer

DEFAULT_ACCESSIBILITY_DESCRIPTION, DEFAULT_DEFAULT_BUTTON_ID, DEFAULT_SCROLLING_MODE

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

DEFAULT_HEIGHT, DEFAULT_WIDTH

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

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	bindHasContentPadding(IWDAttributeInfo attributeInfo) Binds the hasContentPadding property to the context attribute specified by the given attribute info.
void	bindHasContentPadding(String path) Binds the hasContentPadding property to the context attribute specified by the given path.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfHasContentPadding() Returns the binding path of the hasContentPadding property.
void	destroyHeader() Destroys the aggregated Header element.
void	destroyToolBar() Destroys the aggregated ToolBar element.
WDGroupDesign	getDesign() Returns the value of the design property.
boolean	getHasContentPadding() Returns the value of the hasContentPadding property.
IWDCaption	getHeader() Returns the aggregated Header element.
IWDToolBar	getToolBar() Returns the aggregated ToolBar element.
void	setDesign(WDGroupDesign value) Sets the design property to the given value.
void	setHasContentPadding(boolean value) Sets the hasContentPadding property to the given value.
void	setHeader(IWDCaption header) Sets the aggregated Header element.
void	setToolBar(IWDToolBar toolBar) Sets the aggregated ToolBar element.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDScrollContainer

bindAccessibilityDescription, bindAccessibilityDescription, bindDefaultButtonId, bindDefaultButtonId, bindingOfAccessibilityDescription, bindingOfDefaultButtonId, bindingOfScrollingMode, bindScrollingMode, bindScrollingMode, getAccessibilityDescription, getCustomExtensionField, getCustomExtensionLabel, getDefaultButtonId, getScrollingMode, setAccessibilityDescription, setDefaultButtonId, setScrollingMode

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

addChild, addChild, bindHeight, bindHeight, bindingOfHeight, bindingOfWidth, bindWidth, bindWidth, createLayout, destroyAllChildren, getChild, getChildren, getHeight, getLayout, getWidth, hasChildren, indexOfChild, iterateChildren, numberOfChildren, removeAllChildren, removeChild, removeChild, setHeight, setWidth, swapChildren

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDGroupDesign DEFAULT_DESIGN

Default value of the design property is WDGroupDesign.PRIMARYCOLOR.

DEFAULT_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of the hasContentPadding property is true.

See Also:

Constant Field Values

Method Detail

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

Returns the value of the design property.

The initial value is WDGroupDesign.PRIMARYCOLOR.

Determines the design of the group.

Returns:

the current value of the design property

See Also:

setDesign(WDGroupDesign)

setDesign

public void setDesign(WDGroupDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindHasContentPadding

public void bindHasContentPadding(String path)

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

Parameters:

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

bindHasContentPadding

public void bindHasContentPadding(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentPadding

public String bindingOfHasContentPadding()

Returns the binding path of the hasContentPadding property.

Returns:

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

getHasContentPadding

public boolean getHasContentPadding()

Returns the value of the hasContentPadding property.

The initial value is true.

Returns:

the current value of the hasContentPadding property

See Also:

setHasContentPadding(boolean)

setHasContentPadding

public void setHasContentPadding(boolean value)

Sets the hasContentPadding property to the given value.

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

getHeader

public IWDCaption getHeader()

Returns the aggregated Header element. The header of a group contains a caption.

Returns:

the aggregated Header element

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the aggregated Header element.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

Destroys the aggregated Header element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.

getToolBar

public IWDToolBar getToolBar()

Returns the aggregated ToolBar element. A group may contain a toolbar.

Returns:

the aggregated ToolBar element

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the aggregated ToolBar element.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

Destroys the aggregated ToolBar element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.