LayoutElementBuilders.Image.Builder

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

public final class LayoutElementBuilders.Image.Builder

---

Builder for Image.

Summary

Public constructors
Builder() Creates an instance of Builder.

Public methods
@NonNull LayoutElementBuilders.Image	build() Builds an instance with values accumulated in this Builder.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setColorFilter(@NonNull LayoutElementBuilders.ColorFilter colorFilter) Sets filtering parameters for this image.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setContentScaleMode(int contentScaleMode) Sets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setContentScaleMode(     @NonNull LayoutElementBuilders.ContentScaleModeProp contentScaleMode ) Sets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setHeight(@NonNull DimensionBuilders.ImageDimension height) Sets the height of this image.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setModifiers(@NonNull ModifiersBuilders.Modifiers modifiers) Sets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setResourceId(@NonNull String resourceId) Sets the resource_id of the image to render.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setResourceId(@NonNull TypeBuilders.StringProp resourceId) Sets the resource_id of the image to render.
@NonNull LayoutElementBuilders.Image.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setWidth(@NonNull DimensionBuilders.ImageDimension width) Sets the width of this image.

Public constructors

Builder

Added in 1.0.0

public Builder()

Creates an instance of Builder.

Public methods

build

Added in 1.0.0

public @NonNull LayoutElementBuilders.Image build()

Builds an instance with values accumulated in this Builder.

setColorFilter

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setColorFilter(@NonNull LayoutElementBuilders.ColorFilter colorFilter)

Sets filtering parameters for this image. If not specified, defaults to no filtering.

setContentScaleMode

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setContentScaleMode(int contentScaleMode)

Sets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds. Defaults to CONTENT_SCALE_MODE_FIT.

setContentScaleMode

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setContentScaleMode(
    @NonNull LayoutElementBuilders.ContentScaleModeProp contentScaleMode
)

Sets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds. Defaults to CONTENT_SCALE_MODE_FIT.

setHeight

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setHeight(@NonNull DimensionBuilders.ImageDimension height)

Sets the height of this image. If not defined, the image will not be rendered.

setModifiers

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setModifiers(@NonNull ModifiersBuilders.Modifiers modifiers)

Sets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.

setResourceId

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setResourceId(@NonNull String resourceId)

Sets the resource_id of the image to render. This must exist in the supplied resource bundle.

setResourceId

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setResourceId(@NonNull TypeBuilders.StringProp resourceId)

Sets the resource_id of the image to render. This must exist in the supplied resource bundle.

Note that this field only supports static values.

setWidth

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Image.Builder setWidth(@NonNull DimensionBuilders.ImageDimension width)

Sets the width of this image. If not defined, the image will not be rendered.