Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!
added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0

ItemAlignmentFacet.ItemAlignmentDef

public static class ItemAlignmentFacet.ItemAlignmentDef
extends Object

java.lang.Object
   ↳ androidx.leanback.widget.ItemAlignmentFacet.ItemAlignmentDef


Definition of an alignment position under a view.

Summary

Public constructors

ItemAlignmentFacet.ItemAlignmentDef()

Public methods

final int getItemAlignmentFocusViewId()

Returns Id of which child view take focus for alignment.

final int getItemAlignmentOffset()

Returns number of pixels to the end of low edge.

final float getItemAlignmentOffsetPercent()

Gets the offset percent for item alignment in addition to offset.

final int getItemAlignmentViewId()

Returns Id of which child view to be aligned.

boolean isAlignedToTextViewBaseLine()

Returns true when View should be aligned to View.getBaseline()

final boolean isItemAlignmentOffsetWithPadding()

Returns true if applies padding to item alignment when getItemAlignmentOffsetPercent() is 0 or 100; returns false otherwise.

final void setAlignedToTextViewBaseline(boolean alignToBaseline)

When true, align to View.getBaseline() for the view of with id equals getItemAlignmentViewId(); false otherwise.

final void setItemAlignmentFocusViewId(int viewId)

Sets Id of which child view take focus for alignment.

final void setItemAlignmentOffset(int offset)

Sets number of pixels to the end of low edge.

final void setItemAlignmentOffsetPercent(float percent)

Sets the offset percent for item alignment in addition to offset.

final void setItemAlignmentOffsetWithPadding(boolean withPadding)

Sets whether applies padding to item alignment when getItemAlignmentOffsetPercent() is 0 or 100.

final void setItemAlignmentViewId(int viewId)

Sets Id of which child view to be aligned.

Inherited methods

Public constructors

ItemAlignmentFacet.ItemAlignmentDef

added in version 1.0.0
public ItemAlignmentFacet.ItemAlignmentDef ()

Public methods

getItemAlignmentFocusViewId

added in version 1.0.0
public final int getItemAlignmentFocusViewId ()

Returns Id of which child view take focus for alignment. When not set, it will use use same id of getItemAlignmentViewId()

Returns
int

getItemAlignmentOffset

added in version 1.0.0
public final int getItemAlignmentOffset ()

Returns number of pixels to the end of low edge. Supports right to left layout direction. In left to right or vertical case, it's the offset added to left/top edge. In right to left case, it's the offset subtracted from right edge.

Returns
int Number of pixels to the end of low edge.

getItemAlignmentOffsetPercent

added in version 1.0.0
public final float getItemAlignmentOffsetPercent ()

Gets the offset percent for item alignment in addition to offset. E.g., 40 means 40% of the width from the low edge. In the right to left case, it's the 40% from right edge. Use ItemAlignmentFacet.ITEM_ALIGN_OFFSET_PERCENT_DISABLED to disable.

Returns
float

getItemAlignmentViewId

added in version 1.0.0
public final int getItemAlignmentViewId ()

Returns Id of which child view to be aligned. View.NO_ID refers to root view and should be only used in first one. Different view ids of #getAlignmentDefs() define multiple alignment steps within one itemView, e.g. there are two child views R.id.child1 and R.id.child2. App may allocated two ItemAlignmentFacet.ItemAlignmentDefs, one with view id R.id.child1, the other with view id R.id.child2. Note this id may or may not be same as the child view that takes focus.

Returns
int

isAlignedToTextViewBaseLine

added in version 1.0.0
public boolean isAlignedToTextViewBaseLine ()

Returns true when View should be aligned to View.getBaseline()

Returns
boolean

isItemAlignmentOffsetWithPadding

added in version 1.0.0
public final boolean isItemAlignmentOffsetWithPadding ()

Returns true if applies padding to item alignment when getItemAlignmentOffsetPercent() is 0 or 100; returns false otherwise.

When true: Applies start/top padding when getItemAlignmentOffsetPercent() is 0. Applies end/bottom padding when getItemAlignmentOffsetPercent() is 100. Does not apply padding if getItemAlignmentOffsetPercent() is neither 0 nor 100.

When false: does not apply padding

Returns
boolean

setAlignedToTextViewBaseline

added in version 1.0.0
public final void setAlignedToTextViewBaseline (boolean alignToBaseline)

When true, align to View.getBaseline() for the view of with id equals getItemAlignmentViewId(); false otherwise.

Parameters
alignToBaseline boolean: Boolean indicating whether to align to view baseline.

setItemAlignmentFocusViewId

added in version 1.0.0
public final void setItemAlignmentFocusViewId (int viewId)

Sets Id of which child view take focus for alignment. When not set, it will use use same id of getItemAlignmentViewId().

Parameters
viewId int: The id of child view that will be focused to.

setItemAlignmentOffset

added in version 1.0.0
public final void setItemAlignmentOffset (int offset)

Sets number of pixels to the end of low edge. Supports right to left layout direction.

Parameters
offset int: In left to right or vertical case, it's the offset added to left/top edge. In right to left case, it's the offset subtracted from right edge.

setItemAlignmentOffsetPercent

added in version 1.0.0
public final void setItemAlignmentOffsetPercent (float percent)

Sets the offset percent for item alignment in addition to offset. E.g., 40 means 40% of width/height from the low edge. In the right to left case, it's the 40% width from right edge. Use ItemAlignmentFacet.ITEM_ALIGN_OFFSET_PERCENT_DISABLED to disable.

Parameters
percent float

setItemAlignmentOffsetWithPadding

added in version 1.0.0
public final void setItemAlignmentOffsetWithPadding (boolean withPadding)

Sets whether applies padding to item alignment when getItemAlignmentOffsetPercent() is 0 or 100.

When true: Applies start/top padding if getItemAlignmentOffsetPercent() is 0. Applies end/bottom padding if getItemAlignmentOffsetPercent() is 100. Does not apply padding if getItemAlignmentOffsetPercent() is neither 0 nor 100.

When false: does not apply padding

Parameters
withPadding boolean

setItemAlignmentViewId

added in version 1.0.0
public final void setItemAlignmentViewId (int viewId)

Sets Id of which child view to be aligned. View.NO_ID refers to root view and should be only used in first one. Different view ids of #getAlignmentDefs() define multiple alignment steps within one itemView, e.g. there are two child views R.id.child1 and R.id.child2. App may allocated two ItemAlignmentFacet.ItemAlignmentDefs, one with view id R.id.child1, the other with view id R.id.child2. Note this id may or may not be same as the child view that takes focus.

Parameters
viewId int: The id of child view that will be aligned to.