Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

GravityCompat

extends Object
java.lang.Object
   ↳ android.support.v4.view.GravityCompat

Class Overview

Compatibility shim for accessing newer functionality from Gravity .

Summary

Constants
int END Push object to x-axis position at the end of its container, not changing its size.
int RELATIVE_HORIZONTAL_GRAVITY_MASK Binary mask for the horizontal gravity and script specific direction bit.
int RELATIVE_LAYOUT_DIRECTION Raw bit controlling whether the layout direction is relative or not (START/END instead of absolute LEFT/RIGHT).
int START Push object to x-axis position at the start of its container, not changing its size.
Public Constructors
GravityCompat ()
Public Methods
static void apply (int gravity, int w, int h, Rect container, Rect outRect, int layoutDirection)
Apply a gravity constant to an object and take care if layout direction is RTL or not.
static void apply (int gravity, int w, int h, Rect container, int xAdj, int yAdj, Rect outRect, int layoutDirection)
Apply a gravity constant to an object.
static void applyDisplay (int gravity, Rect display, Rect inoutObj, int layoutDirection)
Apply additional gravity behavior based on the overall "display" that an object exists in.
static int getAbsoluteGravity (int gravity, int layoutDirection)

Convert script specific gravity to absolute horizontal value.

[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int END

Push object to x-axis position at the end of its container, not changing its size.

Constant Value: 8388613 (0x00800005)

public static final int RELATIVE_HORIZONTAL_GRAVITY_MASK

Binary mask for the horizontal gravity and script specific direction bit.

Constant Value: 8388615 (0x00800007)

public static final int RELATIVE_LAYOUT_DIRECTION

Raw bit controlling whether the layout direction is relative or not (START/END instead of absolute LEFT/RIGHT).

Constant Value: 8388608 (0x00800000)

public static final int START

Push object to x-axis position at the start of its container, not changing its size.

Constant Value: 8388611 (0x00800003)

Public Constructors

public GravityCompat ()

Public Methods

public static void apply (int gravity, int w, int h, Rect container, Rect outRect, int layoutDirection)

Apply a gravity constant to an object and take care if layout direction is RTL or not.

Parameters
gravity The desired placement of the object, as defined by the constants in this class.
w The horizontal size of the object.
h The vertical size of the object.
container The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.
outRect Receives the computed frame of the object in its container.
layoutDirection The layout direction.
See Also

public static void apply (int gravity, int w, int h, Rect container, int xAdj, int yAdj, Rect outRect, int layoutDirection)

Apply a gravity constant to an object.

Parameters
gravity The desired placement of the object, as defined by the constants in this class.
w The horizontal size of the object.
h The vertical size of the object.
container The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.
xAdj Offset to apply to the X axis. If gravity is LEFT this pushes it to the right; if gravity is RIGHT it pushes it to the left; if gravity is CENTER_HORIZONTAL it pushes it to the right or left; otherwise it is ignored.
yAdj Offset to apply to the Y axis. If gravity is TOP this pushes it down; if gravity is BOTTOM it pushes it up; if gravity is CENTER_VERTICAL it pushes it down or up; otherwise it is ignored.
outRect Receives the computed frame of the object in its container.
layoutDirection The layout direction.
See Also

public static void applyDisplay (int gravity, Rect display, Rect inoutObj, int layoutDirection)

Apply additional gravity behavior based on the overall "display" that an object exists in. This can be used after apply(int, int, int, Rect, int, int, Rect) to place the object within a visible display. By default this moves or clips the object to be visible in the display; the gravity flags DISPLAY_CLIP_HORIZONTAL and DISPLAY_CLIP_VERTICAL can be used to change this behavior.

Parameters
gravity Gravity constants to modify the placement within the display.
display The rectangle of the display in which the object is being placed.
inoutObj Supplies the current object position; returns with it modified if needed to fit in the display.
layoutDirection The layout direction.
See Also

public static int getAbsoluteGravity (int gravity, int layoutDirection)

Convert script specific gravity to absolute horizontal value.

if horizontal direction is LTR, then START will set LEFT and END will set RIGHT. if horizontal direction is RTL, then START will set RIGHT and END will set LEFT.
Parameters
gravity The gravity to convert to absolute (horizontal) values.
layoutDirection The layout direction.
Returns
  • gravity converted to absolute (horizontal) values.