net.sitecore.android.sdk.api

Class DownloadMediaOptions.Builder

java.lang.Object

net.sitecore.android.sdk.api.DownloadMediaOptions.Builder

Enclosing class:

DownloadMediaOptions

public static class DownloadMediaOptions.Builder
extends java.lang.Object

Helper class for building DownloadMediaOptions.

Constructor Summary

Constructors

Constructor and Description
DownloadMediaOptions.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
DownloadMediaOptions.Builder	allowStretch(boolean allowStretch) Allow stretching the image beyond its original size.
DownloadMediaOptions.Builder	backgroundColor(java.lang.String color) Background color for the border added when an image is stretched beyond its original size and allowStretch(boolean)=false.
DownloadMediaOptions	build() Builds DownloadMediaOptions.
DownloadMediaOptions.Builder	database(java.lang.String database) The name of the Sitecore database to pull the image from.
DownloadMediaOptions.Builder	disableMediaCaching(boolean disable) Disable the media cache for this request.
DownloadMediaOptions.Builder	height(int height) The height of the image.
DownloadMediaOptions.Builder	language(java.lang.String language) Retrieve the image from a specific language version of the item.
DownloadMediaOptions.Builder	maxHeight(int maxHeight) Maximum height of the image to display.
DownloadMediaOptions.Builder	maxWidth(int maxWidth) Maximum width of the image to display.
DownloadMediaOptions.Builder	scale(float scale) Scale factor for the image to display.
DownloadMediaOptions.Builder	thumbnail(boolean thumbnail) Display a thumbnail of the requested file, useful for images as well as other media types, such as PDF, flash, and so on.
DownloadMediaOptions.Builder	version(int version) Retrieve the image from a specific version of the item.
DownloadMediaOptions.Builder	width(int width) The width of the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DownloadMediaOptions.Builder

public DownloadMediaOptions.Builder()

Method Detail

width

public DownloadMediaOptions.Builder width(int width)

The width of the image. Be sure to set allowStretch(boolean) if the width will be larger than its original size.

Parameters:

width - image width.

Returns:

this builder.

height

public DownloadMediaOptions.Builder height(int height)

The height of the image. Be sure to set allowStretch(boolean) if the height will be larger than its original size.

Parameters:

height - image height.

Returns:

this builder.

maxWidth

public DownloadMediaOptions.Builder maxWidth(int maxWidth)

Maximum width of the image to display. Scale the image down to this size if necessary.

Parameters:

maxWidth - maximum image width.

Returns:

this builder.

maxHeight

public DownloadMediaOptions.Builder maxHeight(int maxHeight)

Maximum height of the image to display. Scale the image down to this size if necessary.

Parameters:

maxHeight - maximum image height.

Returns:

this builder.

language

public DownloadMediaOptions.Builder language(java.lang.String language)

Retrieve the image from a specific language version of the item.

Parameters:

language - language.

Returns:

this builder.

version

public DownloadMediaOptions.Builder version(int version)

Retrieve the image from a specific version of the item.

Parameters:

version - version number.

Returns:

this builder.

database

public DownloadMediaOptions.Builder database(java.lang.String database)

The name of the Sitecore database to pull the image from.

Parameters:

database - database name.

Returns:

this builder.

backgroundColor

public DownloadMediaOptions.Builder backgroundColor(java.lang.String color)

Background color for the border added when an image is stretched beyond its original size and allowStretch(boolean)=false.

Parameters:

color - color.

Returns:

this builder.

allowStretch

public DownloadMediaOptions.Builder allowStretch(boolean allowStretch)

Allow stretching the image beyond its original size.

Parameters:

allowStretch - whether to allow stretch.

Returns:

this builder.

scale

public DownloadMediaOptions.Builder scale(float scale)

Scale factor for the image to display. Be sure to set allowStretch(boolean) if the image will be scaled to larger than its original size. Any positive floating point number using a dot such as 1.5, which corresponds to 150%.

Parameters:

scale - scale.

Returns:

this builder.

thumbnail

public DownloadMediaOptions.Builder thumbnail(boolean thumbnail)

Display a thumbnail of the requested file, useful for images as well as other media types, such as PDF, flash, and so on.

Parameters:

thumbnail - whether to show thumbnail.

Returns:

this builder.

disableMediaCaching

public DownloadMediaOptions.Builder disableMediaCaching(boolean disable)

Disable the media cache for this request. If true, the image will always be retrieved from the database, bypassing the media cache.

Parameters:

disable - whether to use media cache for request.

Returns:

this builder.

build

public DownloadMediaOptions build()

Builds DownloadMediaOptions.

Returns:

DownloadMediaOptions parameters.