codeScanner (PrimeFaces Extensions VDL Documentation)

All Tags

Description:

CodeScanner allows you to scan bar and QR codes using a device camera. Client behavior events: codeScanned - fires when a code is scanned (org.primefaces.event.SelectEvent).

Component Information
Info	Value
Component Type	`org.primefaces.extensions.component.CodeScanner`
Handler Class	None
Renderer Type	`org.primefaces.extensions.component.CodeScannerRenderer`
Description	None

Attributes
Name	Required	Type	Description
`autoStart`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating the scanner should start when rendered. Default is true.
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An el expression referring to a server side UIComponent instance in a backing bean.
`deviceId`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of the video input device to use. Default is null which selects the first video input device.
`for`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client id of the input this scanner will set the value to. Default is null.
`height`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Height of video in CSS pixels.
`id`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Unique identifier of the component in a namingContainer.
`onerror`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a code scan fails.
`onsuccess`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a code scan is successful.
`rendered`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
`style`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Inline style of the component.
`styleClass`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class of the component.
`type`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Code type ("multi", "bar" or "qr"). Default "multi".
`video`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating a video element should be rendered. Default is true.
`widgetVar`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the client side widget.
`width`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Width of video in CSS pixels.

All Tags

Output generated by Vdldoc View Declaration Language Documentation Generator.