ConstraintAnchor
class ConstraintAnchor
Model a constraint relation. Widgets contains anchors, and a constraint relation between two widgets is made by connecting one anchor to another. The anchor will contains a pointer to the target anchor if it is connected.
Summary
Nested types |
|---|
|
Define the type of anchor |
Public constructors |
|---|
ConstraintAnchor(owner: ConstraintWidget!, type: ConstraintAnchor.Type!)Constructor |
Public functions |
|
|---|---|
Boolean |
connect(toAnchor: ConstraintAnchor!, margin: Int)Connects this anchor to another one. |
Boolean |
connect(Connects this anchor to another one. |
Unit |
copyFrom( |
Unit |
findDependents( |
HashSet<ConstraintAnchor!>! |
|
Int |
|
Int |
Return the connection's margin from this anchor to its target. |
ConstraintAnchor! |
Returns the opposite anchor to this one |
ConstraintWidget! |
getOwner()Return the anchor's owner |
SolverVariable! |
Return the solver variable for this anchor |
ConstraintAnchor! |
Return the connection's target (null if not connected) |
ConstraintAnchor.Type! |
getType()Return the type of the anchor |
Boolean |
|
Boolean |
|
Boolean |
|
Boolean |
Returns the connection status of this anchor |
Boolean |
isConnectionAllowed(target: ConstraintWidget!)Return true if we can connect this anchor to this target. |
Boolean |
isConnectionAllowed(target: ConstraintWidget!, anchor: ConstraintAnchor!)Return true if we can connect this anchor to this target. |
Boolean |
Return true if this anchor is a side anchor |
Boolean |
isSimilarDimensionConnection(anchor: ConstraintAnchor!)Return true if the connection to the given anchor is in the same dimension (horizontal or vertical) |
Boolean |
isValidConnection(anchor: ConstraintAnchor!)Checks if the connection to a given anchor is valid. |
Boolean |
Utility function returning true if this anchor is a vertical one. |
Unit |
reset()Resets the anchor's connection. |
Unit |
|
Unit |
resetSolverVariable(cache: Cache!)Reset the solver variable |
Unit |
setFinalValue(finalValue: Int) |
Unit |
setGoneMargin(margin: Int)Set the gone margin of the connection (if there's one) |
Unit |
Set the margin of the connection (if there's one) |
String! |
toString()Return a string representation of this anchor |
Public properties |
|
|---|---|
Int |
|
ConstraintWidget! |
|
ConstraintAnchor! |
|
ConstraintAnchor.Type! |
Public constructors
ConstraintAnchor
ConstraintAnchor(owner: ConstraintWidget!, type: ConstraintAnchor.Type!)
Constructor
| Parameters | |
|---|---|
owner: ConstraintWidget! |
the widget owner of this anchor. |
type: ConstraintAnchor.Type! |
the anchor type. |
Public functions
connect
fun connect(toAnchor: ConstraintAnchor!, margin: Int): Boolean
Connects this anchor to another one.
| Returns | |
|---|---|
Boolean |
true if the connection succeeds. |
connect
fun connect(
toAnchor: ConstraintAnchor!,
margin: Int,
goneMargin: Int,
forceConnection: Boolean
): Boolean
Connects this anchor to another one.
| Returns | |
|---|---|
Boolean |
true if the connection succeeds. |
copyFrom
fun copyFrom(
source: ConstraintAnchor!,
map: HashMap<ConstraintWidget!, ConstraintWidget!>!
): Unit
findDependents
fun findDependents(
orientation: Int,
list: ArrayList<WidgetGroup!>!,
group: WidgetGroup!
): Unit
getMargin
fun getMargin(): Int
Return the connection's margin from this anchor to its target.
| Returns | |
|---|---|
Int |
the margin value. 0 if not connected. |
getOpposite
fun getOpposite(): ConstraintAnchor!
Returns the opposite anchor to this one
| Returns | |
|---|---|
ConstraintAnchor! |
opposite anchor |
getOwner
fun getOwner(): ConstraintWidget!
Return the anchor's owner
| Returns | |
|---|---|
ConstraintWidget! |
the Widget owning the anchor |
getSolverVariable
fun getSolverVariable(): SolverVariable!
Return the solver variable for this anchor
getTarget
fun getTarget(): ConstraintAnchor!
Return the connection's target (null if not connected)
| Returns | |
|---|---|
ConstraintAnchor! |
the ConstraintAnchor target |
getType
fun getType(): ConstraintAnchor.Type!
Return the type of the anchor
| Returns | |
|---|---|
ConstraintAnchor.Type! |
type of the anchor. |
isConnected
fun isConnected(): Boolean
Returns the connection status of this anchor
| Returns | |
|---|---|
Boolean |
true if the anchor is connected to another one. |
isConnectionAllowed
fun isConnectionAllowed(target: ConstraintWidget!): Boolean
Return true if we can connect this anchor to this target. We recursively follow connections in order to detect eventual cycles; if we do we disallow the connection. We also only allow connections to direct parent, siblings, and descendants.
| Parameters | |
|---|---|
target: ConstraintWidget! |
the ConstraintWidget we are trying to connect to |
| Returns | |
|---|---|
Boolean |
true if the connection is allowed, false otherwise |
isConnectionAllowed
fun isConnectionAllowed(target: ConstraintWidget!, anchor: ConstraintAnchor!): Boolean
Return true if we can connect this anchor to this target. We recursively follow connections in order to detect eventual cycles; if we do we disallow the connection. We also only allow connections to direct parent, siblings, and descendants.
| Parameters | |
|---|---|
target: ConstraintWidget! |
the ConstraintWidget we are trying to connect to |
anchor: ConstraintAnchor! |
Allow anchor if it loops back to me directly |
| Returns | |
|---|---|
Boolean |
if the connection is allowed, false otherwise |
isSideAnchor
fun isSideAnchor(): Boolean
Return true if this anchor is a side anchor
| Returns | |
|---|---|
Boolean |
true if side anchor |
isSimilarDimensionConnection
fun isSimilarDimensionConnection(anchor: ConstraintAnchor!): Boolean
Return true if the connection to the given anchor is in the same dimension (horizontal or vertical)
| Parameters | |
|---|---|
anchor: ConstraintAnchor! |
the anchor we want to connect to |
| Returns | |
|---|---|
Boolean |
true if it's an anchor on the same dimension |
isValidConnection
fun isValidConnection(anchor: ConstraintAnchor!): Boolean
Checks if the connection to a given anchor is valid.
| Parameters | |
|---|---|
anchor: ConstraintAnchor! |
the anchor we want to connect to |
| Returns | |
|---|---|
Boolean |
true if it's a compatible anchor |
isVerticalAnchor
fun isVerticalAnchor(): Boolean
Utility function returning true if this anchor is a vertical one.
| Returns | |
|---|---|
Boolean |
true if vertical anchor, false otherwise |
resetSolverVariable
fun resetSolverVariable(cache: Cache!): Unit
Reset the solver variable
setGoneMargin
fun setGoneMargin(margin: Int): Unit
Set the gone margin of the connection (if there's one)
| Parameters | |
|---|---|
margin: Int |
the new margin of the connection |