public class

HelperReference

extends ConstraintReference

implements Facade

 java.lang.Object

androidx.constraintlayout.core.state.ConstraintReference

↳androidx.constraintlayout.core.state.HelperReference

Subclasses:

HorizontalChainReference, AlignVerticallyReference, VerticalChainReference, BarrierReference, ChainReference, AlignHorizontallyReference, FlowReference, GridReference

Gradle dependencies

compile group: 'androidx.constraintlayout', name: 'constraintlayout-core', version: '1.1.0-beta01'

  • groupId: androidx.constraintlayout
  • artifactId: constraintlayout-core
  • version: 1.1.0-beta01

Artifact androidx.constraintlayout:constraintlayout-core:1.1.0-beta01 it located at Google repository (https://maven.google.com/)

Summary

Fields
protected final StatemHelperState

protected java.util.ArrayList<java.lang.Object>mReferences

from ConstraintReferencemBottomToBottom, mBottomToTop, mEndToEnd, mEndToStart, mHorizontalBias, mLeftToLeft, mLeftToRight, mMarginBottom, mMarginBottomGone, mMarginEnd, mMarginEndGone, mMarginLeft, mMarginLeftGone, mMarginRight, mMarginRightGone, mMarginStart, mMarginStartGone, mMarginTop, mMarginTopGone, mRightToLeft, mRightToRight, mStartToEnd, mStartToStart, mTopToBottom, mTopToTop, mVerticalBias
Constructors
publicHelperReference(State state, State.Helper type)

Methods
public HelperReferenceadd(java.lang.Object objects[])

public voidapply()

public voidapplyBase()

Allows the derived classes to invoke the apply method in the ConstraintReference

public ConstraintWidgetgetConstraintWidget()

public HelperWidgetgetHelperWidget()

public State.HelpergetType()

public voidsetHelperWidget(HelperWidget helperWidget)

from ConstraintReferenceaddCustomColor, addCustomFloat, alpha, applyWidgetConstraints, baseline, baselineToBaseline, baselineToBottom, baselineToTop, bias, bottom, bottomToBottom, bottomToTop, centerHorizontally, centerVertically, circularConstraint, clear, clearAll, clearHorizontal, clearVertical, createConstraintWidget, end, endToEnd, endToStart, getAlpha, getFacade, getHeight, getHorizontalChainStyle, getHorizontalChainWeight, getKey, getPivotX, getPivotY, getRotationX, getRotationY, getRotationZ, getScaleX, getScaleY, getTag, getTranslationX, getTranslationY, getTranslationZ, getVerticalChainStyle, getVerticalChainWeight, getView, getWidth, height, horizontalBias, left, leftToLeft, leftToRight, margin, margin, marginGone, marginGone, pivotX, pivotY, right, rightToLeft, rightToRight, rotationX, rotationY, rotationZ, scaleX, scaleY, setConstraintWidget, setFacade, setHeight, setHorizontalChainStyle, setHorizontalChainWeight, setKey, setTag, setVerticalChainStyle, setVerticalChainWeight, setView, setWidth, start, startToEnd, startToStart, top, topToBottom, topToTop, translationX, translationY, translationZ, validate, verticalBias, visibility, width
from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields

protected final State mHelperState

protected java.util.ArrayList<java.lang.Object> mReferences

Constructors

public HelperReference(State state, State.Helper type)

Methods

public State.Helper getType()

public HelperReference add(java.lang.Object objects[])

public void setHelperWidget(HelperWidget helperWidget)

public HelperWidget getHelperWidget()

public ConstraintWidget getConstraintWidget()

public void apply()

public void applyBase()

Allows the derived classes to invoke the apply method in the ConstraintReference

Source

/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.constraintlayout.core.state;

import androidx.constraintlayout.core.state.helpers.Facade;
import androidx.constraintlayout.core.widgets.ConstraintWidget;
import androidx.constraintlayout.core.widgets.HelperWidget;

import java.util.ArrayList;
import java.util.Collections;

public class HelperReference extends ConstraintReference implements Facade {
    protected final State mHelperState;
    final State.Helper mType;
    protected ArrayList<Object> mReferences = new ArrayList<>();
    private HelperWidget mHelperWidget;

    public HelperReference(State state, State.Helper type) {
        super(state);
        mHelperState = state;
        mType = type;
    }

    public State.Helper getType() {
        return mType;
    }

    // @TODO: add description
    public HelperReference add(Object... objects) {
        Collections.addAll(mReferences, objects);
        return this;
    }

    public void setHelperWidget(HelperWidget helperWidget) {
        mHelperWidget = helperWidget;
    }

    public HelperWidget getHelperWidget() {
        return mHelperWidget;
    }

    @Override
    public ConstraintWidget getConstraintWidget() {
        return getHelperWidget();
    }

    // @TODO: add description
    @Override
    public void apply() {
        // nothing
    }

    /**
     * Allows the derived classes to invoke the apply method in the ConstraintReference
     */
    public void applyBase() {
        super.apply();
    }
}