- Android SDK 4.0 (API Level 15) or above
- Liferay Portal 6.2 (CE or EE), Liferay 7.0 CE, Liferay DXP
- Liferay Screens Compatibility plugin (for Liferay Portal CE or Liferay Portal EE).
- Android SDK 4.0 (API Level 15) and above
- Visual Studio 7.2
- Mono .NET framework 22.214.171.124
PDF Display Screenlet displays a PDF file from a Liferay Instance’s Documents and Media Library.
Screenlets in Liferay Screens call JSON web services in the portal. This Screenlet calls the following services and methods.
The Default View uses Android’s
PdfRenderer to display the PDF. Note that
PdfRenderer requires an Android API level of 21 or higher.
This Screenlet supports offline mode so it can function without a network connection. For more information on how offline mode works, see the tutorial on its architecture. Here are the offline mode policies that you can use with this Screenlet:
|Policy||What happens||When to use|
|The Screenlet loads the data from the Liferay instance. If a connection issue occurs, the Screenlet uses the listener to notify the developer about the error. If the Screenlet successfully loads the data, it stores it in the local cache for later use.||Use this policy when you always need to show updated data, and show nothing when there’s no connection.|
|The Screenlet loads the data from the local cache. If the data isn’t there, the Screenlet uses the listener to notify the developer about the error.||Use this policy when you always need to show local data, without retrieving remote information under any circumstance.|
|The Screenlet loads the data from the Liferay instance. If this succeeds, the Screenlet shows the data to the user and stores it in the local cache for later use. If a connection issue occurs, the Screenlet retrieves the data from the local cache. If the data doesn’t exist there, the Screenlet uses the listener to notify the developer about the error.||Use this policy to show the most recent version of the data when connected, but show an outdated version when there’s no connection.|
|The Screenlet loads the data from the local cache. If the data isn’t there, the Screenlet requests it from the Liferay instance and notifies the developer about any errors that occur (including connectivity errors).||Use this policy to save bandwidth and loading time in case you have local (but probably outdated) data.|
If you don’t use
entryId, you must use both of the following attributes:
|The layout to use to show the View.|
|Whether the PDF automatically loads when the Screenlet appears in the app’s UI. The default value is |
|The primary key of the PDF file.|
|The PDF file’s fully qualified class name. Since files in a Documents and Media Library are |
|The PDF file’s unique identifier. The |
|The offline mode setting. See the Offline section for details.|
Because PDF files are assets, PDF Display Screenlet delegates its events to a
class that implements
AssetDisplayListener. This interface lets you implement
the following methods:
onRetrieveAssetSuccess(AssetEntry assetEntry): Called when the Screenlet successfully loads the PDF file.
error(Exception e, String userAction): Called when an error occurs in the process. The
userActionargument distinguishes the specific action in which the error occurred.