GravityCompat

Kotlin |Java

class GravityCompat

kotlin.Any
↳	androidx.core.view.GravityCompat

Compatibility shim for accessing newer functionality from android.view.Gravity.

Summary

Constants
static Int	END Push object to x-axis position at the end of its container, not changing its size.
static Int	RELATIVE_HORIZONTAL_GRAVITY_MASK Binary mask for the horizontal gravity and script specific direction bit.
static Int	RELATIVE_LAYOUT_DIRECTION Raw bit controlling whether the layout direction is relative or not (START/END instead of absolute LEFT/RIGHT).
static Int	START Push object to x-axis position at the start of its container, not changing its size.

Public methods
static Unit	apply(gravity: Int, w: Int, h: Int, container: Rect!, outRect: Rect!, layoutDirection: Int) Apply a gravity constant to an object and take care if layout direction is RTL or not.
static Unit	apply(gravity: Int, w: Int, h: Int, container: Rect!, xAdj: Int, yAdj: Int, outRect: Rect!, layoutDirection: Int) Apply a gravity constant to an object.
static Unit	applyDisplay(gravity: Int, display: Rect!, inoutObj: Rect!, layoutDirection: Int) Apply additional gravity behavior based on the overall "display" that an object exists in.
static Int	getAbsoluteGravity(gravity: Int, layoutDirection: Int) Convert script specific gravity to absolute horizontal value.

Constants

END

static val END: Int

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

Value: RELATIVE_LAYOUT_DIRECTION | Gravity.RIGHT

RELATIVE_HORIZONTAL_GRAVITY_MASK

static val RELATIVE_HORIZONTAL_GRAVITY_MASK: Int

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

Value: START | END

RELATIVE_LAYOUT_DIRECTION

static val RELATIVE_LAYOUT_DIRECTION: Int

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

Value: 0x00800000

START

static val START: Int

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

Value: RELATIVE_LAYOUT_DIRECTION | Gravity.LEFT

Public methods

apply

static fun apply(
    gravity: Int, 
    w: Int, 
    h: Int, 
    container: Rect!, 
    outRect: Rect!, 
    layoutDirection: Int
): Unit

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

Parameters
gravity	Int: The desired placement of the object, as defined by the constants in this class.
w	Int: The horizontal size of the object.
h	Int: The vertical size of the object.
container	Rect!: 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	Rect!: Receives the computed frame of the object in its container.
layoutDirection	Int: The layout direction.

See Also

• ViewCompat#LAYOUT_DIRECTION_LTRViewCompat#LAYOUT_DIRECTION_RTL

apply

static fun apply(
    gravity: Int, 
    w: Int, 
    h: Int, 
    container: Rect!, 
    xAdj: Int, 
    yAdj: Int, 
    outRect: Rect!, 
    layoutDirection: Int
): Unit

Apply a gravity constant to an object.

Parameters
gravity	Int: The desired placement of the object, as defined by the constants in this class.
w	Int: The horizontal size of the object.
h	Int: The vertical size of the object.
container	Rect!: 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	Int: 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	Int: 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	Rect!: Receives the computed frame of the object in its container.
layoutDirection	Int: The layout direction.

See Also

• ViewCompat#LAYOUT_DIRECTION_LTRViewCompat#LAYOUT_DIRECTION_RTL

applyDisplay

static fun applyDisplay(
    gravity: Int, 
    display: Rect!, 
    inoutObj: Rect!, 
    layoutDirection: Int
): Unit

Apply additional gravity behavior based on the overall "display" that an object exists in. This can be used after android.view.Gravity#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 android.view.Gravity#DISPLAY_CLIP_HORIZONTAL and android.view.Gravity#DISPLAY_CLIP_VERTICAL can be used to change this behavior.

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

See Also

• ViewCompat#LAYOUT_DIRECTION_LTRViewCompat#LAYOUT_DIRECTION_RTL

getAbsoluteGravity

static fun getAbsoluteGravity(
    gravity: Int, 
    layoutDirection: Int
): Int

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	Int: The gravity to convert to absolute (horizontal) values.
layoutDirection	Int: The layout direction.

Return
Int	gravity converted to absolute (horizontal) values.