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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDBarCodeReader

extends IWDUIElement

Web Dynpro BarCodeReader API. BarCodeReader is an invisible UIElement that enables a BarCode Scanner to be used within Pocket PC Internet Explorer. Currently only vendors of Intermec and Symbol are supported.

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

Field Summary

static WDBarCodeReaderType

DEFAULT_TYPE Default value of property type.

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	getOnRead() Returns the action to which the event onRead is mapped.
WDBarCodeReaderType	getType() Returns the value of the type property.
IWDParameterMapping	mappingOfOnRead() Returns the parameter mapping of event onRead.
void	setOnRead(IWDAction action) Maps the event onRead to the given action.
void	setType(WDBarCodeReaderType value) Sets property type to the new value.

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 WDBarCodeReaderType DEFAULT_TYPE

Default value of property type.

Method Detail

getOnRead

public IWDAction getOnRead()

Returns the action to which the event onRead is mapped. Event that will be triggered if a barcode is scanned.

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:

• String barCode - Event parameter for scanned barcode.
• String type - Event parameter for the type of barcode standards.

Returns:

parameter mapping list.

See Also:

getOnRead()

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

Returns the value of the type property. The initial value is WDBarCodeReaderType.INTERMEC. Determines the type of reader to be used for bar code reading. Note that the proper type is device-dependent.

Returns:

the current value of the type property

See Also:

setType(WDBarCodeReaderType)

setType

public void setType(WDBarCodeReaderType value)

Sets property type to the new value.

Parameters:

value - the new value of the type property

See Also:

getType()