MarginLayoutParams
open class MarginLayoutParams : ViewGroup.LayoutParams
| kotlin.Any | ||
| ↳ | android.view.ViewGroup.LayoutParams | |
| ↳ | android.view.ViewGroup.MarginLayoutParams | |
Per-child layout information for layouts that support margins. See ViewGroup Margin Layout Attributes for a list of all child view attributes that this class supports.
Summary
| XML attributes | |
|---|---|
android:layout_margin | 
          Specifies extra space on the left, top, right and bottom sides of this view. | 
android:layout_marginBottom | 
          Specifies extra space on the bottom side of this view. | 
android:layout_marginEnd | 
          Specifies extra space on the end side of this view. | 
android:layout_marginHorizontal | 
          Specifies extra space on the left and right sides of this view. | 
android:layout_marginLeft | 
          Specifies extra space on the left side of this view. | 
android:layout_marginRight | 
          Specifies extra space on the right side of this view. | 
android:layout_marginStart | 
          Specifies extra space on the start side of this view. | 
android:layout_marginTop | 
          Specifies extra space on the top side of this view. | 
android:layout_marginVertical | 
          Specifies extra space on the top and bottom sides of this view. | 
| Inherited XML attributes | |
|---|---|
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
            MarginLayoutParams(c: Context!, attrs: AttributeSet!)Creates a new set of layout parameters.  | 
        |
            MarginLayoutParams(source: ViewGroup.LayoutParams!) | 
        |
| 
            
             Copy constructor.  | 
        |
            MarginLayoutParams(width: Int, height: Int) | 
        |
| Public methods | |
|---|---|
| open Int | 
            
             Retuns the layout direction.  | 
        
| open Int | 
            
             Returns the end margin in pixels.  | 
        
| open Int | 
            
             Returns the start margin in pixels.  | 
        
| open Boolean | 
            
             Check if margins are relative.  | 
        
| open Unit | 
            resolveLayoutDirection(layoutDirection: Int)This will be called by   | 
        
| open Unit | 
            setLayoutDirection(layoutDirection: Int)Set the layout direction  | 
        
| open Unit | 
            setMarginEnd(end: Int)Sets the relative end margin.  | 
        
| open Unit | 
            setMarginStart(start: Int)Sets the relative start margin.  | 
        
| open Unit | 
            setMargins(left: Int, top: Int, right: Int, bottom: Int)Sets the margins, in pixels.  | 
        
| Inherited functions | |
|---|---|
| Properties | |
|---|---|
| Int | 
            
             The bottom margin in pixels of the child.  | 
        
| Int | 
            
             The left margin in pixels of the child.  | 
        
| Int | 
            
             The right margin in pixels of the child.  | 
        
| Int | 
            
             The top margin in pixels of the child.  | 
        
| Inherited properties | |
|---|---|
XML attributes
android:layout_margin
android:layout_marginMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginBottom
android:layout_marginBottomMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginEnd
android:layout_marginEndMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginHorizontal
android:layout_marginHorizontalMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginLeft
android:layout_marginLeftMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginRight
android:layout_marginRightMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginStart
android:layout_marginStartMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginTop
android:layout_marginTopMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
android:layout_marginVertical
android:layout_marginVerticalMay be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
Public constructors
MarginLayoutParams
MarginLayoutParams(
c: Context!,
attrs: AttributeSet!)
Creates a new set of layout parameters. The values are extracted from the supplied attributes set and context.
| Parameters | |
|---|---|
c | 
            Context!: the application environment | 
attrs | 
            AttributeSet!: the set of attributes from which to extract the layout parameters' values | 
MarginLayoutParams
MarginLayoutParams(source: ViewGroup.MarginLayoutParams!)
Copy constructor. Clones the width, height and margin values of the source.
| Parameters | |
|---|---|
source | 
            ViewGroup.MarginLayoutParams!: The layout params to copy from. | 
Public methods
getLayoutDirection
open fun getLayoutDirection(): Int
Retuns the layout direction. Can be either View.LAYOUT_DIRECTION_LTR or View.LAYOUT_DIRECTION_RTL.
| Return | |
|---|---|
Int | 
            the layout direction. | 
getMarginEnd
open fun getMarginEnd(): Int
Returns the end margin in pixels.
| Return | |
|---|---|
Int | 
            the end margin in pixels. | 
getMarginStart
open fun getMarginStart(): Int
Returns the start margin in pixels.
| Return | |
|---|---|
Int | 
            the start margin in pixels. | 
isMarginRelative
open fun isMarginRelative(): Boolean
Check if margins are relative.
| Return | |
|---|---|
Boolean | 
            true if either marginStart or marginEnd has been set. | 
resolveLayoutDirection
open fun resolveLayoutDirection(layoutDirection: Int): Unit
This will be called by android.view.View#requestLayout(). Left and Right margins may be overridden depending on layout direction.
| Parameters | |
|---|---|
layoutDirection | 
            Int: the direction of the layout View.LAYOUT_DIRECTION_LTR View.LAYOUT_DIRECTION_RTL | 
          
setLayoutDirection
open fun setLayoutDirection(layoutDirection: Int): Unit
Set the layout direction
| Parameters | |
|---|---|
layoutDirection | 
            Int: the layout direction. Should be either View.LAYOUT_DIRECTION_LTR or View.LAYOUT_DIRECTION_RTL. | 
          
setMarginEnd
open fun setMarginEnd(end: Int): Unit
Sets the relative end margin. Margin values should be positive.
| Parameters | |
|---|---|
end | 
            Int: the end margin size | 
setMarginStart
open fun setMarginStart(start: Int): Unit
Sets the relative start margin. Margin values should be positive.
| Parameters | |
|---|---|
start | 
            Int: the start margin size | 
setMargins
open fun setMargins(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
Sets the margins, in pixels. A call to android.view.View#requestLayout() needs to be done so that the new margins are taken into account. Left and right margins may be overridden by android.view.View#requestLayout() depending on layout direction. Margin values should be positive.
| Parameters | |
|---|---|
left | 
            Int: the left margin size | 
top | 
            Int: the top margin size | 
right | 
            Int: the right margin size | 
bottom | 
            Int: the bottom margin size | 
Properties
bottomMargin
var bottomMargin: Int
The bottom margin in pixels of the child. Margin values should be positive. Call ViewGroup.setLayoutParams(LayoutParams) after reassigning a new value to this field.
leftMargin
var leftMargin: Int
The left margin in pixels of the child. Margin values should be positive. Call ViewGroup.setLayoutParams(LayoutParams) after reassigning a new value to this field.
rightMargin
var rightMargin: Int
The right margin in pixels of the child. Margin values should be positive. Call ViewGroup.setLayoutParams(LayoutParams) after reassigning a new value to this field.
topMargin
var topMargin: Int
The top margin in pixels of the child. Margin values should be positive. Call ViewGroup.setLayoutParams(LayoutParams) after reassigning a new value to this field.