public class

LongTextLayoutHelper

extends LayoutHelper

 java.lang.Object

androidx.wear.watchface.complications.rendering.utils.LayoutHelper

↳androidx.wear.watchface.complications.rendering.utils.LongTextLayoutHelper

Gradle dependencies

compile group: 'androidx.wear.watchface', name: 'watchface-complications-rendering', version: '1.1.0-rc01'

  • groupId: androidx.wear.watchface
  • artifactId: watchface-complications-rendering
  • version: 1.1.0-rc01

Artifact androidx.wear.watchface:watchface-complications-rendering:1.1.0-rc01 it located at Google repository (https://maven.google.com/)

Overview

Layout helper for TYPE_LONG_TEXT.

Summary

Constructors
publicLongTextLayoutHelper()

Methods
public voidgetIconBounds(Rect outRect)

public Layout.AlignmentgetLongTextAlignment()

public voidgetLongTextBounds(Rect outRect)

public intgetLongTextGravity()

public Layout.AlignmentgetLongTitleAlignment()

public voidgetLongTitleBounds(Rect outRect)

public intgetLongTitleGravity()

public voidgetSmallImageBounds(Rect outRect)

from LayoutHelpergetBounds, getComplicationData, getLargeImageBounds, getRangedValueBounds, getShortTextAlignment, getShortTextBounds, getShortTextGravity, getShortTitleAlignment, getShortTitleBounds, getShortTitleGravity, hasIcon, hasLongTitle, hasShortText, hasShortTitle, hasSmallImage, setComplicationData, setHeight, setWidth, update
from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public LongTextLayoutHelper()

Methods

public void getIconBounds(Rect outRect)

Parameters:

outRect: that receives the computed bounds for the icon

public void getSmallImageBounds(Rect outRect)

Parameters:

outRect: that receives the computed bounds for the small image

public void getLongTextBounds(Rect outRect)

Parameters:

outRect: that receives the computed bounds for the long text

public Layout.Alignment getLongTextAlignment()

Returns:

The to use with long text

public int getLongTextGravity()

Returns:

Gravity to use with long title text

public void getLongTitleBounds(Rect outRect)

Parameters:

outRect: that receives the computed bounds for the long title text

public Layout.Alignment getLongTitleAlignment()

Returns:

The to use with long title text

public int getLongTitleGravity()

Returns:

The gravity to use with Long Title Text

Source

/*
 * Copyright 2020 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.wear.watchface.complications.rendering.utils;

import static androidx.wear.watchface.complications.rendering.utils.LayoutUtils.getBottomHalf;
import static androidx.wear.watchface.complications.rendering.utils.LayoutUtils.getLeftPart;
import static androidx.wear.watchface.complications.rendering.utils.LayoutUtils.getRightPart;
import static androidx.wear.watchface.complications.rendering.utils.LayoutUtils.getTopHalf;
import static androidx.wear.watchface.complications.rendering.utils.LayoutUtils.isWideRectangle;

import android.graphics.Rect;
import android.support.wearable.complications.ComplicationData;
import android.text.Layout;
import android.view.Gravity;

import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;

/**
 * Layout helper for {@link ComplicationData#TYPE_LONG_TEXT}.
 *
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY)
public class LongTextLayoutHelper extends LayoutHelper {

    /** Used to avoid allocating a Rect object whenever needed. */
    private final Rect mBounds = new Rect();

    private boolean shouldShowTextOnly(@NonNull Rect bounds) {
        // Should show only text if there's no visual available or rectangle is not wide enough
        ComplicationData data = getComplicationData();
        return (data.getIcon() == null && data.getSmallImage() == null) || !isWideRectangle(bounds);
    }

    @Override
    public void getIconBounds(@NonNull Rect outRect) {
        getBounds(outRect);
        if (!hasIcon() || hasSmallImage() || shouldShowTextOnly(outRect)) {
            outRect.setEmpty();
        } else {
            // Show icon on the left part of bounds
            getLeftPart(outRect, outRect);
        }
    }

    @Override
    public void getSmallImageBounds(@NonNull Rect outRect) {
        getBounds(outRect);
        if (!hasSmallImage() || shouldShowTextOnly(outRect)) {
            outRect.setEmpty();
        } else {
            // Show image on the left part of bounds
            getLeftPart(outRect, outRect);
        }
    }

    @Override
    public void getLongTextBounds(@NonNull Rect outRect) {
        getBounds(outRect);
        if (shouldShowTextOnly(outRect)) {
            if (hasLongTitle()) {
                // Title is available, use top half
                getTopHalf(outRect, outRect);
            }
            // Title is not available, fill the area
            // No-op here.
        } else {
            // To the right of the icon/small image
            if (!hasLongTitle()) {
                // Full height if there's no title
                getRightPart(outRect, outRect);
            } else {
                // Only top half if there's title
                getRightPart(outRect, outRect);
                getTopHalf(outRect, outRect);
            }
        }
    }

    @NonNull
    @Override
    public Layout.Alignment getLongTextAlignment() {
        getBounds(mBounds);
        if (shouldShowTextOnly(mBounds)) {
            return Layout.Alignment.ALIGN_CENTER;
        } else {
            return Layout.Alignment.ALIGN_NORMAL;
        }
    }

    @Override
    public int getLongTextGravity() {
        // Title is always shown if available
        if (!hasLongTitle()) {
            return Gravity.CENTER_VERTICAL;
        } else {
            return Gravity.BOTTOM;
        }
    }

    @Override
    public void getLongTitleBounds(@NonNull Rect outRect) {
        getBounds(outRect);
        if (!hasLongTitle()) {
            outRect.setEmpty();
        } else {
            if (shouldShowTextOnly(outRect)) {
                getBottomHalf(outRect, outRect);
            } else {
                getRightPart(outRect, outRect);
                getBottomHalf(outRect, outRect);
            }
        }
    }

    @NonNull
    @Override
    public Layout.Alignment getLongTitleAlignment() {
        return getLongTextAlignment();
    }

    @Override
    public int getLongTitleGravity() {
        return Gravity.TOP;
    }
}