org.icefaces.mobi.component.camera

Class CameraBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.camera.CameraBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ICamera

Direct Known Subclasses:

Camera

public abstract class CameraBase
extends javax.faces.component.UIComponentBase
implements ICamera

Renders a button to access the camera on supported clients, and allows uploading and storing an image from the camera or image gallery. The component will fallback to a input file type on unsupported browsers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CameraBase.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.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
CameraBase()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getButtonImage() Return the value of the buttonImage property.
java.lang.String	getButtonLabel() Return the value of the buttonLabel property.
java.lang.Object	getCaptureButtonImage() Return the value of the captureButtonImage property.
java.lang.String	getCaptureMessageLabel() Return the value of the captureMessageLabel property.
java.lang.String	getFamily()
int	getMaxheight() Return the value of the maxheight property.
int	getMaxwidth() Return the value of the maxwidth property.
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.
java.util.Map	getValue() Return the value of the value property.
javax.el.MethodExpression	getValueChangeListener() Return the value of the valueChangeListener property.
boolean	isDisabled() Return the value of the disabled property.
boolean	isImmediate() Return the value of the immediate property.
protected boolean	isPropertySet(java.lang.String finder)
void	setButtonImage(java.lang.Object buttonImage) Set the value of the buttonImage property.
void	setButtonLabel(java.lang.String buttonLabel) Set the value of the buttonLabel property.
void	setCaptureButtonImage(java.lang.Object captureButtonImage) Set the value of the captureButtonImage 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	setImmediate(boolean immediate) Set the value of the immediate property.
void	setMaxheight(int maxheight) Set the value of the maxheight property.
void	setMaxwidth(int maxwidth) Set the value of the maxwidth 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	setValue(java.util.Map value) Set the value of the value property.
void	setValueChangeListener(javax.el.MethodExpression valueChangeListener) Set the value of the valueChangeListener property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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

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

CameraBase

public CameraBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setButtonImage

public void setButtonImage(java.lang.Object buttonImage)

Set the value of the buttonImage property.

Contents: The image to be displayed on the button, instead of a text label. The value may resolve to a byte array, an instance of IceOutputResource or a String containing the URL of the image.

Specified by:

setButtonImage in interface ICamera

getButtonImage

public java.lang.Object getButtonImage()

Return the value of the buttonImage property.

Contents: The image to be displayed on the button, instead of a text label. The value may resolve to a byte array, an instance of IceOutputResource or a String containing the URL of the image.

Specified by:

getButtonImage in interface ICamera

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)

Set the value of the buttonLabel property.

Contents: The label to be displayed on the button.

Specified by:

setButtonLabel in interface ICamera

getButtonLabel

public java.lang.String getButtonLabel()

Return the value of the buttonLabel property.

Contents: The label to be displayed on the button. Default = 'Camera'.

Specified by:

getButtonLabel in interface ICamera

setCaptureButtonImage

public void setCaptureButtonImage(java.lang.Object captureButtonImage)

Set the value of the captureButtonImage property.

Contents: The image to be displayed on the button on a successful image capture, instead of a text label. The value may resolve to a byte array, an instance of IceOutputResource or a String containing the URL of the image. This attribute is only applied if 'buttonImage' is specified.

Specified by:

setCaptureButtonImage in interface ICamera

getCaptureButtonImage

public java.lang.Object getCaptureButtonImage()

Return the value of the captureButtonImage property.

Contents: The image to be displayed on the button on a successful image capture, instead of a text label. The value may resolve to a byte array, an instance of IceOutputResource or a String containing the URL of the image. This attribute is only applied if 'buttonImage' is specified.

Specified by:

getCaptureButtonImage in interface ICamera

setCaptureMessageLabel

public void setCaptureMessageLabel(java.lang.String captureMessageLabel)

Set the value of the captureMessageLabel property.

Contents: The message to be displayed on the button on a successful image capture.

Specified by:

setCaptureMessageLabel in interface ICamera

getCaptureMessageLabel

public java.lang.String getCaptureMessageLabel()

Return the value of the captureMessageLabel property.

Contents: The message to be displayed on the button on a successful image capture. Default = 'Photo Captured'.

Specified by:

getCaptureMessageLabel in interface ICamera

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 ICamera

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 ICamera

setImmediate

public void setImmediate(boolean immediate)

Set the value of the immediate property.

Contents: Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.

Specified by:

setImmediate in interface ICamera

isImmediate

public boolean isImmediate()

Return the value of the immediate property.

Contents: Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. Default = 'false'.

Specified by:

isImmediate in interface ICamera

setMaxheight

public void setMaxheight(int maxheight)

Set the value of the maxheight property.

Contents: The maximum allowed height of the image on those platforms where image cropping is supported. A value of 0 uses the whole height of the captured image.

Specified by:

setMaxheight in interface ICamera

getMaxheight

public int getMaxheight()

Return the value of the maxheight property.

Contents: The maximum allowed height of the image on those platforms where image cropping is supported. A value of 0 uses the whole height of the captured image. Default = 'Integer.MIN_VALUE'.

Specified by:

getMaxheight in interface ICamera

setMaxwidth

public void setMaxwidth(int maxwidth)

Set the value of the maxwidth property.

Contents: The maxium allowed width of the image on those platforms where image cropping is supported. A value of 0 uses the whole width of the captured image.

Specified by:

setMaxwidth in interface ICamera

getMaxwidth

public int getMaxwidth()

Return the value of the maxwidth property.

Contents: The maxium allowed width of the image on those platforms where image cropping is supported. A value of 0 uses the whole width of the captured image. Default = 'Integer.MIN_VALUE'.

Specified by:

getMaxwidth in interface ICamera

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 ICamera

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 ICamera

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 ICamera

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 ICamera

setTabindex

public void setTabindex(int tabindex)

Set the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

setTabindex in interface ICamera

getTabindex

public int getTabindex()

Return the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

getTabindex in interface ICamera

setValue

public void setValue(java.util.Map value)

Set the value of the value property.

Contents: The map object for the uploaded contents. Must resolve to a java.util.Map. The uploaded file will be available in the map with the key of "file".

Specified by:

setValue in interface ICamera

getValue

public java.util.Map getValue()

Return the value of the value property.

Contents: The map object for the uploaded contents. Must resolve to a java.util.Map. The uploaded file will be available in the map with the key of "file".

Specified by:

getValue in interface ICamera

setValueChangeListener

public void setValueChangeListener(javax.el.MethodExpression valueChangeListener)

Set the value of the valueChangeListener property.

Contents: MethodExpression representing a value change listener method that will be notified when a new value has been set for this component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void.

Specified by:

setValueChangeListener in interface ICamera

getValueChangeListener

public javax.el.MethodExpression getValueChangeListener()

Return the value of the valueChangeListener property.

Contents: MethodExpression representing a value change listener method that will be notified when a new value has been set for this component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void.

Specified by:

getValueChangeListener in interface ICamera

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