ConstraintWidget

public ConstraintWidget()

Default constructor

public ConstraintWidget(int width, int height)

Constructor

public ConstraintWidget(int x, int y, int width, int height)

Constructor

public void addToSolver(LinearSystem system, boolean optimize)

Add this widget to the solver

public boolean allowedInBarrier()

Returns true if this widget should be used in a barrier

public void connect(
    ConstraintAnchor.Type constraintFrom,
    ConstraintWidget target,
    ConstraintAnchor.Type constraintTo
)

Connect a given anchor of this widget to another anchor of a target widget

public void connect(ConstraintAnchor from, ConstraintAnchor to, int margin)

Connect the given anchors together (the from anchor should be owned by this widget)

public void connect(
    ConstraintAnchor.Type constraintFrom,
    ConstraintWidget target,
    ConstraintAnchor.Type constraintTo,
    int margin
)

Connect a given anchor of this widget to another anchor of a target widget

public void connectCircularConstraint(
    ConstraintWidget target,
    float angle,
    int radius
)

Set a circular constraint

public void createObjectVariables(LinearSystem system)

Create all the system variables for this widget

public ConstraintAnchor getAnchor(ConstraintAnchor.Type anchorType)

Given a type of anchor, returns the corresponding anchor.

public ArrayList<ConstraintAnchor> getAnchors()

Return the array of anchors of this widget

public int getBaselineDistance()

Return the baseline distance relative to the top of the widget

public float getBiasPercent(int orientation)

Return the percentage bias that is used when two opposite connections exist of the same strength in a particular orientation.

public int getBottom()

Return the bottom position of the widget

public Object getCompanionWidget()

Return the companion widget. Typically, this would be the real widget we represent with this instance of ConstraintWidget.

public int getContainerItemSkip()

Accessor for the skip value

public String getDebugName()

Returns the name of this widget (used for debug purposes)

public ConstraintWidget.DimensionBehaviour getDimensionBehaviour(int orientation)

Get the widget's DimensionBehaviour in an specific orientation.

public float getDimensionRatio()

Return the current ratio of this widget

public int getDimensionRatioSide()

Return the current side on which ratio will be applied

public int getHeight()

Return the height of the widget

public float getHorizontalBiasPercent()

Return the horizontal percentage bias that is used when two opposite connections exist of the same strength.

public ConstraintWidget getHorizontalChainControlWidget()

if in a horizontal chain return the left most widget in the chain.

public int getHorizontalChainStyle()

get the chain starting from this widget to be packed. The horizontal bias will control how elements of the chain are positioned.

public ConstraintWidget.DimensionBehaviour getHorizontalDimensionBehaviour()

Accessor for the horizontal dimension behaviour

public int getHorizontalMargin()

Returns all the horizontal margin of the widget.

public int getLeft()

Return the left position of the widget (similar to getX)

public int getLength(int orientation)

Get a dimension of the widget in a particular orientation.

public int getMinHeight()

Return the minimum height of the widget

public int getMinWidth()

Return the minimum width of the widget

public ConstraintWidget getNextChainMember(int orientation)

Return the next chain member if one exists

public ConstraintWidget getParent()

Returns the parent of this widget if there is one

public ConstraintWidget getPreviousChainMember(int orientation)

Return the previous chain member if one exists

public int getRight()

Return the right position of the widget

public int getTop()

Return the top position of the widget (similar to getY)

public String getType()

Returns the type string if set

public float getVerticalBiasPercent()

Return the vertical percentage bias that is used when two opposite connections exist of the same strength.

public ConstraintWidget getVerticalChainControlWidget()

if in a vertical chain return the top most widget in the chain.

public int getVerticalChainStyle()

Set the chain starting from this widget to be packed. The vertical bias will control how elements of the chain are positioned.

public ConstraintWidget.DimensionBehaviour getVerticalDimensionBehaviour()

Accessor for the vertical dimension behaviour

public int getVerticalMargin()

Returns all the vertical margin of the widget

public int getVisibility()

Returns the current visibility value for this widget

public int getWidth()

Return the width of the widget

public int getX()

Return the x position of the widget, relative to its container

public int getY()

Return the y position of the widget, relative to its container

public boolean hasBaseline()

Return true if this widget has a baseline

public void immediateConnect(
    ConstraintAnchor.Type startType,
    ConstraintWidget target,
    ConstraintAnchor.Type endType,
    int margin,
    int goneMargin
)

Immediate connection to an anchor without any checks.

public boolean isAnimated()

Returns if this widget is animated. Currently only affects gone behaviour

public boolean isHeightWrapContent()

Returns true if height is set to wrap_content

public boolean isInHorizontalChain()

Test if you are in a Horizontal chain

public boolean isInVerticalChain()

Test if you are in a vertical chain

public boolean isRoot()

Returns true if the widget is the root widget

public boolean isWidthWrapContent()

Returns true if width is set to wrap_content

public void resetAllConstraints()

Reset all the constraints set on this widget

public void resetAnchor(ConstraintAnchor anchor)

Reset the given anchor

public void resetAnchors()

Reset all connections

public void resetSolverVariables(Cache cache)

Reset the solver variables of the anchors

public StringBuilder serialize(StringBuilder ret)

Serialize the anchors for JSON5 output

public void setAnimated(boolean animated)

Set if this widget is animated. Currently only affects gone behaviour

public void setBaselineDistance(int baseline)

Set the baseline distance relative to the top of the widget

public void setCompanionWidget(Object companion)

Set the companion widget. Typically, this would be the real widget we represent with this instance of ConstraintWidget.

public void setContainerItemSkip(int skip)

Set the skip value for this widget. This can be used when a widget is in a container, so that container can position the widget as if it was positioned further in the list of widgets. For example, with Table, this is used to skip empty cells (the widget after an empty cell will have a skip value of one)

public void setDebugName(String name)

Set the debug name of this widget

public void setDebugSolverName(LinearSystem system, String name)

Utility debug function. Sets the names of the anchors in the solver given a widget's name. The given name is used as a prefix, resulting in anchors' names of the form:

• {name}.left
• {name}.top
• {name}.right
• {name}.bottom
• {name}.baseline

public void setDimension(int w, int h)

Set both width and height of the widget

public void setDimensionRatio(String ratio)

Set the ratio of the widget

public void setDimensionRatio(float ratio, int dimensionRatioSide)

Set the ratio of the widget The ratio will be applied if at least one of the dimension (width or height) is set to a behaviour of DimensionBehaviour.MATCH_CONSTRAINT -- the dimension's value will be set to the other dimension * ratio.

public void setFrame(int start, int end, int orientation)

Set the position+dimension of the widget based on starting/ending positions on one dimension.

public void setFrame(int left, int top, int right, int bottom)

Set the position+dimension of the widget given left/top/right/bottom

public void setGoneMargin(ConstraintAnchor.Type type, int goneMargin)

Set the margin to be used when connected to a widget with a visibility of GONE

public void setHeight(int h)

Set the height of the widget

public void setHeightWrapContent(boolean heightWrapContent)

Keep track of wrap_content for height

public void setHorizontalBiasPercent(float horizontalBiasPercent)

Set the horizontal bias percent to apply when we have two opposite constraints of equal strength

public void setHorizontalChainStyle(int horizontalChainStyle)

Set the chain starting from this widget to be packed. The horizontal bias will control how elements of the chain are positioned.

public void setHorizontalDimension(int left, int right)

Set the positions for the horizontal dimension only

public void setHorizontalDimensionBehaviour(
    ConstraintWidget.DimensionBehaviour behaviour
)

Set the widget's behaviour for the horizontal dimension

public void setHorizontalMatchStyle(
    int horizontalMatchStyle,
    int min,
    int max,
    float percent
)

Set the horizontal style when MATCH_CONSTRAINT is set

public void setHorizontalWeight(float horizontalWeight)

Set the horizontal weight (only used in chains)

public void setLength(int length, int orientation)

Set the dimension of a widget in a particular orientation.

public void setMinHeight(int h)

Set the minimum height of the widget

public void setMinWidth(int w)

Set the minimum width of the widget

public void setOffset(int x, int y)

Set the offset of this widget relative to the root widget

public void setOrigin(int x, int y)

Set both the origin in (x, y) of the widget, relative to its container

public void setParent(ConstraintWidget widget)

Set the parent of this widget

public void setType(String type)

Set the type of the widget (as a String)

public void setVerticalBiasPercent(float verticalBiasPercent)

Set the vertical bias percent to apply when we have two opposite constraints of equal strength

public void setVerticalChainStyle(int verticalChainStyle)

Set the chain starting from this widget to be packed. The vertical bias will control how elements of the chain are positioned.

public void setVerticalDimension(int top, int bottom)

Set the positions for the vertical dimension only

public void setVerticalDimensionBehaviour(
    ConstraintWidget.DimensionBehaviour behaviour
)

Set the widget's behaviour for the vertical dimension

public void setVerticalMatchStyle(
    int verticalMatchStyle,
    int min,
    int max,
    float percent
)

Set the vertical style when MATCH_CONSTRAINT is set

public void setVerticalWeight(float verticalWeight)

Set the vertical weight (only used in chains)

public void setVisibility(int visibility)

Set the visibility for this widget

public void setWidth(int w)

Set the width of the widget

public void setWidthWrapContent(boolean widthWrapContent)

Keep track of wrap_content for width

public void setX(int x)

Set the x position of the widget, relative to its container

public void setY(int y)

Set the y position of the widget, relative to its container

public void setupDimensionRatio(
    boolean hParentWrapContent,
    boolean vParentWrapContent,
    boolean horizontalDimensionFixed,
    boolean verticalDimensionFixed
)

Resolves the dimension ratio parameters (mResolvedDimensionRatioSide &mDimensionRatio)

public String toString()

Returns a string representation of the ConstraintWidget

public void updateFromSolver(LinearSystem system, boolean optimize)

Update the widget from the values generated by the solver

protected int getRootX()

Return the x position of the widget, relative to the root (without animation)

protected int getRootY()

Return the y position of the widget, relative to the root (without animation)