ItemAlignmentDef
class ItemAlignmentDef
kotlin.Any | |
↳ | androidx.leanback.widget.ItemAlignmentFacet.ItemAlignmentDef |
Definition of an alignment position under a view.
Summary
Public constructors | |
---|---|
<init>() Definition of an alignment position under a view. |
Public methods | |
---|---|
Int |
Returns Id of which child view take focus for alignment. |
Int |
Returns number of pixels to the end of low edge. |
Float |
Gets the offset percent for item alignment in addition to offset. |
Int |
Returns Id of which child view to be aligned. |
open Boolean |
Returns true when View should be aligned to |
Boolean |
Returns true if applies padding to item alignment when |
Unit |
setAlignedToTextViewBaseline(alignToBaseline: Boolean) When true, align to |
Unit |
setItemAlignmentFocusViewId(viewId: Int) Sets Id of which child view take focus for alignment. |
Unit |
setItemAlignmentOffset(offset: Int) Sets number of pixels to the end of low edge. |
Unit |
setItemAlignmentOffsetPercent(percent: Float) Sets the offset percent for item alignment in addition to offset. |
Unit |
setItemAlignmentOffsetWithPadding(withPadding: Boolean) Sets whether applies padding to item alignment when |
Unit |
setItemAlignmentViewId(viewId: Int) Sets Id of which child view to be aligned. |
Public constructors
<init>
ItemAlignmentDef()
Definition of an alignment position under a view.
Public methods
getItemAlignmentFocusViewId
fun getItemAlignmentFocusViewId(): Int
Returns Id of which child view take focus for alignment. When not set, it will use use same id of getItemAlignmentViewId()
getItemAlignmentOffset
fun getItemAlignmentOffset(): Int
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.
Return | |
---|---|
Int |
Number of pixels to the end of low edge. |
getItemAlignmentOffsetPercent
fun getItemAlignmentOffsetPercent(): Float
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 ITEM_ALIGN_OFFSET_PERCENT_DISABLED
to disable.
getItemAlignmentViewId
fun getItemAlignmentViewId(): Int
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 ItemAlignmentDef
s, 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.
See Also
isAlignedToTextViewBaseLine
open fun isAlignedToTextViewBaseLine(): Boolean
Returns true when View should be aligned to View#getBaseline()
isItemAlignmentOffsetWithPadding
fun isItemAlignmentOffsetWithPadding(): Boolean
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
setAlignedToTextViewBaseline
fun setAlignedToTextViewBaseline(alignToBaseline: Boolean): Unit
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
fun setItemAlignmentFocusViewId(viewId: Int): Unit
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
fun setItemAlignmentOffset(offset: Int): Unit
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
fun setItemAlignmentOffsetPercent(percent: Float): Unit
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 ITEM_ALIGN_OFFSET_PERCENT_DISABLED
to disable.
setItemAlignmentOffsetWithPadding
fun setItemAlignmentOffsetWithPadding(withPadding: Boolean): Unit
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
setItemAlignmentViewId
fun setItemAlignmentViewId(viewId: Int): Unit
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 ItemAlignmentDef
s, 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. |
See Also