Package com.stimulsoft.webdesigner

Class StiWebDesignerOptions.PreviewToolbarOptions

java.lang.Object
com.stimulsoft.base.serializing.StiSerializedObject
com.stimulsoft.webdesigner.StiWebDesignerOptions.PreviewToolbarOptions
All Implemented Interfaces:
IStiSerializable, IStiSerializableRef
Enclosing class:
StiWebDesignerOptions
public class StiWebDesignerOptions.PreviewToolbarOptions extends StiSerializedObject

  • Field Summary

    Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

    REFERENCE_EMPTY, REFERENCE_REPORT

  • Constructor Summary

    Constructors
    Constructor
    Description
    PreviewToolbarOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    StiContentAlignment
    getAlignment()
    Gets or sets the alignment of the preview toolbar.
    StiColor
    getBackgroundColor()
    Gets or sets a color of the preview toolbar background.
    StiColor
    getBorderColor()
    Gets or sets a color of the preview toolbar border.
    StiToolbarDisplayMode
    getDisplayMode()
    Gets or sets the display mode of the preview toolbar - simple or separated into upper and lower parts.
    StiColor
    getFontColor()
    Gets or sets a color of the preview toolbar texts.
    String
    getFontFamily()
    Gets or sets a value which indicates which font family will be used for drawing texts in the preview.
    StiPrintDestination
    getPrintDestination()
    Gets or sets the default mode of the report print destination.
    StiWebViewMode
    getViewMode()
    Gets or sets the mode of showing a report in the preview - Single Page, Continuous or Multiple Pages.
    boolean
    isShowBookmarksButton()
    Gets or sets a visibility of the Bookmarks button in the toolbar of the preview.
    boolean
    isShowButtonCaptions()
    Gets or sets a value which allows displaying or hiding preview toolbar buttons captions.
    boolean
    isShowCurrentPageControl()
    Gets or sets a visibility of the current page control in the toolbar of the preview.
    boolean
    isShowEditorButton()
    Gets or sets a visibility of the Editor button in the toolbar of the preview.
    boolean
    isShowFindButton()
    Gets or sets a visibility of the Find button in the toolbar of the preview.
    boolean
    isShowFirstPageButton()
    Gets or sets a visibility of the First Page button in the toolbar of the preview.
    boolean
    isShowLastPageButton()
    Gets or sets a visibility of the Last Page button in the toolbar of the preview.
    boolean
    isShowNextPageButton()
    Gets or sets a visibility of the Next Page button in the toolbar of the preview.
    boolean
    isShowOpenButton()
    Gets or sets a visibility of the Open button in the toolbar of the preview.
    boolean
    isShowParametersButton()
    Gets or sets a visibility of the Parameters button in the toolbar of the preview.
    boolean
    isShowPreviousPageButton()
    Gets or sets a visibility of the Prev Page button in the toolbar of the preview.
    boolean
    isShowPrintButton()
    Gets or sets a visibility of the Print button in the toolbar of the preview.
    boolean
    isShowSaveButton()
    Gets or sets a visibility of the Save button in the toolbar of the preview.
    boolean
    isShowSendEmailButton()
    Gets or sets a visibility of the Send Email button in the toolbar of the preview.
    boolean
    isShowViewModeButton()
    Gets or sets a visibility of the View Mode button in the toolbar of the preview.
    boolean
    isShowZoomButton()
    Gets or sets a visibility of the Zoom control in the toolbar of the preview.
    boolean
    isVisible()
    Gets or sets a value which indicates that toolbar will be shown in the preview.
    void
    setAlignment(StiContentAlignment alignment)
    Gets or sets the alignment of the preview toolbar.
    void
    setBackgroundColor(StiColor backgroundColor)
    Gets or sets a color of the preview toolbar background.
    void
    setBorderColor(StiColor borderColor)
    Gets or sets a color of the preview toolbar border.
    void
    setDisplayMode(StiToolbarDisplayMode displayMode)
    Gets or sets the display mode of the preview toolbar - simple or separated into upper and lower parts.
    void
    setFontColor(StiColor fontColor)
    Gets or sets a color of the preview toolbar texts.
    void
    setFontFamily(String fontFamily)
    Gets or sets a value which indicates which font family will be used for drawing texts in the preview.
    void
    setPrintDestination(StiPrintDestination printDestination)
    Gets or sets the default mode of the report print destination.
    void
    setShowBookmarksButton(boolean showBookmarksButton)
    Gets or sets a visibility of the Bookmarks button in the toolbar of the preview.
    void
    setShowButtonCaptions(boolean showButtonCaptions)
    Gets or sets a value which allows displaying or hiding preview toolbar buttons captions.
    void
    setShowCurrentPageControl(boolean showCurrentPageControl)
    Gets or sets a visibility of the current page control in the toolbar of the preview.
    void
    setShowEditorButton(boolean showEditorButton)
    Gets or sets a visibility of the Editor button in the toolbar of the preview.
    void
    setShowFindButton(boolean showFindButton)
    Gets or sets a visibility of the Find button in the toolbar of the preview.
    void
    setShowFirstPageButton(boolean showFirstPageButton)
    Gets or sets a visibility of the First Page button in the toolbar of the preview.
    void
    setShowLastPageButton(boolean showLastPageButton)
    Gets or sets a visibility of the Last Page button in the toolbar of the preview.
    void
    setShowNextPageButton(boolean showNextPageButton)
    Gets or sets a visibility of the Next Page button in the toolbar of the preview.
    void
    setShowOpenButton(boolean showOpenButton)
    Gets or sets a visibility of the Open button in the toolbar of the preview.
    void
    setShowParametersButton(boolean showParametersButton)
    Gets or sets a visibility of the Parameters button in the toolbar of the preview.
    void
    setShowPreviousPageButton(boolean showPreviousPageButton)
    Gets or sets a visibility of the Prev Page button in the toolbar of the preview.
    void
    setShowPrintButton(boolean showPrintButton)
    Gets or sets a visibility of the Print button in the toolbar of the preview.
    void
    setShowSaveButton(boolean showSaveButton)
    Gets or sets a visibility of the Save button in the toolbar of the preview.
    void
    setShowSendEmailButton(boolean showSendEmailButton)
    Gets or sets a visibility of the Send Email button in the toolbar of the preview.
    void
    setShowViewModeButton(boolean showViewModeButton)
    Gets or sets a visibility of the View Mode button in the toolbar of the preview.
    void
    setShowZoomButton(boolean showZoomButton)
    Gets or sets a visibility of the Zoom control in the toolbar of the preview.
    void
    setViewMode(StiWebViewMode viewMode)
    Gets or sets the mode of showing a report in the preview - Single Page, Continuous or Multiple Pages.
    void
    setVisible(boolean visible)
    Gets or sets a value which indicates that toolbar will be shown in the preview.

    Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

    cleanReference, getReference, setReference

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PreviewToolbarOptions

      public PreviewToolbarOptions()

  • Method Details

    • isVisible

      public boolean isVisible()
      Gets or sets a value which indicates that toolbar will be shown in the preview.
      Returns:
      the visible

    • setVisible

      public void setVisible(boolean visible)
      Gets or sets a value which indicates that toolbar will be shown in the preview.
      Parameters:
      visible - the visible to set

    • getDisplayMode

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

    • setDisplayMode

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

    • getBackgroundColor

      public StiColor getBackgroundColor()
      Gets or sets a color of the preview toolbar background. The default value is the theme color.
      Returns:
      the backgroundColor

    • setBackgroundColor

      public void setBackgroundColor(StiColor backgroundColor)
      Gets or sets a color of the preview toolbar background. The default value is the theme color.
      Parameters:
      backgroundColor - the backgroundColor to set

    • getBorderColor

      public StiColor getBorderColor()
      Gets or sets a color of the preview toolbar border. The default value is the theme color.
      Returns:
      the borderColor

    • setBorderColor

      public void setBorderColor(StiColor borderColor)
      Gets or sets a color of the preview toolbar border. The default value is the theme color.
      Parameters:
      borderColor - the borderColor to set

    • getFontColor

      public StiColor getFontColor()
      Gets or sets a color of the preview toolbar texts.
      Returns:
      the fontColor

    • setFontColor

      public void setFontColor(StiColor fontColor)
      Gets or sets a color of the preview toolbar texts.
      Parameters:
      fontColor - the fontColor to set

    • getFontFamily

      public String getFontFamily()
      Gets or sets a value which indicates which font family will be used for drawing texts in the preview.
      Returns:
      the fontFamily

    • setFontFamily

      public void setFontFamily(String fontFamily)
      Gets or sets a value which indicates which font family will be used for drawing texts in the preview.
      Parameters:
      fontFamily - the fontFamily to set

    • getAlignment

      public StiContentAlignment getAlignment()
      Gets or sets the alignment of the preview toolbar.
      Returns:
      the alignment

    • setAlignment

      public void setAlignment(StiContentAlignment alignment)
      Gets or sets the alignment of the preview toolbar.
      Parameters:
      alignment - the alignment to set

    • isShowButtonCaptions

      public boolean isShowButtonCaptions()
      Gets or sets a value which allows displaying or hiding preview toolbar buttons captions.
      Returns:
      the showButtonCaptions

    • setShowButtonCaptions

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

    • isShowPrintButton

      public boolean isShowPrintButton()
      Gets or sets a visibility of the Print button in the toolbar of the preview.
      Returns:
      the showPrintButton

    • setShowPrintButton

      public void setShowPrintButton(boolean showPrintButton)
      Gets or sets a visibility of the Print button in the toolbar of the preview.
      Parameters:
      showPrintButton - the showPrintButton to set

    • isShowOpenButton

      public boolean isShowOpenButton()
      Gets or sets a visibility of the Open button in the toolbar of the preview.
      Returns:
      the showOpenButton

    • setShowOpenButton

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

    • isShowSaveButton

      public boolean isShowSaveButton()
      Gets or sets a visibility of the Save button in the toolbar of the preview.
      Returns:
      the showSaveButton

    • setShowSaveButton

      public void setShowSaveButton(boolean showSaveButton)
      Gets or sets a visibility of the Save button in the toolbar of the preview.
      Parameters:
      showSaveButton - the showSaveButton to set

    • isShowSendEmailButton

      public boolean isShowSendEmailButton()
      Gets or sets a visibility of the Send Email button in the toolbar of the preview.
      Returns:
      the showSendEmailButton

    • setShowSendEmailButton

      public void setShowSendEmailButton(boolean showSendEmailButton)
      Gets or sets a visibility of the Send Email button in the toolbar of the preview.
      Parameters:
      showSendEmailButton - the showSendEmailButton to set

    • isShowFindButton

      public boolean isShowFindButton()
      Gets or sets a visibility of the Find button in the toolbar of the preview.
      Returns:
      the showFindButton

    • setShowFindButton

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

    • isShowBookmarksButton

      public boolean isShowBookmarksButton()
      Gets or sets a visibility of the Bookmarks button in the toolbar of the preview.
      Returns:
      the showBookmarksButton

    • setShowBookmarksButton

      public void setShowBookmarksButton(boolean showBookmarksButton)
      Gets or sets a visibility of the Bookmarks button in the toolbar of the preview.
      Parameters:
      showBookmarksButton - the showBookmarksButton to set

    • isShowParametersButton

      public boolean isShowParametersButton()
      Gets or sets a visibility of the Parameters button in the toolbar of the preview.
      Returns:
      the showParametersButton

    • setShowParametersButton

      public void setShowParametersButton(boolean showParametersButton)
      Gets or sets a visibility of the Parameters button in the toolbar of the preview.
      Parameters:
      showParametersButton - the showParametersButton to set

    • isShowEditorButton

      public boolean isShowEditorButton()
      Gets or sets a visibility of the Editor button in the toolbar of the preview.
      Returns:
      the showEditorButton

    • setShowEditorButton

      public void setShowEditorButton(boolean showEditorButton)
      Gets or sets a visibility of the Editor button in the toolbar of the preview.
      Parameters:
      showEditorButton - the showEditorButton to set

    • isShowFirstPageButton

      public boolean isShowFirstPageButton()
      Gets or sets a visibility of the First Page button in the toolbar of the preview.
      Returns:
      the showFirstPageButton

    • setShowFirstPageButton

      public void setShowFirstPageButton(boolean showFirstPageButton)
      Gets or sets a visibility of the First Page button in the toolbar of the preview.
      Parameters:
      showFirstPageButton - the showFirstPageButton to set

    • isShowPreviousPageButton

      public boolean isShowPreviousPageButton()
      Gets or sets a visibility of the Prev Page button in the toolbar of the preview.
      Returns:
      the showPreviousPageButton

    • setShowPreviousPageButton

      public void setShowPreviousPageButton(boolean showPreviousPageButton)
      Gets or sets a visibility of the Prev Page button in the toolbar of the preview.
      Parameters:
      showPreviousPageButton - the showPreviousPageButton to set

    • isShowCurrentPageControl

      public boolean isShowCurrentPageControl()
      Gets or sets a visibility of the current page control in the toolbar of the preview.
      Returns:
      the showCurrentPageControl

    • setShowCurrentPageControl

      public void setShowCurrentPageControl(boolean showCurrentPageControl)
      Gets or sets a visibility of the current page control in the toolbar of the preview.
      Parameters:
      showCurrentPageControl - the showCurrentPageControl to set

    • isShowNextPageButton

      public boolean isShowNextPageButton()
      Gets or sets a visibility of the Next Page button in the toolbar of the preview.
      Returns:
      the showNextPageButton

    • setShowNextPageButton

      public void setShowNextPageButton(boolean showNextPageButton)
      Gets or sets a visibility of the Next Page button in the toolbar of the preview.
      Parameters:
      showNextPageButton - the showNextPageButton to set

    • isShowLastPageButton

      public boolean isShowLastPageButton()
      Gets or sets a visibility of the Last Page button in the toolbar of the preview.
      Returns:
      the showLastPageButton

    • setShowLastPageButton

      public void setShowLastPageButton(boolean showLastPageButton)
      Gets or sets a visibility of the Last Page button in the toolbar of the preview.
      Parameters:
      showLastPageButton - the showLastPageButton to set

    • isShowZoomButton

      public boolean isShowZoomButton()
      Gets or sets a visibility of the Zoom control in the toolbar of the preview.
      Returns:
      the showZoomButton

    • setShowZoomButton

      public void setShowZoomButton(boolean showZoomButton)
      Gets or sets a visibility of the Zoom control in the toolbar of the preview.
      Parameters:
      showZoomButton - the showZoomButton to set

    • isShowViewModeButton

      public boolean isShowViewModeButton()
      Gets or sets a visibility of the View Mode button in the toolbar of the preview.
      Returns:
      the showViewModeButton

    • setShowViewModeButton

      public void setShowViewModeButton(boolean showViewModeButton)
      Gets or sets a visibility of the View Mode button in the toolbar of the preview.
      Parameters:
      showViewModeButton - the showViewModeButton to set

    • getPrintDestination

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

    • setPrintDestination

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

    • getViewMode

      public StiWebViewMode getViewMode()
      Gets or sets the mode of showing a report in the preview - Single Page, Continuous or Multiple Pages.
      Returns:
      the viewMode

    • setViewMode

      public void setViewMode(StiWebViewMode viewMode)
      Gets or sets the mode of showing a report in the preview - Single Page, Continuous or Multiple Pages.
      Parameters:
      viewMode - the viewMode to set