DimensionBuilders.ProportionalDimensionProp

public final class DimensionBuilders.ProportionalDimensionProp implements DimensionBuilders.ImageDimension


A type for a dimension that scales itself proportionally to another dimension such that the aspect ratio defined by the given width and height values is preserved.

Note that the width and height are unitless; only their ratio is relevant. This allows for specifying an element's size using common ratios (e.g. width=4, height=3), or to allow an element to be resized proportionally based on the size of an underlying asset (e.g. an 800x600 image being added to a smaller container and resized accordingly).

Summary

Public methods

static @NonNull DimensionBuilders.ProportionalDimensionProp.Builder

Returns a new Builder.

@IntRange(from = "0") @NonNull int

Gets the height to be used when calculating the aspect ratio ratio to preserve.

@IntRange(from = "0") @NonNull int

Gets the width to be used when calculating the aspect ratio to preserve.

Public methods

getAspectRatioHeight

@IntRange(from = "0")
@NonNull
public @IntRange(from = "0") int getAspectRatioHeight()

Gets the height to be used when calculating the aspect ratio ratio to preserve. Intended for testing purposes only.

getAspectRatioWidth

@IntRange(from = "0")
@NonNull
public @IntRange(from = "0") int getAspectRatioWidth()

Gets the width to be used when calculating the aspect ratio to preserve. Intended for testing purposes only.