com.groupdocs.viewer.config
Interface IFrontEndConfiguration

All Known Subinterfaces:
IServiceConfiguration

public interface IFrontEndConfiguration

Author:
Alex Bobkov

Method Summary
 String getBackgroundColor()
          The background CSS color of the top toolbar and the Thumbnails button
EX: 'yellow', '#00ff00', 'rgb(255,0,255)'
 String getCurrentSearchHighlightColor()
          Get Current Search Highlight Color Background color of the current search hit
 String getFileDisplayName()
          File name to Display
Note: this is just a name which will be displayed in all opened documents
 Integer getHeight()
          Get height
Height of the application
Set 0 to 100% height (in this case html tag for example div should contain style with height = 100% property)
 Integer getInitialZoom()
          Get initial zoom
Default zoom is 100%
 String getJqueryFileDownloadCookieName()
          jQuery file download name to store in cookies
Default name is 'jqueryFileDownloadJSForGD'
 Integer getMinimumImageWidth()
          Minimum Image Width If set, the Viewer will load page images with the specified width from the server when starting.
 Integer getPreloadPagesCount()
          Loads, processes and caches a specified number of page images when first opening a document pages processing is the default)
 Integer getQuality()
          Get image quality
Image rendering quality (in range 0..100) for image based engine.
 String getSearchHighlightColor()
          Get Search Highlight Color The color parameter is the background color of search hits.
 String getThumbnailsContainerBackgroundColor()
          Get Thumbnails Container Background Color The background CSS color of the Thumbnails container 'yellow', '#00ff00', 'rgb(255,0,255)'
 String getThumbnailsContainerBorderRightColor()
          Get Thumbnails Container Border Right Color The CSS color of the right border of the Thumbnails container
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'
 Integer getThumbnailsContainerWidth()
          Get Thumbnails Container Width The width of the thumbnails panel
 String getToolbarBorderBottomColor()
          Get Toolbar Border Bottom Color The CSS color of the bottom border of the toolbar
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'
 String getToolbarButtonBorderColor()
          Get Toolbar Button Border Color The CSS color of the border of the toolbar buttons
Ex: (“yellow”, ”#00ff00”, “rgb(255,0,255)“)
 String getToolbarButtonBorderHoverColor()
          Get Toolbar Button Border Hover Color The CSS color of the hover of the toolbar buttons
Ex: (“yellow”, ”#00ff00”, “rgb(255,0,255)“)
 String getToolbarButtonsBoxShadowHoverStyle()
          Get Toolbar Buttons Box Shadow Hover Style
The value of the CSS3 box-shadow property of the toolbar buttons
 String getToolbarButtonsBoxShadowStyle()
          Get Toolbar Buttons Box Shadow Style
The value of the CSS3 box-shadow property of the toolbar buttons
Default: '0 1px 0 rgba(255, 255, 255, 0.2) inset, 0 1px 0 rgba(255, 255, 255, 0.15)'
 String getToolbarInputFieldBorderColor()
          Get Toolbar InputField Border Color The CSS color of the border of the toolbar page number field
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'
 Integer getViewerStyle()
          Initial Viewer style
The page scroll or page flip style
 String getWatermarkColor()
          Get Watermark Color Allows to draw a text watermark on every page of a document.
 Integer getWatermarkFontSize()
          Watermark font size
 String getWatermarkPosition()
          Watermark position
Values: 'Diagonal', 'Horizontal', 'Vertical'
 String getWatermarkText()
          Get WatermarkText Allows to draw a text watermark on every page of a document.
 Integer getWidth()
          Get width
Width of the application
Set 0 to 100% width
 Boolean isConvertWordDocumentsCompletely()
          Converts words documents completely
 Boolean isDownloadPdfFile()
          Download Pdf File If true, the Viewer control will download a PDF version of a document when a user clicks the Download button
 Boolean isEnableStandardErrorHandling()
          Enable Standard Error Handling If false, the standard error window will not be shown on errors.
 Boolean isIgnoreDocumentAbsence()
           
 Boolean isLoadAllPagesOnSearch()
          Load All Pages On Search
 Boolean isOnlyShrinkLargePages()
          Only Shrink Large Pages If the onlyShrinkLargePages parameter is true, large images are zoomed out while small images are left as-is
 Boolean isOpenThumbnails()
          Open thumbnails flag
Defines if thumbnails will be open on application load.
 Boolean isPreloadPagesOnBrowserSide()
          Pre-load pages on browser side
 Boolean isPreventTouchEventsBubbling()
          Prevent Touch Events Bubbling If true, the Viewer will prevent touch events generated by the jQuery UI Touch Punch library from bubbling to parent controls which allows to use scrolling on touch screen devices
 Boolean isPrintWithWatermark()
          Set if to print document with watermarks
 Boolean isSearchForSeparateWords()
          Search For Separate Words If the searchForSeparateWords parameter is true, the Viewer will search for any of the words specified in the search text box.
 Boolean isShowDownload()
          Shows or hides download button
 Boolean isShowDownloadErrorsInPopup()
          Show Download Errors In Popup If true, file download errors will be shown in a popup window instead of redirecting the browser to a page with the error description.
 Boolean isShowFolderBrowser()
          Shows or hides folder browser toolbar
 Boolean isShowHeader()
          Show Header Shows or hides the header with the toolbar controls.
 Boolean isShowImageWidth()
          Show Image Width If true, shows an alert in the browser with the width of the document pages when the application is loading.
 Boolean isShowOnePageInRow()
          Show One Page In Row If true, only one page is shown in one row.
 Boolean isShowPaging()
          Shows or hides paging buttons set
 Boolean isShowPrint()
          Shows or hides print button
 Boolean isShowSearch()
          Shows or hides search button and input
 Boolean isShowThumbnails()
          Show thumbnails flag
 Boolean isShowViewerStyleControl()
          Shows or hides style control toolbar
 Boolean isShowZoom()
          Shows or hides zoom button
 Boolean isSupportPageReordering()
          Support Page Reordering If true, the Viewer supports reordering of pages by dragging thumbnails.
 Boolean isSupportPageRotation()
          Support page rotation
 Boolean isSupportTextSelection()
          Whether or not the Viewer supports selecting text using the mouse
 Boolean isTreatPhrasesInDoubleQuotesAsExactPhrases()
          Treat Phrases In Double Quotes As Exact Phrases If true, then if a search phrase is in double quotes, the Viewer will find a match only if words in a current document are in the same order as they are in the search phrase and each word is equal to each word of the search phrase.
 Boolean isUseEmScaling()
          Use Em Scaling
 Boolean isUseImageBasedPrinting()
          Use Image Based Printing If true, creates print dialog with images.
 Boolean isUseInnerThumbnails()
          Use Inner Thumbnails If true, the thumbnails are shown beside the document area.
 Boolean isUsePdfPrinting()
          PDF printing flag If true, opens a PDF document in a new tab when printing
If false, prints documents as HTML in the current window (default)
 Boolean isUsePngImagesForHtmlBasedEngine()
          Use Png Images For Html Based Engine If true, the Viewer will generate page backgrounds as PNG images (it is useful for Inernet Explorer 8 which does not support SVG images), otherwise it will generate SVG images which reference PNG images
 Boolean isZoomToFitHeight()
          Zoom to fit height flag
 Boolean isZoomToFitWidth()
          Zoom to fit width flag
 

Method Detail

getBackgroundColor

String getBackgroundColor()
The background CSS color of the top toolbar and the Thumbnails button
EX: 'yellow', '#00ff00', 'rgb(255,0,255)'

Returns:
Background color CSS value

isConvertWordDocumentsCompletely

Boolean isConvertWordDocumentsCompletely()
Converts words documents completely

Returns:
Boolean value

getCurrentSearchHighlightColor

String getCurrentSearchHighlightColor()
Get Current Search Highlight Color Background color of the current search hit

Returns:
Current Search Highlight Color

isDownloadPdfFile

Boolean isDownloadPdfFile()
Download Pdf File If true, the Viewer control will download a PDF version of a document when a user clicks the Download button

Returns:
Boolean value

isEnableStandardErrorHandling

Boolean isEnableStandardErrorHandling()
Enable Standard Error Handling If false, the standard error window will not be shown on errors. One can attach his own error handlers to a Viewer instance

Returns:
Boolean value

getFileDisplayName

String getFileDisplayName()
File name to Display
Note: this is just a name which will be displayed in all opened documents

Returns:
file name

getHeight

Integer getHeight()
Get height
Height of the application
Set 0 to 100% height (in this case html tag for example div should contain style with height = 100% property)

Returns:
height

isIgnoreDocumentAbsence

Boolean isIgnoreDocumentAbsence()
Returns:

getInitialZoom

Integer getInitialZoom()
Get initial zoom
Default zoom is 100%

Returns:
initial zoom

getJqueryFileDownloadCookieName

String getJqueryFileDownloadCookieName()
jQuery file download name to store in cookies
Default name is 'jqueryFileDownloadJSForGD'

Returns:
Download cookie name

isLoadAllPagesOnSearch

Boolean isLoadAllPagesOnSearch()
Load All Pages On Search

Returns:
Boolean value

getMinimumImageWidth

Integer getMinimumImageWidth()
Minimum Image Width If set, the Viewer will load page images with the specified width from the server when starting.
It will not load page images from the server again after zooming if the current page image size is smaller than the value specified and if the original (not scaled) page image size is smaller than the value specified.
It means that in most cases the Viewer will load page images only once and will not reload them after zooming in/out. Issues can appear on the browser or server side if this value is very big because there could be not enough memory for image processing.

Returns:
Minimum Image Width

isOnlyShrinkLargePages

Boolean isOnlyShrinkLargePages()
Only Shrink Large Pages If the onlyShrinkLargePages parameter is true, large images are zoomed out while small images are left as-is

Returns:
Boolean value

isOpenThumbnails

Boolean isOpenThumbnails()
Open thumbnails flag
Defines if thumbnails will be open on application load.

Returns:
Boolean value

getPreloadPagesCount

Integer getPreloadPagesCount()
Loads, processes and caches a specified number of page images when first opening a document pages processing is the default)

Returns:
pre-load page count

isPreloadPagesOnBrowserSide

Boolean isPreloadPagesOnBrowserSide()
Pre-load pages on browser side

Returns:
Boolean value

isPreventTouchEventsBubbling

Boolean isPreventTouchEventsBubbling()
Prevent Touch Events Bubbling If true, the Viewer will prevent touch events generated by the jQuery UI Touch Punch library from bubbling to parent controls which allows to use scrolling on touch screen devices

Returns:
Boolean value

isPrintWithWatermark

Boolean isPrintWithWatermark()
Set if to print document with watermarks

Returns:
Boolean value

getQuality

Integer getQuality()
Get image quality
Image rendering quality (in range 0..100) for image based engine.

Returns:
image quality

isSearchForSeparateWords

Boolean isSearchForSeparateWords()
Search For Separate Words If the searchForSeparateWords parameter is true, the Viewer will search for any of the words specified in the search text box.
If false, the Viewer control will search for exact matches of a whole phrase specified in the search text box.
If the treatPhrasesInDoubleQuotesAsExactPhrases parameter is true, then if a search phrase is in double quotes, the Viewer will find a match only if words in a current document are in the same order as they are in the search phrase and each word is equal to each word of the search phrase. Whitespaces and separator characters are ignored

Returns:
Boolean value

getSearchHighlightColor

String getSearchHighlightColor()
Get Search Highlight Color The color parameter is the background color of search hits.

Returns:
Search Highlight Color

isShowDownload

Boolean isShowDownload()
Shows or hides download button

Returns:
Boolean value

isShowDownloadErrorsInPopup

Boolean isShowDownloadErrorsInPopup()
Show Download Errors In Popup If true, file download errors will be shown in a popup window instead of redirecting the browser to a page with the error description.
Currently this feature does not work when the Viewer is used in a cross-domain manner

Returns:
Show Download Errors In Popup

isShowFolderBrowser

Boolean isShowFolderBrowser()
Shows or hides folder browser toolbar

Returns:
Boolean value

isShowHeader

Boolean isShowHeader()
Show Header Shows or hides the header with the toolbar controls.
If false, one can create his custom controls and control the Viewer by calling its methods to navigate pages, zoom in or out, and so on

Returns:
ShowHeader

isShowImageWidth

Boolean isShowImageWidth()
Show Image Width If true, shows an alert in the browser with the width of the document pages when the application is loading.
ShowHeader: shows or hides the header with the toolbar controls.
If false, one can create his custom controls and control the Viewer by calling its methods to navigate pages, zoom in or out, and so on

Returns:
Show Image Width

isShowOnePageInRow

Boolean isShowOnePageInRow()
Show One Page In Row If true, only one page is shown in one row. Otherwise there can be multiple pages placed at the same vertical position.

Returns:
Boolean value

isShowPaging

Boolean isShowPaging()
Shows or hides paging buttons set

Returns:
Boolean value

isShowPrint

Boolean isShowPrint()
Shows or hides print button

Returns:
Boolean value

isShowSearch

Boolean isShowSearch()
Shows or hides search button and input

Returns:
Boolean value

isShowThumbnails

Boolean isShowThumbnails()
Show thumbnails flag

Returns:
Boolean value

isShowViewerStyleControl

Boolean isShowViewerStyleControl()
Shows or hides style control toolbar

Returns:
Boolean value

isShowZoom

Boolean isShowZoom()
Shows or hides zoom button

Returns:
Boolean value

isSupportPageReordering

Boolean isSupportPageReordering()
Support Page Reordering If true, the Viewer supports reordering of pages by dragging thumbnails.
Only the image-based engine supports this feature.

Returns:
Boolean value

isSupportPageRotation

Boolean isSupportPageRotation()
Support page rotation

Returns:
Boolean value

isSupportTextSelection

Boolean isSupportTextSelection()
Whether or not the Viewer supports selecting text using the mouse

Returns:
Boolean value

getThumbnailsContainerBackgroundColor

String getThumbnailsContainerBackgroundColor()
Get Thumbnails Container Background Color The background CSS color of the Thumbnails container 'yellow', '#00ff00', 'rgb(255,0,255)'

Returns:
Thumbnails Container Background Color

getThumbnailsContainerBorderRightColor

String getThumbnailsContainerBorderRightColor()
Get Thumbnails Container Border Right Color The CSS color of the right border of the Thumbnails container
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'

Returns:
Thumbnails Container Border Right Color

getThumbnailsContainerWidth

Integer getThumbnailsContainerWidth()
Get Thumbnails Container Width The width of the thumbnails panel

Returns:
Thumbnails Container Width

getToolbarBorderBottomColor

String getToolbarBorderBottomColor()
Get Toolbar Border Bottom Color The CSS color of the bottom border of the toolbar
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'

Returns:
Toolbar Border Bottom Color

getToolbarButtonBorderColor

String getToolbarButtonBorderColor()
Get Toolbar Button Border Color The CSS color of the border of the toolbar buttons
Ex: (“yellow”, ”#00ff00”, “rgb(255,0,255)“)

Returns:
Toolbar Button Border Color

getToolbarButtonBorderHoverColor

String getToolbarButtonBorderHoverColor()
Get Toolbar Button Border Hover Color The CSS color of the hover of the toolbar buttons
Ex: (“yellow”, ”#00ff00”, “rgb(255,0,255)“)

Returns:
Toolbar Button Border Hover Color

getToolbarButtonsBoxShadowHoverStyle

String getToolbarButtonsBoxShadowHoverStyle()
Get Toolbar Buttons Box Shadow Hover Style
The value of the CSS3 box-shadow property of the toolbar buttons

Returns:
Toolbar Buttons Box Shadow Hover Style

getToolbarButtonsBoxShadowStyle

String getToolbarButtonsBoxShadowStyle()
Get Toolbar Buttons Box Shadow Style
The value of the CSS3 box-shadow property of the toolbar buttons
Default: '0 1px 0 rgba(255, 255, 255, 0.2) inset, 0 1px 0 rgba(255, 255, 255, 0.15)'

Returns:
Toolbar Buttons Box Shadow Style

getToolbarInputFieldBorderColor

String getToolbarInputFieldBorderColor()
Get Toolbar InputField Border Color The CSS color of the border of the toolbar page number field
Ex: 'yellow', '#00ff00', 'rgb(255,0,255)'

Returns:
Toolbar InputFiel dBorder Color

isTreatPhrasesInDoubleQuotesAsExactPhrases

Boolean isTreatPhrasesInDoubleQuotesAsExactPhrases()
Treat Phrases In Double Quotes As Exact Phrases If true, then if a search phrase is in double quotes, the Viewer will find a match only if words in a current document are in the same order as they are in the search phrase and each word is equal to each word of the search phrase. Whitespaces and separator characters are ignored

Returns:
Boolean value

isUseEmScaling

Boolean isUseEmScaling()
Use Em Scaling

Returns:
Boolean value

isUseImageBasedPrinting

Boolean isUseImageBasedPrinting()
Use Image Based Printing If true, creates print dialog with images.
If false, creates html print dialog.

Returns:
Boolean value

isUseInnerThumbnails

Boolean isUseInnerThumbnails()
Use Inner Thumbnails If true, the thumbnails are shown beside the document area. If false, the thumbnails are shown over the document area

Returns:
Boolean value

isUsePdfPrinting

Boolean isUsePdfPrinting()
PDF printing flag If true, opens a PDF document in a new tab when printing
If false, prints documents as HTML in the current window (default)

Returns:
Boolean value

isUsePngImagesForHtmlBasedEngine

Boolean isUsePngImagesForHtmlBasedEngine()
Use Png Images For Html Based Engine If true, the Viewer will generate page backgrounds as PNG images (it is useful for Inernet Explorer 8 which does not support SVG images), otherwise it will generate SVG images which reference PNG images

Returns:
Boolean value

getViewerStyle

Integer getViewerStyle()
Initial Viewer style
The page scroll or page flip style

Returns:
viewer style

getWatermarkColor

String getWatermarkColor()
Get Watermark Color Allows to draw a text watermark on every page of a document.
Specifies the color of a watermark.

Returns:
Watermark Color

getWatermarkFontSize

Integer getWatermarkFontSize()
Watermark font size

Returns:
Watermark font size

getWatermarkPosition

String getWatermarkPosition()
Watermark position
Values: 'Diagonal', 'Horizontal', 'Vertical'

Returns:
Watermark position

getWatermarkText

String getWatermarkText()
Get WatermarkText Allows to draw a text watermark on every page of a document.
Specifies the text of a watermark.

Returns:
WatermarkText

getWidth

Integer getWidth()
Get width
Width of the application
Set 0 to 100% width

Returns:
width

isZoomToFitHeight

Boolean isZoomToFitHeight()
Zoom to fit height flag

Returns:
Boolean value

isZoomToFitWidth

Boolean isZoomToFitWidth()
Zoom to fit width flag

Returns:
Boolean value


Copyright © 2015. All rights reserved.