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

All Superinterfaces:

IWDAbstractCaption, IWDTableCellEditor, IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDFileDownload, IWDLinkToAction, IWDLinkToURL

public interface IWDLink

extends IWDAbstractCaption, IWDTableCellEditor

Web Dynpro Link API. Link is the abstract base class of UI elements that represent a hypertext link.

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

Field Summary

static java.lang.String	DEFAULT_IMAGE_HEIGHT Default value of property imageHeight.
static java.lang.String	DEFAULT_IMAGE_WIDTH Default value of property imageWidth.
static WDLinkSize	DEFAULT_SIZE Default value of property size.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static boolean	DEFAULT_WRAPPING Default value of property wrapping.

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

DEFAULT_IMAGE_ALT, DEFAULT_IMAGE_FIRST, DEFAULT_IMAGE_SOURCE, DEFAULT_TEXT_DIRECTION

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindImageHeight(IWDAttributeInfo attributeInfo) Binds property imageHeight to the context attribute specified by the given attribute info.
void	bindImageHeight(java.lang.String path) Binds property imageHeight to the context attribute specified by path.
void	bindImageWidth(IWDAttributeInfo attributeInfo) Binds property imageWidth to the context attribute specified by the given attribute info.
void	bindImageWidth(java.lang.String path) Binds property imageWidth to the context attribute specified by path.
java.lang.String	bindingOfImageHeight() Binding path of property imageHeight.
java.lang.String	bindingOfImageWidth() Binding path of property imageWidth.
java.lang.String	bindingOfSize() Binding path of property size.
java.lang.String	bindingOfText() Binding path of property text.
java.lang.String	bindingOfWrapping() Binding path of property wrapping.
void	bindSize(IWDAttributeInfo attributeInfo) Binds property size to the context attribute specified by the given attribute info.
void	bindSize(java.lang.String path) Binds property size to the context attribute specified by path.
void	bindText(IWDAttributeInfo attributeInfo) Binds property text to the context attribute specified by the given attribute info.
void	bindText(java.lang.String path) Binds property text to the context attribute specified by path.
void	bindWrapping(IWDAttributeInfo attributeInfo) Binds property wrapping to the context attribute specified by the given attribute info.
void	bindWrapping(java.lang.String path) Binds property wrapping to the context attribute specified by path.
java.lang.String	getImageHeight() Returns the value of the imageHeight property.
java.lang.String	getImageWidth() Returns the value of the imageWidth property.
WDLinkSize	getSize() Returns the value of the size property.
java.lang.String	getText() Returns the value of the text property.
boolean	getWrapping() Returns the value of the wrapping property.
void	setImageHeight(java.lang.String value) Sets property imageHeight to the new value.
void	setImageWidth(java.lang.String value) Sets property imageWidth to the new value.
void	setSize(WDLinkSize value) Sets property size to the new value.
void	setText(java.lang.String value) Sets property text to the new value.
void	setWrapping(boolean value) Sets property wrapping to the new value.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

bindImageAlt, bindImageAlt, bindImageFirst, bindImageFirst, bindImageSource, bindImageSource, bindingOfImageAlt, bindingOfImageFirst, bindingOfImageSource, bindingOfTextDirection, bindTextDirection, bindTextDirection, getImageAlt, getImageFirst, getImageSource, getTextDirection, setImageAlt, setImageFirst, setImageSource, setTextDirection

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_HEIGHT

public static final java.lang.String DEFAULT_IMAGE_HEIGHT

Default value of property imageHeight.

DEFAULT_IMAGE_WIDTH

public static final java.lang.String DEFAULT_IMAGE_WIDTH

Default value of property imageWidth.

DEFAULT_SIZE

public static final WDLinkSize DEFAULT_SIZE

Default value of property size.

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

Default value of property text.

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of property wrapping.

Method Detail

bindImageHeight

public void bindImageHeight(java.lang.String path)

Binds property imageHeight to the context attribute specified by path.

Parameters:

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

bindImageHeight

public void bindImageHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageHeight

public java.lang.String bindingOfImageHeight()

Binding path of property imageHeight.

Returns:

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

getImageHeight

public java.lang.String getImageHeight()

Returns the value of the imageHeight property. The initial value is "". Determines the height (CSS size) of the image.

Returns:

the current value of the imageHeight property

See Also:

setImageHeight(String)

setImageHeight

public void setImageHeight(java.lang.String value)

Sets property imageHeight to the new value.

Parameters:

value - the new value of the imageHeight property

See Also:

getImageHeight()

bindImageWidth

public void bindImageWidth(java.lang.String path)

Binds property imageWidth to the context attribute specified by path.

Parameters:

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

bindImageWidth

public void bindImageWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageWidth

public java.lang.String bindingOfImageWidth()

Binding path of property imageWidth.

Returns:

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

getImageWidth

public java.lang.String getImageWidth()

Returns the value of the imageWidth property. The initial value is "". Determines the width (CSS size) of the image.

Returns:

the current value of the imageWidth property

See Also:

setImageWidth(String)

setImageWidth

public void setImageWidth(java.lang.String value)

Sets property imageWidth to the new value.

Parameters:

value - the new value of the imageWidth property

See Also:

getImageWidth()

bindSize

public void bindSize(java.lang.String path)

Binds property size to the context attribute specified by path.

Parameters:

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

bindSize

public void bindSize(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSize

public java.lang.String bindingOfSize()

Binding path of property size.

Returns:

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

getSize

public WDLinkSize getSize()

Returns the value of the size property. The initial value is WDLinkSize.STANDARD. Determines the symbolic size of this link.

Returns:

the current value of the size property

See Also:

setSize(WDLinkSize)

setSize

public void setSize(WDLinkSize value)

Sets property size to the new value.

Parameters:

value - the new value of the size property

See Also:

getSize()

bindText

public void bindText(java.lang.String path)

Binds property text to the context attribute specified by path.

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public java.lang.String bindingOfText()

Binding path of property text.

Returns:

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

getText

public java.lang.String getText()

Returns the value of the text property. The initial value is null. The text of the caption.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(java.lang.String value)

Sets property text to the new value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindWrapping

public void bindWrapping(java.lang.String path)

Binds property wrapping to the context attribute specified by path.

Parameters:

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

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWrapping

public java.lang.String bindingOfWrapping()

Binding path of property wrapping.

Returns:

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

getWrapping

public boolean getWrapping()

Returns the value of the wrapping property. The initial value is false. Determines if the link wraps its text.

Returns:

the current value of the wrapping property

See Also:

setWrapping(boolean)

setWrapping

public void setWrapping(boolean value)

Sets property wrapping to the new value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()