com.weebly.opus1269.clipman.ui.helpers

Class MenuTintHelper

java.lang.Object

com.weebly.opus1269.clipman.ui.helpers.MenuTintHelper

public class MenuTintHelper
extends java.lang.Object

Apply colors and/or transparency to menu icons in a Menu.

Example usage:

 public boolean onCreateOptionsMenu(Menu menu) { ...
 int color = getResources().getColor(R.color.your_awesome_color); int alpha =
 204; // 80% transparency MenuTintHelper.on(menu).setMenuItemIconColor(color).setMenuItemIconAlpha(alpha).apply(this);
 ... } 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MenuTintHelper.Builder
static class	MenuTintHelper.NativeActionExpandListener
static class	MenuTintHelper.SearchViewFocusListener Auto collapses the SearchView when the soft keyboard is dismissed.

Field Summary

Fields

Modifier and Type	Field and Description
private android.view.ViewGroup	actionBarView
private boolean	forceIcons
private android.view.Menu	menu
private java.lang.Integer	menuItemIconAlpha
private java.lang.Integer	menuItemIconColor
private static java.lang.reflect.Method	nativeIsActionButton
private java.lang.Integer	originalMenuItemIconColor
private android.widget.ImageView	overflowButton
private java.lang.Integer	overflowDrawableId
private boolean	reApplyOnChange
private java.lang.Integer	subMenuIconAlpha
private java.lang.Integer	subMenuIconColor
private static java.lang.String	TAG

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MenuTintHelper(MenuTintHelper.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	apply(android.app.Activity activity) Sets a ColorFilter and/or alpha on all the MenuItems in the menu, including the OverflowMenuButton.
static void	colorIcons(android.app.Activity activity, android.view.Menu menu, int color) Apply a ColorFilter with the specified color to all icons in the menu.
static void	colorMenuItem(android.view.MenuItem menuItem, java.lang.Integer color, java.lang.Integer alpha) Sets the color filter and/or the alpha transparency on a MenuItem's icon.
private void	colorOverflowMenuItem(android.widget.ImageView overflow)
private static android.view.ViewGroup	findActionBar(android.app.Activity activity)
private static android.widget.ImageView	findOverflowMenuButton(android.app.Activity activity, android.view.ViewGroup viewGroup)
private static android.view.ViewGroup	findToolbar(android.view.ViewGroup viewGroup)
static void	forceMenuIcons(android.view.Menu menu) Set the menu to show MenuItem icons in the overflow window.
android.view.Menu	getMenu()
android.widget.ImageView	getOverflowMenuButton()
static android.widget.ImageView	getOverflowMenuButton(android.app.Activity activity)
static boolean	isActionButton(android.view.MenuItem item) Check if an item is showing (not in the overflow menu).
static boolean	isInOverflow(android.view.MenuItem item) Check if an item is in the overflow menu.
static MenuTintHelper.Builder	on(android.view.Menu menu)
void	reapply() Sets a ColorFilter and/or alpha on all the MenuItems in the menu, including the OverflowMenuButton.
void	setMenuItemIconColor(java.lang.Integer color)

Methods inherited from class java.lang.Object

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

Field Detail

TAG

private static final java.lang.String TAG

See Also:

Constant Field Values

nativeIsActionButton

private static java.lang.reflect.Method nativeIsActionButton

menu

private final android.view.Menu menu

originalMenuItemIconColor

private final java.lang.Integer originalMenuItemIconColor

menuItemIconAlpha

private final java.lang.Integer menuItemIconAlpha

subMenuIconColor

private final java.lang.Integer subMenuIconColor

subMenuIconAlpha

private final java.lang.Integer subMenuIconAlpha

overflowDrawableId

private final java.lang.Integer overflowDrawableId

reApplyOnChange

private final boolean reApplyOnChange

forceIcons

private final boolean forceIcons

menuItemIconColor

private java.lang.Integer menuItemIconColor

overflowButton

private android.widget.ImageView overflowButton

actionBarView

private android.view.ViewGroup actionBarView

Constructor Detail

MenuTintHelper

private MenuTintHelper(MenuTintHelper.Builder builder)

Method Detail

isActionButton

public static boolean isActionButton(android.view.MenuItem item)

Check if an item is showing (not in the overflow menu).

Parameters:

item - the MenuItem.

Returns:

true if the MenuItem is visible on the ActionBar.

isInOverflow

public static boolean isInOverflow(android.view.MenuItem item)

Check if an item is in the overflow menu.

Parameters:

item - the MenuItem

Returns:

true if the MenuItem is in the overflow menu.

See Also:

isActionButton(MenuItem)

colorMenuItem

public static void colorMenuItem(android.view.MenuItem menuItem,
                                 java.lang.Integer color,
                                 java.lang.Integer alpha)

Sets the color filter and/or the alpha transparency on a MenuItem's icon.

Parameters:

menuItem - The MenuItem to theme.

color - The color to set for the color filter or null for no changes.

alpha - The alpha value (0...255) to set on the icon or null for no changes.

forceMenuIcons

public static void forceMenuIcons(android.view.Menu menu)

Set the menu to show MenuItem icons in the overflow window.

Parameters:

menu - the menu to force icons to show

on

public static MenuTintHelper.Builder on(android.view.Menu menu)

colorIcons

public static void colorIcons(android.app.Activity activity,
                              android.view.Menu menu,
                              int color)

Apply a ColorFilter with the specified color to all icons in the menu.

Parameters:

activity - the Activity.

menu - the menu after items have been added.

color - the color for the ColorFilter.

getOverflowMenuButton

public static android.widget.ImageView getOverflowMenuButton(android.app.Activity activity)

Parameters:

activity - the Activity

Returns:

the OverflowMenuButton or null if it doesn't exist.

findOverflowMenuButton

@Nullable
private static android.widget.ImageView findOverflowMenuButton(android.app.Activity activity,
                                                                          android.view.ViewGroup viewGroup)

findActionBar

@Nullable
private static android.view.ViewGroup findActionBar(android.app.Activity activity)

findToolbar

@Nullable
private static android.view.ViewGroup findToolbar(android.view.ViewGroup viewGroup)

apply

public void apply(android.app.Activity activity)

Sets a ColorFilter and/or alpha on all the MenuItems in the menu, including the OverflowMenuButton.

Call this method after inflating/creating your menu in Activity.onCreateOptionsMenu(Menu).

Note: This is targeted for the native ActionBar/Toolbar, not AppCompat.

Parameters:

activity - the activity to apply the menu tinting on.

reapply

public void reapply()

Sets a ColorFilter and/or alpha on all the MenuItems in the menu, including the OverflowMenuButton.

This should only be called after calling apply(Activity). It is useful for when MenuItems might be re-arranged due to an action view being collapsed or expanded.

colorOverflowMenuItem

private void colorOverflowMenuItem(android.widget.ImageView overflow)

getMenu

public android.view.Menu getMenu()

getOverflowMenuButton

public android.widget.ImageView getOverflowMenuButton()

setMenuItemIconColor

public void setMenuItemIconColor(java.lang.Integer color)