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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDRFIDReader

extends IWDUIElement

Web Dynpro RFIDReader API. RFIDReader is an invisible UIElement that enables a RFID Reader to be used within Pocket PC Internet Explorer. As prerequisite the ActiveX control provided by SAP AG must be installed on the local device.

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

Field Summary

static java.lang.String	DEFAULT_CLASS_ID Default value of property classId.
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

void	bindClassId(IWDAttributeInfo attributeInfo) Binds property classId to the context attribute specified by the given attribute info.
void	bindClassId(java.lang.String path) Binds property classId to the context attribute specified by path.
java.lang.String	bindingOfClassId() Binding path of property classId.
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	getClassId() Returns the value of the classId property.
java.lang.String	getKeyCode() Returns the value of the keyCode property.
IWDAction	getOnRead() Returns the action to which the event onRead is mapped.
IWDParameterMapping	mappingOfOnRead() Returns the parameter mapping of event onRead.
void	setClassId(java.lang.String value) Sets property classId to the new value.
void	setKeyCode(java.lang.String value) Sets property keyCode to the new value.
void	setOnRead(IWDAction action) Maps the event onRead 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_CLASS_ID

public static final java.lang.String DEFAULT_CLASS_ID

Default value of property classId.

DEFAULT_KEY_CODE

public static final java.lang.String DEFAULT_KEY_CODE

Default value of property keyCode.

Method Detail

getOnRead

public IWDAction getOnRead()

Returns the action to which the event onRead is mapped. Event that will be triggered if RFID tags are read by pressing the RFID key, for example.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnRead()

setOnRead

public void setOnRead(IWDAction action)

Maps the event onRead to the given action.

Parameters:

action - the action for the event

See Also:

getOnRead()

mappingOfOnRead

public IWDParameterMapping mappingOfOnRead()

Returns the parameter mapping of event onRead.

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:

• int failureCount - Event parameter returned to tell the number of tags that are failed to be read.
• String tagList - Event parameter returned to tell the raw data containing all the tags read. Note the internal format is vendor specific.

Returns:

parameter mapping list.

See Also:

getOnRead()

bindClassId

public void bindClassId(java.lang.String path)

Binds property classId to the context attribute specified by path.

Parameters:

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

bindClassId

public void bindClassId(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfClassId

public java.lang.String bindingOfClassId()

Binding path of property classId.

Returns:

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

getClassId

public java.lang.String getClassId()

Returns the value of the classId property. The initial value is "". Must be set to the ActiveX control name that is used to create the RFIDReader object. In the following example the classId is et to be SAP.RfidG4. var reader = new ActiveXObject('SAP.RfidG4');

Returns:

the current value of the classId property

See Also:

setClassId(String)

setClassId

public void setClassId(java.lang.String value)

Sets property classId to the new value.

Parameters:

value - the new value of the classId property

See Also:

getClassId()

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