PDF Component

  • Component title: PDF
  • Component group: Asset Share Commons - asset details
  • Released with version 3.7.2

PDF component - Center

The PDF component displays a PDF rendition for a given Asset using the Adobe PDF Embed API.

Authoring

Authors have several configurations available to choose which asset rendition is displayed.

Dialog

PDF dialog

Rendition

A PDF rendition that can be picked from a dropdown that lists all Asset Rendition Names that are registered to Asset Rendition Dispatcher OSGi configurations with type = pdf. These values are exposed via Asset Share Commons’ Asset Rendition framework.

OOTB the available PDF renditions are available:

  • Original (maps to static original rendition)
  • Pdf (maps to the static rendition with node name matching *.pdf)

Type

The type of PDF viewer to use. The options are:

  • Sized Container: The PDF viewer will be sized to the container it is in. This is the default.
  • Full Width: The PDF viewer will be sized to the full width of the browser window.
  • In-line: The PDF viewer will be sized to the full width of the browser window, and will be in-line with the rest of the content.

You can explore the different types in the Adobe PDF Viewer demo. Note that “Lightbox” is not supported by this component.

Default View Mode

The default view of the PDF. The options are:

  • Fit Page: The PDF will be sized to display the entire page in the viewer.
  • Fit Width: The PDF will be sized to display the entire width of the page in the viewer.
  • Two Column: The PDF will be sized to display two columns of the page in the viewer.
  • Two Column Fit Page: The PDF will be sized to display two columns of the page in the viewer, and the page will be sized to display the entire page in the viewer.

Sized Container options

PDF - Sized Container - dialog

These options only display and are in effect with Type = Sized Container.

PDF Viewer Height (in pixels)

Height in pixels of the PDF viewer.

Fullscreen Mode

Show the full screen button also appears in the bottom toolbar which allows users to view the PDF in full screen mode.

Download PDF

Allow download of the PDF.

Allow printing of the PDF.

Full Window options

PDF - Full Window - dialog

These options only display and are in effect with Type = Full Window.

PDF Viewer Height (in pixels)

Height in pixels of the PDF viewer.

Read only

Check this box to true if you want to render the PDF in read-only mode. Commenting is not allowed and existing PDF comments are displayed as read only.

Fullscreen Mode

Show the full screen button also appears in the bottom toolbar which allows users to view the PDF in full screen mode.

Zoom Controls

Show zoom-in and zoom-out controls in the right-hand panel.

Download PDF

Allow download of the PDF.

Allow printing of the PDF.

Show Bookmarks

Show bookmark controls in the right-hand panel.

Enable linearization

PDF - Enable Linearization - dialog

Enable linearization to optimize PDFs for faster viewing.

Policy Dialog

PDF - Policy - dialog

The Policy Dialog is configured on the PDF component’s policy via the Editable Templates.

Client ID

Enter the client ID for your Adobe Document Cloud account registered with your Adobe Acrobat Viewer.

A Client ID can be obtained from the Adobe PDF Embed API Credentials.

Since v3.8.0, the client ID can optionally be provided via OSGI configuration, such that it can be maintained in Git. Client IDs provided via Policy will supersede any provided via OSGi configuration.

/apps/my-app/osgiconfig/config.xxx/com.adobe.aem.commons.assetshare.util.impl.AdobePdfEmbedApiImpl.cfg.json

{
   "client.id": "abcdef0123456789"
}

Asset Details Page Selector

In order to use this PDF asset details component, the asset must have a PDF rendition. Often, only PDF assets themselves are expected to be displayed via this component, which means that PDF assets need to have their own Asset Details page.

In order to achieve this Asset -> Asset Details page mapping, is recommended to use the Content Type Asset Details Selector or develop a custom Asset Details Page Selector, and set it via the Search Page properties.

Technical details

  • Component: /apps/asset-share-commons/components/details/pdf
  • Sling Model: com.adobe.aem.commons.assetshare.components.details.impl.PdfImpl

Dialog Data Sources