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

Interface IWDLink

All Superinterfaces:

IWDAbstractCaption, IWDTableCellEditor, IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDFileDownload, IWDLinkToAction, IWDLinkToURL, IWDToolBarLinkToAction, IWDToolBarLinkToURL

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!

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_HEIGHT Default value of the imageHeight property is "".
static String	DEFAULT_IMAGE_WIDTH Default value of the imageWidth property is "".
static WDLinkSize	DEFAULT_SIZE Default value of the size property is WDLinkSize.STANDARD.
static String	DEFAULT_TEXT Default value of the text property is "".
static boolean	DEFAULT_WRAPPING Default value of the wrapping property is false.

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 the imageHeight property to the context attribute specified by the given attribute info.
void	bindImageHeight(String path) Binds the imageHeight property to the context attribute specified by the given path.
void	bindImageWidth(IWDAttributeInfo attributeInfo) Binds the imageWidth property to the context attribute specified by the given attribute info.
void	bindImageWidth(String path) Binds the imageWidth property to the context attribute specified by the given path.
String	bindingOfImageHeight() Returns the binding path of the imageHeight property.
String	bindingOfImageWidth() Returns the binding path of the imageWidth property.
String	bindingOfSize() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
String	bindingOfText() Returns the binding path of the text property.
String	bindingOfWrapping() Returns the binding path of the wrapping property.
void	bindSize(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
void	bindSize(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
void	bindText(IWDAttributeInfo attributeInfo) Binds the text property to the context attribute specified by the given attribute info.
void	bindText(String path) Binds the text property to the context attribute specified by the given path.
void	bindWrapping(IWDAttributeInfo attributeInfo) Binds the wrapping property to the context attribute specified by the given attribute info.
void	bindWrapping(String path) Binds the wrapping property to the context attribute specified by the given path.
String	getImageHeight() Returns the value of the imageHeight property.
String	getImageWidth() Returns the value of the imageWidth property.
WDLinkSize	getSize() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
String	getText() Returns the value of the text property.
boolean	getWrapping() Returns the value of the wrapping property.
void	setImageHeight(String value) Sets the imageHeight property to the given value.
void	setImageWidth(String value) Sets the imageWidth property to the given value.
void	setSize(WDLinkSize value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
void	setText(String value) Sets the text property to the given value.
void	setWrapping(boolean value) Sets the wrapping property to the given 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_IMAGE_HEIGHT

public static final String DEFAULT_IMAGE_HEIGHT

Default value of the imageHeight property is "".

See Also:

Constant Field Values

DEFAULT_IMAGE_WIDTH

public static final String DEFAULT_IMAGE_WIDTH

Default value of the imageWidth property is "".

See Also:

Constant Field Values

DEFAULT_SIZE

public static final WDLinkSize DEFAULT_SIZE

Default value of the size property is WDLinkSize.STANDARD.

DEFAULT_TEXT

public static final String DEFAULT_TEXT

Default value of the text property is "".

See Also:

Constant Field Values

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of the wrapping property is false.

See Also:

Constant Field Values

Method Detail

bindImageHeight

public void bindImageHeight(String path)

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

Parameters:

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

bindImageHeight

public void bindImageHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageHeight

public String bindingOfImageHeight()

Returns the binding path of the imageHeight property.

Returns:

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

getImageHeight

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

Sets the imageHeight property to the given value.

Parameters:

value - the new value of the imageHeight property

See Also:

getImageHeight()

bindImageWidth

public void bindImageWidth(String path)

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

Parameters:

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

bindImageWidth

public void bindImageWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageWidth

public String bindingOfImageWidth()

Returns the binding path of the imageWidth property.

Returns:

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

getImageWidth

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

Sets the imageWidth property to the given value.

Parameters:

value - the new value of the imageWidth property

See Also:

getImageWidth()

bindSize

public void bindSize(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

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

Parameters:

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

bindSize

public void bindSize(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

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

Parameters:

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

bindingOfSize

public String bindingOfSize()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Returns the binding path of the size property.

Returns:

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

getSize

public WDLinkSize getSize()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

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)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Sets the size property to the given value.

Parameters:

value - the new value of the size property

See Also:

getSize()

bindText

public void bindText(String path)

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

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public String bindingOfText()

Returns the binding path of the text property.

Returns:

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

getText

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

Sets the text property to the given value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindWrapping

public void bindWrapping(String path)

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

Parameters:

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

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWrapping

public String bindingOfWrapping()

Returns the binding path of the wrapping property.

Returns:

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

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()