public
final
class
ItemAlignmentFacet
extends Object
| java.lang.Object | |
| ↳ | android.support.v17.leanback.widget.ItemAlignmentFacet |
Optional facet provided by RecyclerView.Adapter or RecyclerView.ViewHolder for
use in HorizontalGridView and VerticalGridView. Apps using Presenter may
set facet using setFacet(Class, Object) or
setFacet(Class, Object). Facet on ViewHolder has a higher priority
than Presenter or Adapter.
ItemAlignmentFacet contains single or multiple ItemAlignmentFacet.ItemAlignmentDefs. First
ItemAlignmentFacet.ItemAlignmentDef describes the default alignment position for ViewHolder, it also
overrides the default item alignment settings on VerticalGridView and
HorizontalGridView. When there are multiple ItemAlignmentFacet.ItemAlignmentDefs, the extra
ItemAlignmentFacet.ItemAlignmentDefs are used to calculate deltas from first alignment position. When a
descendant view is focused within the ViewHolder, grid view will visit focused view and its
ancestors till the root of ViewHolder to match extra ItemAlignmentFacet.ItemAlignmentDefs'
getItemAlignmentViewId(). Once a match found, the
ItemAlignmentFacet.ItemAlignmentDef is used to adjust a scroll delta from default alignment position.
Nested classes | |
|---|---|
class |
ItemAlignmentFacet.ItemAlignmentDef
Definition of an alignment position under a view. |
Constants | |
|---|---|
float |
ITEM_ALIGN_OFFSET_PERCENT_DISABLED
Value indicates that percent is not used. |
Public constructors | |
|---|---|
ItemAlignmentFacet()
|
|
Public methods | |
|---|---|
ItemAlignmentDef[]
|
getAlignmentDefs()
Returns read only definitions of alignment positions. |
boolean
|
isMultiAlignment()
|
void
|
setAlignmentDefs(ItemAlignmentDef[] defs)
Sets definitions of alignment positions. |
Inherited methods | |
|---|---|
java.lang.Object
| |
float ITEM_ALIGN_OFFSET_PERCENT_DISABLED
Value indicates that percent is not used.
Constant Value: -1.0
ItemAlignmentFacet ()
ItemAlignmentDef[] getAlignmentDefs ()
Returns read only definitions of alignment positions.
| Returns | |
|---|---|
ItemAlignmentDef[] |
|
boolean isMultiAlignment ()
| Returns | |
|---|---|
boolean |
|
void setAlignmentDefs (ItemAlignmentDef[] defs)
Sets definitions of alignment positions.
| Parameters | |
|---|---|
defs |
ItemAlignmentDef
|