Package com.skydoves.landscapist
Class ImageOptions
-
- All Implemented Interfaces:
@Immutable() public final class ImageOptions
Represents parameters to load generic Image Composable.
-
-
Field Summary
Fields Modifier and Type Field Description private final BooleanisValidSizeprivate final Alignmentalignmentprivate final StringcontentDescriptionprivate final ContentScalecontentScaleprivate final ColorFiltercolorFilterprivate final Floatalphaprivate final IntSizerequestSizeprivate final StringtestTag
-
Constructor Summary
Constructors Constructor Description ImageOptions(Alignment alignment, String contentDescription, ContentScale contentScale, ColorFilter colorFilter, Float alpha, IntSize requestSize, String testTag)
-
Method Summary
Modifier and Type Method Description final BooleanisValidSize()final AlignmentgetAlignment()The alignment parameter used to place the loaded ImageBitmap in the image container. final StringgetContentDescription()The content description used to provide accessibility to describe the image. final ContentScalegetContentScale()The scale parameter used to determine the aspect ratio scaling to be used for the loaded ImageBitmap. final ColorFiltergetColorFilter()The colorFilter parameter used to apply for the image when it is rendered onscreen. final FloatgetAlpha()The alpha parameter used to apply for the image when it is rendered onscreen. final IntSizegetRequestSize()The IntSize that will be used to request remote images. final StringgetTestTag()A test tag option that will be applied to a success image's modifier. -
-
Constructor Detail
-
ImageOptions
ImageOptions(Alignment alignment, String contentDescription, ContentScale contentScale, ColorFilter colorFilter, Float alpha, IntSize requestSize, String testTag)
-
-
Method Detail
-
isValidSize
final Boolean isValidSize()
-
getAlignment
final Alignment getAlignment()
The alignment parameter used to place the loaded ImageBitmap in the image container.
-
getContentDescription
final String getContentDescription()
The content description used to provide accessibility to describe the image.
-
getContentScale
final ContentScale getContentScale()
The scale parameter used to determine the aspect ratio scaling to be used for the loaded ImageBitmap.
-
getColorFilter
final ColorFilter getColorFilter()
The colorFilter parameter used to apply for the image when it is rendered onscreen.
-
getAlpha
final Float getAlpha()
The alpha parameter used to apply for the image when it is rendered onscreen.
-
getRequestSize
final IntSize getRequestSize()
The IntSize that will be used to request remote images.
-
getTestTag
final String getTestTag()
A test tag option that will be applied to a success image's modifier.
-
-
-
-