Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.popup

Class PopupAttachment

java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupAttachment
All Implemented Interfaces:
Loadable
public final class PopupAttachment extends Object implements Loadable
Represents an attachment belonging to a popup. Wraps the Attachment object and adds additional properties and methods to support displaying attachments in a popup.
Since:
200.1.0

  • Property Details

  • Method Details

    • attachmentProperty

      public ReadOnlyObjectProperty<Attachment> attachmentProperty()
      The underlying Attachment.
      Since:
      200.1.0
      See Also:

    • getAttachment

      public Attachment getAttachment()
      Gets the value of the property attachment.
      Property description:
      The underlying Attachment.
      Since:
      200.1.0

    • contentTypeProperty

      public ReadOnlyStringProperty contentTypeProperty()
      The MIME content type of the PopupAttachment.
      Since:
      200.1.0
      See Also:

    • getContentType

      public String getContentType()
      Gets the value of the property contentType.
      Property description:
      The MIME content type of the PopupAttachment.
      Since:
      200.1.0

    • filePathProperty

      public ReadOnlyStringProperty filePathProperty()
      The local temporary filepath where we store the attachment once it is loaded.
      Since:
      200.1.0
      See Also:

    • getFilePath

      public String getFilePath()
      Gets the value of the property filePath.
      Property description:
      The local temporary filepath where we store the attachment once it is loaded.
      Since:
      200.1.0

    • localProperty

      public ReadOnlyBooleanProperty localProperty()
      A value indicating whether "loading" (fetching the data) can be accomplished without using the network.

      This is true if it just needs to pull the data from a database, false if the loading will cause a network request.

      Since:
      200.1.0
      See Also:

    • isLocal

      public boolean isLocal()
      Gets the value of the property local.
      Property description:
      A value indicating whether "loading" (fetching the data) can be accomplished without using the network.

      This is true if it just needs to pull the data from a database, false if the loading will cause a network request.

      Since:
      200.1.0

    • nameProperty

      public ReadOnlyStringProperty nameProperty()
      The name of the PopupAttachment.
      Since:
      200.1.0
      See Also:

    • getName

      public String getName()
      Gets the value of the property name.
      Property description:
      The name of the PopupAttachment.
      Since:
      200.1.0

    • sizeProperty

      public ReadOnlyLongProperty sizeProperty()
      The size of the PopupAttachment in bytes.
      Since:
      200.1.0
      See Also:

    • getSize

      public long getSize()
      Gets the value of the property size.
      Property description:
      The size of the PopupAttachment in bytes.
      Since:
      200.1.0

    • typeProperty

      public ReadOnlyObjectProperty<PopupAttachmentType> typeProperty()
      The type of the PopupAttachment.
      Since:
      200.1.0
      See Also:

    • getType

      public PopupAttachmentType getType()
      Gets the value of the property type.
      Property description:
      The type of the PopupAttachment.
      Since:
      200.1.0

    • createFullImageAsync

      public ListenableFuture<Image> createFullImageAsync()
      Creates asynchronously the full image for displaying the attachment in full screen or some UI larger than a thumbnail.

      This is only supported if the getType() is PopupAttachmentType.IMAGE.

      Returns:
      a task that represents the asynchronous operation. The task result contains the full image as an Image.
      Since:
      200.1.0

    • createThumbnailAsync

      public ListenableFuture<Image> createThumbnailAsync(int width, int height)
      Creates asynchronously a thumbnail image with the specified width and height.

      This is only supported if the getType() is PopupAttachmentType.IMAGE.

      Parameters:
      width - width of the thumbnail
      height - height of the thumbnail
      Returns:
      a task that represents the asynchronous operation. The task result contains the thumbnail as an Image.
      Since:
      200.1.0

    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      See Also:

    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the property loadError.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.

    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      See Also:

    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the property loadStatus.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the LoadStatus of the loadable resource

    • 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 from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.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 interface Loadable

    • 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 to LoadStatus.LOADING. A listener can be added via Loadable.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 calling Loadable.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) when loadAsync 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 or LoadStatus.FAILED_TO_LOAD state) when loadAsync 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 calling Loadable.cancelLoad().

      Specified by:
      loadAsync in interface Loadable

    • 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 interface Loadable

    • addDoneLoadingListener

      public void addDoneLoadingListener(Runnable runner)
      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, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      Parameters:
      runner - a Runnable that is invoked upon completion of the load operation

    • removeDoneLoadingListener

      public boolean removeDoneLoadingListener(Runnable runner)
      Description copied from interface: Loadable
      Removes a done loading listener from the loadable resource.
      Specified by:
      removeDoneLoadingListener in interface Loadable
      Parameters:
      runner - 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 a LoadStatusChangedListener 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 interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be added

    • removeLoadStatusChangedListener

      public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Removes a LoadStatusChangedListener from the loadable resource.
      Specified by:
      removeLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be removed
      Returns:
      true if the listener was removed, otherwise false