AppCompatDelegate

FEATURE_ACTION_MODE_OVERLAY

int FEATURE_ACTION_MODE_OVERLAY

Flag for specifying the behavior of action modes when an Action Bar is not present. If overlay is enabled, the action mode UI will be allowed to cover existing window content.

Constant Value: 10 (0x0000000a)

FEATURE_SUPPORT_ACTION_BAR

int FEATURE_SUPPORT_ACTION_BAR

Flag for enabling the support Action Bar.

This is enabled by default for some devices. The Action Bar replaces the title bar and provides an alternate location for an on-screen menu button on some devices.

Constant Value: 108 (0x0000006c)

FEATURE_SUPPORT_ACTION_BAR_OVERLAY

int FEATURE_SUPPORT_ACTION_BAR_OVERLAY

Flag for requesting an support Action Bar that overlays window content. Normally an Action Bar will sit in the space above window content, but if this feature is requested along with FEATURE_SUPPORT_ACTION_BAR it will be layered over the window content itself. This is useful if you would like your app to have more control over how the Action Bar is displayed, such as letting application content scroll beneath an Action Bar with a transparent background or otherwise displaying a transparent/translucent Action Bar over application content.

This mode is especially useful with View.SYSTEM_UI_FLAG_FULLSCREEN, which allows you to seamlessly hide the action bar in conjunction with other screen decorations. When an ActionBar is in this mode it will adjust the insets provided to View.fitSystemWindows(Rect) to include the content covered by the action bar, so you can do layout within that space.

Constant Value: 109 (0x0000006d)

MODE_NIGHT_AUTO

int MODE_NIGHT_AUTO

Mode which means to use night mode when it is determined that it is night or not.

The calculation used to determine whether it is night or not makes use of the location APIs (if this app has the necessary permissions). This allows us to generate accurate sunrise and sunset times. If this app does not have permission to access the location APIs then we use hardcoded times which will be less accurate.

Constant Value: 0 (0x00000000)

MODE_NIGHT_FOLLOW_SYSTEM

int MODE_NIGHT_FOLLOW_SYSTEM

Mode which uses the system's night mode setting to determine if it is night or not.

Constant Value: -1 (0xffffffff)

MODE_NIGHT_NO

int MODE_NIGHT_NO

Mode which means to not use night mode, and therefore prefer notnight qualified resources where available, regardless of the time.

Constant Value: 1 (0x00000001)

MODE_NIGHT_YES

int MODE_NIGHT_YES

Mode which means to always use night mode, and therefore prefer night qualified resources where available, regardless of the time.

Constant Value: 2 (0x00000002)

addContentView

void addContentView (View v, 
                ViewGroup.LayoutParams lp)

Should be called instead of addContentView(android.view.View, android.view.ViewGroup.LayoutParams)}

applyDayNight

boolean applyDayNight ()

Allow AppCompat to apply the night and notnight resource qualifiers.

Doing this enables the Theme.AppCompat.DayNight family of themes to work, using the computed twilight to automatically select a dark or light theme.

You can override the night mode using setLocalNightMode(int).

This only works on devices running ICE_CREAM_SANDWICH and above.

If this is called after the host component has been created, the component will either be automatically recreated or its Configuration updated. Which one depends on how the component is setup (via android:configChanges or similar).

create

AppCompatDelegate create (Dialog dialog, 
                AppCompatCallback callback)

Create a AppCompatDelegate to use with dialog.

create

AppCompatDelegate create (Activity activity, 
                AppCompatCallback callback)

Create a AppCompatDelegate to use with activity.

createView

View createView (View parent, 
                String name, 
                Context context, 
                AttributeSet attrs)

This should be called from a LayoutInflater.Factory2 in order to return tint-aware widgets.

This is only needed if you are using your own LayoutInflater factory, and have therefore not installed the default factory via installViewFactory().

findViewById

T findViewById (int id)

Finds a view that was identified by the id attribute from the XML that was processed in onCreate(Bundle).

getDefaultNightMode

int getDefaultNightMode ()

Returns the default night mode.

getDrawerToggleDelegate

ActionBarDrawerToggle.Delegate getDrawerToggleDelegate ()

Returns an ActionBarDrawerToggle.Delegate which can be returned from your Activity if it implements ActionBarDrawerToggle.DelegateProvider.

getMenuInflater

MenuInflater getMenuInflater ()

Return the value of this call from your getMenuInflater()

getSupportActionBar

ActionBar getSupportActionBar ()

Support library version of getActionBar().

hasWindowFeature

boolean hasWindowFeature (int featureId)

Query for the availability of a certain feature.

This should be called instead of hasFeature(int).

installViewFactory

void installViewFactory ()

Installs AppCompat's LayoutInflater Factory so that it can replace the framework widgets with compatible tinted versions. This should be called before super.onCreate() as so:

 protected void onCreate(Bundle savedInstanceState) {
     getDelegate().installViewFactory();
     getDelegate().onCreate(savedInstanceState);
     super.onCreate(savedInstanceState);

     // ...
 }
 

invalidateOptionsMenu

void invalidateOptionsMenu ()

Should be called from invalidateOptionsMenu()} or supportInvalidateOptionsMenu().

isCompatVectorFromResourcesEnabled

boolean isCompatVectorFromResourcesEnabled ()

Returns whether vector drawables on older platforms (< API 21) can be accessed from within resources.

isHandleNativeActionModesEnabled

boolean isHandleNativeActionModesEnabled ()

Returns whether AppCompat handles any native action modes itself.

onConfigurationChanged

void onConfigurationChanged (Configuration newConfig)

Should be called from onConfigurationChanged(Configuration)

onCreate

void onCreate (Bundle savedInstanceState)

Should be called from Activity.onCreate().

This should be called before super.onCreate() as so:

 protected void onCreate(Bundle savedInstanceState) {
     getDelegate().onCreate(savedInstanceState);
     super.onCreate(savedInstanceState);
     // ...
 }
 

onDestroy

void onDestroy ()

Should be called from onDestroy()

onPostCreate

void onPostCreate (Bundle savedInstanceState)

Should be called from onPostCreate(android.os.Bundle)

onPostResume

void onPostResume ()

Should be called from onPostResume()

onSaveInstanceState

void onSaveInstanceState (Bundle outState)

Allows AppCompat to save instance state.

onStart

void onStart ()

Should be called from onStart() Activity.onStart()}

onStop

void onStop ()

Should be called from Activity.onStop()

requestWindowFeature

boolean requestWindowFeature (int featureId)

Enable extended window features. This should be called instead of requestWindowFeature(int) or getWindow().requestFeature().

setCompatVectorFromResourcesEnabled

void setCompatVectorFromResourcesEnabled (boolean enabled)

Sets whether vector drawables on older platforms (< API 21) can be used within DrawableContainer resources.

When enabled, AppCompat can intercept some drawable inflation from the framework, which enables implicit inflation of vector drawables within DrawableContainer resources. You can then use those drawables in places such as android:src on ImageView, or android:drawableLeft on TextView. Example usage:

 <selector xmlns:android="...">
     <item android:state_checked="true"
           android:drawable="@drawable/vector_checked_icon" />
     <item android:drawable="@drawable/vector_icon" />
 </selector>

 <TextView
         ...
         android:drawableLeft="@drawable/vector_state_list_icon" />
 

This feature defaults to disabled, since enabling it can cause issues with memory usage, and problems updating Configuration instances. If you update the configuration manually, then you probably do not want to enable this. You have been warned.

Even with this disabled, you can still use vector resources through setImageResource(int) and its app:srcCompat attribute. They can also be used in anything which AppCompat inflates for you, such as menu resources.

Please note: this only takes effect in Activities created after this call.

setContentView

void setContentView (View v)

Should be called instead of setContentView(android.view.View)}

setContentView

void setContentView (int resId)

Should be called instead of setContentView(int)}

setContentView

void setContentView (View v, 
                ViewGroup.LayoutParams lp)

Should be called instead of setContentView(android.view.View, android.view.ViewGroup.LayoutParams)}

setDefaultNightMode

void setDefaultNightMode (int mode)

Sets the default night mode. This is used across all activities/dialogs but can be overridden locally via setLocalNightMode(int).

This method only takes effect for those situations where applyDayNight() works. Defaults to MODE_NIGHT_NO.

This only takes effect for components which are created after the call. Any components which are already open will not be updated.

setHandleNativeActionModesEnabled

void setHandleNativeActionModesEnabled (boolean enabled)

Whether AppCompat handles any native action modes itself.

This methods only takes effect on ICE_CREAM_SANDWICH and above.

setLocalNightMode

void setLocalNightMode (int mode)

Override the night mode used for this delegate's host component. This method only takes effect for those situations where applyDayNight() works.

As this will call applyDayNight(), the host component might be recreated automatically.

setSupportActionBar

void setSupportActionBar (Toolbar toolbar)

Set a Toolbar to act as the ActionBar for this delegate.

When set to a non-null value the getSupportActionBar() ()} method will return an ActionBar object that can be used to control the given toolbar as if it were a traditional window decor action bar. The toolbar's menu will be populated with the Activity's options menu and the navigation button will be wired through the standard home menu select action.

In order to use a Toolbar within the Activity's window content the application must not request the window feature FEATURE_SUPPORT_ACTION_BAR.

setTitle

void setTitle (CharSequence title)

Should be called from onTitleChanged(CharSequence, int)}

startSupportActionMode

ActionMode startSupportActionMode (ActionMode.Callback callback)

Start an action mode.