- All Implemented Interfaces:
Loadable
- Since:
- 200.1.0
-
Property Summary
TypePropertyDescriptionThe underlyingAttachment
.The MIME content type of the PopupAttachment.The local temporary filepath where we store the attachment once it is loaded.The load error.The load status.A value indicating whether "loading" (fetching the data) can be accomplished without using the network.The name of the PopupAttachment.The size of the PopupAttachment in bytes.The type of the PopupAttachment. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable runner) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.The underlyingAttachment
.void
Cancels loading metadata for the object.The MIME content type of the PopupAttachment.Creates asynchronously the full image for displaying the attachment in full screen or some UI larger than a thumbnail.createThumbnailAsync
(int width, int height) Creates asynchronously a thumbnail image with the specified width and height.The local temporary filepath where we store the attachment once it is loaded.Gets the value of theattachment
property.Gets the value of thecontentType
property.Gets the value of thefilePath
property.Gets the value of theloadError
property.Gets the value of theloadStatus
property.getName()
Gets the value of thename
property.long
getSize()
Gets the value of thesize
property.getType()
Gets the value of thetype
property.boolean
isLocal()
Gets the value of thelocal
property.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.A value indicating whether "loading" (fetching the data) can be accomplished without using the network.The name of the PopupAttachment.boolean
removeDoneLoadingListener
(Runnable runner) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.The size of the PopupAttachment in bytes.The type of the PopupAttachment.
-
Property Details
-
attachment
The underlyingAttachment
.- Since:
- 200.1.0
- See Also:
-
contentType
The MIME content type of the PopupAttachment.- Since:
- 200.1.0
- See Also:
-
filePath
The local temporary filepath where we store the attachment once it is loaded.- Since:
- 200.1.0
- See Also:
-
local
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:
-
name
The name of the PopupAttachment.- Since:
- 200.1.0
- See Also:
-
size
The size of the PopupAttachment in bytes.- Since:
- 200.1.0
- See Also:
-
type
The type of the PopupAttachment.- Since:
- 200.1.0
- See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
-
Method Details
-
attachmentProperty
The underlyingAttachment
.- Returns:
- the
attachment
property - Since:
- 200.1.0
- See Also:
-
getAttachment
Gets the value of theattachment
property.- Property description:
- The underlying
Attachment
. - Returns:
- the value of the
attachment
property - Since:
- 200.1.0
- See Also:
-
contentTypeProperty
The MIME content type of the PopupAttachment.- Returns:
- the
contentType
property - Since:
- 200.1.0
- See Also:
-
getContentType
Gets the value of thecontentType
property.- Property description:
- The MIME content type of the PopupAttachment.
- Returns:
- the value of the
contentType
property - Since:
- 200.1.0
- See Also:
-
filePathProperty
The local temporary filepath where we store the attachment once it is loaded.- Returns:
- the
filePath
property - Since:
- 200.1.0
- See Also:
-
getFilePath
Gets the value of thefilePath
property.- Property description:
- The local temporary filepath where we store the attachment once it is loaded.
- Returns:
- the value of the
filePath
property - Since:
- 200.1.0
- See Also:
-
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.
- Returns:
- the
local
property - Since:
- 200.1.0
- See Also:
-
isLocal
public boolean isLocal()Gets the value of thelocal
property.- 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.
- Returns:
- the value of the
local
property - Since:
- 200.1.0
- See Also:
-
nameProperty
The name of the PopupAttachment.- Returns:
- the
name
property - Since:
- 200.1.0
- See Also:
-
getName
Gets the value of thename
property.- Property description:
- The name of the PopupAttachment.
- Returns:
- the value of the
name
property - Since:
- 200.1.0
- See Also:
-
sizeProperty
The size of the PopupAttachment in bytes.- Returns:
- the
size
property - Since:
- 200.1.0
- See Also:
-
getSize
public long getSize()Gets the value of thesize
property.- Property description:
- The size of the PopupAttachment in bytes.
- Returns:
- the value of the
size
property - Since:
- 200.1.0
- See Also:
-
typeProperty
The type of the PopupAttachment.- Returns:
- the
type
property - Since:
- 200.1.0
- See Also:
-
getType
Gets the value of thetype
property.- Property description:
- The type of the PopupAttachment.
- Returns:
- the value of the
type
property - Since:
- 200.1.0
- See Also:
-
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()
isPopupAttachmentType.IMAGE
.- Returns:
- a task that represents the asynchronous operation. The task result contains the full image as an
Image
. - Since:
- 200.1.0
-
createThumbnailAsync
Creates asynchronously a thumbnail image with the specified width and height.This is only supported if the
getType()
isPopupAttachmentType.IMAGE
.- Parameters:
width
- width of the thumbnailheight
- 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
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadStatus
property - See Also:
-
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
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 interfaceLoadable
- Parameters:
runner
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
runner
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
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
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
-