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

All Superinterfaces:

IWDViewElement

public interface IWDPatternContentArea

extends IWDViewElement

Web Dynpro PatternContentArea API. Determines the content item of a pattern container. The content item could either a UIElement or a ToolBar. If a ToolBar and UIElement is specified only the UiElement is rendered!

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

Field Summary

static boolean	DEFAULT_BORDER Default value of property border.
static WDPatternContainerDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of property hasContentPadding.
static WDUnidirectionalScrollingMode	DEFAULT_HORIZONTAL_SCROLLING_MODE Default value of property horizontalScrollingMode.
static WDVisibility	DEFAULT_VISIBLE Default value of property visible.

Method Summary

void	bindBorder(IWDAttributeInfo attributeInfo) Binds property border to the context attribute specified by the given attribute info.
void	bindBorder(java.lang.String path) Binds property border 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	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.
void	bindHorizontalScrollingMode(IWDAttributeInfo attributeInfo) Binds property horizontalScrollingMode to the context attribute specified by the given attribute info.
void	bindHorizontalScrollingMode(java.lang.String path) Binds property horizontalScrollingMode to the context attribute specified by path.
java.lang.String	bindingOfBorder() Binding path of property border.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfHasContentPadding() Binding path of property hasContentPadding.
java.lang.String	bindingOfHorizontalScrollingMode() Binding path of property horizontalScrollingMode.
java.lang.String	bindingOfVisible() Binding path of property visible.
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	destroyContent() Destroys the Content instance.
void	destroyToolBar() Destroys the ToolBar instance.
boolean	getBorder() Returns the value of the border property.
IWDUIElement	getContent() Gets the Content instance.
WDPatternContainerDesign	getDesign() Returns the value of the design property.
boolean	getHasContentPadding() Returns the value of the hasContentPadding property.
WDUnidirectionalScrollingMode	getHorizontalScrollingMode() Returns the value of the horizontalScrollingMode property.
IWDPatternTray	getPatternTray() Returns the current PatternTray.
IWDToolBar	getToolBar() Gets the ToolBar instance.
WDVisibility	getVisible() Returns the value of the visible property.
void	setBorder(boolean value) Sets property border to the new value.
void	setContent(IWDUIElement content) Sets the Content instance.
void	setDesign(WDPatternContainerDesign value) Sets property design to the new value.
void	setHasContentPadding(boolean value) Sets property hasContentPadding to the new value.
void	setHorizontalScrollingMode(WDUnidirectionalScrollingMode value) Sets property horizontalScrollingMode to the new value.
void	setToolBar(IWDToolBar toolBar) Sets the ToolBar instance.
void	setVisible(WDVisibility value) Sets property visible to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_BORDER

public static final boolean DEFAULT_BORDER

Default value of property border.

DEFAULT_DESIGN

public static final WDPatternContainerDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of property hasContentPadding.

DEFAULT_HORIZONTAL_SCROLLING_MODE

public static final WDUnidirectionalScrollingMode DEFAULT_HORIZONTAL_SCROLLING_MODE

Default value of property horizontalScrollingMode.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

Method Detail

bindBorder

public void bindBorder(java.lang.String path)

Binds property border to the context attribute specified by path.

Parameters:

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

bindBorder

public void bindBorder(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBorder

public java.lang.String bindingOfBorder()

Binding path of property border.

Returns:

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

getBorder

public boolean getBorder()

Returns the value of the border property. The initial value is false. Determines whether the PatternContentArea control has a border or not.

Returns:

the current value of the border property

See Also:

setBorder(boolean)

setBorder

public void setBorder(boolean value)

Sets property border to the new value.

Parameters:

value - the new value of the border property

See Also:

getBorder()

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. Specifies the design for the PatternContentArea control. For the parameter values see enumeration 'PatternContainerDesign'.

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

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. Determineswhether the PatternContentArea control has content padding or not.

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

bindHorizontalScrollingMode

public void bindHorizontalScrollingMode(java.lang.String path)

Binds property horizontalScrollingMode to the context attribute specified by path.

Parameters:

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

bindHorizontalScrollingMode

public void bindHorizontalScrollingMode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHorizontalScrollingMode

public java.lang.String bindingOfHorizontalScrollingMode()

Binding path of property horizontalScrollingMode.

Returns:

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

getHorizontalScrollingMode

public WDUnidirectionalScrollingMode getHorizontalScrollingMode()

Returns the value of the horizontalScrollingMode property. The initial value is WDUnidirectionalScrollingMode.NONE. This specifies the type of horizontal scrolling which occurs in the PatternContentArea. The default value is NONE which shows all content regardless of width. SHOW turns on the scrollbars (both vertical and horizontal) for the control, regardless of whether the control's content exceeds the available width. AUTO turns scrollbars on only if the width of the content exceeds the available width of the parent window.

Returns:

the current value of the horizontalScrollingMode property

See Also:

setHorizontalScrollingMode(WDUnidirectionalScrollingMode)

setHorizontalScrollingMode

public void setHorizontalScrollingMode(WDUnidirectionalScrollingMode value)

Sets property horizontalScrollingMode to the new value.

Parameters:

value - the new value of the horizontalScrollingMode property

See Also:

getHorizontalScrollingMode()

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 this PatternContentArea is visible or not.

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

getContent

public IWDUIElement getContent()

Gets the Content instance.

Returns:

the current Content

See Also:

setContent(IWDUIElement)

setContent

public void setContent(IWDUIElement content)

Sets the Content instance.

Parameters:

content - the new content

See Also:

getContent()

destroyContent

public void destroyContent()

Destroys the Content 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.

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.

getPatternTray

public IWDPatternTray getPatternTray()

Returns the current PatternTray.

Returns:

the current PatternTray