belongs to Maven artifact androidx.appcompat:appcompat:1.0.0-alpha1

LinearLayoutCompat

public class LinearLayoutCompat
extends ViewGroup

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ androidx.appcompat.widget.LinearLayoutCompat


A Layout that arranges its children in a single column or a single row. The direction of the row can be set by calling setOrientation(). You can also specify gravity, which specifies the alignment of all the child elements by calling setGravity() or specify that specific children grow to fill up any remaining space in the layout by setting the weight member of LinearLayoutCompat.LayoutParams. The default orientation is horizontal.

See the Linear Layout guide.

Also see LinearLayoutCompat.LayoutParams for layout attributes

Summary

Nested classes

class LinearLayoutCompat.LayoutParams

Per-child layout information associated with ViewLinearLayout. 

Constants

int HORIZONTAL

int SHOW_DIVIDER_BEGINNING

Show a divider at the beginning of the group.

int SHOW_DIVIDER_END

Show a divider at the end of the group.

int SHOW_DIVIDER_MIDDLE

Show dividers between each item in the group.

int SHOW_DIVIDER_NONE

Don't show any dividers.

int VERTICAL

Inherited constants

Inherited fields

Public constructors

LinearLayoutCompat(Context context)
LinearLayoutCompat(Context context, AttributeSet attrs)
LinearLayoutCompat(Context context, AttributeSet attrs, int defStyleAttr)

Public methods

LinearLayoutCompat.LayoutParams generateLayoutParams(AttributeSet attrs)
int getBaseline()
int getBaselineAlignedChildIndex()
Drawable getDividerDrawable()
int getDividerPadding()

Get the padding size used to inset dividers in pixels

int getGravity()

Returns the current gravity.

int getOrientation()

Returns the current orientation.

int getShowDividers()
float getWeightSum()

Returns the desired weights sum.

boolean isBaselineAligned()

Indicates whether widgets contained within this layout are aligned on their baseline or not.

boolean isMeasureWithLargestChildEnabled()

When true, all children with a weight will be considered having the minimum size of the largest child.

void onInitializeAccessibilityEvent(AccessibilityEvent event)
void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)
void setBaselineAligned(boolean baselineAligned)

Defines whether widgets contained in this layout are baseline-aligned or not.

void setBaselineAlignedChildIndex(int i)
void setDividerDrawable(Drawable divider)

Set a drawable to be used as a divider between items.

void setDividerPadding(int padding)

Set padding displayed on both ends of dividers.

void setGravity(int gravity)

Describes how the child views are positioned.

void setHorizontalGravity(int horizontalGravity)
void setMeasureWithLargestChildEnabled(boolean enabled)

When set to true, all children with a weight will be considered having the minimum size of the largest child.

void setOrientation(int orientation)

Should the layout be a column or a row.

void setShowDividers(int showDividers)

Set how dividers should be shown between items in this layout

void setVerticalGravity(int verticalGravity)
void setWeightSum(float weightSum)

Defines the desired weights sum.

boolean shouldDelayChildPressedState()

Protected methods

boolean checkLayoutParams(ViewGroup.LayoutParams p)
LinearLayoutCompat.LayoutParams generateDefaultLayoutParams()

Returns a set of layout parameters with a width of ViewGroup.LayoutParams.MATCH_PARENT and a height of ViewGroup.LayoutParams.WRAP_CONTENT when the layout's orientation is VERTICAL.

LinearLayoutCompat.LayoutParams generateLayoutParams(ViewGroup.LayoutParams p)
void onDraw(Canvas canvas)
void onLayout(boolean changed, int l, int t, int r, int b)
void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Inherited methods

Constants

HORIZONTAL

int HORIZONTAL

Constant Value: 0 (0x00000000)

SHOW_DIVIDER_BEGINNING

int SHOW_DIVIDER_BEGINNING

Show a divider at the beginning of the group.

Constant Value: 1 (0x00000001)

SHOW_DIVIDER_END

int SHOW_DIVIDER_END

Show a divider at the end of the group.

Constant Value: 4 (0x00000004)

SHOW_DIVIDER_MIDDLE

int SHOW_DIVIDER_MIDDLE

Show dividers between each item in the group.

Constant Value: 2 (0x00000002)

SHOW_DIVIDER_NONE

int SHOW_DIVIDER_NONE

Don't show any dividers.

Constant Value: 0 (0x00000000)

VERTICAL

int VERTICAL

Constant Value: 1 (0x00000001)

Public constructors

LinearLayoutCompat

LinearLayoutCompat (Context context)

Parameters
context Context

LinearLayoutCompat

LinearLayoutCompat (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

LinearLayoutCompat

LinearLayoutCompat (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

Public methods

generateLayoutParams

LinearLayoutCompat.LayoutParams generateLayoutParams (AttributeSet attrs)

Parameters
attrs AttributeSet

Returns
LinearLayoutCompat.LayoutParams

getBaseline

int getBaseline ()

Returns
int

getBaselineAlignedChildIndex

int getBaselineAlignedChildIndex ()

Returns
int The index of the child that will be used if this layout is part of a larger layout that is baseline aligned, or -1 if none has been set.

getDividerDrawable

Drawable getDividerDrawable ()

Returns
Drawable the divider Drawable that will divide each item.

getDividerPadding

int getDividerPadding ()

Get the padding size used to inset dividers in pixels

Returns
int

getGravity

int getGravity ()

Returns the current gravity. See Gravity

Returns
int the current gravity.

See also:

getOrientation

int getOrientation ()

Returns the current orientation.

Returns
int either HORIZONTAL or VERTICAL

getShowDividers

int getShowDividers ()

Returns
int A flag set indicating how dividers should be shown around items.

getWeightSum

float getWeightSum ()

Returns the desired weights sum.

Returns
float A number greater than 0.0f if the weight sum is defined, or a number lower than or equals to 0.0f if not weight sum is to be used.

isBaselineAligned

boolean isBaselineAligned ()

Indicates whether widgets contained within this layout are aligned on their baseline or not.

Returns
boolean true when widgets are baseline-aligned, false otherwise

isMeasureWithLargestChildEnabled

boolean isMeasureWithLargestChildEnabled ()

When true, all children with a weight will be considered having the minimum size of the largest child. If false, all children are measured normally.

Returns
boolean True to measure children with a weight using the minimum size of the largest child, false otherwise.

onInitializeAccessibilityEvent

void onInitializeAccessibilityEvent (AccessibilityEvent event)

Parameters
event AccessibilityEvent

onInitializeAccessibilityNodeInfo

void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfo info)

Parameters
info AccessibilityNodeInfo

setBaselineAligned

void setBaselineAligned (boolean baselineAligned)

Defines whether widgets contained in this layout are baseline-aligned or not.

Parameters
baselineAligned boolean: true to align widgets on their baseline, false otherwise

setBaselineAlignedChildIndex

void setBaselineAlignedChildIndex (int i)

Parameters
i int: The index of the child that will be used if this layout is part of a larger layout that is baseline aligned.

setDividerDrawable

void setDividerDrawable (Drawable divider)

Set a drawable to be used as a divider between items.

Parameters
divider Drawable: Drawable that will divide each item.

setDividerPadding

void setDividerPadding (int padding)

Set padding displayed on both ends of dividers.

Parameters
padding int: Padding value in pixels that will be applied to each end

setGravity

void setGravity (int gravity)

Describes how the child views are positioned. Defaults to GRAVITY_TOP. If this layout has a VERTICAL orientation, this controls where all the child views are placed if there is extra vertical space. If this layout has a HORIZONTAL orientation, this controls the alignment of the children.

Parameters
gravity int: See Gravity

setHorizontalGravity

void setHorizontalGravity (int horizontalGravity)

Parameters
horizontalGravity int

setMeasureWithLargestChildEnabled

void setMeasureWithLargestChildEnabled (boolean enabled)

When set to true, all children with a weight will be considered having the minimum size of the largest child. If false, all children are measured normally. Disabled by default.

Parameters
enabled boolean: True to measure children with a weight using the minimum size of the largest child, false otherwise.

setOrientation

void setOrientation (int orientation)

Should the layout be a column or a row.

Parameters
orientation int: Pass HORIZONTAL or VERTICAL. Default value is HORIZONTAL.

setShowDividers

void setShowDividers (int showDividers)

Set how dividers should be shown between items in this layout

Parameters
showDividers int: One or more of SHOW_DIVIDER_BEGINNING, SHOW_DIVIDER_MIDDLE, or SHOW_DIVIDER_END, or SHOW_DIVIDER_NONE to show no dividers.

setVerticalGravity

void setVerticalGravity (int verticalGravity)

Parameters
verticalGravity int

setWeightSum

void setWeightSum (float weightSum)

Defines the desired weights sum. If unspecified the weights sum is computed at layout time by adding the layout_weight of each child. This can be used for instance to give a single child 50% of the total available space by giving it a layout_weight of 0.5 and setting the weightSum to 1.0.

Parameters
weightSum float: a number greater than 0.0f, or a number lower than or equals to 0.0f if the weight sum should be computed from the children's layout_weight

shouldDelayChildPressedState

boolean shouldDelayChildPressedState ()

Returns
boolean

Protected methods

checkLayoutParams

boolean checkLayoutParams (ViewGroup.LayoutParams p)

Parameters
p ViewGroup.LayoutParams

Returns
boolean

generateDefaultLayoutParams

LinearLayoutCompat.LayoutParams generateDefaultLayoutParams ()

Returns a set of layout parameters with a width of ViewGroup.LayoutParams.MATCH_PARENT and a height of ViewGroup.LayoutParams.WRAP_CONTENT when the layout's orientation is VERTICAL. When the orientation is HORIZONTAL, the width is set to ViewGroup.LayoutParams.WRAP_CONTENT and the height to ViewGroup.LayoutParams.WRAP_CONTENT.

Returns
LinearLayoutCompat.LayoutParams

generateLayoutParams

LinearLayoutCompat.LayoutParams generateLayoutParams (ViewGroup.LayoutParams p)

Parameters
p ViewGroup.LayoutParams

Returns
LinearLayoutCompat.LayoutParams

onDraw

void onDraw (Canvas canvas)

Parameters
canvas Canvas

onLayout

void onLayout (boolean changed, 
                int l, 
                int t, 
                int r, 
                int b)

Parameters
changed boolean

l int

t int

r int

b int

onMeasure

void onMeasure (int widthMeasureSpec, 
                int heightMeasureSpec)

Parameters
widthMeasureSpec int

heightMeasureSpec int