com.sap.tc.webdynpro.clientserver.uielib.mobile.api
Interface IWDFunctionKey

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDFunctionKey

extends IWDUIElement

Web Dynpro FunctionKey API. FunctionKey is an invisible UIElement that allows applications to map a Reader's physical key to a Web Dynpro action.

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

Field Summary

static java.lang.String

DEFAULT_KEY_CODE Default value of property keyCode.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

java.lang.String	bindingOfKeyCode() Binding path of property keyCode.
void	bindKeyCode(IWDAttributeInfo attributeInfo) Binds property keyCode to the context attribute specified by the given attribute info.
void	bindKeyCode(java.lang.String path) Binds property keyCode to the context attribute specified by path.
java.lang.String	getKeyCode() Returns the value of the keyCode property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setKeyCode(java.lang.String value) Sets property keyCode to the new value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.

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_KEY_CODE

public static final java.lang.String DEFAULT_KEY_CODE

Default value of property keyCode.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. Event that will be triggered if the mapped function key is pressed.

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()

bindKeyCode

public void bindKeyCode(java.lang.String path)

Binds property keyCode to the context attribute specified by path.

Parameters:

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

bindKeyCode

public void bindKeyCode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfKeyCode

public java.lang.String bindingOfKeyCode()

Binding path of property keyCode.

Returns:

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

getKeyCode

public java.lang.String getKeyCode()

Returns the value of the keyCode property. The initial value is "". Property to specify the function key representation in the browser for the key mapping. It is vendor and browser dependent and corresponds exactly to the meta tag attribute name http-equiv. For example, the keyCode is IBrowse_OnKey49 in the follwoing example.

Returns:

the current value of the keyCode property

See Also:

setKeyCode(String)

setKeyCode

public void setKeyCode(java.lang.String value)

Sets property keyCode to the new value.

Parameters:

value - the new value of the keyCode property

See Also:

getKeyCode()