org.icefaces.mobi.component.microphone

Class MicrophoneBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.microphone.MicrophoneBase

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, IMicrophone

Direct Known Subclasses:

Microphone

public abstract class MicrophoneBase
extends javax.faces.component.UIComponentBase
implements IMicrophone

Renders a button to access the device audio recording features. The component will fall back to input file type element on unsupported clients. The audio file can then be uploaded, processed and stored on the server.

Nested Class Summary

Nested Classes

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

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.
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	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	setImmediate(boolean immediate) Set the value of the immediate 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

MicrophoneBase

public MicrophoneBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)

Set the value of the buttonLabel property.

Contents: The button label.

Specified by:

setButtonLabel in interface IMicrophone

getButtonLabel

public java.lang.String getButtonLabel()

Return the value of the buttonLabel property.

Contents: The button label. Default = 'Record'.

Specified by:

getButtonLabel in interface IMicrophone

setCaptureMessageLabel

public void setCaptureMessageLabel(java.lang.String captureMessageLabel)

Set the value of the captureMessageLabel property.

Contents: The button label to be displayed upon successful capture of audio from the device.

Specified by:

setCaptureMessageLabel in interface IMicrophone

getCaptureMessageLabel

public java.lang.String getCaptureMessageLabel()

Return the value of the captureMessageLabel property.

Contents: The button label to be displayed upon successful capture of audio from the device. Default = 'Audio Captured'.

Specified by:

getCaptureMessageLabel in interface IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

setTabindex

public void setTabindex(int tabindex)

Set the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

setTabindex in interface IMicrophone

getTabindex

public int getTabindex()

Return the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

getTabindex in interface IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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 IMicrophone

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