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

All Superinterfaces:

IWDAbstractCaption, IWDLink, IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDLinkToAction

extends IWDLink

Web Dynpro LinkToAction API. LinkToAction represents a hypertext link that triggers off a Web Dynpro action when navigated.

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

Field Summary

static WDLinkType

DEFAULT_TYPE Default value of property type.

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

DEFAULT_IMAGE_HEIGHT, DEFAULT_IMAGE_WIDTH, DEFAULT_SIZE, DEFAULT_TEXT, DEFAULT_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

java.lang.String	bindingOfType() Binding path of property type.
void	bindType(IWDAttributeInfo attributeInfo) Binds property type to the context attribute specified by the given attribute info.
void	bindType(java.lang.String path) Binds property type to the context attribute specified by path.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
WDLinkType	getType() Returns the value of the type property.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setType(WDLinkType value) Sets property type to the new value.

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

bindImageHeight, bindImageHeight, bindImageWidth, bindImageWidth, bindingOfImageHeight, bindingOfImageWidth, bindingOfSize, bindingOfText, bindingOfWrapping, bindSize, bindSize, bindText, bindText, bindWrapping, bindWrapping, getImageHeight, getImageWidth, getSize, getText, getWrapping, setImageHeight, setImageWidth, setSize, setText, setWrapping

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_TYPE

public static final WDLinkType DEFAULT_TYPE

Default value of property type.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. The action performed when the link is activated.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnAction()

bindType

public void bindType(java.lang.String path)

Binds property type to the context attribute specified by path.

Parameters:

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

bindType

public void bindType(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfType

public java.lang.String bindingOfType()

Binding path of property type.

Returns:

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

getType

public WDLinkType getType()

Returns the value of the type property. The initial value is WDLinkType.FUNCTION. Sets the type for the Link control. For the parameter values see enumeration 'LinkType'. Default is 'FUNCTION'.

Returns:

the current value of the type property

See Also:

setType(WDLinkType)

setType

public void setType(WDLinkType value)

Sets property type to the new value.

Parameters:

value - the new value of the type property

See Also:

getType()