net.zer0bandwidth.android.lib.view.updaters

Class MenuItemUpdater

java.lang.Object

net.zer0bandwidth.android.lib.view.updaters.MenuItemUpdater

All Implemented Interfaces:

java.lang.Runnable

public class MenuItemUpdater
extends java.lang.Object
implements java.lang.Runnable

Updates the text and icon of a known MenuItem. This task class should be run directly on the UI thread by the context that creates it.

this.runOnUiThread( new MenuItemUpdater( mi, sCaption, resIconID ) ) ;

Since:

zer0bandwidth-net/android 0.1.2 (#28)

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ICON_NOT_SET Magic value to be used for m_resIcon when no icon should be set.
protected android.view.MenuItem	m_mi The menu item to be updated.
protected int	m_resIcon The resource ID of the icon that should be used for the item.
protected java.lang.String	m_sCaption The text of the caption to be set for the item.

Constructor Summary

Constructors

Constructor and Description
MenuItemUpdater(android.view.MenuItem mi, android.content.Context ctx, int resCaption) Sets up the updater.
MenuItemUpdater(android.view.MenuItem mi, android.content.Context ctx, int resCaption, int resIcon) Sets up the updater.
MenuItemUpdater(android.view.MenuItem mi, java.lang.String sCaption) Sets up the updater.
MenuItemUpdater(android.view.MenuItem mi, java.lang.String sCaption, int resIcon) Sets up the updater.

Method Summary

Modifier and Type	Method and Description
protected MenuItemUpdater	init(android.view.MenuItem mi, java.lang.String sCaption, int resIcon) Initializes the task instance.
void	run()

Methods inherited from class java.lang.Object

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

Field Detail

ICON_NOT_SET

protected static final int ICON_NOT_SET

Magic value to be used for m_resIcon when no icon should be set.

See Also:

Constant Field Values

m_mi

protected android.view.MenuItem m_mi

The menu item to be updated.

m_sCaption

protected java.lang.String m_sCaption

The text of the caption to be set for the item.

m_resIcon

protected int m_resIcon

The resource ID of the icon that should be used for the item.

Constructor Detail

MenuItemUpdater

public MenuItemUpdater(android.view.MenuItem mi,
                       java.lang.String sCaption,
                       int resIcon)

Sets up the updater.

Parameters:

mi - the menu item to be updated

sCaption - the caption to be assigned

resIcon - the icon to be assigned

MenuItemUpdater

public MenuItemUpdater(android.view.MenuItem mi,
                       java.lang.String sCaption)

Sets up the updater. No icon resource will be set for the item.

Parameters:

mi - the menu item to be updated

sCaption - the icon to be assigned

MenuItemUpdater

public MenuItemUpdater(android.view.MenuItem mi,
                       android.content.Context ctx,
                       int resCaption,
                       int resIcon)

Sets up the updater.

Parameters:

mi - the menu item to be updated

ctx - a context to provide string resources

resCaption - the resource ID of the caption to be set

resIcon - the icon to be set

MenuItemUpdater

public MenuItemUpdater(android.view.MenuItem mi,
                       android.content.Context ctx,
                       int resCaption)

Sets up the updater. No icon resource will be set for the item.

Parameters:

mi - the menu item to be updated

ctx - a context to provide string resources

resCaption - the resource ID of the caption to be set

Method Detail

init

protected MenuItemUpdater init(android.view.MenuItem mi,
                               java.lang.String sCaption,
                               int resIcon)

Initializes the task instance. Called by the various constructors.

Parameters:

mi - the menu item to be updated

sCaption - the caption to be set

resIcon - the icon to be set

Returns:

(fluid)

run

public void run()

Specified by:

run in interface java.lang.Runnable