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!

Note: To be used only by the Portal Platform group. Other usages by applications and customers WILL NOT BE SUPPORTED!

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

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 boolean	DEFAULT_BORDER Default value of the border property is false.
static WDPatternContainerDesign	DEFAULT_DESIGN Default value of the design property is WDPatternContainerDesign.PLAIN.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of the hasContentPadding property is true.
static WDUnidirectionalScrollingMode	DEFAULT_HORIZONTAL_SCROLLING_MODE Default value of the horizontalScrollingMode property is WDUnidirectionalScrollingMode.NONE.
static WDVisibility	DEFAULT_VISIBLE Default value of the visible property is WDVisibility.VISIBLE.

Method Summary

void	bindBorder(IWDAttributeInfo attributeInfo) Binds the border property to the context attribute specified by the given attribute info.
void	bindBorder(String path) Binds the border property to the context attribute specified by the given path.
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.
void	bindHorizontalScrollingMode(IWDAttributeInfo attributeInfo) Binds the horizontalScrollingMode property to the context attribute specified by the given attribute info.
void	bindHorizontalScrollingMode(String path) Binds the horizontalScrollingMode property to the context attribute specified by the given path.
String	bindingOfBorder() Returns the binding path of the border property.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfHasContentPadding() Returns the binding path of the hasContentPadding property.
String	bindingOfHorizontalScrollingMode() Returns the binding path of the horizontalScrollingMode property.
String	bindingOfVisible() Returns the binding path of the visible property.
void	bindVisible(IWDAttributeInfo attributeInfo) Binds the visible property to the context attribute specified by the given attribute info.
void	bindVisible(String path) Binds the visible property to the context attribute specified by the given path.
void	destroyContent() Destroys the aggregated Content element.
void	destroyToolBar() Destroys the aggregated ToolBar element.
boolean	getBorder() Returns the value of the border property.
IWDUIElement	getContent() Returns the aggregated Content element
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 PatternTray this PatternContentArea belongs to
IWDToolBar	getToolBar() Returns the aggregated ToolBar element
WDVisibility	getVisible() Returns the value of the visible property.
void	setBorder(boolean value) Sets the border property to the given value.
void	setContent(IWDUIElement content) Sets the aggregated Content element.
void	setDesign(WDPatternContainerDesign value) Sets the design property to the given value.
void	setHasContentPadding(boolean value) Sets the hasContentPadding property to the given value.
void	setHorizontalScrollingMode(WDUnidirectionalScrollingMode value) Sets the horizontalScrollingMode property to the given value.
void	setToolBar(IWDToolBar toolBar) Sets the aggregated ToolBar element.
void	setVisible(WDVisibility value) Sets the visible property to the given value.

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_BORDER

public static final boolean DEFAULT_BORDER

Default value of the border property is false.

See Also:

Constant Field Values

DEFAULT_DESIGN

public static final WDPatternContainerDesign DEFAULT_DESIGN

Default value of the design property is WDPatternContainerDesign.PLAIN.

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

DEFAULT_HORIZONTAL_SCROLLING_MODE

public static final WDUnidirectionalScrollingMode DEFAULT_HORIZONTAL_SCROLLING_MODE

Default value of the horizontalScrollingMode property is WDUnidirectionalScrollingMode.NONE.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of the visible property is WDVisibility.VISIBLE.

Method Detail

bindBorder

public void bindBorder(String path)

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

Parameters:

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

bindBorder

public void bindBorder(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBorder

public String bindingOfBorder()

Returns the binding path of the border property.

Returns:

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

Parameters:

value - the new value of the border property

See Also:

getBorder()

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 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 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.

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 the hasContentPadding property to the given value.

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

bindHorizontalScrollingMode

public void bindHorizontalScrollingMode(String path)

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

Parameters:

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

bindHorizontalScrollingMode

public void bindHorizontalScrollingMode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHorizontalScrollingMode

public String bindingOfHorizontalScrollingMode()

Returns the binding path of the horizontalScrollingMode property.

Returns:

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

Parameters:

value - the new value of the horizontalScrollingMode property

See Also:

getHorizontalScrollingMode()

bindVisible

public void bindVisible(String path)

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

Parameters:

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

bindVisible

public void bindVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfVisible

public String bindingOfVisible()

Returns the binding path of the visible property.

Returns:

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

Parameters:

value - the new value of the visible property

See Also:

getVisible()

getContent

public IWDUIElement getContent()

Returns the aggregated Content element.

Returns:

the aggregated Content element

See Also:

setContent(IWDUIElement)

setContent

public void setContent(IWDUIElement content)

Sets the aggregated Content element.

Parameters:

content - the new content

See Also:

getContent()

destroyContent

public void destroyContent()

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

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.

getPatternTray

public IWDPatternTray getPatternTray()

Returns the PatternTray this PatternContentArea belongs to.

Returns:

the PatternTray this PatternContentArea belongs to