com.stfalcon.frescoimageviewer

Class ImageViewer.Builder<T>

java.lang.Object

com.stfalcon.frescoimageviewer.ImageViewer.Builder<T>

Enclosing class:

ImageViewer

public static class ImageViewer.Builder<T>
extends java.lang.Object

Builder class for ImageViewer

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, java.util.List<T> images) Constructor using a context and images urls list for this builder and the ImageViewer it creates.
Builder(android.content.Context context, T[] images) Constructor using a context and images urls array for this builder and the ImageViewer it creates.

Method Summary

Modifier and Type	Method and Description
ImageViewer.Builder	allowSwipeToDismiss(boolean value) Allow or disallow swipe to dismiss gesture.
ImageViewer.Builder	allowZooming(boolean value) Allow or disallow zooming.
ImageViewer	build() Creates a ImageViewer with the arguments supplied to this builder.
ImageViewer.Builder	hideStatusBar(boolean shouldHide) Set status bar visibility.
ImageViewer.Builder	setBackgroundColor(int color) Set background color int for viewer
ImageViewer.Builder	setBackgroundColorRes(int color) Set background color resource for viewer
ImageViewer.Builder	setContainerPadding(android.content.Context context, int padding) Set common padding for zooming and scrolling area using dimension.
ImageViewer.Builder	setContainerPadding(android.content.Context context, int start, int top, int end, int bottom) Set start, top, end and bottom padding for zooming and scrolling area using dimension.
ImageViewer.Builder	setContainerPaddingPx(int padding) Set common padding for zooming and scrolling area in px.
ImageViewer.Builder	setContainerPaddingPx(int start, int top, int end, int bottom) Set start, top, end and bottom padding for zooming and scrolling area in px.
ImageViewer.Builder	setCustomDraweeHierarchyBuilder(com.facebook.drawee.generic.GenericDraweeHierarchyBuilder customHierarchyBuilder) Set GenericDraweeHierarchyBuilder for drawees inside viewer.
ImageViewer.Builder	setCustomImageRequestBuilder(com.facebook.imagepipeline.request.ImageRequestBuilder customImageRequestBuilder) Set @ImageRequestBuilder for drawees.
ImageViewer.Builder	setFormatter(ImageViewer.Formatter<T> formatter) If you use an non-string collection, you can use custom ImageViewer.Formatter to represent it as url.
ImageViewer.Builder	setImageChangeListener(ImageViewer.OnImageChangeListener imageChangeListener) Set ImageViewer.OnImageChangeListener for viewer.
ImageViewer.Builder	setImageMargin(android.content.Context context, int dimen) Set space between the images using dimension.
ImageViewer.Builder	setImageMarginPx(int marginPixels) Set space between the images in px.
ImageViewer.Builder	setOnDismissListener(ImageViewer.OnDismissListener onDismissListener) Set ImageViewer.OnDismissListener for viewer.
ImageViewer.Builder	setOverlayView(android.view.View view) Set overlay view
ImageViewer.Builder	setStartPosition(int position) Set background color int for viewer
ImageViewer	show() Creates a ImageViewer with the arguments supplied to this builder and ImageViewer.show()'s the dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context,
               T[] images)

Constructor using a context and images urls array for this builder and the ImageViewer it creates.

Builder

public Builder(android.content.Context context,
               java.util.List<T> images)

Constructor using a context and images urls list for this builder and the ImageViewer it creates.

Method Detail

setFormatter

public ImageViewer.Builder setFormatter(ImageViewer.Formatter<T> formatter)

If you use an non-string collection, you can use custom ImageViewer.Formatter to represent it as url.

setBackgroundColorRes

public ImageViewer.Builder setBackgroundColorRes(@ColorRes
                                                 int color)

Set background color resource for viewer

Returns:

This Builder object to allow for chaining of calls to set methods

setBackgroundColor

public ImageViewer.Builder setBackgroundColor(int color)

Set background color int for viewer

Returns:

This Builder object to allow for chaining of calls to set methods

setStartPosition

public ImageViewer.Builder setStartPosition(int position)

Set background color int for viewer

Returns:

This Builder object to allow for chaining of calls to set methods

setImageChangeListener

public ImageViewer.Builder setImageChangeListener(ImageViewer.OnImageChangeListener imageChangeListener)

Set ImageViewer.OnImageChangeListener for viewer.

Returns:

This Builder object to allow for chaining of calls to set methods

setOverlayView

public ImageViewer.Builder setOverlayView(android.view.View view)

Set overlay view

Returns:

This Builder object to allow for chaining of calls to set methods

setImageMarginPx

public ImageViewer.Builder setImageMarginPx(int marginPixels)

Set space between the images in px.

Returns:

This Builder object to allow for chaining of calls to set methods

setImageMargin

public ImageViewer.Builder setImageMargin(android.content.Context context,
                                          @DimenRes
                                          int dimen)

Set space between the images using dimension.

Returns:

This Builder object to allow for chaining of calls to set methods

setContainerPaddingPx

public ImageViewer.Builder setContainerPaddingPx(int start,
                                                 int top,
                                                 int end,
                                                 int bottom)

Set start, top, end and bottom padding for zooming and scrolling area in px.

Returns:

This Builder object to allow for chaining of calls to set methods

setContainerPadding

public ImageViewer.Builder setContainerPadding(android.content.Context context,
                                               @DimenRes
                                               int start,
                                               @DimenRes
                                               int top,
                                               @DimenRes
                                               int end,
                                               @DimenRes
                                               int bottom)

Set start, top, end and bottom padding for zooming and scrolling area using dimension.

Returns:

This Builder object to allow for chaining of calls to set methods

setContainerPaddingPx

public ImageViewer.Builder setContainerPaddingPx(int padding)

Set common padding for zooming and scrolling area in px.

Returns:

This Builder object to allow for chaining of calls to set methods

setContainerPadding

public ImageViewer.Builder setContainerPadding(android.content.Context context,
                                               @DimenRes
                                               int padding)

Set common padding for zooming and scrolling area using dimension.

Returns:

This Builder object to allow for chaining of calls to set methods

hideStatusBar

public ImageViewer.Builder hideStatusBar(boolean shouldHide)

Set status bar visibility. By default is true.

Returns:

This Builder object to allow for chaining of calls to set methods

allowZooming

public ImageViewer.Builder allowZooming(boolean value)

Allow or disallow zooming. By default is true.

Returns:

This Builder object to allow for chaining of calls to set methods

allowSwipeToDismiss

public ImageViewer.Builder allowSwipeToDismiss(boolean value)

Allow or disallow swipe to dismiss gesture. By default is true.

Returns:

This Builder object to allow for chaining of calls to set methods

setOnDismissListener

public ImageViewer.Builder setOnDismissListener(ImageViewer.OnDismissListener onDismissListener)

Set ImageViewer.OnDismissListener for viewer.

Returns:

This Builder object to allow for chaining of calls to set methods

setCustomImageRequestBuilder

public ImageViewer.Builder setCustomImageRequestBuilder(com.facebook.imagepipeline.request.ImageRequestBuilder customImageRequestBuilder)

Set @ImageRequestBuilder for drawees. Use it for post-processing, custom resize options etc. Use ImageViewer.createImageRequestBuilder() to create its new instance.

Returns:

This Builder object to allow for chaining of calls to set methods

setCustomDraweeHierarchyBuilder

public ImageViewer.Builder setCustomDraweeHierarchyBuilder(com.facebook.drawee.generic.GenericDraweeHierarchyBuilder customHierarchyBuilder)

Set GenericDraweeHierarchyBuilder for drawees inside viewer. Use it for drawee customizing (e.g. failure image, placeholder, progressbar etc.) N.B.! Due to zoom logic there is limitation of scale type which always equals FIT_CENTER. Other values will be ignored

Returns:

This Builder object to allow for chaining of calls to set methods

build

public ImageViewer build()

Creates a ImageViewer with the arguments supplied to this builder. It does not ImageViewer.show() the dialog. This allows the user to do any extra processing before displaying the dialog. Use show() if you don't have any other processing to do and want this to be created and displayed.

show

public ImageViewer show()

Creates a ImageViewer with the arguments supplied to this builder and ImageViewer.show()'s the dialog.