Package com.adobe.cq.wcm.core.components.models

Interface PdfViewer

All Superinterfaces:
Component, ComponentExporter
@ConsumerType public interface PdfViewer extends Component
Defines the PdfViewer component model.
Since:
com.adobe.cq.wcm.core.components.models 12.13.0

  • Field Details

    • PN_DOCUMENT_PATH

      static final String PN_DOCUMENT_PATH
      Defines the path of the PDF to display
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_DISPLAY_TYPE

      static final String PN_DISPLAY_TYPE
      Defines the display type
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • FULL_WINDOW

      static final String FULL_WINDOW
      Show PDF in full window
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • SIZED_CONTAINER

      static final String SIZED_CONTAINER
      Show PDF in a sized container
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • IN_LINE

      static final String IN_LINE
      Show PDF inline
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_BORDERLESS

      static final String PN_BORDERLESS
      Set to true to enable full screen borderless
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_DEFAULT_VIEW_MODE

      static final String PN_DEFAULT_VIEW_MODE
      Defines the display view
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_ANNOTATION_TOOLS

      static final String PN_SHOW_ANNOTATION_TOOLS
      Set to true to enable annotation tools
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_LEFT_HAND_PANEL

      static final String PN_SHOW_LEFT_HAND_PANEL
      Set to true to display left side panel
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_FULL_SCREEN

      static final String PN_SHOW_FULL_SCREEN
      Set to true to show full screen button
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_PAGE_CONTROLS

      static final String PN_SHOW_PAGE_CONTROLS
      Set to true to show page controls
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_DOCK_PAGE_CONTROLS

      static final String PN_DOCK_PAGE_CONTROLS
      Set to true to dock controls to bottom
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_DOWNLOAD_PDF

      static final String PN_SHOW_DOWNLOAD_PDF
      Set to true to show download button
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • PN_SHOW_PRINT_PDF

      static final String PN_SHOW_PRINT_PDF
      Set to true to show print button
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • CSS_FULL_WINDOW

      static final String CSS_FULL_WINDOW
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • CSS_BORDERLESS

      static final String CSS_BORDERLESS
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • CSS_SIZED_CONTAINER

      static final String CSS_SIZED_CONTAINER
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

    • CSS_IN_LINE

      static final String CSS_IN_LINE
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0
      See Also:

  • Method Details

    • getType

      default String getType()
      Returns Document Cloud Viewer embed type.
      Returns:
      Document Cloud Viewer embed type
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getDocumentPath

      default String getDocumentPath()
      Returns the path of the document
      Returns:
      Path of the document
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getDocumentFileName

      default String getDocumentFileName()
      Returns the document file name
      Returns:
      Document file name
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getClientId

      default String getClientId()
      Returns the Document Cloud client id
      Returns:
      Document Cloud client id
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getReportSuiteId

      default String getReportSuiteId()
      Returns the Adobe Analytics report suite id
      Returns:
      Adobe Analytics report suite id
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getDefaultViewMode

      default String getDefaultViewMode()
      Returns the default view mode
      Returns:
      Default view mode
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isBorderless

      default boolean isBorderless()
      Returns true if the document is to be diplayed borderless
      Returns:
      true if the document is to be diplayed borderless
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowAnnotationTools

      default boolean isShowAnnotationTools()
      Returns true if the annotation tools should be displayed
      Returns:
      true if the annotation tools should be displayed
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowLeftHandPanel

      default boolean isShowLeftHandPanel()
      Returns true if the left hand panel should be showmn
      Returns:
      true if the left hand panel should be showmn
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowFullScreen

      default boolean isShowFullScreen()
      Returns true if the fullscreen button should be shown
      Returns:
      true if the fullscreen button should be shown
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowDownloadPdf

      default boolean isShowDownloadPdf()
      Returns true if the download button should be shown
      Returns:
      true if the download button should be shown
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowPrintPdf

      default boolean isShowPrintPdf()
      Returns true if the print button should be shown
      Returns:
      true if the print button should be shown
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isShowPageControls

      default boolean isShowPageControls()
      Returns true if the page controls should be shown
      Returns:
      true if the page controls should be shown
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • isDockPageControls

      default boolean isDockPageControls()
      Returns true if the page controls should be docked
      Returns:
      true if the page controls should be docked
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getViewerConfigJson

      default String getViewerConfigJson()
      Returns the Document Cloud Viewer configuration JSON
      Returns:
      Document Cloud Viewer configuration JSON
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0

    • getContainerClass

      default String getContainerClass()
      Returns the CSS class to be applied to the Document Cloud Viewer container
      Returns:
      one of defined CSS_* classes
      Since:
      com.adobe.cq.wcm.core.components.models 12.13.0