LayoutElementBuilders.Image.Builder

Builder()

Creates an instance of Builder.

Note that, when using this constructor, it should be paired with setResourceId, and resource used for it needs to be manually registered in TileService#onTileResourcesRequest for Tiles. This constructor can't be mixed with setImageResource, otherwise an exception will be thrown.

Builder(scope: ProtoLayoutScope)

Creates an instance of Builder with automatic resource registration used.

Note that, when using this constructor, it should be paired with setImageResource. Additionally, Resources object shouldn't be provided in TileService#onTileResourcesRequest method for your Tile as resources would be automatically registered. This constructor can't be mixed with setResourceId, otherwise an exception will be thrown.

When using this constructor and automatic resource registration, there's no need to provide resources version in Tile.Builder.setResourcesVersion, as ProtoLayoutScope will handle versioning and changes of the resources automatically. However, setting custom version in Tile.Builder.setResourcesVersion is still supported.

fun build(): LayoutElementBuilders.Image

Builds an instance with values accumulated in this Builder.

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

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

@RequiresSchemaVersion(major = 1, minor = 0)
fun setContentScaleMode(contentScaleMode: Int): LayoutElementBuilders.Image.Builder

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.

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

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.

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

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

@RequiresSchemaVersion(major = 1, minor = 0)
fun setImageResource(resource: ResourceBuilders.ImageResource): LayoutElementBuilders.Image.Builder

Sets the specific resource of the image to render. This method will automatically assign the ID and add the given resource in the resources bundle.

@RequiresSchemaVersion(major = 1, minor = 0)
fun setImageResource(
    resource: ResourceBuilders.ImageResource,
    resourceId: String
): LayoutElementBuilders.Image.Builder

Sets the specific resource of the image to render. This method will automatically add the given resource in the resources bundle.

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

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

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

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

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

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.

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

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