Interface PdfViewer
-
- All Superinterfaces:
Component,ComponentExporter
@ConsumerType public interface PdfViewer extends Component
Defines thePdfViewercomponent model.- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCSS_BORDERLESSstatic java.lang.StringCSS_FULL_WINDOWstatic java.lang.StringCSS_IN_LINEstatic java.lang.StringCSS_SIZED_CONTAINERstatic java.lang.StringFULL_WINDOWShow PDF in full windowstatic java.lang.StringIN_LINEShow PDF inlinestatic java.lang.StringPN_BORDERLESSSet totrueto enable full screen borderlessstatic java.lang.StringPN_DEFAULT_VIEW_MODEDefines the display viewstatic java.lang.StringPN_DISPLAY_TYPEDefines the display typestatic java.lang.StringPN_DOCK_PAGE_CONTROLSSet totrueto dock controls to bottomstatic java.lang.StringPN_DOCUMENT_PATHDefines the path of the PDF to displaystatic java.lang.StringPN_SHOW_ANNOTATION_TOOLSSet totrueto enable annotation toolsstatic java.lang.StringPN_SHOW_DOWNLOAD_PDFSet totrueto show download buttonstatic java.lang.StringPN_SHOW_FULL_SCREENSet totrueto show full screen buttonstatic java.lang.StringPN_SHOW_LEFT_HAND_PANELSet totrueto display left side panelstatic java.lang.StringPN_SHOW_PAGE_CONTROLSSet totrueto show page controlsstatic java.lang.StringPN_SHOW_PRINT_PDFSet totrueto show print buttonstatic java.lang.StringSIZED_CONTAINERShow PDF in a sized container
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.StringgetClientId()Returns the Document Cloud client iddefault java.lang.StringgetContainerClass()Returns the CSS class to be applied to the Document Cloud Viewer containerdefault java.lang.StringgetDefaultViewMode()Returns the default view modedefault java.lang.StringgetDocumentFileName()Returns the document file namedefault java.lang.StringgetDocumentPath()Returns the path of the documentdefault java.lang.StringgetReportSuiteId()Returns the Adobe Analytics report suite iddefault java.lang.StringgetType()Returns Document Cloud Viewer embed type.default java.lang.StringgetViewerConfigJson()Returns the Document Cloud Viewer configuration JSONdefault booleanisBorderless()Returnstrueif the document is to be diplayed borderlessdefault booleanisDockPageControls()Returnstrueif the page controls should be dockeddefault booleanisShowAnnotationTools()Returnstrueif the annotation tools should be displayeddefault booleanisShowDownloadPdf()Returnstrueif the download button should be showndefault booleanisShowFullScreen()Returnstrueif the fullscreen button should be showndefault booleanisShowLeftHandPanel()Returnstrueif the left hand panel should be showmndefault booleanisShowPageControls()Returnstrueif the page controls should be showndefault booleanisShowPrintPdf()Returnstrueif 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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String PN_BORDERLESS
Set totrueto 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 java.lang.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 java.lang.String PN_SHOW_ANNOTATION_TOOLS
Set totrueto 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 java.lang.String PN_SHOW_LEFT_HAND_PANEL
Set totrueto 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 java.lang.String PN_SHOW_FULL_SCREEN
Set totrueto 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 java.lang.String PN_SHOW_PAGE_CONTROLS
Set totrueto 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 java.lang.String PN_DOCK_PAGE_CONTROLS
Set totrueto 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 java.lang.String PN_SHOW_DOWNLOAD_PDF
Set totrueto 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 java.lang.String PN_SHOW_PRINT_PDF
Set totrueto show print button- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_FULL_WINDOW
static final java.lang.String CSS_FULL_WINDOW
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_BORDERLESS
static final java.lang.String CSS_BORDERLESS
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
CSS_SIZED_CONTAINER
static final java.lang.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 java.lang.String CSS_IN_LINE
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
default java.lang.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 java.lang.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 java.lang.String getDocumentFileName()
Returns the document file name- Returns:
- Document file name
- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
getClientId
default java.lang.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 java.lang.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 java.lang.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()
Returnstrueif the document is to be diplayed borderless- Returns:
trueif the document is to be diplayed borderless- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowAnnotationTools
default boolean isShowAnnotationTools()
Returnstrueif the annotation tools should be displayed- Returns:
trueif the annotation tools should be displayed- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowLeftHandPanel
default boolean isShowLeftHandPanel()
Returnstrueif the left hand panel should be showmn- Returns:
trueif the left hand panel should be showmn- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowFullScreen
default boolean isShowFullScreen()
Returnstrueif the fullscreen button should be shown- Returns:
trueif the fullscreen button should be shown- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowDownloadPdf
default boolean isShowDownloadPdf()
Returnstrueif the download button should be shown- Returns:
trueif the download button should be shown- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowPrintPdf
default boolean isShowPrintPdf()
Returnstrueif the print button should be shown- Returns:
trueif the print button should be shown- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isShowPageControls
default boolean isShowPageControls()
Returnstrueif the page controls should be shown- Returns:
trueif the page controls should be shown- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
isDockPageControls
default boolean isDockPageControls()
Returnstrueif the page controls should be docked- Returns:
trueif the page controls should be docked- Since:
- com.adobe.cq.wcm.core.components.models 12.13.0
-
getViewerConfigJson
default java.lang.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 java.lang.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
-
-