WidgetFrame

Artifact: androidx.constraintlayout:constraintlayout-core

View Source

Added in 1.1.0-beta01

---

Kotlin |Java

class WidgetFrame

---

Utility class to encapsulate layout of a widget

Summary

Public constructors
WidgetFrame()
WidgetFrame(frame: WidgetFrame!)
WidgetFrame(widget: ConstraintWidget!)

Public functions
Unit	addCustomColor(name: String!, color: Int)
Unit	addCustomFloat(name: String!, value: Float)
Float	centerX()
Float	centerY()
Boolean	containsCustom(name: String) Return whether this WidgetFrame contains a custom property of the given name.
CustomVariable!	getCustomAttribute(name: String!) Get the custom attribute given Nam
(Mutable)Set<String!>!	getCustomAttributeNames() Get the known custom Attributes names
Int	getCustomColor(name: String!)
Float	getCustomFloat(name: String!)
String!	getId()
TypedBundle!	getMotionProperties() get the property bundle associated with MotionAttributes
Int	height()
java-static Unit	interpolate(     parentWidth: Int,     parentHeight: Int,     frame: WidgetFrame!,     start: WidgetFrame!,     end: WidgetFrame!,     transition: Transition!,     progress: Float )
Boolean	isDefaultTransform()
StringBuilder!	serialize(ret: StringBuilder!)
StringBuilder!	serialize(ret: StringBuilder!, sendPhoneOrientation: Boolean) If true also send the phone orientation
Unit	setCustomAttribute(name: String!, type: Int, value: Boolean)
Unit	setCustomAttribute(name: String!, type: Int, value: Float)
Unit	setCustomAttribute(name: String!, type: Int, value: Int)
Unit	setCustomAttribute(name: String!, type: Int, value: String!)
Unit	setCustomValue(valueAt: CustomAttribute!, mTempValues: FloatArray!)
Boolean	setValue(key: String!, value: CLElement!)
WidgetFrame!	update()
WidgetFrame!	update(widget: ConstraintWidget!)
Unit	updateAttributes(frame: WidgetFrame!)
Int	width()

Public properties
Float	alpha
Int	bottom
Float	interpolatedPos
Int	left
String!	name
java-static Float	phone_orientation
Float	pivotX
Float	pivotY
Int	right
Float	rotationX
Float	rotationY
Float	rotationZ
Float	scaleX
Float	scaleY
Int	top
Float	translationX
Float	translationY
Float	translationZ
Int	visibility
ConstraintWidget!	widget

Public constructors

WidgetFrame

Added in 1.1.0-beta01

WidgetFrame()

WidgetFrame

Added in 1.1.0-beta01

WidgetFrame(frame: WidgetFrame!)

WidgetFrame

Added in 1.1.0-beta01

WidgetFrame(widget: ConstraintWidget!)

Public functions

addCustomColor

Added in 1.1.0-beta01

fun addCustomColor(name: String!, color: Int): Unit

addCustomFloat

Added in 1.1.0-beta01

fun addCustomFloat(name: String!, value: Float): Unit

centerX

Added in 1.1.0-beta01

fun centerX(): Float

centerY

Added in 1.1.0-beta01

fun centerY(): Float

containsCustom

Added in 1.1.0-beta01

fun containsCustom(name: String): Boolean

Return whether this WidgetFrame contains a custom property of the given name.

getCustomAttribute

Added in 1.1.0-beta01

fun getCustomAttribute(name: String!): CustomVariable!

Get the custom attribute given Nam

Parameters
name: String!	Name of the custom attribut

Returns
CustomVariable!	The customAttribute

getCustomAttributeNames

Added in 1.1.0-beta01

fun getCustomAttributeNames(): (Mutable)Set<String!>!

Get the known custom Attributes names

Returns
(Mutable)Set<String!>!	set of custom attribute names

getCustomColor

Added in 1.1.0-beta01

fun getCustomColor(name: String!): Int

getCustomFloat

Added in 1.1.0-beta01

fun getCustomFloat(name: String!): Float

getId

Added in 1.1.0-beta01

fun getId(): String!

getMotionProperties

Added in 1.1.0-beta01

fun getMotionProperties(): TypedBundle!

get the property bundle associated with MotionAttributes

Returns
TypedBundle!	the property bundle associated with MotionAttributes or null

height

Added in 1.1.0-beta01

fun height(): Int

interpolate

Added in 1.1.0-beta01

java-static fun interpolate(
    parentWidth: Int,
    parentHeight: Int,
    frame: WidgetFrame!,
    start: WidgetFrame!,
    end: WidgetFrame!,
    transition: Transition!,
    progress: Float
): Unit

isDefaultTransform

Added in 1.1.0-beta01

fun isDefaultTransform(): Boolean

serialize

Added in 1.1.0-beta01

fun serialize(ret: StringBuilder!): StringBuilder!

serialize

Added in 1.1.0-beta01

fun serialize(ret: StringBuilder!, sendPhoneOrientation: Boolean): StringBuilder!

If true also send the phone orientation

setCustomAttribute

Added in 1.1.0-beta01

fun setCustomAttribute(name: String!, type: Int, value: Boolean): Unit

setCustomAttribute

Added in 1.1.0-beta01

fun setCustomAttribute(name: String!, type: Int, value: Float): Unit

setCustomAttribute

Added in 1.1.0-beta01

fun setCustomAttribute(name: String!, type: Int, value: Int): Unit

setCustomAttribute

Added in 1.1.0-beta01

fun setCustomAttribute(name: String!, type: Int, value: String!): Unit

setCustomValue

Added in 1.1.0-beta01

fun setCustomValue(valueAt: CustomAttribute!, mTempValues: FloatArray!): Unit

setValue

Added in 1.1.0-beta01

fun setValue(key: String!, value: CLElement!): Boolean

Throws
androidx.constraintlayout.core.parser.CLParsingException

update

Added in 1.1.0-beta01

fun update(): WidgetFrame!

update

Added in 1.1.0-beta01

fun update(widget: ConstraintWidget!): WidgetFrame!

updateAttributes

Added in 1.1.0-beta01

fun updateAttributes(frame: WidgetFrame!): Unit

width

Added in 1.1.0-beta01

fun width(): Int

Public properties

alpha

Added in 1.1.0-beta01

val alpha: Float

bottom

Added in 1.1.0-beta01

val bottom: Int

interpolatedPos

Added in 1.1.0-beta01

val interpolatedPos: Float

left

Added in 1.1.0-beta01

val left: Int

name

Added in 1.1.0-beta01

val name: String!

phone_orientation

Added in 1.1.0-beta01

java-static val phone_orientation: Float

pivotX

Added in 1.1.0-beta01

val pivotX: Float

pivotY

Added in 1.1.0-beta01

val pivotY: Float

right

Added in 1.1.0-beta01

val right: Int

rotationX

Added in 1.1.0-beta01

val rotationX: Float

rotationY

Added in 1.1.0-beta01

val rotationY: Float

rotationZ

Added in 1.1.0-beta01

val rotationZ: Float

scaleX

Added in 1.1.0-beta01

val scaleX: Float

scaleY

Added in 1.1.0-beta01

val scaleY: Float

top

Added in 1.1.0-beta01

val top: Int

translationX

Added in 1.1.0-beta01

val translationX: Float

translationY

Added in 1.1.0-beta01

val translationY: Float

translationZ

Added in 1.1.0-beta01

val translationZ: Float

visibility

Added in 1.1.0-beta01

val visibility: Int

widget

Added in 1.1.0-beta01

val widget: ConstraintWidget!