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

Interface IWDAbstractCaption

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDAbstractButton, IWDButton, IWDCaption, IWDFileDownload, IWDLink, IWDLinkToAction, IWDLinkToURL, IWDPrintButton, IWDToolBarButton, IWDToolBarLinkToAction, IWDToolBarLinkToURL

public interface IWDAbstractCaption

extends IWDUIElement

Web Dynpro AbstractCaption API. AbstractCaption represents a caption composed of a text label and an icon. The property text determines the displayed caption text. The displayed image is determined by the URL given by property imageSource. If the image is not accessible the alternative text given by imageAlt is displayed. The image position relative to the text is given by the property imageFirst, where imageFirst = true means that the image is displayed on the left of the text.

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 String	DEFAULT_IMAGE_ALT Default value of the imageAlt property is "".
static boolean	DEFAULT_IMAGE_FIRST Default value of the imageFirst property is true.
static String	DEFAULT_IMAGE_SOURCE Default value of the imageSource property is "".
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of the textDirection property is WDTextDirection.INHERIT.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindImageAlt(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindImageAlt(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindImageFirst(IWDAttributeInfo attributeInfo) Binds the imageFirst property to the context attribute specified by the given attribute info.
void	bindImageFirst(String path) Binds the imageFirst property to the context attribute specified by the given path.
void	bindImageSource(IWDAttributeInfo attributeInfo) Binds the imageSource property to the context attribute specified by the given attribute info.
void	bindImageSource(String path) Binds the imageSource property to the context attribute specified by the given path.
String	bindingOfImageAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	bindingOfImageFirst() Returns the binding path of the imageFirst property.
String	bindingOfImageSource() Returns the binding path of the imageSource property.
String	bindingOfTextDirection() Returns the binding path of the textDirection property.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds the textDirection property to the context attribute specified by the given attribute info.
void	bindTextDirection(String path) Binds the textDirection property to the context attribute specified by the given path.
String	getImageAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
boolean	getImageFirst() Returns the value of the imageFirst property.
String	getImageSource() Returns the value of the imageSource property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
void	setImageAlt(String value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	setImageFirst(boolean value) Sets the imageFirst property to the given value.
void	setImageSource(String value) Sets the imageSource property to the given value.
void	setTextDirection(WDTextDirection value) Sets the textDirection property to the given 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_IMAGE_ALT

public static final String DEFAULT_IMAGE_ALT

Default value of the imageAlt property is "".

See Also:

Constant Field Values

DEFAULT_IMAGE_FIRST

public static final boolean DEFAULT_IMAGE_FIRST

Default value of the imageFirst property is true.

See Also:

Constant Field Values

DEFAULT_IMAGE_SOURCE

public static final String DEFAULT_IMAGE_SOURCE

Default value of the imageSource property is "".

See Also:

Constant Field Values

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of the textDirection property is WDTextDirection.INHERIT.

Method Detail

bindImageAlt

public void bindImageAlt(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

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

bindImageAlt

public void bindImageAlt(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

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

bindingOfImageAlt

public String bindingOfImageAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the binding path of the imageAlt property.

Returns:

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

getImageAlt

public String getImageAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the value of the imageAlt property.

The initial value is "".

The alternative text displayed if the image cannot be displayed.

Returns:

the current value of the imageAlt property

See Also:

setImageAlt(String)

setImageAlt

public void setImageAlt(String value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Sets the imageAlt property to the given value.

Parameters:

value - the new value of the imageAlt property

See Also:

getImageAlt()

bindImageFirst

public void bindImageFirst(String path)

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

Parameters:

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

bindImageFirst

public void bindImageFirst(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageFirst

public String bindingOfImageFirst()

Returns the binding path of the imageFirst property.

Returns:

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

getImageFirst

public boolean getImageFirst()

Returns the value of the imageFirst property.

The initial value is true.

Determines if the image is displayed on the left (imageFirst = true) or on the right of the text.

Returns:

the current value of the imageFirst property

See Also:

setImageFirst(boolean)

setImageFirst

public void setImageFirst(boolean value)

Sets the imageFirst property to the given value.

Parameters:

value - the new value of the imageFirst property

See Also:

getImageFirst()

bindImageSource

public void bindImageSource(String path)

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

Parameters:

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

bindImageSource

public void bindImageSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageSource

public String bindingOfImageSource()

Returns the binding path of the imageSource property.

Returns:

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

getImageSource

public String getImageSource()

Returns the value of the imageSource property.

The initial value is null.

The image source given as an URL.

Returns:

the current value of the imageSource property

See Also:

setImageSource(String)

setImageSource

public void setImageSource(String value)

Sets the imageSource property to the given value.

Parameters:

value - the new value of the imageSource property

See Also:

getImageSource()

bindTextDirection

public void bindTextDirection(String path)

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

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public String bindingOfTextDirection()

Returns the binding path of the textDirection property.

Returns:

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

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property.

The initial value is WDTextDirection.INHERIT.

Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets the textDirection property to the given value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()