AppBarLayout.LayoutParams
public
static
class
AppBarLayout.LayoutParams
extends LinearLayout.LayoutParams
java.lang.Object | ||||
↳ | android.view.ViewGroup.LayoutParams | |||
↳ | android.view.ViewGroup.MarginLayoutParams | |||
↳ | android.widget.LinearLayout.LayoutParams | |||
↳ | com.google.android.material.appbar.AppBarLayout.LayoutParams |
A ViewGroup.LayoutParams
implementation for AppBarLayout
.
Summary
XML attributes | |
---|---|
AppBarLayout_Layout_layout_scrollFlags |
|
AppBarLayout_Layout_layout_scrollInterpolator |
Constants | |
---|---|
int |
SCROLL_FLAG_ENTER_ALWAYS
When entering (scrolling on screen) the view will scroll on any downwards scroll event, regardless of whether the scrolling view is also scrolling. |
int |
SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED
An additional flag for 'enterAlways' which modifies the returning view to only initially scroll back to it's collapsed height. |
int |
SCROLL_FLAG_EXIT_UNTIL_COLLAPSED
When exiting (scrolling off screen) the view will be scrolled until it is 'collapsed'. |
int |
SCROLL_FLAG_NO_SCROLL
Disable scrolling on the view. |
int |
SCROLL_FLAG_SCROLL
The view will be scroll in direct relation to scroll events. |
int |
SCROLL_FLAG_SNAP
Upon a scroll ending, if the view is only partially visible then it will be snapped and scrolled to its closest edge. |
int |
SCROLL_FLAG_SNAP_MARGINS
An additional flag to be used with 'snap'. |
Inherited constants |
---|
![]()
android.view.ViewGroup.LayoutParams
|
Inherited fields |
---|
![]()
android.widget.LinearLayout.LayoutParams
|
![]()
android.view.ViewGroup.MarginLayoutParams
|
![]()
android.view.ViewGroup.LayoutParams
|
Public constructors | |
---|---|
AppBarLayout.LayoutParams(Context c, AttributeSet attrs)
|
|
AppBarLayout.LayoutParams(int width, int height)
|
|
AppBarLayout.LayoutParams(int width, int height, float weight)
|
|
AppBarLayout.LayoutParams(ViewGroup.LayoutParams p)
|
|
AppBarLayout.LayoutParams(ViewGroup.MarginLayoutParams source)
|
|
AppBarLayout.LayoutParams(LinearLayout.LayoutParams source)
|
|
AppBarLayout.LayoutParams(AppBarLayout.LayoutParams source)
|
Public methods | |
---|---|
int
|
getScrollFlags()
Returns the scrolling flags. |
Interpolator
|
getScrollInterpolator()
Returns the |
void
|
setScrollFlags(int flags)
Set the scrolling flags. |
void
|
setScrollInterpolator(Interpolator interpolator)
Set the interpolator to when scrolling the view associated with this |
Inherited methods | |
---|---|
![]()
android.widget.LinearLayout.LayoutParams
| |
![]()
android.view.ViewGroup.MarginLayoutParams
| |
![]()
android.view.ViewGroup.LayoutParams
| |
![]()
java.lang.Object
|
XML attributes
AppBarLayout_Layout_layout_scrollFlags
Related methods:
AppBarLayout_Layout_layout_scrollInterpolator
Related methods:
Constants
SCROLL_FLAG_ENTER_ALWAYS
int SCROLL_FLAG_ENTER_ALWAYS
When entering (scrolling on screen) the view will scroll on any downwards scroll event, regardless of whether the scrolling view is also scrolling. This is commonly referred to as the 'quick return' pattern.
Constant Value: 4 (0x00000004)
SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED
int SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED
An additional flag for 'enterAlways' which modifies the returning view to only initially scroll back to it's collapsed height. Once the scrolling view has reached the end of it's scroll range, the remainder of this view will be scrolled into view. The collapsed height is defined by the view's minimum height.
Constant Value: 8 (0x00000008)
SCROLL_FLAG_EXIT_UNTIL_COLLAPSED
int SCROLL_FLAG_EXIT_UNTIL_COLLAPSED
When exiting (scrolling off screen) the view will be scrolled until it is 'collapsed'. The collapsed height is defined by the view's minimum height.
Constant Value: 2 (0x00000002)
SCROLL_FLAG_NO_SCROLL
int SCROLL_FLAG_NO_SCROLL
Disable scrolling on the view. This flag should not be combined with any of the other scroll flags.
Constant Value: 0 (0x00000000)
SCROLL_FLAG_SCROLL
int SCROLL_FLAG_SCROLL
The view will be scroll in direct relation to scroll events. This flag needs to be set for any of the other flags to take effect. If any sibling views before this one do not have this flag, then this value has no effect.
Constant Value: 1 (0x00000001)
SCROLL_FLAG_SNAP
int SCROLL_FLAG_SNAP
Upon a scroll ending, if the view is only partially visible then it will be snapped and scrolled to its closest edge. For example, if the view only has its bottom 25% displayed, it will be scrolled off screen completely. Conversely, if its bottom 75% is visible then it will be scrolled fully into view.
Constant Value: 16 (0x00000010)
SCROLL_FLAG_SNAP_MARGINS
int SCROLL_FLAG_SNAP_MARGINS
An additional flag to be used with 'snap'. If set, the view will be snapped to its top and bottom margins, as opposed to the edges of the view itself.
Constant Value: 32 (0x00000020)
Public constructors
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (Context c, AttributeSet attrs)
Parameters | |
---|---|
c |
Context |
attrs |
AttributeSet |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (int width, int height)
Parameters | |
---|---|
width |
int |
height |
int |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (int width, int height, float weight)
Parameters | |
---|---|
width |
int |
height |
int |
weight |
float |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (ViewGroup.LayoutParams p)
Parameters | |
---|---|
p |
ViewGroup.LayoutParams |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (ViewGroup.MarginLayoutParams source)
Parameters | |
---|---|
source |
ViewGroup.MarginLayoutParams |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (LinearLayout.LayoutParams source)
Parameters | |
---|---|
source |
LinearLayout.LayoutParams |
AppBarLayout.LayoutParams
AppBarLayout.LayoutParams (AppBarLayout.LayoutParams source)
Parameters | |
---|---|
source |
AppBarLayout.LayoutParams |
Public methods
getScrollFlags
int getScrollFlags ()
Returns the scrolling flags.
Related XML Attributes:
Returns | |
---|---|
int |
See also:
getScrollInterpolator
Interpolator getScrollInterpolator ()
Returns the Interpolator
being used for scrolling the view associated with this
AppBarLayout.LayoutParams
. Null indicates 'normal' 1-to-1 scrolling.
Related XML Attributes:
Returns | |
---|---|
Interpolator |
See also:
setScrollFlags
void setScrollFlags (int flags)
Set the scrolling flags.
Related XML Attributes:
Parameters | |
---|---|
flags |
int : bitwise int of SCROLL_FLAG_SCROLL , SCROLL_FLAG_EXIT_UNTIL_COLLAPSED , SCROLL_FLAG_ENTER_ALWAYS , SCROLL_FLAG_ENTER_ALWAYS_COLLAPSED , SCROLL_FLAG_SNAP , and SCROLL_FLAG_SNAP_MARGINS . Otherwise, use SCROLL_FLAG_NO_SCROLL to disable
scrolling. |
See also:
setScrollInterpolator
void setScrollInterpolator (Interpolator interpolator)
Set the interpolator to when scrolling the view associated with this AppBarLayout.LayoutParams
.
Related XML Attributes:
Parameters | |
---|---|
interpolator |
Interpolator : the interpolator to use, or null to use normal 1-to-1 scrolling. |
See also:
Interfaces
Classes
- AppBarLayout
- AppBarLayout.BaseBehavior
- AppBarLayout.BaseBehavior.BaseDragCallback
- AppBarLayout.BaseBehavior.SavedState
- AppBarLayout.Behavior
- AppBarLayout.Behavior.DragCallback
- AppBarLayout.LayoutParams
- AppBarLayout.ScrollingViewBehavior
- CollapsingToolbarLayout
- CollapsingToolbarLayout.LayoutParams
- MaterialToolbar
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-12-27 UTC.