jadex.android.controlcenter.IChildPreferenceScreen Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-runtimetools-android Show documentation

The Jadex rules tools package contains tools for the Jadex active components infrastructure.

The newest version!

package jadex.android.controlcenter;

import android.preference.PreferenceScreen;
import android.view.Menu;
import android.view.MenuItem;

/**
 * Interface used for Child Preference Screens that are shown in {@link OptionsMenuDelegatingPreferenceActivity}.
 */
public interface IChildPreferenceScreen
{
	/**
	 * Sets the PreferenceScreen this Settings object can display its
	 * preferences on.
	 * 
	 * @param screen
	 */
	void setPreferenceScreen(PreferenceScreen screen);
	
	/**
	 * Called when the PreferenceScreen is switched.
	 */
	void onDestroy();

	/**
	 * Returns the Title of this Settings Implementation. Must be unique.
	 * 
	 * @return {@link String}
	 */
	String getTitle();

	/**
	 * Called from the Control Center when an Options Menu is requested.
	 * 
	 * @param menu
	 *            The Menu where this Settings Implementation can add its
	 *            entries to.
	 * @return true, if an Option menu should be shown, else false
	 */
	boolean onCreateOptionsMenu(Menu menu);

	/**
	 * Called from the Control Center when a {@link MenuItem} is selected.
	 * 
	 * @param item
	 *            The selected {@link MenuItem}
	 * @return true if menu should be closed
	 */
	boolean onOptionsItemSelected(MenuItem item);

	/**
	 * Called from the Control Center when a {@link Menu} is closed.
	 * 
	 * @param menu
	 *            The closed {@link Menu}
	 */
	void onOptionsMenuClosed(Menu menu);
	
	
}