android.lib.widget.snackbar

Class Snackbar

java.lang.Object

android.lib.widget.snackbar.Snackbar

public class Snackbar
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Snackbar.Gravity Constant values for defining the placement of the Snackbar within its container.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_INFINITE Shows the text notification for an infinite period of time.
static int	LENGTH_LONG Shows the text notification for a long period of time.
static int	LENGTH_SHORT Shows the text notification for a short period of time.

Method Summary

Methods

Modifier and Type	Method and Description
void	hide() Hides the Snackbar if it is currently showing; otherwise, does nothing.
Snackbar	setAction(java.lang.CharSequence action, int color, android.view.View.OnClickListener listener) Sets the action button text and text color, and the botton's click event listener.
Snackbar	setAction(int resId, int color, android.view.View.OnClickListener listener) Sets the action button text and text color, and the botton's click event listener.
Snackbar	setActions(int resId1, int color1, android.view.View.OnClickListener listener1, int resId2, int color2, android.view.View.OnClickListener listener2) Sets the text, text color, and the click event listeners for the two action buttons.
Snackbar	setDuration(int duration) Sets how long to show the text notification for.
Snackbar	setGravity(Snackbar.Gravity gravity) Sets the placement of the Snackbar within its container.
Snackbar	setText(java.lang.CharSequence s) Sets the string value of the Snackbar.
Snackbar	setText(int resId) Sets the string value of the Snackbar.
Snackbar	setTextColor(int color) Sets the text color of the string to be displayed.
void	show() Shows the Snackbar.
static Snackbar	with(android.app.Activity activity) Creates a Snackbar with the given Activity as its container.

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH_SHORT

public static final int LENGTH_SHORT

Shows the text notification for a short period of time. This time could be user-definable. This is the default.

See Also:

{#setDuration(int)}, Constant Field Values

LENGTH_LONG

public static final int LENGTH_LONG

Shows the text notification for a long period of time. This time could be user-definable.

See Also:

{#setDuration(int)}, Constant Field Values

LENGTH_INFINITE

public static final int LENGTH_INFINITE

Shows the text notification for an infinite period of time.

See Also:

Constant Field Values

Method Detail

setDuration

public Snackbar setDuration(int duration)

Sets how long to show the text notification for.

Parameters:

duration - The duration to show the text notification for.

Returns:

The original Snackbar object.

See Also:

#LENGTH_SHORT}, #LENGTH_LONG}

setGravity

public Snackbar setGravity(Snackbar.Gravity gravity)

Sets the placement of the Snackbar within its container.

Parameters:

gravity - The placement, either Snackbar.Gravity.TOP or Snackbar.Gravity.BOTTOM.

Returns:

The original Snackbar object.

See Also:

Gravity#TOP}, Gravity#BOTTOM}

setText

public Snackbar setText(int resId)

Sets the string value of the Snackbar.

Parameters:

resId - The string resource ID to set.

Returns:

The original Snackbar object.

setText

public Snackbar setText(java.lang.CharSequence s)

Sets the string value of the Snackbar.

Parameters:

s - The string value to set.

Returns:

The original Snackbar object.

setTextColor

public Snackbar setTextColor(int color)

Sets the text color of the string to be displayed.

Parameters:

color - The text color of the string to be displayed.

Returns:

The original Snackbar object.

setAction

public Snackbar setAction(int resId,
                 int color,
                 android.view.View.OnClickListener listener)

Sets the action button text and text color, and the botton's click event listener.

Parameters:

resId - The action button text resource ID.

color - The action button text color.

listener - The action button click event listener.

Returns:

The original Snackbar object.

setAction

public Snackbar setAction(java.lang.CharSequence action,
                 int color,
                 android.view.View.OnClickListener listener)

Sets the action button text and text color, and the botton's click event listener.

Parameters:

action - The action button text.

color - The action button text color.

listener - The action button click event listener.

Returns:

The original Snackbar object.

setActions

public Snackbar setActions(int resId1,
                  int color1,
                  android.view.View.OnClickListener listener1,
                  int resId2,
                  int color2,
                  android.view.View.OnClickListener listener2)

Sets the text, text color, and the click event listeners for the two action buttons.

Parameters:

resId1 - The text resource ID for the first action button.

color1 - The text color for the first action button.

listener1 - The click event listener for the first action button.

resId2 - The text resource ID for the second action button.

color2 - The text color for the second action button.

listener2 - The click event listener for the second action button.

Returns:

The original Snackbar object.

show

public void show()

Shows the Snackbar.

hide

public void hide()

Hides the Snackbar if it is currently showing; otherwise, does nothing.

with

public static Snackbar with(android.app.Activity activity)

Creates a Snackbar with the given Activity as its container.

Parameters:

activity - The container.