io.rong.imkit.utils

Class SystemBarTintManager

java.lang.Object

io.rong.imkit.utils.SystemBarTintManager

public class SystemBarTintManager
extends java.lang.Object

Class to manage status and navigation bar tint effects when using KitKat translucent system UI modes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemBarTintManager.SystemBarConfig Class which describes system bar sizing and other characteristics for the current device configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TINT_COLOR The default system bar tint color value.

Constructor Summary

Constructors

Constructor and Description
SystemBarTintManager(android.app.Activity activity) Constructor.

Method Summary

Modifier and Type	Method and Description
SystemBarTintManager.SystemBarConfig	getConfig() Get the system bar configuration.
boolean	isNavBarTintEnabled() Is tinting enabled for the system navigation bar?
boolean	isStatusBarTintEnabled() Is tinting enabled for the system status bar?
void	setNavigationBarAlpha(float alpha) Apply the specified alpha to the system navigation bar.
void	setNavigationBarTintColor(int color) Apply the specified color tint to the system navigation bar.
void	setNavigationBarTintDrawable(android.graphics.drawable.Drawable drawable) Apply the specified drawable to the system navigation bar.
void	setNavigationBarTintEnabled(boolean enabled) Enable tinting of the system navigation bar.
void	setNavigationBarTintResource(int res) Apply the specified drawable or color resource to the system navigation bar.
void	setStatusBarAlpha(float alpha) Apply the specified alpha to the system status bar.
void	setStatusBarTintColor(int color) Apply the specified color tint to the system status bar.
void	setStatusBarTintDrawable(android.graphics.drawable.Drawable drawable) Apply the specified drawable to the system status bar.
void	setStatusBarTintEnabled(boolean enabled) Enable tinting of the system status bar.
void	setStatusBarTintResource(int res) Apply the specified drawable or color resource to the system status bar.
void	setTintAlpha(float alpha) Apply the specified alpha to all system UI bars.
void	setTintColor(int color) Apply the specified color tint to all system UI bars.
void	setTintDrawable(android.graphics.drawable.Drawable drawable) Apply the specified drawable to all system UI bars.
void	setTintResource(int res) Apply the specified drawable or color resource to all system UI bars.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TINT_COLOR

public static final int DEFAULT_TINT_COLOR

The default system bar tint color value.

See Also:

Constant Field Values

Constructor Detail

SystemBarTintManager

public SystemBarTintManager(android.app.Activity activity)

Constructor. Call this in the host activity onCreate method after its content view has been set. You should always create new instances when the host activity is recreated.

Parameters:

activity - The host activity.

Method Detail

setNavigationBarTintEnabled

public void setNavigationBarTintEnabled(boolean enabled)

Enable tinting of the system navigation bar.

If the platform does not have soft navigation keys, is running Jelly Bean or earlier, or translucent system UI modes have not been enabled in either the theme or via window flags, then this method does nothing.

Parameters:

enabled - True to enable tinting, false to disable it (default).

setTintColor

public void setTintColor(int color)

Apply the specified color tint to all system UI bars.

Parameters:

color - The color of the background tint.

setTintResource

public void setTintResource(int res)

Apply the specified drawable or color resource to all system UI bars.

Parameters:

res - The identifier of the resource.

setTintDrawable

public void setTintDrawable(android.graphics.drawable.Drawable drawable)

Apply the specified drawable to all system UI bars.

Parameters:

drawable - The drawable to use as the background, or null to remove it.

setTintAlpha

public void setTintAlpha(float alpha)

Apply the specified alpha to all system UI bars.

Parameters:

alpha - The alpha to use

setStatusBarTintColor

public void setStatusBarTintColor(int color)

Apply the specified color tint to the system status bar.

Parameters:

color - The color of the background tint.

setStatusBarTintResource

public void setStatusBarTintResource(int res)

Apply the specified drawable or color resource to the system status bar.

Parameters:

res - The identifier of the resource.

setStatusBarTintDrawable

public void setStatusBarTintDrawable(android.graphics.drawable.Drawable drawable)

Apply the specified drawable to the system status bar.

Parameters:

drawable - The drawable to use as the background, or null to remove it.

setStatusBarAlpha

public void setStatusBarAlpha(float alpha)

Apply the specified alpha to the system status bar.

Parameters:

alpha - The alpha to use

setNavigationBarTintColor

public void setNavigationBarTintColor(int color)

Apply the specified color tint to the system navigation bar.

Parameters:

color - The color of the background tint.

setNavigationBarTintResource

public void setNavigationBarTintResource(int res)

Apply the specified drawable or color resource to the system navigation bar.

Parameters:

res - The identifier of the resource.

setNavigationBarTintDrawable

public void setNavigationBarTintDrawable(android.graphics.drawable.Drawable drawable)

Apply the specified drawable to the system navigation bar.

Parameters:

drawable - The drawable to use as the background, or null to remove it.

setNavigationBarAlpha

public void setNavigationBarAlpha(float alpha)

Apply the specified alpha to the system navigation bar.

Parameters:

alpha - The alpha to use

getConfig

public SystemBarTintManager.SystemBarConfig getConfig()

Get the system bar configuration.

Returns:

The system bar configuration for the current device configuration.

isStatusBarTintEnabled

public boolean isStatusBarTintEnabled()

Is tinting enabled for the system status bar?

Returns:

True if enabled, False otherwise.

setStatusBarTintEnabled

public void setStatusBarTintEnabled(boolean enabled)

Enable tinting of the system status bar.

If the platform is running Jelly Bean or earlier, or translucent system UI modes have not been enabled in either the theme or via window flags, then this method does nothing.

Parameters:

enabled - True to enable tinting, false to disable it (default).

isNavBarTintEnabled

public boolean isNavBarTintEnabled()

Is tinting enabled for the system navigation bar?

Returns:

True if enabled, False otherwise.