Back to Fresco

PipelineDraweeControllerBuilder

docs/javadoc/reference/com/facebook/drawee/backends/pipeline/PipelineDraweeControllerBuilder.html

3.6.036.9 KB
Original Source

Fresco

|

|

Packages | Classes

Classes

Packages | Classes

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

PipelineDraweeControllerBuilder

extends AbstractDraweeControllerBuilder<BUILDER extends AbstractDraweeControllerBuilder<BUILDER, REQUEST, IMAGE, INFO>, REQUEST, IMAGE, INFO>

| java.lang.Object | | ↳ | com.facebook.drawee.controller.AbstractDraweeControllerBuilder<BUILDER extends com.facebook.drawee.controller.AbstractDraweeControllerBuilder<BUILDER, REQUEST, IMAGE, INFO>, REQUEST, IMAGE, INFO> | | | ↳ | com.facebook.drawee.backends.pipeline.PipelineDraweeControllerBuilder |

Class Overview

Concrete implementation of ImagePipeline Drawee controller builder.

See AbstractDraweeControllerBuilder for more details.

Summary

Public Constructors
Public Methods
static ImageRequest.RequestLevel
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
PipelineDraweeControllerBuilder
Protected Methods
DataSource<CloseableReference<CloseableImage>>
Concrete builder classes should override this method to return a data source for the request.
RequestListener
PipelineDraweeController
Concrete builder classes should override this method to return a new controller.

| [Expand] Inherited Methods | | --- | | From class com.facebook.drawee.controller.AbstractDraweeControllerBuilder

| AbstractDraweeController | build() Builds the specified controller. | | AbstractDraweeController | buildController() Builds a regular controller. | | static String | generateUniqueControllerId() Generates unique controller id. | | boolean | getAutoPlayAnimations() Gets whether to auto play animations. | | Object | getCallerContext() Gets the caller context. | | String | getContentDescription() Gets the accessibility content description. | | Context | getContext() | | ControllerListener<? super INFO> | getControllerListener() Gets the controller listener | | ControllerViewportVisibilityListener | getControllerViewportVisibilityListener() Gets the controller viewport visibility listener. | | abstract DataSource<IMAGE> | getDataSourceForRequest(DraweeController controller, String controllerId, REQUEST imageRequest, Object callerContext, AbstractDraweeControllerBuilder.CacheLevel cacheLevel) Concrete builder classes should override this method to return a data source for the request. | | Supplier<DataSource<IMAGE>> | getDataSourceSupplier() Gets the data source supplier if set. | | Supplier<DataSource<IMAGE>> | getDataSourceSupplierForRequest(DraweeController controller, String controllerId, REQUEST imageRequest) Creates a data source supplier for the given image request. | | Supplier<DataSource<IMAGE>> | getDataSourceSupplierForRequest(DraweeController controller, String controllerId, REQUEST imageRequest, AbstractDraweeControllerBuilder.CacheLevel cacheLevel) Creates a data source supplier for the given image request. | | Supplier<DataSource<IMAGE>> | getFirstAvailableDataSourceSupplier(DraweeController controller, String controllerId, REQUEST[] imageRequests, boolean tryBitmapCacheOnlyFirst) | | REQUEST[] | getFirstAvailableImageRequests() Gets the array of first-available image requests. | | REQUEST | getImageRequest() Gets the image request. | | LoggingListener | getLoggingListener() | | REQUEST | getLowResImageRequest() Gets the low-res image request. | | DraweeController | getOldController() Gets the old controller to be reused. | | boolean | getRetainImageOnFailure() Gets whether to retain image on failure. | | boolean | getTapToRetryEnabled() Gets whether tap-to-retry is enabled. | | final BUILDER | getThis() | | void | maybeAttachListeners(AbstractDraweeController controller) Attaches listeners (if specified) to the given controller. | | void | maybeBuildAndSetGestureDetector(AbstractDraweeController controller) Installs a gesture detector to the given controller. | | void | maybeBuildAndSetRetryManager(AbstractDraweeController controller) Installs a retry manager (if specified) to the given controller. | | abstract AbstractDraweeController | obtainController() Concrete builder classes should override this method to return a new controller. | | Supplier<DataSource<IMAGE>> | obtainDataSourceSupplier(DraweeController controller, String controllerId) Gets the top-level data source supplier to be used by a controller. | | BUILDER | reset() Resets this builder to its initial values making it reusable. | | BUILDER | setAutoPlayAnimations(boolean enabled) Sets whether to auto play animations. | | BUILDER | setCallerContext(Object callerContext) Sets the caller context. | | BUILDER | setContentDescription(String contentDescription) Sets the accessibility content description. | | BUILDER | setControllerListener(ControllerListener<? super INFO> controllerListener) Sets the controller listener. | | BUILDER | setControllerViewportVisibilityListener(ControllerViewportVisibilityListener controllerViewportVisibilityListener) Sets the controller viewport visibility listener. | | BUILDER | setDataSourceSupplier(Supplier<DataSource<IMAGE>> dataSourceSupplier) Sets the data source supplier to be used. | | BUILDER | setFirstAvailableImageRequests(REQUEST[] firstAvailableImageRequests) Sets the array of first-available image requests that will be probed in order. | | BUILDER | setFirstAvailableImageRequests(REQUEST[] firstAvailableImageRequests, boolean tryCacheOnlyFirst) Sets the array of first-available image requests that will be probed in order. | | BUILDER | setImageRequest(REQUEST imageRequest) Sets the image request. | | BUILDER | setLoggingListener(LoggingListener loggingListener) | | BUILDER | setLowResImageRequest(REQUEST lowResImageRequest) Sets the low-res image request. | | BUILDER | setOldController(DraweeController oldController) Sets the old controller to be reused if possible. | | BUILDER | setRetainImageOnFailure(boolean enabled) Sets whether to display last available image in case of failure. | | BUILDER | setTapToRetryEnabled(boolean enabled) Sets whether tap-to-retry is enabled. | | void | validate() Validates the parameters before building a controller. |

| | From class java.lang.Object

| Object | clone() | | boolean | equals(Object arg0) | | void | finalize() | | final Class<?> | getClass() | | int | hashCode() | | final void | notify() | | final void | notifyAll() | | String | toString() | | final void | wait(long arg0, int arg1) | | final void | wait(long arg0) | | final void | wait() |

| | From interface com.facebook.drawee.interfaces.SimpleDraweeControllerBuilder

| abstract DraweeController | build() Builds the specified controller. | | abstract SimpleDraweeControllerBuilder | setCallerContext(Object callerContext) Sets the caller context. | | abstract SimpleDraweeControllerBuilder | setOldController(DraweeController oldController) Sets the old controller to be reused if possible. | | abstract SimpleDraweeControllerBuilder | setUri(String uriString) Sets the uri from a string. | | abstract SimpleDraweeControllerBuilder | setUri(Uri uri) Sets the uri. |

|

Public Constructors

public PipelineDraweeControllerBuilder(Context context, PipelineDraweeControllerFactory pipelineDraweeControllerFactory, ImagePipeline imagePipeline, Set<ControllerListener> boundControllerListeners, Set<ControllerListener2> boundControllerListeners2)

Public Methods

public static ImageRequest.RequestLevel convertCacheLevelToRequestLevel(AbstractDraweeControllerBuilder.CacheLevel cacheLevel)

public PipelineDraweeControllerBuilder setCustomDrawableFactories(DrawableFactory... drawableFactories)

public PipelineDraweeControllerBuilder setCustomDrawableFactories(ImmutableList<DrawableFactory> customDrawableFactories)

public PipelineDraweeControllerBuilder setCustomDrawableFactory(DrawableFactory drawableFactory)

public PipelineDraweeControllerBuilder setImageOriginListener(ImageOriginListener imageOriginListener)

public PipelineDraweeControllerBuilder setPerfDataListener(ImagePerfDataListener imagePerfDataListener)

public PipelineDraweeControllerBuilder setUri(String uriString)

public PipelineDraweeControllerBuilder setUri(Uri uri)

Protected Methods

protected DataSource<CloseableReference<CloseableImage>> getDataSourceForRequest(DraweeController controller, String controllerId, ImageRequest imageRequest, Object callerContext, AbstractDraweeControllerBuilder.CacheLevel cacheLevel)

Concrete builder classes should override this method to return a data source for the request.

IMPORTANT: Do NOT ever call this method directly. This method is only to be called from a supplier created in {#code getDataSourceSupplierForRequest(REQUEST, boolean)}.

IMPORTANT: Make sure that you do NOT use any non-final field from this method, as the field may change if the instance of this builder gets reused. If any such field is required, override {#code getDataSourceSupplierForRequest(REQUEST, boolean)}, and store the field in a final variable (same as it is done for callerContext).

protected RequestListener getRequestListener(DraweeController controller)

protected PipelineDraweeController obtainController()

Concrete builder classes should override this method to return a new controller.

+Generated by Doclava. +