Package com.stimulsoft.webviewer

Class StiWebViewerOptions.ToolbarOptions

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

  • Constructor Details

    • ToolbarOptions

      public ToolbarOptions()

  • Method Details

    • isShowResourcesButton

      public boolean isShowResourcesButton()
      a visibility of the Resources button in the toolbar of the viewer.
      Returns:
      the showResourcesButton

    • setShowResourcesButton

      public void setShowResourcesButton(boolean showResourcesButton)
      a visibility of the Resources button in the toolbar of the viewer.
      Parameters:
      showResourcesButton - the showResourcesButton to set

    • isAutoHide

      public boolean isAutoHide()
      a value which allows automatically hide the viewer toolbar in mobile mode.
      Returns:
      the autoHide

    • setAutoHide

      public void setAutoHide(boolean autoHide)
      a value which allows automatically hide the viewer toolbar in mobile mode.
      Parameters:
      autoHide - the autoHide to set

    • isShowPinToolbarButton

      public boolean isShowPinToolbarButton()
      a visibility of the Pin button in the toolbar of the viewer in mobile mode.
      Returns:
      the showPinToolbarButton

    • setShowPinToolbarButton

      public void setShowPinToolbarButton(boolean showPinToolbarButton)
      a visibility of the Pin button in the toolbar of the viewer in mobile mode.
      Parameters:
      showPinToolbarButton - the showPinToolbarButton to set

    • getDisplayMode

      public StiToolbarDisplayMode getDisplayMode()
      the display mode of the toolbar - simple or separated into upper and lower parts.
      Returns:
      the displayMode

    • setDisplayMode

      public void setDisplayMode(StiToolbarDisplayMode displayMode)
      the display mode of the toolbar - simple or separated into upper and lower parts.
      Parameters:
      displayMode - the displayMode to set

    • isShowOpenButton

      public boolean isShowOpenButton()
      a visibility of the Open button in the toolbar of the viewer.
      Returns:
      the showOpenButton

    • setShowOpenButton

      public void setShowOpenButton(boolean showOpenButton)
      a visibility of the Open button in the toolbar of the viewer.
      Parameters:
      showOpenButton - the showOpenButton to set

    • isShowFindButton

      public boolean isShowFindButton()
      a visibility of the Find button in the toolbar of the viewer.
      Returns:
      the showFindButton

    • setShowFindButton

      public void setShowFindButton(boolean showFindButton)
      a visibility of the Find button in the toolbar of the viewer.
      Parameters:
      showFindButton - the showFindButton to set

    • getToolbarBorderColor

      public StiColor getToolbarBorderColor()
      a color of the toolbar border. The default value is the theme color.
      Returns:
      the toolbarBorderColor

    • setToolbarBorderColor

      public void setToolbarBorderColor(StiColor toolbarBorderColor)
      a color of the toolbar border. The default value is the theme color.
      Parameters:
      toolbarBorderColor - the toolbarBorderColor to set

    • getToolbarBackgroundColor

      public StiColor getToolbarBackgroundColor()
      a color of the toolbar background. The default value is the theme color.
      Returns:
      the toolbarBackgroundColor

    • setToolbarBackgroundColor

      public void setToolbarBackgroundColor(StiColor toolbarBackgroundColor)
      a color of the toolbar background. The default value is the theme color.
      Parameters:
      toolbarBackgroundColor - the toolbarBackgroundColor to set

    • isShowToolbar

      public boolean isShowToolbar()
      a value which indicates that toolbar will be shown in the viewer.
      Returns:
      the showToolbar

    • setShowToolbar

      public void setShowToolbar(boolean showToolbar)
      a value which indicates that toolbar will be shown in the viewer.
      Parameters:
      showToolbar - the showToolbar to set

    • isVisible

      public boolean isVisible()
      A value which indicates that toolbar will be shown in the viewer.
      Returns:
      the visible

    • setVisible

      public void setVisible(boolean visible)
      A value which indicates that toolbar will be shown in the viewer.
      Parameters:
      visible - the visible to set

    • getBackgroundColor

      public StiColor getBackgroundColor()
      A color of the toolbar background. The default value is the theme color.
      Returns:
      the backgroundColor

    • setBackgroundColor

      public void setBackgroundColor(StiColor backgroundColor)
      A color of the toolbar background. The default value is the theme color.
      Parameters:
      backgroundColor - the backgroundColor to set

    • getBorderColor

      public StiColor getBorderColor()
      A color of the toolbar border. The default value is the theme color.
      Returns:
      the borderColor

    • setBorderColor

      public void setBorderColor(StiColor borderColor)
      A color of the toolbar border. The default value is the theme color.
      Parameters:
      borderColor - the borderColor to set

    • getFontColor

      public StiColor getFontColor()
      A color of the toolbar texts.
      Returns:
      the fontColor

    • setFontColor

      public void setFontColor(StiColor fontColor)
      A color of the toolbar texts.
      Parameters:
      fontColor - the fontColor to set

    • getFontFamily

      public String getFontFamily()
      A value which indicates which font family will be used for drawing texts in the viewer.
      Returns:
      the fontFamily

    • setFontFamily

      public void setFontFamily(String fontFamily)
      A value which indicates which font family will be used for drawing texts in the viewer.
      Parameters:
      fontFamily - the fontFamily to set

    • getAlignment

      public StiContentAlignment getAlignment()
      The alignment of the viewer toolbar.
      Returns:
      the alignment

    • setAlignment

      public void setAlignment(StiContentAlignment alignment)
      The alignment of the viewer toolbar.
      Parameters:
      alignment - the alignment to set

    • isShowButtonCaptions

      public boolean isShowButtonCaptions()
      A value which allows displaying or hiding toolbar buttons captions.
      Returns:
      the showButtonCaptions

    • setShowButtonCaptions

      public void setShowButtonCaptions(boolean showButtonCaptions)
      A value which allows displaying or hiding toolbar buttons captions.
      Parameters:
      showButtonCaptions - the showButtonCaptions to set

    • isShowPrintButton

      public boolean isShowPrintButton()
      A visibility of the Print button in the toolbar of the viewer.
      Returns:
      the showPrintButton

    • setShowPrintButton

      public void setShowPrintButton(boolean showPrintButton)
      A visibility of the Print button in the toolbar of the viewer.
      Parameters:
      showPrintButton - the showPrintButton to set

    • isShowSaveButton

      public boolean isShowSaveButton()
      A visibility of the Save button in the toolbar of the viewer.
      Returns:
      the showSaveButton

    • setShowSaveButton

      public void setShowSaveButton(boolean showSaveButton)
      A visibility of the Save button in the toolbar of the viewer.
      Parameters:
      showSaveButton - the showSaveButton to set

    • isShowSendEmailButton

      public boolean isShowSendEmailButton()
      A visibility of the Send Email button in the toolbar of the viewer.
      Returns:
      the showSendEmailButton

    • setShowSendEmailButton

      public void setShowSendEmailButton(boolean showSendEmailButton)
      A visibility of the Send Email button in the toolbar of the viewer.
      Parameters:
      showSendEmailButton - the showSendEmailButton to set

    • isShowBookmarksButton

      public boolean isShowBookmarksButton()
      A visibility of the Bookmarks button in the toolbar of the viewer.
      Returns:
      the showBookmarksButton

    • setShowBookmarksButton

      public void setShowBookmarksButton(boolean showBookmarksButton)
      A visibility of the Bookmarks button in the toolbar of the viewer.
      Parameters:
      showBookmarksButton - the showBookmarksButton to set

    • isShowParametersButton

      public boolean isShowParametersButton()
      A visibility of the Parameters button in the toolbar of the viewer.
      Returns:
      the showParametersButton

    • setShowParametersButton

      public void setShowParametersButton(boolean showParametersButton)
      A visibility of the Parameters button in the toolbar of the viewer.
      Parameters:
      showParametersButton - the showParametersButton to set

    • isShowEditorButton

      public boolean isShowEditorButton()
      A visibility of the Editor button in the toolbar of the viewer.
      Returns:
      the showEditorButton

    • setShowEditorButton

      public void setShowEditorButton(boolean showEditorButton)
      A visibility of the Editor button in the toolbar of the viewer.
      Parameters:
      showEditorButton - the showEditorButton to set

    • isShowFullScreenButton

      public boolean isShowFullScreenButton()
      A visibility of the Full Screen button in the toolbar of the viewer.
      Returns:
      the showFullScreenButton

    • setShowFullScreenButton

      public void setShowFullScreenButton(boolean showFullScreenButton)
      A visibility of the Full Screen button in the toolbar of the viewer.
      Parameters:
      showFullScreenButton - the showFullScreenButton to set

    • isShowFirstPageButton

      public boolean isShowFirstPageButton()
      A visibility of the First Page button in the toolbar of the viewer.
      Returns:
      the showFirstPageButton

    • setShowFirstPageButton

      public void setShowFirstPageButton(boolean showFirstPageButton)
      A visibility of the First Page button in the toolbar of the viewer.
      Parameters:
      showFirstPageButton - the showFirstPageButton to set

    • isShowPreviousPageButton

      public boolean isShowPreviousPageButton()
      A visibility of the Prev Page button in the toolbar of the viewer.
      Returns:
      the showPreviousPageButton

    • setShowPreviousPageButton

      public void setShowPreviousPageButton(boolean showPreviousPageButton)
      A visibility of the Prev Page button in the toolbar of the viewer.
      Parameters:
      showPreviousPageButton - the showPreviousPageButton to set

    • isShowCurrentPageControl

      public boolean isShowCurrentPageControl()
      A visibility of the current page control in the toolbar of the viewer.
      Returns:
      the showCurrentPageControl

    • setShowCurrentPageControl

      public void setShowCurrentPageControl(boolean showCurrentPageControl)
      A visibility of the current page control in the toolbar of the viewer.
      Parameters:
      showCurrentPageControl - the showCurrentPageControl to set

    • isShowNextPageButton

      public boolean isShowNextPageButton()
      A visibility of the Next Page button in the toolbar of the viewer.
      Returns:
      the showNextPageButton

    • setShowNextPageButton

      public void setShowNextPageButton(boolean showNextPageButton)
      A visibility of the Next Page button in the toolbar of the viewer.
      Parameters:
      showNextPageButton - the showNextPageButton to set

    • isShowLastPageButton

      public boolean isShowLastPageButton()
      A visibility of the Last Page button in the toolbar of the viewer.
      Returns:
      the showLastPageButton

    • setShowLastPageButton

      public void setShowLastPageButton(boolean showLastPageButton)
      A visibility of the Last Page button in the toolbar of the viewer.
      Parameters:
      showLastPageButton - the showLastPageButton to set

    • isShowZoomButton

      public boolean isShowZoomButton()
      A visibility of the Zoom control in the toolbar of the viewer.
      Returns:
      the showZoomButton

    • setShowZoomButton

      public void setShowZoomButton(boolean showZoomButton)
      A visibility of the Zoom control in the toolbar of the viewer.
      Parameters:
      showZoomButton - the showZoomButton to set

    • isShowViewModeButton

      public boolean isShowViewModeButton()
      A visibility of the View Mode button in the toolbar of the viewer.
      Returns:
      the showViewModeButton

    • setShowViewModeButton

      public void setShowViewModeButton(boolean showViewModeButton)
      A visibility of the View Mode button in the toolbar of the viewer.
      Parameters:
      showViewModeButton - the showViewModeButton to set

    • isShowDesignButton

      public boolean isShowDesignButton()
      A visibility of the Design button in the toolbar of the viewer.
      Returns:
      the showDesignButton

    • setShowDesignButton

      public void setShowDesignButton(boolean showDesignButton)
      A visibility of the Design button in the toolbar of the viewer.
      Parameters:
      showDesignButton - the showDesignButton to set

    • isShowAboutButton

      public boolean isShowAboutButton()
      A visibility of the About button in the toolbar of the viewer.
      Returns:
      the showAboutButton

    • setShowAboutButton

      public void setShowAboutButton(boolean showAboutButton)
      A visibility of the About button in the toolbar of the viewer.
      Parameters:
      showAboutButton - the showAboutButton to set

    • getPrintDestination

      public StiPrintDestination getPrintDestination()
      The default mode of the report print destination.
      Returns:
      the printDestination

    • setPrintDestination

      public void setPrintDestination(StiPrintDestination printDestination)
      The default mode of the report print destination.
      Parameters:
      printDestination - the printDestination to set

    • getViewMode

      public StiWebViewMode getViewMode()
      The mode of showing a report in the viewer - one page or the whole report.
      Returns:
      the viewMode

    • setViewMode

      public void setViewMode(StiWebViewMode viewMode)
      The mode of showing a report in the viewer - one page or the whole report.
      Parameters:
      viewMode - the viewMode to set

    • getZoom

      public int getZoom()
      The report showing zoom. The default value is 100. PageWidth = -1;PageHeight = -2;
      Returns:
      the zoom

    • setZoom

      public void setZoom(int zoom)
      The report showing zoom. The default value is 100. PageWidth = -1; PageHeight = -2;
      Parameters:
      zoom - the zoom to set

    • isMenuAnimation

      public boolean isMenuAnimation()
      A value which indicates that menu animation is enabled.
      Returns:
      the menuAnimation

    • setMenuAnimation

      public void setMenuAnimation(boolean menuAnimation)
      A value which indicates that menu animation is enabled.
      Parameters:
      menuAnimation - the menuAnimation to set

    • getShowMenuMode

      public StiShowMenuMode getShowMenuMode()
      The mode that shows menu of the viewer.
      Returns:
      the showMenuMode

    • setShowMenuMode

      public void setShowMenuMode(StiShowMenuMode showMenuMode)
      The mode that shows menu of the viewer.
      Parameters:
      showMenuMode - the showMenuMode to set