com.hound.android.sdk

Class VoiceSearchUIConfig

java.lang.Object

com.hound.android.sdk.VoiceSearchUIConfig

public class VoiceSearchUIConfig
extends java.lang.Object

Use to override the default color and behavior of the HoundifyVoiceSearchActivity. This can be configure at application startup and applied by calling Houndify.setVoiceSearchUIConfig()

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Integer	buttonColor
protected java.lang.String	helpURL
protected java.lang.String	hintSubtitleText
protected java.lang.String	hintTitleText
protected java.lang.Integer	panelColor
protected java.lang.Integer	scrimAlpha
protected java.lang.Integer	scrimColor
protected java.lang.Integer	searchButtonColor
protected java.lang.String	subtitleText
protected java.lang.Integer	textColor
protected android.graphics.Typeface	textTypeFace
protected java.lang.String	titleText
protected boolean	useBlackAttributionImage
protected VoiceSearchUIHelpClickListener	voiceSearchUIHelpClickListener

Constructor Summary

Constructors

Constructor and Description
VoiceSearchUIConfig()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	getButtonColor() Returns the color used for drawing all the buttons.
java.lang.String	getHelpURL() Returns the help URL associated with the help button.
java.lang.String	getHintSubtitleText() Returns the hint subtitle text, of null if none is set.
java.lang.String	getHintTitleText() Returns the current hint text, null if not set.
java.lang.Integer	getPanelColor() Gets the background color used in the panel containing the search button.
java.lang.Integer	getScrimAlpha() Value of 0-255 for Srim's opacity.
java.lang.Integer	getScrimColor()
java.lang.Integer	getSearchButtonColor() Returns the search button color or null if default color is being used.
java.lang.String	getSubtitleText() Returns the subtitle text or null if not set.
java.lang.Integer	getTextColor() Returns the color to use for rendering all text.
android.graphics.Typeface	getTextTypeFace() Returns the TypeFace being used for text or null if default Roboto is being used.
java.lang.String	getTitleText() Returns the title text on the search panel.
VoiceSearchUIHelpClickListener	getVoiceSearchUIHelpClickListener() Returns the active voiceSearchUIHelpClickListener, null if none is configured.
boolean	isUseBlackAttributionImage() Returns true if the black attribution image is being used, false if white is being used.
VoiceSearchUIConfig	setButtonColor(java.lang.Integer buttonColor) Sets the color to use for all the buttons except the search button
VoiceSearchUIConfig	setHelpURL(java.lang.String helpURL) Sets a help URL which will be linked with the help button and triggered when click.
VoiceSearchUIConfig	setHintSubtitleText(java.lang.String hintSubtitleText) Sets the hint subtitle text to be display below the Hint Title Text.
VoiceSearchUIConfig	setHintTitleText(java.lang.String hintTitleText) Sets the hint text used if user delays saying request.
VoiceSearchUIConfig	setPanelColor(java.lang.Integer panelColor) Sets the background color used in the panel containing the search button.
VoiceSearchUIConfig	setScrimAlpha(java.lang.Integer scrimAlpha) Set value of 0-255 for Srim's opacity
VoiceSearchUIConfig	setScrimColor(java.lang.Integer scrimColor)
VoiceSearchUIConfig	setSearchButtonColor(java.lang.Integer searchButtonColor) Sets the search button color
VoiceSearchUIConfig	setSubtitleText(java.lang.String subtitleText) Sets the subtitle text to be display the title text.
VoiceSearchUIConfig	setTextColor(java.lang.Integer textColor) Sets the text color for all text.
VoiceSearchUIConfig	setTextTypeFace(android.graphics.Typeface textTypeFace) Set the text type face to use for all text.
VoiceSearchUIConfig	setTitleText(java.lang.String titleText) Sets the title text on the search panel (default is "Speak Now")
VoiceSearchUIConfig	setUseBlackAttributionImage(boolean useBlackAttributionImage) Set true to use the black Houndification attribution image in place of the default white image.
VoiceSearchUIConfig	setVoiceSearchUIHelpClickListener(VoiceSearchUIHelpClickListener voiceSearchUIHelpClickListener) Sets a help button click listener for handling the listening pages help button click directly.

Methods inherited from class java.lang.Object

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

Field Detail

panelColor

protected java.lang.Integer panelColor

scrimColor

protected java.lang.Integer scrimColor

scrimAlpha

protected java.lang.Integer scrimAlpha

textColor

protected java.lang.Integer textColor

textTypeFace

protected android.graphics.Typeface textTypeFace

searchButtonColor

protected java.lang.Integer searchButtonColor

buttonColor

protected java.lang.Integer buttonColor

titleText

protected java.lang.String titleText

subtitleText

protected java.lang.String subtitleText

hintTitleText

protected java.lang.String hintTitleText

hintSubtitleText

protected java.lang.String hintSubtitleText

useBlackAttributionImage

protected boolean useBlackAttributionImage

helpURL

protected java.lang.String helpURL

voiceSearchUIHelpClickListener

protected VoiceSearchUIHelpClickListener voiceSearchUIHelpClickListener

Constructor Detail

VoiceSearchUIConfig

public VoiceSearchUIConfig()

Method Detail

getPanelColor

public java.lang.Integer getPanelColor()

Gets the background color used in the panel containing the search button.

Returns:

color value to use, or null if default color should be used.

setPanelColor

public VoiceSearchUIConfig setPanelColor(java.lang.Integer panelColor)

Sets the background color used in the panel containing the search button. This can be set to null to use the default color.

Parameters:

panelColor -

getScrimColor

public java.lang.Integer getScrimColor()

setScrimColor

public VoiceSearchUIConfig setScrimColor(java.lang.Integer scrimColor)

setTextColor

public VoiceSearchUIConfig setTextColor(java.lang.Integer textColor)

Sets the text color for all text. Set to null to use default color.

Parameters:

textColor -

Returns:

getTextColor

public java.lang.Integer getTextColor()

Returns the color to use for rendering all text.

Returns:

null if default color is being used.

setTextTypeFace

public VoiceSearchUIConfig setTextTypeFace(android.graphics.Typeface textTypeFace)

Set the text type face to use for all text.

Parameters:

textTypeFace -

getTextTypeFace

public android.graphics.Typeface getTextTypeFace()

Returns the TypeFace being used for text or null if default Roboto is being used.

Returns:

setSearchButtonColor

public VoiceSearchUIConfig setSearchButtonColor(java.lang.Integer searchButtonColor)

Sets the search button color

Parameters:

searchButtonColor -

Returns:

getSearchButtonColor

public java.lang.Integer getSearchButtonColor()

Returns the search button color or null if default color is being used.

Returns:

setButtonColor

public VoiceSearchUIConfig setButtonColor(java.lang.Integer buttonColor)

Sets the color to use for all the buttons except the search button

Parameters:

buttonColor -

getButtonColor

public java.lang.Integer getButtonColor()

Returns the color used for drawing all the buttons.

Returns:

getScrimAlpha

public java.lang.Integer getScrimAlpha()

Value of 0-255 for Srim's opacity.

Returns:

integer value of 0-255 or null if not set

setScrimAlpha

public VoiceSearchUIConfig setScrimAlpha(java.lang.Integer scrimAlpha)

Set value of 0-255 for Srim's opacity

Parameters:

scrimAlpha -

getTitleText

public java.lang.String getTitleText()

Returns the title text on the search panel.

Returns:

text string or null if not set.

setTitleText

public VoiceSearchUIConfig setTitleText(java.lang.String titleText)

Sets the title text on the search panel (default is "Speak Now")

Parameters:

titleText -

getSubtitleText

public java.lang.String getSubtitleText()

Returns the subtitle text or null if not set.

Returns:

setSubtitleText

public VoiceSearchUIConfig setSubtitleText(java.lang.String subtitleText)

Sets the subtitle text to be display the title text.

Parameters:

subtitleText -

setHintTitleText

public VoiceSearchUIConfig setHintTitleText(java.lang.String hintTitleText)

Sets the hint text used if user delays saying request.

Parameters:

hintTitleText -

getHintTitleText

public java.lang.String getHintTitleText()

Returns the current hint text, null if not set.

Returns:

setHintSubtitleText

public VoiceSearchUIConfig setHintSubtitleText(java.lang.String hintSubtitleText)

Sets the hint subtitle text to be display below the Hint Title Text.

Parameters:

hintSubtitleText -

getHintSubtitleText

public java.lang.String getHintSubtitleText()

Returns the hint subtitle text, of null if none is set.

Returns:

setUseBlackAttributionImage

public VoiceSearchUIConfig setUseBlackAttributionImage(boolean useBlackAttributionImage)

Set true to use the black Houndification attribution image in place of the default white image.

Parameters:

useBlackAttributionImage - true for black image, false for white image.

isUseBlackAttributionImage

public boolean isUseBlackAttributionImage()

Returns true if the black attribution image is being used, false if white is being used.

Returns:

setHelpURL

public VoiceSearchUIConfig setHelpURL(java.lang.String helpURL)

Sets a help URL which will be linked with the help button and triggered when click. Alternatively, a voiceSearchUIHelpClickListener can be set to handle the help click directly. See setVoiceSearchUIHelpClickListener(). If no URL is set then the help button won't be shown.

Parameters:

helpURL -

getHelpURL

public java.lang.String getHelpURL()

Returns the help URL associated with the help button.

Returns:

setVoiceSearchUIHelpClickListener

public VoiceSearchUIConfig setVoiceSearchUIHelpClickListener(VoiceSearchUIHelpClickListener voiceSearchUIHelpClickListener)

Sets a help button click listener for handling the listening pages help button click directly. Or, setHelpURL() can be used to set a URL.

Parameters:

voiceSearchUIHelpClickListener -

getVoiceSearchUIHelpClickListener

public VoiceSearchUIHelpClickListener getVoiceSearchUIHelpClickListener()

Returns the active voiceSearchUIHelpClickListener, null if none is configured.

Returns: