added in API level 1

ViewConfiguration

public class ViewConfiguration
extends Object

java.lang.Object
   ↳ android.view.ViewConfiguration


Contains methods to standard constants used in the UI for timeouts, sizes, and distances.

Summary

Public constructors

ViewConfiguration()

This constructor was deprecated in API level 3. Use get(android.content.Context) instead.

Public methods

static ViewConfiguration get(Context context)

Returns a configuration for the specified context.

static long getDefaultActionModeHideDuration()
static int getDoubleTapTimeout()
static int getEdgeSlop()

This method was deprecated in API level 3. Use getScaledEdgeSlop() instead.

static int getFadingEdgeLength()

This method was deprecated in API level 3. Use getScaledFadingEdgeLength() instead.

static long getGlobalActionKeyTimeout()

This method was deprecated in API level 20. This timeout should not be used by applications

static int getJumpTapTimeout()
static int getKeyRepeatDelay()
static int getKeyRepeatTimeout()
static int getLongPressTimeout()
static int getMaximumDrawingCacheSize()

This method was deprecated in API level 3. Use getScaledMaximumDrawingCacheSize() instead.

static int getMaximumFlingVelocity()

This method was deprecated in API level 4. Use getScaledMaximumFlingVelocity() instead.

static int getMinimumFlingVelocity()

This method was deprecated in API level 3. Use getScaledMinimumFlingVelocity() instead.

static int getPressedStateDuration()
int getScaledDoubleTapSlop()
int getScaledEdgeSlop()
int getScaledFadingEdgeLength()
float getScaledHorizontalScrollFactor()
int getScaledHoverSlop()
int getScaledMaximumDrawingCacheSize()

The maximum drawing cache size expressed in bytes.

int getScaledMaximumFlingVelocity()
int getScaledMinimumFlingVelocity()
int getScaledOverflingDistance()
int getScaledOverscrollDistance()
int getScaledPagingTouchSlop()
int getScaledScrollBarSize()
int getScaledTouchSlop()
float getScaledVerticalScrollFactor()
int getScaledWindowTouchSlop()
static int getScrollBarFadeDuration()
static int getScrollBarSize()

This method was deprecated in API level 3. Use getScaledScrollBarSize() instead.

static int getScrollDefaultDelay()
static float getScrollFriction()

The amount of friction applied to scrolls and flings.

static int getTapTimeout()
static int getTouchSlop()

This method was deprecated in API level 3. Use getScaledTouchSlop() instead.

static int getWindowTouchSlop()

This method was deprecated in API level 3. Use getScaledWindowTouchSlop() instead.

static long getZoomControlsTimeout()

The amount of time that the zoom controls should be displayed on the screen expressed in milliseconds.

boolean hasPermanentMenuKey()

Report if the device has a permanent menu key available to the user.

boolean shouldShowMenuShortcutsWhenKeyboardPresent()

Check if shortcuts should be displayed in menus.

Inherited methods

Public constructors

ViewConfiguration

added in API level 1
public ViewConfiguration ()

This constructor was deprecated in API level 3.
Use get(android.content.Context) instead.

Public methods

get

added in API level 3
public static ViewConfiguration get (Context context)

Returns a configuration for the specified context. The configuration depends on various parameters of the context, like the dimension of the display or the density of the display.

Parameters
context Context: The application context used to initialize the view configuration.

Returns
ViewConfiguration

getDefaultActionModeHideDuration

added in API level 23
public static long getDefaultActionModeHideDuration ()

Returns
long the default duration in milliseconds for ActionMode.hide(long).

getDoubleTapTimeout

added in API level 3
public static int getDoubleTapTimeout ()

Returns
int the duration in milliseconds between the first tap's up event and the second tap's down event for an interaction to be considered a double-tap.

getEdgeSlop

added in API level 1
public static int getEdgeSlop ()

This method was deprecated in API level 3.
Use getScaledEdgeSlop() instead.

Returns
int Inset in dips to look for touchable content when the user touches the edge of the screen

getFadingEdgeLength

added in API level 1
public static int getFadingEdgeLength ()

This method was deprecated in API level 3.
Use getScaledFadingEdgeLength() instead.

Returns
int the length of the fading edges in dips

getGlobalActionKeyTimeout

added in API level 1
public static long getGlobalActionKeyTimeout ()

This method was deprecated in API level 20.
This timeout should not be used by applications

The amount of time a user needs to press the relevant key to bring up the global actions dialog.

Returns
long how long a user needs to press the relevant key to bring up the global actions dialog.

getJumpTapTimeout

added in API level 1
public static int getJumpTapTimeout ()

Returns
int the duration in milliseconds we will wait to see if a touch event is a jump tap. If the user does not move within this interval, it is considered to be a tap.

getKeyRepeatDelay

added in API level 12
public static int getKeyRepeatDelay ()

Returns
int the time between successive key repeats in milliseconds.

getKeyRepeatTimeout

added in API level 12
public static int getKeyRepeatTimeout ()

Returns
int the time before the first key repeat in milliseconds.

getLongPressTimeout

added in API level 1
public static int getLongPressTimeout ()

Returns
int the duration in milliseconds before a press turns into a long press

getMaximumDrawingCacheSize

added in API level 1
public static int getMaximumDrawingCacheSize ()

This method was deprecated in API level 3.
Use getScaledMaximumDrawingCacheSize() instead.

The maximum drawing cache size expressed in bytes.

Returns
int the maximum size of View's drawing cache expressed in bytes

getMaximumFlingVelocity

added in API level 4
public static int getMaximumFlingVelocity ()

This method was deprecated in API level 4.
Use getScaledMaximumFlingVelocity() instead.

Returns
int Maximum velocity to initiate a fling, as measured in dips per second.

getMinimumFlingVelocity

added in API level 1
public static int getMinimumFlingVelocity ()

This method was deprecated in API level 3.
Use getScaledMinimumFlingVelocity() instead.

Returns
int Minimum velocity to initiate a fling, as measured in dips per second.

getPressedStateDuration

added in API level 1
public static int getPressedStateDuration ()

Returns
int the duration in milliseconds of the pressed state in child components.

getScaledDoubleTapSlop

added in API level 3
public int getScaledDoubleTapSlop ()

Returns
int Distance in pixels between the first touch and second touch to still be considered a double tap

getScaledEdgeSlop

added in API level 3
public int getScaledEdgeSlop ()

Returns
int Inset in pixels to look for touchable content when the user touches the edge of the screen

getScaledFadingEdgeLength

added in API level 3
public int getScaledFadingEdgeLength ()

Returns
int the length of the fading edges in pixels

getScaledHorizontalScrollFactor

added in API level 26
public float getScaledHorizontalScrollFactor ()

Returns
float Amount to scroll in response to a horizontal MotionEvent.ACTION_SCROLL event. Multiply this by the event's axis value to obtain the number of pixels to be scrolled.

getScaledHoverSlop

added in API level 28
public int getScaledHoverSlop ()

Returns
int Distance in pixels a hover can wander while it is still considered "stationary".

getScaledMaximumDrawingCacheSize

added in API level 3
public int getScaledMaximumDrawingCacheSize ()

The maximum drawing cache size expressed in bytes.

Returns
int the maximum size of View's drawing cache expressed in bytes

getScaledMaximumFlingVelocity

added in API level 4
public int getScaledMaximumFlingVelocity ()

Returns
int Maximum velocity to initiate a fling, as measured in pixels per second.

getScaledMinimumFlingVelocity

added in API level 3
public int getScaledMinimumFlingVelocity ()

Returns
int Minimum velocity to initiate a fling, as measured in pixels per second.

getScaledOverflingDistance

added in API level 9
public int getScaledOverflingDistance ()

Returns
int The maximum distance a View should overfling by when showing edge effects (in pixels).

getScaledOverscrollDistance

added in API level 9
public int getScaledOverscrollDistance ()

Returns
int The maximum distance a View should overscroll by when showing edge effects (in pixels).

getScaledPagingTouchSlop

added in API level 8
public int getScaledPagingTouchSlop ()

Returns
int Distance in pixels a touch can wander before we think the user is scrolling a full page

getScaledScrollBarSize

added in API level 3
public int getScaledScrollBarSize ()

Returns
int The width of the horizontal scrollbar and the height of the vertical scrollbar in pixels

getScaledTouchSlop

added in API level 3
public int getScaledTouchSlop ()

Returns
int Distance in pixels a touch can wander before we think the user is scrolling

getScaledVerticalScrollFactor

added in API level 26
public float getScaledVerticalScrollFactor ()

Returns
float Amount to scroll in response to a vertical MotionEvent.ACTION_SCROLL event. Multiply this by the event's axis value to obtain the number of pixels to be scrolled.

getScaledWindowTouchSlop

added in API level 3
public int getScaledWindowTouchSlop ()

Returns
int Distance in pixels a touch must be outside the bounds of a window for it to be counted as outside the window for purposes of dismissing that window.

getScrollBarFadeDuration

added in API level 5
public static int getScrollBarFadeDuration ()

Returns
int Duration of the fade when scrollbars fade away in milliseconds

getScrollBarSize

added in API level 1
public static int getScrollBarSize ()

This method was deprecated in API level 3.
Use getScaledScrollBarSize() instead.

Returns
int The width of the horizontal scrollbar and the height of the vertical scrollbar in dips

getScrollDefaultDelay

added in API level 5
public static int getScrollDefaultDelay ()

Returns
int Default delay before the scrollbars fade in milliseconds

getScrollFriction

added in API level 1
public static float getScrollFriction ()

The amount of friction applied to scrolls and flings.

Returns
float A scalar dimensionless value representing the coefficient of friction.

getTapTimeout

added in API level 1
public static int getTapTimeout ()

Returns
int the duration in milliseconds we will wait to see if a touch event is a tap or a scroll. If the user does not move within this interval, it is considered to be a tap.

getTouchSlop

added in API level 1
public static int getTouchSlop ()

This method was deprecated in API level 3.
Use getScaledTouchSlop() instead.

Returns
int Distance in dips a touch can wander before we think the user is scrolling

getWindowTouchSlop

added in API level 1
public static int getWindowTouchSlop ()

This method was deprecated in API level 3.
Use getScaledWindowTouchSlop() instead.

Returns
int Distance in dips a touch must be outside the bounds of a window for it to be counted as outside the window for purposes of dismissing that window.

getZoomControlsTimeout

added in API level 1
public static long getZoomControlsTimeout ()

The amount of time that the zoom controls should be displayed on the screen expressed in milliseconds.

Returns
long the time the zoom controls should be visible expressed in milliseconds.

hasPermanentMenuKey

added in API level 14
public boolean hasPermanentMenuKey ()

Report if the device has a permanent menu key available to the user.

As of Android 3.0, devices may not have a permanent menu key available. Apps should use the action bar to present menu options to users. However, there are some apps where the action bar is inappropriate or undesirable. This method may be used to detect if a menu key is present. If not, applications should provide another on-screen affordance to access functionality.

Returns
boolean true if a permanent menu key is present, false otherwise.

shouldShowMenuShortcutsWhenKeyboardPresent

added in API level 28
public boolean shouldShowMenuShortcutsWhenKeyboardPresent ()

Check if shortcuts should be displayed in menus.

Returns
boolean True if shortcuts should be displayed in menus.