Interface PdfViewer
-
- All Superinterfaces:
Component
,ComponentExporter
@ConsumerType public interface PdfViewer extends Component
Defines thePdfViewer
component model.- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
CSS_BORDERLESS
static String
CSS_FULL_WINDOW
static String
CSS_IN_LINE
static String
CSS_SIZED_CONTAINER
static String
FULL_WINDOW
Show PDF in full windowstatic String
IN_LINE
Show PDF inlinestatic String
PN_BORDERLESS
Set totrue
to enable full screen borderlessstatic String
PN_DEFAULT_VIEW_MODE
Defines the display viewstatic String
PN_DISPLAY_TYPE
Defines the display typestatic String
PN_DOCK_PAGE_CONTROLS
Set totrue
to dock controls to bottomstatic String
PN_DOCUMENT_PATH
Defines the path of the PDF to displaystatic String
PN_SHOW_ANNOTATION_TOOLS
Set totrue
to enable annotation toolsstatic String
PN_SHOW_DOWNLOAD_PDF
Set totrue
to show download buttonstatic String
PN_SHOW_FULL_SCREEN
Set totrue
to show full screen buttonstatic String
PN_SHOW_LEFT_HAND_PANEL
Set totrue
to display left side panelstatic String
PN_SHOW_PAGE_CONTROLS
Set totrue
to show page controlsstatic String
PN_SHOW_PRINT_PDF
Set totrue
to show print buttonstatic String
SIZED_CONTAINER
Show PDF in a sized container
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default String
getClientId()
Returns the Document Cloud client iddefault String
getContainerClass()
Returns the CSS class to be applied to the Document Cloud Viewer containerdefault String
getDefaultViewMode()
Returns the default view modedefault String
getDocumentFileName()
Returns the document file namedefault String
getDocumentPath()
Returns the path of the documentdefault String
getReportSuiteId()
Returns the Adobe Analytics report suite iddefault String
getType()
Returns Document Cloud Viewer embed type.default String
getViewerConfigJson()
Returns the Document Cloud Viewer configuration JSONdefault boolean
isBorderless()
Returnstrue
if the document is to be diplayed borderlessdefault boolean
isDockPageControls()
Returnstrue
if the page controls should be dockeddefault boolean
isShowAnnotationTools()
Returnstrue
if the annotation tools should be displayeddefault boolean
isShowDownloadPdf()
Returnstrue
if the download button should be showndefault boolean
isShowFullScreen()
Returnstrue
if the fullscreen button should be showndefault boolean
isShowLeftHandPanel()
Returnstrue
if the left hand panel should be showmndefault boolean
isShowPageControls()
Returnstrue
if the page controls should be showndefault boolean
isShowPrintPdf()
Returnstrue
if the print button should be shown-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getExportedType, getId
-
-
-
-
Field Detail
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
IN_LINE
static final String IN_LINE
Show PDF inline- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_BORDERLESS
static final String PN_BORDERLESS
Set totrue
to enable full screen borderless- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
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:
- Constant Field Values
-
PN_SHOW_ANNOTATION_TOOLS
static final String PN_SHOW_ANNOTATION_TOOLS
Set totrue
to enable annotation tools- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_SHOW_LEFT_HAND_PANEL
static final String PN_SHOW_LEFT_HAND_PANEL
Set totrue
to display left side panel- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_SHOW_FULL_SCREEN
static final String PN_SHOW_FULL_SCREEN
Set totrue
to show full screen button- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_SHOW_PAGE_CONTROLS
static final String PN_SHOW_PAGE_CONTROLS
Set totrue
to show page controls- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_DOCK_PAGE_CONTROLS
static final String PN_DOCK_PAGE_CONTROLS
Set totrue
to dock controls to bottom- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_SHOW_DOWNLOAD_PDF
static final String PN_SHOW_DOWNLOAD_PDF
Set totrue
to show download button- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
PN_SHOW_PRINT_PDF
static final String PN_SHOW_PRINT_PDF
Set totrue
to show print button- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_FULL_WINDOW
static final String CSS_FULL_WINDOW
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_BORDERLESS
static final String CSS_BORDERLESS
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_SIZED_CONTAINER
static final String CSS_SIZED_CONTAINER
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_IN_LINE
static final String CSS_IN_LINE
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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
-
-