Class PopupAttachment
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.popup.PopupAttachment
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PopupAttachment.EditState
The edit state of attachments in a PopupAttachmentManager.static class
PopupAttachment.Type
The type of attachments in a PopupAttachmentManager
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(java.lang.Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.ListenableFuture<android.graphics.Bitmap>
createFullImageAsync()
Asynchronously creates the full sized image of the attachment.ListenableFuture<android.graphics.Bitmap>
createThumbnailAsync(int width, int height)
Asynchronously creates a thumbnail of the attachment.Attachment
getAttachment()
Gets the underlying Attachment.java.lang.String
getContentType()
Gets the attachment's content type.PopupAttachment.EditState
getEditState()
Gets thePopupAttachment.EditState
of the attachment.java.lang.String
getFilePath()
Gets the filepath of the attachment if it is local, or null if it is not.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.java.lang.String
getName()
Gets the name of the attachment.long
getSize()
Gets the size of the attachment data.PopupAttachment.Type
getType()
Gets thePopupAttachment.Type
of the attachment.boolean
isLocal()
Returns true if the attachment is a local attachment.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(java.lang.Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Gets the name of the attachment.- Returns:
- the name of the attachment
- Since:
- 100.0.0
-
getContentType
public java.lang.String getContentType()
Gets the attachment's content type.- Returns:
- the attachment's content type
- Since:
- 100.0.0
-
getSize
public long getSize()
Gets the size of the attachment data.- Returns:
- the size of the attachment data
- Since:
- 100.0.0
-
getAttachment
public Attachment getAttachment()
Gets the underlying Attachment.- Returns:
- the underlying Attachment
- Since:
- 100.0.0
-
getType
public PopupAttachment.Type getType()
Gets thePopupAttachment.Type
of the attachment.- Returns:
- the type of the attachment
- Since:
- 100.0.0
-
getEditState
public PopupAttachment.EditState getEditState()
Gets thePopupAttachment.EditState
of the attachment.- Returns:
- the EditState of the Attachment
- Since:
- 100.0.0
-
getFilePath
public java.lang.String getFilePath()
Gets the filepath of the attachment if it is local, or null if it is not.- Returns:
- the filepath of the attachment
- Since:
- 100.0.0
-
isLocal
public boolean isLocal()
Returns true if the attachment is a local attachment.- Returns:
- true if the attachment is local
- Since:
- 100.0.0
-
createThumbnailAsync
public ListenableFuture<android.graphics.Bitmap> createThumbnailAsync(int width, int height)
Asynchronously creates a thumbnail of the attachment. In the case of a video thumbnail, only two sizes are supported: 512 x 384 and 96 x 96. If width and height are equal in value, or if both of them are below 96, then the latter will be used. This is only supported if the attachment is of Type IMAGE or VIDEO. If the attachment is of another type, or if there was an issue saving it to storage, the ListenableFuture will return null.- Parameters:
width
- the width of the thumbnail in pixelsheight
- the height of the thumbnail in pixels- Returns:
- a ListenableFuture containing the resulting Bitmap
- Throws:
java.lang.IllegalStateException
- if there is no path to the temporary filejava.lang.UnsupportedOperationException
- if the attachment type is not IMAGE or VIDEO- Since:
- 100.0.0
-
createFullImageAsync
public ListenableFuture<android.graphics.Bitmap> createFullImageAsync()
Asynchronously creates the full sized image of the attachment. This is only supported if the attachment is of Type IMAGE.- Returns:
- a ListenableFuture containing the resulting Bitmap
- Throws:
java.lang.IllegalStateException
- if there is no path to the temporary filejava.lang.UnsupportedOperationException
- if the attachment type is not IMAGE- Since:
- 100.0.0
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
public ArcGISRuntimeException getLoadError()
Description copied from interface:Loadable
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
cancelLoad
public void cancelLoad()
Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
loadAsync
public void loadAsync()
Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
.
-
retryLoadAsync
public void retryLoadAsync()
Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
addDoneLoadingListener
public void addDoneLoadingListener(java.lang.Runnable listener)
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, use the
Loadable.addLoadStatusChangedListener(LoadStatusChangedListener)
method instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(java.lang.Runnable listener)
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
-