Rename callback methods for contextual modes to match recent refactoring.

Change-Id: I9403f0c728143cd075827f21270b5468abc5271b
This commit is contained in:
Adam Powell
2010-07-21 11:46:18 -07:00
parent c1b11b1b37
commit 2175f1370c
3 changed files with 29 additions and 29 deletions

View File

@@ -24636,7 +24636,7 @@
deprecated="not deprecated"
visibility="public"
>
<method name="onContextItemClicked"
<method name="onContextualItemClicked"
return="boolean"
abstract="true"
native="false"
@@ -24651,7 +24651,7 @@
<parameter name="item" type="android.view.MenuItem">
</parameter>
</method>
<method name="onCreateContextMode"
<method name="onCreateContextualMode"
return="boolean"
abstract="true"
native="false"
@@ -24666,7 +24666,7 @@
<parameter name="menu" type="android.view.Menu">
</parameter>
</method>
<method name="onDestroyContextMode"
<method name="onDestroyContextualMode"
return="void"
abstract="true"
native="false"
@@ -24679,7 +24679,7 @@
<parameter name="mode" type="android.app.ContextualMode">
</parameter>
</method>
<method name="onPrepareContextMode"
<method name="onPrepareContextualMode"
return="boolean"
abstract="true"
native="false"

View File

@@ -61,7 +61,7 @@ public abstract class ContextualMode {
/**
* Invalidate the contextual mode and refresh menu content. The contextual mode's
* {@link ContextualMode.Callback} will have its
* {@link Callback#onPrepareContextMode(ContextualMode, Menu)} method called.
* {@link Callback#onPrepareContextualMode(ContextualMode, Menu)} method called.
* If it returns true the menu will be scanned for updated content and any relevant changes
* will be reflected to the user.
*/
@@ -69,7 +69,7 @@ public abstract class ContextualMode {
/**
* Finish and close this context mode. The context mode's {@link ContextualMode.Callback} will
* have its {@link Callback#onDestroyContextMode(ContextualMode)} method called.
* have its {@link Callback#onDestroyContextualMode(ContextualMode)} method called.
*/
public abstract void finish();
@@ -104,52 +104,52 @@ public abstract class ContextualMode {
*
* <p>A context mode's lifecycle is as follows:
* <ul>
* <li>{@link Callback#onCreateContextMode(ContextualMode, Menu)} once on initial
* <li>{@link Callback#onCreateContextualMode(ContextualMode, Menu)} once on initial
* creation</li>
* <li>{@link Callback#onPrepareContextMode(ContextualMode, Menu)} after creation
* <li>{@link Callback#onPrepareContextualMode(ContextualMode, Menu)} after creation
* and any time the {@link ContextualMode} is invalidated</li>
* <li>{@link Callback#onContextItemClicked(ContextualMode, MenuItem)} any time a
* <li>{@link Callback#onContextualItemClicked(ContextualMode, MenuItem)} any time a
* contextual action button is clicked</li>
* <li>{@link Callback#onDestroyContextMode(ContextualMode)} when the context mode
* <li>{@link Callback#onDestroyContextualMode(ContextualMode)} when the context mode
* is closed</li>
* </ul>
*/
public interface Callback {
/**
* Called when a context mode is first created. The menu supplied will be used to generate
* action buttons for the context mode.
* Called when a contextual mode is first created. The menu supplied will be used to
* generate action buttons for the contextual mode.
*
* @param mode ContextMode being created
* @param mode ContextualMode being created
* @param menu Menu used to populate contextual action buttons
* @return true if the context mode should be created, false if entering this context mode
* should be aborted.
* @return true if the contextual mode should be created, false if entering this
* mode should be aborted.
*/
public boolean onCreateContextMode(ContextualMode mode, Menu menu);
public boolean onCreateContextualMode(ContextualMode mode, Menu menu);
/**
* Called to refresh a context mode's action menu whenever it is invalidated.
* Called to refresh a contextual mode's action menu whenever it is invalidated.
*
* @param mode ContextMode being prepared
* @param mode ContextualMode being prepared
* @param menu Menu used to populate contextual action buttons
* @return true if the menu or context mode was updated, false otherwise.
* @return true if the menu or contextual mode was updated, false otherwise.
*/
public boolean onPrepareContextMode(ContextualMode mode, Menu menu);
public boolean onPrepareContextualMode(ContextualMode mode, Menu menu);
/**
* Called to report a user click on a contextual action button.
*
* @param mode The current ContextMode
* @param mode The current ContextualMode
* @param item The item that was clicked
* @return true if this callback handled the event, false if the standard MenuItem
* invocation should continue.
*/
public boolean onContextItemClicked(ContextualMode mode, MenuItem item);
public boolean onContextualItemClicked(ContextualMode mode, MenuItem item);
/**
* Called when a context mode is about to be exited and destroyed.
* Called when a contextual mode is about to be exited and destroyed.
*
* @param mode The current ContextMode being destroyed
* @param mode The current ContextualMode being destroyed
*/
public void onDestroyContextMode(ContextualMode mode);
public void onDestroyContextualMode(ContextualMode mode);
}
}

View File

@@ -240,7 +240,7 @@ public class ActionBarImpl extends ActionBar {
}
ContextMode mode = new ContextMode(callback);
if (callback.onCreateContextMode(mode, mode.getMenu())) {
if (callback.onCreateContextualMode(mode, mode.getMenu())) {
mode.invalidate();
mUpperContextView.initForMode(mode);
mAnimatorView.setDisplayedChild(CONTEXT_VIEW);
@@ -383,7 +383,7 @@ public class ActionBarImpl extends ActionBar {
@Override
public void finish() {
mCallback.onDestroyContextMode(this);
mCallback.onDestroyContextualMode(this);
mAnimatorView.setDisplayedChild(NORMAL_VIEW);
// Clear out the context mode views after the animation finishes
@@ -399,7 +399,7 @@ public class ActionBarImpl extends ActionBar {
@Override
public void invalidate() {
if (mCallback.onPrepareContextMode(this, mMenu)) {
if (mCallback.onPrepareContextualMode(this, mMenu)) {
// Refresh content in both context views
}
}
@@ -436,7 +436,7 @@ public class ActionBarImpl extends ActionBar {
}
public boolean onMenuItemSelected(MenuBuilder menu, MenuItem item) {
return mCallback.onContextItemClicked(this, item);
return mCallback.onContextualItemClicked(this, item);
}
public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) {