Package com.stimulsoft.webviewer

Class StiWebViewerOptions.AppearanceOptions

java.lang.Object
com.stimulsoft.webviewer.StiWebViewerOptions.AppearanceOptions
Enclosing class:
StiWebViewerOptions
public class StiWebViewerOptions.AppearanceOptions extends Object

  • Field Details

    • parametersPanelPosition

      public StiParametersPanelPosition parametersPanelPosition

    • customCss

      public String customCss

    • printToPdfMode

      public StiPrintToPdfMode printToPdfMode

    • saveMenuImageSize

      public StiImageSize saveMenuImageSize

    • allowSelectionCurrentPage

      public boolean allowSelectionCurrentPage

  • Constructor Details

    • AppearanceOptions

      public AppearanceOptions()

  • Method Details

    • isParametersPanelShowDescriptions

      public boolean isParametersPanelShowDescriptions()
      a value which indicates that showing descriptions for variables is allowed.
      Returns:

    • setParametersPanelShowDescriptions

      public void setParametersPanelShowDescriptions(boolean parametersPanelShowDescriptions)
      a value which indicates that showing descriptions for variables is allowed.
      Parameters:
      parametersPanelShowDescriptions -

    • isAllowSelectionCurrentPage

      public boolean isAllowSelectionCurrentPage()
      A value which allows selection of the current page in the viewer.
      Returns:

    • setAllowSelectionCurrentPage

      public void setAllowSelectionCurrentPage(boolean allowSelectionCurrentPage)
      A value which allows selection of the current page in the viewer.
      Parameters:
      allowSelectionCurrentPage -

    • getPageBorderRadius

      public int getPageBorderRadius()
      A border radius of the page in the viewer.
      Returns:

    • setPageBorderRadius

      public void setPageBorderRadius(int pageBorderRadius)
      A border radius of the page in the viewer.
      Parameters:
      pageBorderRadius -

    • getSaveMenuImageSize

      public StiImageSize getSaveMenuImageSize()
      A value which indicates images size of the save menu in the viewer
      Returns:

    • setSaveMenuImageSize

      public void setSaveMenuImageSize(StiImageSize saveMenuImageSize)
      A value which indicates images size of the save menu in the viewer
      Parameters:
      saveMenuImageSize -

    • getPrintToPdfMode

      public StiPrintToPdfMode getPrintToPdfMode()
      Returns:
      the printToPdfMode

    • setPrintToPdfMode

      public void setPrintToPdfMode(StiPrintToPdfMode printToPdfMode)
      Parameters:
      printToPdfMode - the printToPdfMode to set

    • isAllowTouchZoom

      public boolean isAllowTouchZoom()
      A value which allows touch zoom in the viewer.
      Returns:
      the allowTouchZoom

    • setAllowTouchZoom

      public void setAllowTouchZoom(boolean allowTouchZoom)
      A value which allows touch zoom in the viewer.
      Parameters:
      allowTouchZoom - the allowTouchZoom to set

    • getCustomCss

      public String getCustomCss()
      a path to the custom css file for the viewer.
      Returns:
      the customCss

    • setCustomCss

      public void setCustomCss(String customCss)
      a path to the custom css file for the viewer.
      Parameters:
      customCss - the customCss to set

    • getParametersPanelPosition

      public StiParametersPanelPosition getParametersPanelPosition()
      a position of the parameters panel.
      Returns:
      the parametersPanelPosition

    • setParametersPanelPosition

      public void setParametersPanelPosition(StiParametersPanelPosition parametersPanelPosition)
      a position of the parameters panel.
      Parameters:
      parametersPanelPosition - the parametersPanelPosition to set

    • isStoreExportSettings

      public boolean isStoreExportSettings()
      a value which allows store the export settings in the cookies.
      Returns:
      the storeExportSettings

    • setStoreExportSettings

      public void setStoreExportSettings(boolean storeExportSettings)
      a value which allows store the export settings in the cookies.
      Parameters:
      storeExportSettings - the storeExportSettings to set

    • getDatePickerFirstDayOfWeek

      public StiFirstDayOfWeek getDatePickerFirstDayOfWeek()
      the first day of week in the date picker.
      Returns:
      the datePickerFirstDayOfWeek

    • setDatePickerFirstDayOfWeek

      public void setDatePickerFirstDayOfWeek(StiFirstDayOfWeek datePickerFirstDayOfWeek)
      the first day of week in the date picker.
      Parameters:
      datePickerFirstDayOfWeek - the datePickerFirstDayOfWeek to set

    • getReportDisplayMode

      public StiReportDisplayMode getReportDisplayMode()
      a method how the viewer will show a report.
      Returns:
      the reportDisplayMode

    • setReportDisplayMode

      public void setReportDisplayMode(StiReportDisplayMode reportDisplayMode)
      a method how the viewer will show a report.
      Parameters:
      reportDisplayMode - the reportDisplayMode to set

    • isShowTooltipsHelp

      public boolean isShowTooltipsHelp()
      a value which indicates that show or hide the help link in tooltips.
      Returns:
      the showTooltipsHelp

    • setShowTooltipsHelp

      public void setShowTooltipsHelp(boolean showTooltipsHelp)
      a value which indicates that show or hide the help link in tooltips.
      Parameters:
      showTooltipsHelp - the showTooltipsHelp to set

    • getDesignWindow

      public String getDesignWindow()
      a browser window to open page at design event. _self or _blank
      Returns:
      the designWindow

    • setDesignWindow

      public void setDesignWindow(String designWindow)
      a browser window to open page at design event. _self or _blank
      Parameters:
      designWindow - the designWindow to set

    • getOpenExportedReportWindow

      public String getOpenExportedReportWindow()
      a browser window to open the exported report. _self or _blank
      Returns:
      the openExportedReportWindow

    • setOpenExportedReportWindow

      public void setOpenExportedReportWindow(String openExportedReportWindow)
      a browser window to open the exported report. _self or _blank
      Parameters:
      openExportedReportWindow - the openExportedReportWindow to set

    • getOpenLinksWindow

      public String getOpenLinksWindow()
      a browser window to open links from the report. _self or _blank
      Returns:
      the openLinksWindow

    • setOpenLinksWindow

      public void setOpenLinksWindow(String openLinksWindow)
      a browser window to open links from the report. _self or _blank
      Parameters:
      openLinksWindow - the openLinksWindow to set

    • getBackgroundColor

      public StiColor getBackgroundColor()
      The background color of the viewer.
      Returns:
      the backgroundColor

    • setBackgroundColor

      public void setBackgroundColor(StiColor backgroundColor)
      The background color of the viewer.
      Parameters:
      backgroundColor - the backgroundColor to set

    • isRightToLeft

      public boolean isRightToLeft()
      A value which controls of output objects in the right to left mode.
      Returns:
      the rightToLeft

    • setRightToLeft

      public void setRightToLeft(boolean rightToLeft)
      A value which controls of output objects in the right to left mode.
      Parameters:
      rightToLeft - the rightToLeft to set

    • isFullScreenMode

      public boolean isFullScreenMode()
      A value which indicates which indicates that the viewer is displayed in full screen mode.
      Returns:
      the fullScreenMode

    • setFullScreenMode

      public void setFullScreenMode(boolean fullScreenMode)
      A value which indicates which indicates that the viewer is displayed in full screen mode.
      Parameters:
      fullScreenMode - the fullScreenMode to set

    • isScrollbarsMode

      public boolean isScrollbarsMode()
      A value which indicates that the viewer will show the report area with scrollbars.
      Returns:
      the scrollbarsMode

    • setScrollbarsMode

      public void setScrollbarsMode(boolean scrollbarsMode)
      A value which indicates that the viewer will show the report area with scrollbars.
      Parameters:
      scrollbarsMode - the scrollbarsMode to set

    • getOpenLinksTarget

      public String getOpenLinksTarget()
      A target to open links from the report.
      Returns:
      the openLinksTarget

    • setOpenLinksTarget

      public void setOpenLinksTarget(String openLinksTarget)
      A target to open links from the report.
      Parameters:
      openLinksTarget - the openLinksTarget to set

    • getOpenExportedReportTarget

      public String getOpenExportedReportTarget()
      A target to open the exported report.
      Returns:
      the openExportedReportTarget

    • setOpenExportedReportTarget

      public void setOpenExportedReportTarget(String openExportedReportTarget)
      A target to open the exported report.
      Parameters:
      openExportedReportTarget - the openExportedReportTarget to set

    • isShowTooltips

      public boolean isShowTooltips()
      A value which indicates that show or hide tooltips.
      Returns:
      the showTooltips

    • setShowTooltips

      public void setShowTooltips(boolean showTooltips)
      A value which indicates that show or hide tooltips.
      Parameters:
      showTooltips - the showTooltips to set

    • getPageAlignment

      public StiContentAlignment getPageAlignment()
      The alignment of the viewer page.
      Returns:
      the pageAlignment

    • setPageAlignment

      public void setPageAlignment(StiContentAlignment pageAlignment)
      The alignment of the viewer page.
      Parameters:
      pageAlignment - the pageAlignment to set

    • isShowPageShadow

      public boolean isShowPageShadow()
      A value which indicates that the shadow of the page will be displayed in the viewer.
      Returns:
      the showPageShadow

    • setShowPageShadow

      public void setShowPageShadow(boolean showPageShadow)
      A value which indicates that the shadow of the page will be displayed in the viewer.
      Parameters:
      showPageShadow - the showPageShadow to set

    • getPageBorderColor

      public StiColor getPageBorderColor()
      A color of the report page border.
      Returns:
      the pageBorderColor

    • setPageBorderColor

      public void setPageBorderColor(StiColor pageBorderColor)
      A color of the report page border.
      Parameters:
      pageBorderColor - the pageBorderColor to set

    • isBookmarksPrint

      public boolean isBookmarksPrint()
      A value which allows printing report bookmarks.
      Returns:
      the bookmarksPrint

    • setBookmarksPrint

      public void setBookmarksPrint(boolean bookmarksPrint)
      A value which allows printing report bookmarks.
      Parameters:
      bookmarksPrint - the bookmarksPrint to set

    • getBookmarksTreeWidth

      public int getBookmarksTreeWidth()
      A width of the bookmarks tree in the viewer.
      Returns:
      the bookmarksTreeWidth

    • setBookmarksTreeWidth

      public void setBookmarksTreeWidth(int bookmarksTreeWidth)
      A width of the bookmarks tree in the viewer.
      Parameters:
      bookmarksTreeWidth - the bookmarksTreeWidth to set

    • getParametersPanelMaxHeight

      public int getParametersPanelMaxHeight()
      A max height of parameters panel in the viewer.
      Returns:
      the parametersPanelMaxHeight

    • setParametersPanelMaxHeight

      public void setParametersPanelMaxHeight(int parametersPanelMaxHeight)
      A max height of parameters panel in the viewer.
      Parameters:
      parametersPanelMaxHeight - the parametersPanelMaxHeight to set

    • getParametersPanelColumnsCount

      public int getParametersPanelColumnsCount()
      A count columns in parameters panel.
      Returns:
      the parametersPanelColumnsCount

    • setParametersPanelColumnsCount

      public void setParametersPanelColumnsCount(int parametersPanelColumnsCount)
      A count columns in parameters panel.
      Parameters:
      parametersPanelColumnsCount - the parametersPanelColumnsCount to set

    • getParametersPanelDateFormat

      public String getParametersPanelDateFormat()
      A date format for datetime parameters in parameters panel.
      Returns:
      the parametersPanelDateFormat

    • setParametersPanelDateFormat

      public void setParametersPanelDateFormat(String parametersPanelDateFormat)
      A date format for datetime parameters in parameters panel.
      Parameters:
      parametersPanelDateFormat - the parametersPanelDateFormat to set

    • getInterfaceType

      public StiInterfaceType getInterfaceType()
      The type of the viewer interface.
      Returns:
      the interfaceType

    • setInterfaceType

      public void setInterfaceType(StiInterfaceType interfaceType)
      The type of the viewer interface.
      Parameters:
      interfaceType - the interfaceType to set

    • getChartRenderType

      public StiHtmlChartType getChartRenderType()
      The type of the chart in the viewer.
      Returns:
      the chartRenderType

    • setChartRenderType

      public void setChartRenderType(StiHtmlChartType chartRenderType)
      Parameters:
      chartRenderType - the chartRenderType to set