org.icefaces.mobi.component.scan

Class ScanBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.icefaces.mobi.component.scan.ScanBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IScan

Direct Known Subclasses:

Scan

public abstract class ScanBase
extends javax.faces.component.UIInput
implements IScan

The Scan component captures a QR code value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScanBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ScanBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getButtonLabel() Return the value of the buttonLabel property.
java.lang.String	getCaptureMessageLabel() Return the value of the captureMessageLabel property.
java.lang.String	getFamily()
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
int	getTabindex() Return the value of the tabindex property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setButtonLabel(java.lang.String buttonLabel) Set the value of the buttonLabel property.
void	setCaptureMessageLabel(java.lang.String captureMessageLabel) Set the value of the captureMessageLabel property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTabindex(int tabindex) Set the value of the tabindex property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

ScanBase

public ScanBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)

Set the value of the buttonLabel property.

Contents: The button label for this component.

Specified by:

setButtonLabel in interface IScan

getButtonLabel

public java.lang.String getButtonLabel()

Return the value of the buttonLabel property.

Contents: The button label for this component. Default = 'Scan Code'.

Specified by:

getButtonLabel in interface IScan

setCaptureMessageLabel

public void setCaptureMessageLabel(java.lang.String captureMessageLabel)

Set the value of the captureMessageLabel property.

Contents: The message displays upon successful capture from device.

Specified by:

setCaptureMessageLabel in interface IScan

getCaptureMessageLabel

public java.lang.String getCaptureMessageLabel()

Return the value of the captureMessageLabel property.

Contents: The message displays upon successful capture from device. Default = 'Scan Captured'.

Specified by:

getCaptureMessageLabel in interface IScan

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted.

Specified by:

setDisabled in interface IScan

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted. Default = 'false'.

Specified by:

isDisabled in interface IScan

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

setStyle in interface IScan

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

getStyle in interface IScan

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IScan

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IScan

setTabindex

public void setTabindex(int tabindex)

Set the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

setTabindex in interface IScan

getTabindex

public int getTabindex()

Return the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

getTabindex in interface IScan

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent