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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDIFrame

extends IWDUIElement

Web Dynpro IFrame API. IFrame represents an internal frame. It is used to display Web resources like HTML pages in a certain view area. The URL of the displayed resource is given by the property source, the size of the area is given by height and width. BEWARE: This UI element must not be used to embed interactive resources, e.g. applications! It's content may be reloaded at the Web Dynpro framework's discretion whenever technical restrictions require it! In fact, its content is reloaded after every roundtrip when using server-side rendering.

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 java.lang.String	DEFAULT_HEIGHT Default value of property height.
static WDScrollingMode	DEFAULT_SCROLLING_MODE Default value of property scrollingMode.
static java.lang.String	DEFAULT_SOURCE Default value of property source.
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	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	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	bindingOfBorder() Binding path of property border.
java.lang.String	bindingOfHeight() Binding path of property height.
java.lang.String	bindingOfScrollingMode() Binding path of property scrollingMode.
java.lang.String	bindingOfSource() Binding path of property source.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindScrollingMode(IWDAttributeInfo attributeInfo) Binds property scrollingMode to the context attribute specified by the given attribute info.
void	bindScrollingMode(java.lang.String path) Binds property scrollingMode to the context attribute specified by path.
void	bindSource(IWDAttributeInfo attributeInfo) Binds property source to the context attribute specified by the given attribute info.
void	bindSource(java.lang.String path) Binds property source to the context attribute specified by path.
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.
boolean	getBorder() Returns the value of the border property.
java.lang.String	getHeight() Returns the value of the height property.
WDScrollingMode	getScrollingMode() Returns the value of the scrollingMode property.
java.lang.String	getSource() Returns the value of the source property.
java.lang.String	getWidth() Returns the value of the width property.
void	setBorder(boolean value) Sets property border to the new value.
void	setHeight(java.lang.String value) Sets property height to the new value.
void	setScrollingMode(WDScrollingMode value) Sets property scrollingMode to the new value.
void	setSource(java.lang.String value) Sets property source to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.

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_BORDER

public static final boolean DEFAULT_BORDER

Default value of property border.

DEFAULT_HEIGHT

public static final java.lang.String DEFAULT_HEIGHT

Default value of property height.

DEFAULT_SCROLLING_MODE

public static final WDScrollingMode DEFAULT_SCROLLING_MODE

Default value of property scrollingMode.

DEFAULT_SOURCE

public static final java.lang.String DEFAULT_SOURCE

Default value of property source.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

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 if a border is drawn around the internal frame.

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

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 "300". Determines the height of the frame (in pixels).

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

bindScrollingMode

public void bindScrollingMode(java.lang.String path)

Binds property scrollingMode to the context attribute specified by path.

Parameters:

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

bindScrollingMode

public void bindScrollingMode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfScrollingMode

public java.lang.String bindingOfScrollingMode()

Binding path of property scrollingMode.

Returns:

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

getScrollingMode

public WDScrollingMode getScrollingMode()

Returns the value of the scrollingMode property. The initial value is WDScrollingMode.AUTO. Determines the scrolling behaviour of this internal frame.

Returns:

the current value of the scrollingMode property

See Also:

setScrollingMode(WDScrollingMode)

setScrollingMode

public void setScrollingMode(WDScrollingMode value)

Sets property scrollingMode to the new value.

Parameters:

value - the new value of the scrollingMode property

See Also:

getScrollingMode()

bindSource

public void bindSource(java.lang.String path)

Binds property source to the context attribute specified by path.

Parameters:

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

bindSource

public void bindSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSource

public java.lang.String bindingOfSource()

Binding path of property source.

Returns:

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

getSource

public java.lang.String getSource()

Returns the value of the source property. The initial value is "". Determines the URL of the resource displayed in this frame.

Returns:

the current value of the source property

See Also:

setSource(String)

setSource

public void setSource(java.lang.String value)

Sets property source to the new value.

Parameters:

value - the new value of the source property

See Also:

getSource()

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 "300". Determines the width of the frame (in pixels).

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