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

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDAbstractButton, IWDButton, IWDCaption, IWDFileDownload, IWDLink, IWDLinkToAction, IWDLinkToURL, IWDToolBarButton

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

Field Summary

static java.lang.String	DEFAULT_IMAGE_ALT Default value of property imageAlt.
static boolean	DEFAULT_IMAGE_FIRST Default value of property imageFirst.
static java.lang.String	DEFAULT_IMAGE_SOURCE Default value of property imageSource.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindImageAlt(IWDAttributeInfo attributeInfo) Binds property imageAlt to the context attribute specified by the given attribute info.
void	bindImageAlt(java.lang.String path) Binds property imageAlt to the context attribute specified by path.
void	bindImageFirst(IWDAttributeInfo attributeInfo) Binds property imageFirst to the context attribute specified by the given attribute info.
void	bindImageFirst(java.lang.String path) Binds property imageFirst to the context attribute specified by path.
void	bindImageSource(IWDAttributeInfo attributeInfo) Binds property imageSource to the context attribute specified by the given attribute info.
void	bindImageSource(java.lang.String path) Binds property imageSource to the context attribute specified by path.
java.lang.String	bindingOfImageAlt() Binding path of property imageAlt.
java.lang.String	bindingOfImageFirst() Binding path of property imageFirst.
java.lang.String	bindingOfImageSource() Binding path of property imageSource.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
java.lang.String	getImageAlt() Returns the value of the imageAlt property.
boolean	getImageFirst() Returns the value of the imageFirst property.
java.lang.String	getImageSource() Returns the value of the imageSource property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
void	setImageAlt(java.lang.String value) Sets property imageAlt to the new value.
void	setImageFirst(boolean value) Sets property imageFirst to the new value.
void	setImageSource(java.lang.String value) Sets property imageSource to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection 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_IMAGE_ALT

public static final java.lang.String DEFAULT_IMAGE_ALT

Default value of property imageAlt.

DEFAULT_IMAGE_FIRST

public static final boolean DEFAULT_IMAGE_FIRST

Default value of property imageFirst.

DEFAULT_IMAGE_SOURCE

public static final java.lang.String DEFAULT_IMAGE_SOURCE

Default value of property imageSource.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

Method Detail

bindImageAlt

public void bindImageAlt(java.lang.String path)

Binds property imageAlt to the context attribute specified by path.

Parameters:

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

bindImageAlt

public void bindImageAlt(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageAlt

public java.lang.String bindingOfImageAlt()

Binding path of property imageAlt.

Returns:

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

getImageAlt

public java.lang.String getImageAlt()

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(java.lang.String value)

Sets property imageAlt to the new value.

Parameters:

value - the new value of the imageAlt property

See Also:

getImageAlt()

bindImageFirst

public void bindImageFirst(java.lang.String path)

Binds property imageFirst to the context attribute specified by path.

Parameters:

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

bindImageFirst

public void bindImageFirst(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageFirst

public java.lang.String bindingOfImageFirst()

Binding path of property imageFirst.

Returns:

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

Parameters:

value - the new value of the imageFirst property

See Also:

getImageFirst()

bindImageSource

public void bindImageSource(java.lang.String path)

Binds property imageSource to the context attribute specified by path.

Parameters:

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

bindImageSource

public void bindImageSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageSource

public java.lang.String bindingOfImageSource()

Binding path of property imageSource.

Returns:

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

getImageSource

public java.lang.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(java.lang.String value)

Sets property imageSource to the new value.

Parameters:

value - the new value of the imageSource property

See Also:

getImageSource()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

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

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()