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

Field Summary

static WDGroupDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of property hasContentPadding.

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

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

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

bindingOfScrollingMode, bindScrollingMode, bindScrollingMode, getScrollingMode, 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

getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDGroupDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of property hasContentPadding.

Method Detail

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 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 property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindHasContentPadding

public void bindHasContentPadding(java.lang.String path)

Binds property hasContentPadding to the context attribute specified by path.

Parameters:

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

bindHasContentPadding

public void bindHasContentPadding(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentPadding

public java.lang.String bindingOfHasContentPadding()

Binding path of property hasContentPadding.

Returns:

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

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

getHeader

public IWDCaption getHeader()

Gets the Header instance. The header of a group contains a caption.

Returns:

the current Header

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the Header instance.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

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

getToolBar

public IWDToolBar getToolBar()

Gets the ToolBar instance. A group may contain a toolbar.

Returns:

the current ToolBar

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the ToolBar instance.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

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