Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (C) 2010 The Android Open Source Project
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package com.actionbarsherlock.view;
 
Represents a contextual mode of the user interface. Action modes can be used for modal interactions with content and replace parts of the normal UI until finished. Examples of good action modes include selection modes, search, content editing, etc.
 
 public abstract class ActionMode {
     private Object mTag;

    
Set a tag object associated with this ActionMode.

Like the tag available to views, this allows applications to associate arbitrary data with an ActionMode for later reference.

Parameters:
tag Tag to associate with this ActionMode
See also:
getTag()
 
     public void setTag(Object tag) {
          = tag;
     }

    
Retrieve the tag object associated with this ActionMode.

Like the tag available to views, this allows applications to associate arbitrary data with an ActionMode for later reference.

Returns:
Tag associated with this ActionMode
See also:
setTag(java.lang.Object)
 
     public Object getTag() {
         return ;
     }

    
Set the title of the action mode. This method will have no visible effect if a custom view has been set.

Parameters:
title Title string to set
See also:
setTitle(int)
setCustomView(android.view.View)
 
     public abstract void setTitle(CharSequence title);

    
Set the title of the action mode. This method will have no visible effect if a custom view has been set.

Parameters:
resId Resource ID of a string to set as the title
See also:
setTitle(java.lang.CharSequence)
setCustomView(android.view.View)
 
     public abstract void setTitle(int resId);

    
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.

Parameters:
subtitle Subtitle string to set
See also:
setSubtitle(int)
setCustomView(android.view.View)
 
     public abstract void setSubtitle(CharSequence subtitle);

    
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.

Parameters:
resId Resource ID of a string to set as the subtitle
See also:
setSubtitle(java.lang.CharSequence)
setCustomView(android.view.View)
 
    public abstract void setSubtitle(int resId);

    
Set a custom view for this action mode. The custom view will take the place of the title and subtitle. Useful for things like search boxes.

Parameters:
view Custom view to use in place of the title/subtitle.
See also:
setTitle(java.lang.CharSequence)
setSubtitle(java.lang.CharSequence)
    public abstract void setCustomView(View view);

    
Invalidate the action mode and refresh menu content. The mode's ActionMode.Callback will have its ActionMode.Callback.onPrepareActionMode(com.actionbarsherlock.view.ActionMode,com.actionbarsherlock.view.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.
    public abstract void invalidate();

    
Finish and close this action mode. The action mode's ActionMode.Callback will have its ActionMode.Callback.onDestroyActionMode(com.actionbarsherlock.view.ActionMode) method called.
    public abstract void finish();

    
Returns the menu of actions that this action mode presents.

Returns:
The action mode's menu.
    public abstract Menu getMenu();

    
Returns the current title of this action mode.

Returns:
Title text
    public abstract CharSequence getTitle();

    
Returns the current subtitle of this action mode.

Returns:
Subtitle text
    public abstract CharSequence getSubtitle();

    
Returns the current custom view for this action mode.

Returns:
The current custom view
    public abstract View getCustomView();

    
Returns a MenuInflater with the ActionMode's context.
    public abstract MenuInflater getMenuInflater();

    
Returns whether the UI presenting this action mode can take focus or not. This is used by internal components within the framework that would otherwise present an action mode UI that requires focus, such as an EditText as a custom view.

Returns:
true if the UI used to show this action mode can take focus
Hide:
Internal use only
    public boolean isUiFocusable() {
        return true;
    }

    
Callback interface for action modes. Supplied to android.view.View.startActionMode(android.view.ActionMode.Callback), a Callback configures and handles events raised by a user's interaction with an action mode.

An action mode's lifecycle is as follows:

    public interface Callback {
        
Called when action mode is first created. The menu supplied will be used to generate action buttons for the action mode.

Parameters:
mode ActionMode being created
menu Menu used to populate action buttons
Returns:
true if the action mode should be created, false if entering this mode should be aborted.
        public boolean onCreateActionMode(ActionMode modeMenu menu);

        
Called to refresh an action mode's action menu whenever it is invalidated.

Parameters:
mode ActionMode being prepared
menu Menu used to populate action buttons
Returns:
true if the menu or action mode was updated, false otherwise.
        public boolean onPrepareActionMode(ActionMode modeMenu menu);

        
Called to report a user click on an action button.

Parameters:
mode The current ActionMode
item The item that was clicked
Returns:
true if this callback handled the event, false if the standard MenuItem invocation should continue.
        public boolean onActionItemClicked(ActionMode modeMenuItem item);

        
Called when an action mode is about to be exited and destroyed.

Parameters:
mode The current ActionMode being destroyed
        public void onDestroyActionMode(ActionMode mode);
    }
New to GrepCode? Check out our FAQ X